# legacydeveloper Object Reference - Full Documentation # AbnExperiment Represents an A/B/n experiment that's used with Marketing Cloud Next content, Experience Cloud websites, and platform automations. This object is available in API version 63.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | DataSpaceId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the data space where an experiment's resources originate. Required. This field is a relationship field. Relationship Name DataSpace Refers To DataSpace | | Description | Type string Properties Filter, Group, Nillable, Sort Description Text description of the experiment. Optional. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description System or user-generated API name for the experiment. Required. | | LastAnalyzed | Type dateTime Properties Filter, Nillable, Sort Description Time and date of last analysis. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time an experiment was referenced by another resource. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time a user viewed the experiment. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Text label that identifies the experiment. Required. | | PersonalizationSchemaEnum | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Picklist value that indicates the type of personalization schema, which is related to where a personalization decision is created. Possible values are: - DecisionDefined - ExperienceVariation - FlowPath | | PersonalizationSchemaId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to the schema that’s related to the experiment. This field is a relationship field. Relationship Name PersonalizationSchema Refers To PersonalizationSchema | | PrimaryMetricId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to engagement signal metrics, which are used to measure an experiment. This field is a polymorphic relationship field. Relationship Name PrimaryMetric Refers To EngagementSignalCmpndMetric, EngagementSignalMetric | | ProfileDataGraphId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to the profile data graph that’s used. This field is a relationship field. Relationship Name ProfileDataGraph Refers To DataGraph | | ScheduleFrequencyInMinutes | Type int Properties Filter, Group, Nillable, Sort Description Number of minutes that defines when personalized content can be made available. | | Source | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates where the experiment was created. Possible values are: - BlockBuilder—CMS content editors - ExperienceBuilder—Experience Site Builder - FlowBuilder - PersonalizationApp | | SourceRecordId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to the specific record that contains the experiment. This field is a polymorphic relationship field. Relationship Name SourceRecord Refers To FlowRecordElement, ManagedContent | | StartedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates when the experiment began or is scheduled to begin. | | State | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Picklist value that indicates the current state of the experiment. Possible values are: - Archived - Created - Started - Stopped The default value is Created. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Picklist value that indicates the current status of the experiment while an action is being performed. Possible values are: - Active - CreateError - DeleteError - Deleting - EditError - Processing The default value is Processing. | | StoppedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates when the experiment ended or is scheduled to end. | | WinnerSelectionMode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Possible values are: - Automatic - Manual The default value is Manual. | ## 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. [AbnExperimentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AbnExperimentFeed](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. [AbnExperimentHistory](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. [AbnExperimentOwnerSharingRule](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. [AbnExperimentShare](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. # AbnExperimentCohort Represents the specified audience that's participating in an A/B/n experiment. This object is available in API version 63.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AbnExperimentId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to a related experiment. This field is a relationship field. Relationship Name AbnExperiment Relationship Type Parent-detail Refers To AbnExperiment (the parent object) | | AllocationWeight | Type int Properties Filter, Group, Nillable, Sort Description Percentage of an audience to experience the selected part of the experiment. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Three letter ISO currency codes for supported currencies. Optional. Possible values are: - USD—U.S. Dollar | | DataSpaceId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to the data space where an experiment cohort's resources originate. Required. This field is a relationship field. Relationship Name DataSpace Refers To DataSpace | | Description | Type string Properties Filter, Group, Nillable, Sort Description Text description of the experiment. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description System or user-generated API name for the experiment. Required. | | IsControl | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the cohort is used as the control group that performance is checked against. The default value is false. | | IsFallThrough | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this cohort captures users who don't meet the criteria for other cohorts in the experiment. When true, this cohort serves as the fallback option. When false, users must explicitly qualify for this cohort. The default value is false. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Text label that identifies the experiment cohort. Required. | | PersonalizerId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to the personalizer that’s related to the experiment cohort. This field is a relationship field. Relationship Name Personalizer Refers To PersonalizationRecommender | ## Usage Use this object to describe experiment cohorts or to change allocation weights. ## 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. [AbnExperimentCohortChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AbnExperimentCohortFeed](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. [AbnExperimentCohortHistory](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. [AbnExperimentCohortOwnerSharingRule](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. [AbnExperimentCohortShare](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. # AcceptedEventRelation Represents event participants (invitees or attendees) with the status Accepted for a given event. This object is available in API versions 29.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | EventId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the event. This is a relationship field. Relationship Name Event Relationship Type Lookup Refers To Event | | RelationId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the invitee. This is a polymorphic relationship field. Relationship Name Relation Relationship Type Lookup Refers To Calendar, Contact, Lead, User | | RespondedDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates the most recent date and time when the invitee accepted an invitation to the event. | | Response | Type string Properties Filter, Group, Nillable, Sort Description Indicates the content of the response field. Label is Comment. | | Type | Type string Properties Filter, Group, Nillable, Sort Description Indicates whether the invitee is a user, lead or contact, or resource. | ## Usage Query invitees who have accepted an invitation to an event SELECT eventId, type, response FROM AcceptedEventRelation WHERE eventid='00UTD000000ZH5LA' #### See Also - [DeclinedEventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_declinedeventrelation.htm "Represents event participants (invitees or attendees) with the status Declined for a given event. This object is available in API versions 29.0 and later.") - [UndecidedEventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_undecidedeventrelation.htm "Represents event participants (invitees or attendees) with the status Not Responded for a given event. This object is available in API versions 29.0 and later.") # Account Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners). ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), merge(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Experience Cloud site or Customer Portal users can access their own accounts and any account shared with them. ## Fields | Field Name | Details | | --- | --- | | AccountNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Account number assigned to this account (not the unique, system-generated ID assigned during creation). Maximum size is 40 characters. | | AccountSource | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The source of the account record. For example, Advertisement or Trade Show. The source is selected from a picklist of available values, which are set by an administrator. Each picklist value can have up to 40 characters. | | ActivityMetricId | Type reference Properties Filter, Group, Nillable, Sort Description When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric. This field is a relationship field. Relationship Name ActivityMetric Refers To ActivityMetric | | ActivityMetricRollupId | Type reference Properties Filter, Group, Nillable, Sort Description When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup. This field is a relationship field. Relationship Name ActivityMetricRollup Refers To ActivityMetricRollup | | AnnualRevenue | Type currency Properties Create, Filter, Nillable, Sort, Update Description Estimated annual revenue of the account. | | BillingAddress | Type address Properties Filter, Nillable Description The compound form of the billing address. Read-only. For details on compound address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address of this account. Maximum size is 40 characters. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address of this account. Maximum size is 80 characters. | | BillingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the account’s billing address. | | BillingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the billing address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address of this account. Maximum size is 20 characters. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address of this account. Maximum size is 80 characters. | | BillingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the account’s billing address. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street address for the billing address of this account. | | ChannelProgramLevelName | Type string Properties Group, Nillable Description Read only. Name of the channel program level the account has enrolled. If this account has enrolled more than one channel program level, the oldest channel program name is displayed. | | ChannelProgramName | Type string Properties Group, Nillable Description Read only. Name of the channel program the account has enrolled. If this account has enrolled more than one channel program, the oldest channel program name is displayed. | | CleanStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the record’s clean status as compared with Data.com.. Possible values are: - AcknowledgedThe label on the account record detail page is Reviewed. - Different - Inactive - Matched—The label on the account record detail page is In Sync. - NotFound - PendingThe label on the account record detail page is Not Compared. - SelectMatch - Skipped | | CommerceCustomerReference | Type string Properties Filter, Group, Nillable, Sort Description The external Commerce ID of the individual. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later. | | CommerceGroupReference | Type string Properties Filter, Group, Nillable, Sort Description The external name of the Commerce customer group. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later. | | CommerceOrganizationReference | Type string Properties Filter, Group, Nillable, Sort Description The external organization ID of the Commerce instance. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later. | | ConnectionReceivedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce. | | ConnectionSentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections. | | Description | Type textarea Properties Create, Nillable, Update Description Text description of the account. Limited to 32,000 KB. | | DunsNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. Maximum size is 9 characters. This field is available on business accounts, not person accounts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is only available to organizations that use Data.com Prospector or Data.com Clean. | | Fax | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Fax number for the account. | | Industry | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description An industry associated with this account. For example, Biotechnology. Maximum size is 40 characters. | | IsBuyer | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the account is enabled as a buyer for Lightning B2B Commerce. The default value is false. This field is available in API version 48.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is only available to organizations that have the B2B Commerce license enabled. | | IsCustomerPortal | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the account has at least one contact enabled to use the org's Experience Cloud site or Customer Portal (true) or not (false). This field is available if Customer Portal is enabled OR digital experiences is enabled. If your org is enabled to use Content Security Policy (CSP) features, then this field is visible on the Account object even if those features are later disabled. If you change this field's value from true to false, you can disable up to 100 Experience Cloud site or Customer Portal users associated with the account and permanently delete all of the account's site roles and groups. You can't restore deleted site roles and groups. Exclude this field when merging accounts. This field can be updated in API version 16.0 and later. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for an Experience Cloud site. We also recommend that you make this update after business hours. | | IsPartner | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the account has at least one contact enabled to use the org's partner portal (true) or not (false). This field is available if partner relationship management (partner portal) is enabled OR digital experiences is enabled and you have partner portal licenses. If you change this field's value from true to false, you can disable up to 15 partner portal users associated with the account and permanently delete all of the account's partner portal roles and groups. You can't restore deleted partner portal roles and groups. Disabling a partner portal user in the Salesforce user interface or the API doesn’t change this field's value from true to false. Even if this field's value is false, you can enable a contact on an account as a partner portal user via the API. Exclude this field when merging accounts. This field can be updated in API version 16.0 and later. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for an Experience Cloud site. We also recommend that you make this update after business hours. | | IsPersonAccount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read only. Label is **Is Person Account**. Indicates whether this account has a record type of Person Account (true) or not (false). | | IsPriorityRecord | Type boolean Properties Defaulted on create, Group Description Shows whether the user has marked the account as important (True) or not (False). The default value is false. Available in API version 60.0 and later. | | Jigsaw | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description References the ID of a company in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is **Data.com Key**. This field is available on business accounts, not person accounts. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify the value in the Jigsaw field. | | JigsawCompanyId | Type string Properties Filter, Group, Nillable, Sort Description The ID of the company in reference to Jigsaw. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Don’t modify the value in the Jigsaw field. | | LastActivityDate | Type date Properties Filter, Group, Nillable, Sort Description Value is one of the following, whichever is the most recent: - Due date of the most recent event logged against the record. - Due date of the most recently closed task associated with the record. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The 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. | | MasterRecordId | Type reference Properties Filter, Group, Nillable, Sort Description If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null. This is a relationship field. Relationship Name MasterRecord Relationship Type Lookup Refers To Account | | NaicsCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The six-digit North American Industry Classification System (NAICS) code is the standard used by business and government to classify business establishments into industries, according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. Maximum size is 8 characters. This field is available on business accounts, not person accounts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is only available to organizations that use Data.com Prospector or Data.com Clean. | | NaicsDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an org’s line of business, based on its NAICS code. Maximum size is 120 characters. This field is available on business accounts, not person accounts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is only available to organizations that use Data.com Prospector or Data.com Clean. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Required. Label is **Account Name**. Name of the account. Maximum size is 255 characters. If the account has a record type of Person Account: - This value is the concatenation of the FirstName, MiddleName, LastName, and Suffix of the associated person contact. - You can't modify this value. | | NumberOfEmployees | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Label is **Employees**. Number of employees working at the company represented by this account. Maximum size is eight digits. | | OperatingHoursId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The operating hours associated with the account. Available only if Field Service is enabled. This is a relationship field. Relationship Name OperatingHours Relationship Type Lookup Refers To OperatingHours | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this account. Default value is the user logged in to the API to perform the create. If you have set up account teams in your org, updating this field has different consequences depending on your version of the API: - For API version 12.0 and later, sharing records are kept, as they are for all objects. - For API version before 12.0, sharing records are deleted. - For API version 16.0 and later, users must have the “Transfer Record” permission in order to update (transfer) account ownership using this field. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | Ownership | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Ownership type for the account, for example Private, Public, or Subsidiary. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the parent object, if any. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account | | PersonActionCadenceAssigneeId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the sales rep designated to work the lead through their assigned cadence. This field is available in API version 47.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. This field is a polymorphic relationship field. Relationship Name PersonActionCadenceAssignee Refers To Group, User | | PersonActionCadenceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the lead’s assigned cadence. This field is available in API version 46.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. This is a relationship field. Relationship Name PersonActionCadence Refers To ActionCadence | | PersonActionCadenceState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The state of the current action cadence tracker. This field is available in API version 50.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. Possible values are: - Complete - Error - Initializing - Paused - Processing - Running | | PersonIndividualId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the data privacy record associated with this person’s account. This field is available if you enabled Data Protection and Privacy in Setup. Available in API version 42.0 and later. | | PersonScheduledResumeDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the action cadence tracker is going to resume after it’s paused or on a wait step. This field is available in API version 54.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number for this account. Maximum size is 40 characters. | | PhotoUrl | Type url Properties Filter, Group, Nillable, Sort Description Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account. Blank if Social Accounts and Contacts isn't enabled for the org or if Social Accounts and Contacts is disabled for the requesting user. | | Rating | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The account’s prospect rating, for example Hot, Warm, or Cold. | | RecordTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the record type assigned to this object. | | Salutation | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Honorific added to the name for use in letters, etc. This field is available on person accounts. | | ShippingAddress | Type address Properties Filter, Nillable Description The compound form of the shipping address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | ShippingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address for this account. City maximum size is 40 characters | | ShippingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address for this account. Country maximum size is 80 characters. | | ShippingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the account’s shipping address. | | ShippingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the shipping address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | ShippingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | ShippingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | ShippingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address for this account. Postal code maximum size is 20 characters. | | ShippingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address for this account. State maximum size is 80 characters. | | ShippingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the account’s shipping address. | | ShippingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street address of the shipping address for this account. Maximum of 255 characters. | | Sic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Standard Industrial Classification code of the company’s main business categorization, for example, 57340 for Electronics. Maximum of 20 characters. This field is available on business accounts, not person accounts. | | SicDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an org’s line of business, based on its SIC code. Maximum length is 80 characters. This field is available on business accounts, not person accounts. | | Site | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the account’s location, for example Headquarters or London. Label is **Account Site**. Maximum of 80 characters. | | TickerSymbol | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The stock market symbol for this account. Maximum of 20 characters. This field is available on business accounts, not person accounts. | | Tradestyle | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A name, different from its legal name, that an org may use for conducting business. Similar to “Doing business as” or “DBA”. Maximum length is 255 characters. This field is available on business accounts, not person accounts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is only available to organizations that use Data.com Prospector or Data.com Clean. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Type of account, for example, Customer, Competitor, or Partner. | | Website | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The website of this account. Maximum of 255 characters. | | YearStarted | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The date when an org was legally established. Maximum length is 4 characters. This field is available on business accounts, not person accounts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is only available to organizations that use Data.com Prospector or Data.com Clean. | ## IsPersonAccount Fields These fields are the subset of person account fields that are contained in the child person contact record of each person account. If the IsPersonAccount field has the value false, the following fields have a null value and can't be modified. If true, the fields can be modified. Person account fields only show when person accounts are enabled. Person accounts are disabled by default.
Field Name Details
FirstName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
First name of the person for a person account. Maximum size is 40 characters.
LastName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Last name of the person for a person account. Required if the record type is a person account record type. Maximum size is 80 characters.
MiddleName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Middle name of the person for a person account. Maximum size is 40 characters.
PersonAssistantName
Type
string
Properties
Create, Filter, Nillable, Update
Description
The person account’s assistant name. Label is Assistant. Maximum size is 40 characters.
PersonAssistantPhone
Type
phone
Properties
Create, Filter, Nillable, Update
Description
The person account’s assistant phone. Label is Asst. Phone. Maximum size is 40 characters.
PersonBirthDate
Type
date
Properties
Create, Filter, Nillable, Update
Description
The birthday of the contact associated with this person account. Label is Birthdate. The year portion of the PersonBirthDate field is ignored in filter criteria, including report filters, list view filters, and SOQL queries. For example, the following SOQL query returns person accounts with birthdays later in the year than today:
SELECT FirstName, LastName, PersonBirthDate
FROM Account
WHERE Birthdate > TODAY
PersonContactId
Type
reference
Properties
Filter, Nillable, Update
Description
The ID for the contact associated with this person account. Label is Contact ID.
PersonDepartment
Type
string
Properties
Create, Filter, Nillable, Update
Description
The department. Label is Department. Maximum size is 80 characters.
PersonEmail
Type
email
Properties
Create, Filter, Nillable, Update
Description
Email address for this person account. Label is Email.
PersonEmailBouncedDate
Type
dateTime
Properties
Create, Filter, Nillable, Update
Description
If bounce management is activated and an email sent to the person account bounces, the date and time the bounce occurred.
PersonEmailBouncedReason
Type
string
Properties
Create, Filter, Nillable, Update
Description
If bounce management is activated and an email sent to the person account bounces, the reason the bounce occurred
PersonGenderIdentity
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The person’s internal experience of their gender, which may or may not correspond to the person’s designated sex at birth. Label is Gender Identity.
PersonHasOptedOutOfEmail
Type
boolean
Properties
Create, Filter, Nillable, Update
Description
Indicates whether the person account has opted out of email (true) or not (false). Label is Email Opt Out.
PersonHomePhone
Type
phone
Properties
Create, Filter, Nillable, Update
Description
The home phone number for this person account. Label is Home Phone.
PersonLeadSource
Type
picklist
Properties
Create, Filter, Nillable, Update
Description
The person account’s lead source. Label is Lead Source.
PersonMailingAddress
Type
address
Properties
Filter, Nillable
Description
The compound form of the person account mailing address. Read-only. For details on compound address fields, see Address Compound Fields.
  • PersonMailingCity
  • PersonMailingCountry
  • PersonMailingPostalCode
  • PersonMailingState
Type
string
Properties
Create, Filter, Nillable, Update
Description
Details about the mailing address for this person account. Labels are Mailing City, Mailing Country, Postal Code, and State. Maximum size for city and country is 40 characters. Maximum size for postal code and state is 20 characters.
  • PersonMailingCountryCode
  • PersonMailingStateCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO country or state code for the mailing address of the person account.
PersonMailingGeocodeAccuracy
Type
picklist
Properties
Retrieve, Query, Restricted picklist, Nillable
Description
Accuracy level of the geocode for the person’s mailing address. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
PersonMailingLatitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with PersonMailingLongitude to specify the precise geolocation of a person account’s mailing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
PersonMailingLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with PersonMailingLatitude to specify the precise geolocation of a person account’s mailing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
PersonMailingStreet
Type
textarea
Properties
Create, Filter, Nillable, Update
Description
The mailing street address for this person account. Label is Mailing Street. Maximum size is 255 characters.
PersonMobilePhone
Type
phone
Properties
Create, Filter, Nillable, Update
Description
The mobile phone number for this person account. Label is Mobile.
  • PersonOtherCity
  • PersonOtherCountry
  • PersonOtherPostalCode
  • PersonOtherState
Type
string
Properties
Create, Filter, Nillable, Update
Description
Details about the alternate address for this person account. Labels are Other City, Other Country, Other Zip/Postal Code, and Other State.
  • PersonOtherCountryCode
  • PersonOtherStateCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO country or state code for the alternate address of the person account.
PersonOtherLatitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with PersonOtherLongitude to specify the precise geolocation of a person account’s alternate address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
PersonOtherLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with PersonOtherLatitude to specify the precise geolocation of a person account’s alternate address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
PersonOtherPhone
Type
phone
Properties
Create, Filter, Nillable, Update
Description
The alternate phone number for this person account. Label is Other Phone.
PersonOtherStreet
Type
textarea
Properties
Create, Filter, Nillable, Update
Description
The person account’s alternate street address. Label is Other Street.
PersonPronouns
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The individual’s personal pronouns, reflecting their gender identity. Others can use these pronouns to refer to the individual in the third person. The entry is selected from a picklist of available values, which the administrator sets. Maximum 40 characters. Label is Pronouns.
Possible values are:
  • He/Him
  • He/They
  • Not Listed
  • She/Her
  • She/They
  • They/Them
PersonReportsToId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort Update
Description
ID of the person account or contact that this person account reports to.
This field doesn't appear if enableReportsToOnPersonAccount in the AccountSettings metadata type is false.
Available in API version 62.0 and later.
This is a relationship field.
Relationship Name
PersonReportsTo
Relationship Type
Lookup
Refers To
Contact
PersonTitle
Type
string
Properties
Create, Filter, Nillable, Update
Description
The person account’s title. Label is Title. Maximum size is 80 characters. When converting a lead to a person account, the conversion fails if the lead’s Title field contains more than 80 characters.
Suffix
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name suffix of the person for a person account. Maximum size is 40 characters.
![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When importing account data, users need the Set Audit Fields upon Record Creation permission to assign values to audit fields such as CreatedDate. Audit fields are automatically updated during API operations unless you set these fields yourself. ## Usage Use this object to query and manage accounts in your org. Client applications can create, update, delete, or query Attachment records associated with an account via the API. Client applications can also create or update account objects by converting a Lead via the convertLead() call. If the values in the IsPersonAccount Fields are not null, you can't change IsPersonAccount to false or an error occurs. ## 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. [AccountChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 44.0) Change events are available for the object. [AccountFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) (API version 18.0) Feed tracking is available for the object. [AccountHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) (API version 11.0) History is available for tracked fields of the object. [AccountOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm) Sharing rules are available for the object. [AccountShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm) Sharing is available for the object. #### See Also - [AccountShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm "Represents a sharing entry on an account.") - [AccountTeamMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountteammember.htm "Represents a User who is a member of an Account team.") - [_SOAP API Developer Guide_: Person Account Record Types](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_guidelines_personaccounts.htm "SOAP API Developer Guide: Person Account Record Types - HTML (New Window)") # AccountBrand Represents the brand details of a Partner Account. This object is available in API version 43.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated() query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only if digital experiences is enabled in your org and it has a Partner Community or Customer Community Plus license. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the Account. This number is unique within your organization. | | Address | Type address Properties Filter, Nillable Description The street address. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city. | | CompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the company associated with the account brand. | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the account is physically located. | | Email | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Email address associated with the account. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist Sort, Update Description Stores data for accurate geocoded location. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Most recent date referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Most recent date viewed. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used along with Longitude to specify the precise geolocation of an address. | | LogoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the logo. | | LogoUrl | Type url Properties Nillable, Description URL of the logo. This field is available in API version 44.0 and later. | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of an address. | | Name | Type string Properties Create, Filter, Nillable, Sort, Update Description Required. Name of the account. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. ID of the Owner. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number. | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code where the user’s IP address is physically located. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The address state. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The address street. | | Website | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Website for the Account Brand. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [AccountBrandOwnerSharingRule](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. [AccountBrandShare](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. # AccountCleanInfo Stores the metadata Data.com Clean uses to determine an account record’s clean status. AccountCleanInfo helps you automate the cleaning or related processing of account records. This object is removed in API version 67.0 ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). Account Clean Info provides a snapshot of the data in your Salesforce account record and its matched Data.com record at the time the Salesforce record was cleaned. Account Clean Info includes a number of bit vector fields, whose component fields each correspond to individual object fields and provide related data or status information about those fields. For example, the bit vector field IsDifferent has an IsDifferentState field. If the IsDifferentState field’s value is False, that means the State field value is _the same_ on the Salesforce account record and its matched Data.com record. AccountCleanInfo bit vector fields include: - CleanedBy indicates who (a user) or what (a Clean job) cleaned the account record. - IsDifferent indicates whether or not a field on the account record has a value that differs from the corresponding field on the matched Data.com record. - IsFlaggedWrong indicates whether or not a field on the account record has a value that is flagged as wrong to Data.com. - IsReviewed indicates whether or not a field on the account record is in a Reviewed state, which means that the value was reviewed but not accepted. Their individual bits are defined here. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Sort Description The unique, system-generated ID assigned when the account record was created. | | AccountSite | Type string Properties Filter, Group, Nillable, Sort Description Information about the account’s location, such as single location, headquarters, or branch. | | Address | Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | AnnualRevenue | Type currency Properties Filter, Nillable, Sort Description Estimated annual revenue of the account. | | City | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the account. | | CleanedByJob | Type boolean Properties Filter Description Indicates whether the account record was cleaned by a Data.com Clean job (true) or not (false). | | CleanedByUser | Type boolean Properties Filter Description Indicates whether the account record was cleaned by a Salesforce user (true) or not (false). | | CompanyName | Type string Properties Filter, Group, Nillable, Sort Description The name of the company. | | CompanyStatusDataDotCom | Type picklist Properties Filter, Group, Nillable, Sort Description The status of the company per Data.com. Values are: Company is In Business per Data.com or Company is Out of Business per Data.com. | | Country | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the account. | | DandBCompanyDunsNumber | Type string Properties Filter, Group, Nillable, Sort Description The D-U-N-S Number on the D&B Company record (if any) that is linked to the account. | | DataDotComId | Type string Properties Filter, Group, Nillable, Sort Description The ID Data.com maintains for the company. | | Description | Type textarea Properties Nillable Description A description of the account. | | DunsNumber | Type string Properties Filter, Group, Nillable, Sort Description The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. | | DunsRightMatchConfidence | Type int Properties Filter, Group, Nillable, Sort Description The account’s DUNSRight confidence code. | | DunsRightMatchGrade | Type string Properties Filter, Group, Nillable, Sort Description The account’s DUNSRight match grade. | | Fax | Type phone Properties Filter, Group, Nillable, Sort Description The account’s fax number. | | Industry | Type picklist Properties Filter, Group, Nillable, Sort Description The industry the account belongs to. | | IsDifferentAccountSite | Type boolean Properties Filter Description Indicates whether the account’s AccountSite field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentAnnualRevenue | Type boolean Properties Filter Description Indicates whether the account’s AnnualRevenue field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCity | Type boolean Properties Filter Description Indicates whether the account’s City field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCompanyName | Type boolean Properties Filter Description Indicates whether the account’s AccountName field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCountry | Type boolean Properties Filter Description Indicates whether the account’s Country field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCountryCode | Type boolean Properties Filter Description Indicates whether the account’s Country Code field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentDandBCompanyDunsNumber | Type boolean Properties Filter Description Indicates whether the account’s DandBCompanyID field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentDescription | Type boolean Properties Filter Description Indicates whether the account’s Description field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentDunsNumber | Type boolean Properties Filter Description Indicates whether the account’s DunsNumber field value is different from the D-U-N-S Number on its matched Data.com record (true) or not (false). | | IsDifferentFax | Type boolean Properties Filter Description Indicates whether the account’s Fax field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentIndustry | Type boolean Properties Filter Description Indicates whether the account’s Industry field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentNaicsCode | Type boolean Properties Filter Description Indicates whether the account’s NaicsCode field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentNaicsDescription | Type boolean Properties Filter Description Indicates whether the account’s NaicsDescription field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentNumberOfEmployees | Type boolean Properties Filter Description Indicates whether the account’s NumberOf Employees field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentOwnership | Type boolean Properties Filter Description Indicates whether the account’s Ownership field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentPhone | Type boolean Properties Filter Description Indicates whether the account’s Phone field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentPostalCode | Type boolean Properties Filter Description Indicates whether the account’s PostalCode field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentSic | Type boolean Properties Filter Description Indicates whether the account’s Sic field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentSicDescription | Type boolean Properties Filter Description Indicates whether the account’s SicDescription field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentState | Type boolean Properties Filter Description Indicates whether the account’s State field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentStateCode | Type boolean Properties Filter Description Indicates whether the account’s State Code field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentStreet | Type boolean Properties Filter Description Indicates whether the account’s State field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentTickerSymbol | Type boolean Properties Filter Description Indicates whether the account’s TickerSymbol field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentTradestyle | Type boolean Properties Filter Description Indicates whether the account’s Tradestyle field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentWebsite | Type boolean Properties Filter Description Indicates whether the account’s Website field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentYearStarted | Type boolean Properties Filter Description Indicates whether the account’s YearStarted field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsFlaggedWrongAccountSite | Type boolean Properties Filter, Update Description Indicates whether the account’s AccountSite field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongAddress | Type boolean Properties Filter, Update Description Indicates whether the account’s Address field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongAnnualRevenue | Type boolean Properties Filter, Update Description Indicates whether the account’s AnnualRevenue field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongCompanyName | Type boolean Properties Filter, Update Description Indicates whether the account’s CompanyName field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongDescription | Type boolean Properties Filter, Update Description Indicates whether the account’s Description field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongDunsNumber | Type boolean Properties Filter, Update Description Indicates whether the account’s DunsNumber field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongFax | Type boolean Properties Filter, Update Description Indicates whether the account’s Fax field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongIndustry | Type boolean Properties Filter, Update Description Indicates whether the account’s Industry field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongNaicsCode | Type boolean Properties Filter, Update Description Indicates whether the account’s NaicsCode field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongNaicsDescription | Type boolean Properties Filter, Update Description Indicates whether the account’s NaicsDescription field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongNumberOfEmployees | Type boolean Properties Filter, Update Description Indicates whether the account’s NumberOfEmployees field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongOwnership | Type boolean Properties Filter, Update Description Indicates whether the account’s Ownership field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongPhone | Type boolean Properties Filter, Update Description Indicates whether the account’s Phone field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongSic | Type boolean Properties Filter, Update Description Indicates whether the account’s Sic field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongSicDescription | Type boolean Properties Filter, Update Description Indicates whether the account’s SicDescription field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongTickerSymbol | Type boolean Properties Filter, Update Description Indicates whether the account’s TickerSymbol field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongTradestyle | Type boolean Properties Filter, Update Description Indicates whether the account’s Tradestyle field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongWebsite | Type boolean Properties Filter, Update Description Indicates whether the account’s Website field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongYearStarted | Type boolean Properties Filter, Update Description Indicates whether the account’s YearStarted field value is flagged as wrong to Data.com (true) or not (false). | | IsInactive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the account has been reported to Data.com as Inactive (true) or not (false). | | IsReviewedAccountSite | Type boolean Properties Filter, Update Description Indicates whether the account’s AccountSite field value is in a Reviewed state (true) or not (false). | | IsReviewedAddress | Type boolean Properties Filter, Update Description Indicates whether the account’s Address field value is in a Reviewed state (true) or not (false). | | IsReviewedAnnualRevenue | Type boolean Properties Filter, Update Description Indicates whether the account’s AnnualRevenue field value is in a Reviewed state (true) or not (false). | | IsReviewedCompanyName | Type boolean Properties Filter, Update Description Indicates whether the account’s CompanyName field value is in a Reviewed state (true) or not (false). | | IsReviewedDandBCompanyDunsNumber | Type boolean Properties Filter, Update Description Indicates whether the account’s DandBCompanyID field value is in a Reviewed state (true) or not (false). | | IsReviewedDescription | Type boolean Properties Filter, Update Description Indicates whether the account’s Description field value is in a Reviewed state (true) or not (false). | | IsReviewedDunsNumber | Type boolean Properties Filter, Update Description Indicates whether the account’s DunsNumber field value is in a Reviewed state (true) or not (false). | | IsReviewedFax | Type boolean Properties Filter, Update Description Indicates whether the account’s Fax field value is in a Reviewed state (true) or not (false). | | IsReviewedIndustry | Type boolean Properties Filter, Update Description Indicates whether the account’s Industry field value is in a Reviewed state (true) or not (false). | | IsReviewedNaicsCode | Type boolean Properties Filter, Update Description Indicates whether the account’s NaicsCode field value is in a Reviewed state (true) or not (false). | | IsReviewedNaicsDescription | Type boolean Properties Filter, Update Description Indicates whether the account’s NaicsDescription field value is in a Reviewed state (true) or not (false). | | IsReviewedNumberOfEmployees | Type boolean Properties Filter, Update Description Indicates whether the account’s NumberOfEmployees field value is in a Reviewed state (true) or not (false). | | IsReviewedOwnership | Type boolean Properties Filter, Update Description Indicates whether the account’s Ownership field value is in a Reviewed state (true) or not (false). | | IsReviewedPhone | Type boolean Properties Filter, Update Description Indicates whether the account’s Phone field value is in a Reviewed state (true) or not (false). | | IsReviewedSic | Type boolean Properties Filter, Update Description Indicates whether the account’s Sic field value is in a Reviewed state (true) or not (false). | | IsReviewedSicDescription | Type boolean Properties Filter, Update Description Indicates whether the account’s SicDescription field value is in a Reviewed state (true) or not (false). | | IsReviewedTickerSymbol | Type boolean Properties Filter, Update Description Indicates whether the account’s TickerSymbol field value is in a Reviewed state (true) or not (false). | | IsReviewedTradestyle | Type boolean Properties Filter, Update Description Indicates whether the account’s Tradestyle field value is in a Reviewed state (true) or not (false). | | IsReviewedWebsite | Type boolean Properties Filter, Update Description Indicates whether the account’s Website field value is in a Reviewed state (true) or not (false). | | IsReviewedYearStarted | Type boolean Properties Filter, Update Description Indicates whether the account’s YearStarted field value is in a Reviewed state (true) or not (false). | | LastMatchedDate | Type dateTime Properties Filter, Sort Description The date the account record was last matched and linked to a Data.com record. | | LastStatusChangedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of who or what last changed the record’s Clean Status field value: a Salesforce user or a Clean job. | | LastStatusChangedDate | Type dateTime Properties Filter, Nillable, Sort Description The date on which the record’s Clean Status field value was last changed. | | Latitude | Type double Properties Filter, Nillable, Sort Description Used with Longitude to specify the precise geolocation of a billing address. Data not currently provided. | | Longitude | Type double Properties Filter, Nillable, Sort Description Used with Latitude to specify the precise geolocation of a billing address. Data not currently provided. | | NaicsCode | Type string Properties Filter, Group, Nillable, Sort Description The six-digit North American Industry Classification System (NAICS) code is the standard used by business and government to classify business establishments into industries, according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. | | NaicsDescription | Type string Properties Filter, Group, Nillable, Sort Description A brief description of an organization’s line of business, based on its NAICS code. | | Name | Type string Properties Filter, Group, Sort, Update Description Field label is **Account Clean Info Name**. The name of the account. Maximum size is 255 characters. | | NumberOfEmployees | Type int Properties Filter, Group, Nillable, Sort Description The number of employees working at the account. | | Ownership | Type picklist Properties Filter, Group, Nillable, Sort Description Ownership type for the account, for example Private, Public, or Subsidiary. | | Phone | Type phone Properties Filter, Group, Nillable, Sort Description The phone number for the account. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the account. | | Sic | Type string Properties Filter, Group, Nillable, Sort Description Standard Industrial Classification code of the company’s main business categorization, for example, 57340 for Electronics. | | SicDescription | Type string Properties Filter, Group, Nillable, Sort Description A brief description of an organization’s line of business, based on its SIC code. | | State | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the account. | | Street | Type textarea Properties Filter, Group, Nillable, Sort Description Details for the billing address of the account. | | TickerSymbol | Type string Properties Filter, Group, Nillable, Sort Description The stock market symbol for the account. | | Tradestyle | Type string Properties Filter, Group, Nillable, Sort Description A name, different from its legal name, that an organization can use for conducting business. Similar to “Doing business as” (DBA). | | Website | Type url Properties Filter, Group, Nillable, Sort Description The website of the account. | | YearStarted | Type string Properties Filter, Group, Nillable, Sort Description The year the company was established or the year when current ownership or management assumed control of the company. | ## Usage Administrators can modify a limited set of AccountCleanInfo fields from the Account Clean Info page. Developers can create triggers that read the Account Clean Info fields to help automate the cleaning or related processing of account records. For example, you might create a trigger that reads the Clean Status field on the Account object. If an account record’s Clean Status field value is Different but the record has no Billing Street value, the trigger could update the record’s status to Not Compared. Create triggers that read AccountCleanInfo fields to help automate the cleaning or related processing of account records. For example: - Keep account records’ status InSync if the only difference from matched records is the Phone format (for example, (415) 353-8000 on the account record versus 415 353 8000 on the matched Data.com record). trigger AccountPhoneTrigger on Account (before update) { for (Account account: Trigger.new) { Account oldAccount = Trigger.oldMap.get(account.ID); if (account.CleanStatus == 'Different') { List cleanInfo = \[Select Id, IsDifferentPhone, IsReviewedPhone, Phone from AccountCleanInfo where AccountId = :account.Id\]; if (cleanInfo.size() > 0 && cleanInfo\[0\].IsDifferentPhone && cleanInfo\[0\].Phone.StartsWith('+')) { // if Data.com phone number is marked Different but starts with ‘+’, ignore this // and set the status to “Reviewed” AccountCleanInfo cleanInfoToUpdate = new AccountCleanInfo(); cleanInfoToUpdate.Id = cleanInfo\[0\].Id; cleanInfoToUpdate.IsReviewedPhone = true; update cleanInfoToUpdate; account.CleanStatus = 'Reviewed'; } } } } - Create a customized set of Industry field values for accounts. Use triggers to map values from fields on imported or cleaned records onto a standard set of values. - Read the CleanStatus field value on the Account object. If that value is Different, but a Salesforce record has no street address value, update the record’s status to Not Compared. ## 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. [AccountCleanInfoChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # AccountContactRelation Represents a relationship between a contact and one or more accounts. This object is available in API version 37.0. The AccountContactRelation object supports person accounts. That means that a person account can be either a related contact on a business account or a related account on a contact. A person account can also be related to another person account as either a related contact or related account. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AccountContactRelationshipCurrency | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | AccountId | Type reference Properties Create, Filter, Group, Sort Description ID of the account that is related to the contact. Field can't be modified when updating existing account-contact relationship records. | | ContactId | Type reference Properties Create, Filter, Group, Sort Description ID of the contact that is related to the account. Field can't be modified when updating existing account-contact relationship records. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date a relationship between a contact and account ended. Use with the Start Date to keep a history of the relationship. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether relationship is active (true) or not (false). | | IsDirect | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the account associated with the contact is the contact's primary account (true) or not (false). | | Roles | Type multipicklist Properties Create, Filter, Nillable, Update Description The contact’s participating role in the account. Values are Business User, Decision Maker, Economic Buyer, Economic Decision Maker, Evaluator, Executive Sponsor, Influencer, Technical Buyer, and Other. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date a relationship between a contact and account began. Use with the End Date to keep a history of the relationship. | ## Usage Use this object to associate a single contact record to multiple account records so you can easily track the relationships between the people and businesses they work with. When you insert a non-private contact in your org that associates a contact to multiple accounts, an AccountContactRelation is created and its validation rules, database insertion, and triggers are executed immediately after the contact is saved to the database. When you change a contact's primary account, an AccountContactRelation may be created or edited, and the AccountContactRelation validation rules, database changes, and triggers are executed immediately after the contact is saved to the database. See [Order of Execution](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_triggers_order_of_execution.htm). ## Associated Objects This object has these 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. [AccountContactRelationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. # AccountContactRole Represents the role that a Contact plays on an Account. ## 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 | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Account. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | ContactId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the Contact associated with this account. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsPrimary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the Contact plays the primary role on the Account (true) or not (false). Note that each account has only one primary contact role. Label is **Primary**. Default value is false. | | Role | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the role played by the Contact on this Account, such as Decision Maker, Approver, Buyer, and so on. Must be unique—there can't be multiple records in which the AccountId, ContactId, and Role values are identical. Different contacts can play the same role on the same account. A contact can play different roles on the same account. | ## Usage Use this object to define the role that a Contact plays on a given Account within the context of a specific Opportunity. ## 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. [AccountContactRoleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. #### See Also - [Account](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm "Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners).") - [Contact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm "Represents a contact, which is a person associated with an account.") # AccountInsight Represents an individual insight (a key business development) related to an account record. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To see an insight related to a specific account, users need a Sales Cloud Einstein license and access to the account record. As of the Spring ’20 release, Pardot and Sales Engagement users no longer have access to this object. ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Sort Description ID of the related account record. | | ActualHeardWithinDays | Type int Properties Filter, Group, Nillable, Sort Description Reserved for future use. | | CompetitorName | Type string Properties Filter, Group, Nillable, Sort Description This field has been deprecated as of API version 45.0. | | ContactName | Type string Properties Filter, Group, Nillable, Sort Description This field is not in use as of API version 46.0. | | ContactTitle | Type string Properties Filter, Group, Nillable, Sort Description This field is not in use as of API version 46.0. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Division | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The division of the related record. | | ExpectedHeardWithinDays | Type int Properties Filter, Group, Nillable, Sort Description Reserved for future use. | | LastHeard | Type dateTime Properties Filter, Nillable, Sort Description Reserved for future use. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | NumberOfNewsArticles | Type int Properties Filter, Group, Nillable, Sort Description The number of news articles related to insights of type M&A activity detected, Company is expanding, and Leadership changes. | | Rationale | Type string Properties Filter, Group, Nillable Description The explanation for an insight, providing more background information and details that are specific to the org. | | Title | Type string Properties Filter, Group, Nillable Description The title of the insight. | | TrendType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The trend type of the insight. Possible values include: - Negative - Positive - Informational | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of insight. Possible values include: - M&A activity detected - Company is expanding - Leadership changes | ## Usage This object is read-only and isn’t supported with workflows, triggers, or process builder. # AccountOwnerSharingRule Represents the rules for sharing an account with a User other than the owner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org. ## 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 | | --- | --- | | AccountAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Update Description A value that represents the type of sharing being allowed. The possible values are: - Read - Edit - All (This value isn’t valid for creating or updating.) | | CaseAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group for all child cases. The possible values are: - None - Read - Edit | | ContactAccessLevel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A value that represents the type of access granted to the target Group, UserRole, or User for any associated contacts. The possible values are: - None - Read - Edit ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When DefaultContactAccess is set to Controlled by Parent, you can’t create or update this field. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. This field is available in API version 24.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. An Account owned by a User in the source Group triggers the rule to give access. | | OpportunityAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group for any associated Opportunity. The possible values are: - None - Read - Edit | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access. | ## Usage Use this object to manage the sharing rules for accounts. General sharing and territory management-related sharing use this object. For example, the following code creates an account owner sharing rule between two public groups, which can also contain portal users. AccountOwnerSharingRule rule = new AccountOwnerSharingRule(); rule.setName("RuleName"); // Set the sharing rule name rule.setDeveloperName("RuleDeveloperName"); // Set the sharing rule developer name rule.setGroupId("00Gx00000000000"); // Set the group of users to share records from rule.setUserOrGroupId("00Gx00000000001"); // Set the group of users to share records to rule.setAccountAccessLevel("Edit"); rule.setOpportunityAccessLevel("Read"); rule.setCaseAccessLevel("None"); connection.create(rule); ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original territory management feature is now unavailable. For more information, see [The Original Territory Management Module Will Be Retired in the Summer ’21 Release](https://help.salesforce.com/articleView?id=The-original-Territory-Management-module-will-be-retired-in-the-Summer-20-release&language=en_US&type=1). The information in this topic applies to the original territory management feature only, and not to Enterprise Territory Management. #### See Also - [Account](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm "Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners).") - [AccountShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm "Represents a sharing entry on an account.") - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - html (New Window)") # AccountPartner This object represents a partner relationship between two Account records. An AccountPartner record is created automatically when a Partner record is created for a partner relationship between two accounts. An AccountPartner record is also created automatically between an account and an opportunity’s account when a Partner record is created between an account and an opportunity. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is completely distinct from and independent of Account records that have been enabled for the partner portal. ## Supported Calls create(), delete(), describeLayout()describeSObjects(), query(), retrieve() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | AccountFromId | Type reference Properties Create, Filter, Group, Sort Description ID of the main Account in the partner relationship. This is a relationship field. Relationship Name AccountFrom Relationship Type Lookup Refers To Account | | AccountToId | Type reference Properties Create, Filter, Group, Sort Description ID of the partner Account in the partner relationship. This is a relationship field. Relationship Name AccountTo Relationship Type Lookup Refers To Account | | IsPrimary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the AccountPartner is the primary partner of an opportunity (true). When there are no corresponding Opportunity Partner records, the value is false. | | OpportunityId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the opportunity in a partner relationship. This is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | ReversePartnerId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the reciprocal AccountPartner record in a partner relationship. | | Role | Type picklist Properties Create, Filter, Group, Nillable, Sort Description The UserRole that the partner Account has on the main Account. For example, Consultant or Distributor. | ## Creating an Account-Account Partner Relationship When you create a partner relationship between two accounts (when you create a Partner record and specify the AccountFromId), the API automatically creates two AccountPartner records, one for the forward relationship and one for the reverse. For example, if you create a Partner relationship with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId, the API automatically creates two AccountPartner records: - The forward relationship AccountPartner with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId. - The reverse relationship AccountPartner with “Acme Consulting” as the AccountFromId and “Acme, Inc.” as the AccountToId. - The value of the Role field in the reverse relationship AccountPartner is set to the PartnerRole record ReverseRole value associated with the value of the Role field in the forward relationship AccountPartner. This mapping allows the API to manage the records and their relationships efficiently. #### See Also - [Partner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partner.htm "Represents a partner relationship between two Account records or between an Opportunity record and an Account record.") - [OpportunityPartner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitypartner.htm "This object represents a partner relationship between an Account and an Opportunity. An OpportunityPartner record is created automatically when a Partner record is created for a partner relationship between an account and an opportunity.") # AccountPlan Represents customer information with measurable objectives and executable steps to proactively manage and grow customer relationships. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules This object is available if sales account plans are turned on. ## Fields | Field | Details | | --- | --- | | AccountChallenges | Type textarea Properties Create, Nillable, Update Description The key obstacles to the growth of the account. | | AccountCmptvWeaknesses | Type textarea Properties Create, Nillable, Update Description The shortcomings that hinder the account’s ability to outperform competitors in the market. | | AccountCompetitiveStrengths | Type textarea Properties Create, Nillable, Update Description The abilities of the account to outperform their competitors in the market. | | AccountCompetitors | Type textarea Properties Create, Nillable, Update Description The businesses or companies that offer similar products or services and compete for the same target market as the account. | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Account record. This field is a relationship field. Relationship Name Account Refers To Account | | AccountIndustryTrends | Type textarea Properties Create, Nillable, Update Description The shifts in the pattern of the industry that are specific to the account. | | AccountInternalRiskRating | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The rating that’s assigned to assess the risk level of the account. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. | | AccountPrfmIndicators | Type textarea Properties Create, Nillable, Update Description The key performance indicators used by the account to measure the success and effectiveness of a product or service. | | AccountStrategicPriorities | Type textarea Properties Create, Nillable, Update Description The key priorities of the account. | | AccountVision | Type textarea Properties Create, Nillable, Update Description The long-term value statement of the account. | | CallingStrategy | Type textarea Properties Create, Nillable, Update Description How frequently the relationship team meets with the account. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. | | CallingStrategyNotes | Type textarea Properties Create, Nillable, Update Description The outline of the format and organization of account meetings. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The end date of the account plan. | | FlexCard | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Omnistudio FlexCard. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly. For example, accessed through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the account plan. | | Notes | Type textarea Properties Create, Nillable, Update Description The notes or observations for the account plan. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the account plan. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | RelationshipOpportunities | Type textarea Properties Create, Nillable, Update Description The list of sales or potential deal opportunities in the relationship with the account. | | RelationshipStrengths | Type textarea Properties Create, Nillable, Update Description The strengths in the relationship with the account. | | RelationshipSummary | Type textarea Properties Create, Nillable, Update Description A concise overview of the relationship dynamics with the account. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. | | RelationshipThreats | Type textarea Properties Create, Nillable, Update Description The possible concerns in the relationship with the account. | | RelationshipWeaknesses | Type textarea Properties Create, Nillable, Update Description The shortcomings in the relationship with the account. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the account plan. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Specifies the status of the account plan. Possible values are: - Active - Inactive - Not Started The default value is Not Started. | ## Associated Objects This object has these 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. [AccountPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [AccountPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [AccountPlanOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm) Sharing rules are available for the object. [AccountPlanShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm) Sharing is available for the object. # AccountPlanObjective Represents strategic objectives or initiatives pursued by a relationship team with a customer to enhance customer engagement and satisfaction. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if sales account plans are turned on. ## Fields | Field | Details | | --- | --- | | AccountPlanId | Type reference Properties Create, Filter, Group, Sort Description The account plan associated with the objective. This field is a relationship field. Relationship Name AccountPlan Relationship Type Master-detail Refers To AccountPlan | | AccountPlanObjCategoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The category associated with the account plan objective. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. This field is a relationship field. Relationship Name AccountPlanObjCategory Refers To AccountPlanObjectiveCategory | | Description | Type textarea Properties Create, Nillable, Update Description The description of the account plan objective. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The end date of the account plan objective. | | ExternalStakeholderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The customer stakeholder contact associated with the account plan objective. The relationship team collaborates with the customer stakeholder to achieve a specific objective. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. This field is a relationship field. Relationship Name ExternalStakeholder Refers To Contact | | LastInteractionSumGenDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the most recent interaction summary was generated using Einstein Generative AI. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the account plan objective. | | ObjectiveInteractionSummary | Type textarea Properties Create, Nillable, Update Description The summary of interactions that occur with the account in relation to the account plan objective. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. | | ObjectiveOwnerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The owner user associated with the objective. This field is a relationship field. Relationship Name ObjectiveOwner Refers To User | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who created the record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Priority | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the level of importance placed on achieving the objective associated with the account plan. To access this field, you must have an FSC Sales or a Financial Services Cloud Extension license. Possible values are: - High - Low - Medium | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the account plan objective. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the status of the account plan objective. Possible values are: - Closed - In Progress - New | ## Associated Objects This object has these 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. [AccountPlanObjectiveChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanObjectiveHistory](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. [AccountPlanObjectiveOwnerSharingRule](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. [AccountPlanObjectiveShare](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. # AccountPlanObjectiveMeasure Represents the performance of target metrics for an objective associated with the account plan. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if sales account plans are turned on. ## Fields | Field | Details | | --- | --- | | AccountPlanObjMeasCalcDefId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account plan objective calculation definition associated with the measure. This field is a relationship field. Available in API version 63.0 and later. Relationship Name AccountPlanObjMeasCalcDef Refers To AccountPlanObjMeasCalcDef | | AccountPlanObjectiveId | Type reference Properties Create, Filter, Group, Sort Description The account plan objective associated with the measure. This field is a relationship field. Relationship Name AccountPlanObjective Relationship Type Master-detail Refers To AccountPlanObjective | | CurrentCurrencyValue | Type currency Properties Filter, Nillable, Sort Description The current value in currency for a measure associated with the account plan objective. | | CurrentNumberValue | Type double Properties Filter, Nillable, Sort Description The current numerical value for a measure associated with the account plan objective. | | CurrentPercentValue | Type percent Properties Filter, Nillable, Sort Description The current value in percentage for a measure associated with the account plan objective. | | CurrentValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The current value for a measure associated with the account plan objective. | | CurrentValueTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the current value was last updated. This field is available in API version 63.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the account plan objective measure. | | TargetCurrencyValue | Type currency Properties Filter, Nillable, Sort Description The target value in currency for a measure associated with the account plan objective. | | TargetNumberValue | Type double Properties Filter, Nillable, Sort Description The target numerical value for a measure associated with the account plan objective. | | TargetPercentValue | Type percent Properties Filter, Nillable, Sort Description The target value in percentage for a measure associated with the account plan objective. | | TargetValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The target value for a measure associated with the account plan objective. | | ValueType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of value that's measured. Possible values are: - Currency - Number - Percent | ## Associated Objects This object has these 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. [AccountPlanObjectiveMeasureChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanObjectiveMeasureHistory](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. # AccountPlanObjMeasCalcCond Represents a field and value combination for filtering records to include in the calculation of a sales account plan objective measure’s current value. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available if sales account plans are turned on. ## Fields | Field | Details | | --- | --- | | AccountPlanObjMeasCalcDefId | Type reference Properties Create, Filter, Group, Sort Description The account plan objective measure calculation definition where this criteria is used. This field is a relationship field. Relationship Name AccountPlanObjMeasCalcDef Relationship Type Master-detail Refers To AccountPlanObjMeasCalcDef | | FieldName | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A field on the calculation definition’s TargetObject that you want to filter by. Fields on the Campaign, Case, Contact, or Opportunity objects are supported. | | Operation | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The logical operator for matching records with the specified field value. Possible values are: - Contains - Equals - GreaterOrEqual - GreaterThan - LessOrEqual - LessThan - NotContain - NotEqual - StartsWith | | Value | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value to match for the specified field. | ## Usage Let’s say that a calculation definition tracks the currency amount on Closed Won opportunities. The calculation definition’s TargetObject is Opportunity, and the condition further specifies these values. - FieldName is StageName. - Operation is Equals. - Value is ClosedWon. # AccountPlanObjMeasCalcDef Represents the definition of a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available if sales account plans are turned on. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A summary of the calculation definition that’s visible to users when they select the definition for an account plan objective measure. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 consecutive underscores | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The combined language and locale ISO code, which controls the language of the calculation definition. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for this calculation definition. This display value is the internal label that doesn't get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of these values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | RollupType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The method for calculating the account plan objective measure’s current value from records that match the calculation definition and any optional conditions. Possible values are: - Count - Max - Min - Sum In Setup, this field’s label is Calculation Type. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Possible values are: - Active - Draft - Inactive Only active calculation definitions are available for users to select when they specify an account plan objective measure. | | TargetField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The field on TargetObject to use for calculating the account plan objective measure’s current value. Rollup fields on the Campaign, Case, Contact, or Opportunity object are supported. In Setup, this field’s label is Rollup Field. | | TargetObject | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The object to use for calculating the account plan objective measure’s current value. Possible values are: - Campaign - Case - Contact - Opportunity | | ValueType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The data type for calculating the account plan objective measure’s current value. Possible values are: - Currency - Number - Percent | ## Usage Let’s say that a calculation definition tracks the currency amount on opportunities. The calculation definition’s TargetObject is Opportunity, TargetField is Amount, and RollupType is Sum. # AccountPlanObjMeasCalcDefLocalization Represents the translated value of the definition of a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure. This object is available in API version 63.0 and later when the Translation Workbench is enabled. ## Supported Calls create(), delete(), describeSObjects(), getDeleted()getUpdated()query(), retrieve(), update(), upsert() ## Special Access Rules - Your organization must be using Lightning Experience with Sales Cloud in Enterprise, Performance, Unlimited, and Einstein 1 Sales Edition editions. - Translation Workbench must be enabled for your org. - Sales account plans must be turned on. - Users with the Customize Application or Manage Translation permission can create or update AccountPlanObjMeasCalcDef translations. ## Fields | Field | Details | | --- | --- | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language the AccountPlanObjMeasCalcDef is translated into. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of these values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related account plan objective measure calculation definition. This field is a relationship field. | | Value | Type textarea Properties Create, Filter, Sort, update Description The translated label of the account plan objective measure calculation definition. | ## Usage Translate the labels of your account plan objective measure calculation definitions for supported languages . # AccountPlanObjMeasRela Represents a junction between an account plan objective measure and the related objects. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountPlanObjectiveMeasureId | Type reference Properties Create, Filter, Group, Sort Description The account plan objective measure associated with the record. This field is a relationship field. Relationship Name AccountPlanObjectiveMeasure Relationship Type Master-detail Refers To AccountPlanObjectiveMeasure (the master object) | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the account plan objective measure relation record. | | ReferenceRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record of the object associated with the account plan objective measure. This field is a polymorphic relationship field. Relationship Name ReferenceRecord Refers To Case, FinancialDeal, Opportunity | ## 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. [AccountPlanObjMeasRelaChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanObjMeasRelaHistory](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. # AccountProspectingAgentResearch Represents research done by a prospecting agent on an account record. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Sort Description This field is a relationship field. Relationship Name Account Relationship Type Master-detail Refers To Account (the master object) | | IsQualified | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The default value is false. | | Rationale | Type textarea Properties Nillable Description The explanation of why the account was qualified or not. The rationale provides extra context to guide human users in their decision making. | | ResearchRunKey | Type string Properties Filter, Group, Nillable, Sort Description The date and time the research was complete. | # AccountRelationship Represents a relationship of a given type between two accounts. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules In Digital Experience Settings, turn on the Enable Account Relationships org preference, which is off by default. ## Fields | Field | Details | | --- | --- | | AccountFromID | Type reference Properties Create, Filter, Group, Sort, Description ID of the account that gains access to data from AccountTo. | | AccountToId | Type reference Properties Create, Filter, Group, Sort Description ID of the account sharing data with AccountFrom. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, the user accessed this record or list view (LastReferencedDate) but didn’t viewed it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the account relationship. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who created the account relationship. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The relationship type. All account relationship sharing rules of that type are to this account relationship. Standard values are: - System Integrator - Agency - Advertiser - Reseller - Distributor - Developer - Broker - Lender - Institution - Contractor - Dealer - Consultant - Client - Vendor - Agent - Retailer - SubContractor - Supplier Picklist items can be updated with your own values. | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [AccountRelationshipFeed](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. [AccountRelationshipHistory](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. [AccountRelationshipOwnerSharingRule](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. [AccountRelationshipShare](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. # AccountRelationshipShareRule Represents the rule that determines which object records are shared, how they are shared, the account relationship type that shares the records, and the level of access granted to the records. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(). describeSObjects(), query(), retrieve(), update(). upsert() ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Type of access granted by the share rule. Valid values are: - Read (Read Only) - Edit (Read/Write) | | AccountToCriteriaField | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Criteria that must be met for the data to be shared. Possible values are: - Account.OwnerId - Account.ParentId - Campaign.OwnerId - Case.AccountId - Case.OwnerId - Contact.AccountId - Contact.OwnerId - Lead.ConvertedAccountId - Lead.OwnerId - Lead.PartnerAccountId - Opportunity.PartnerAccountId - Order.AccountId - Order.ActivatedById - Order.CompanyAuthorizedById - Order.OwnerId - PartnerFundAllocation.CreatedById - PartnerFundAllocation.ChannelPartnerId - PartnerFundAllocation.OwnerId - PartnerFundClaim.CreatedById - PartnerFundClaim.OwnerId - PartnerFundRequest.ChannelPartnerId - PartnerFundRequest.CreatedById - PartnerFundRequest.OwnerId - PartnerMarketingBudget.CreatedById - PartnerMarketingBudget.ChannelPartnerId - PartnerMarketingBudget.OwnerId | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A meaningful explanation of the sharing rule. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | EntityType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of data shared by this rule. Values are: - Account - Campaign - Case - Contact - Lead - Order - PartnerFundAllocation - PartnerFundClaim - PartnerFundRequest - PartnerMarketingBudget | | Language | Type picklist Properties Create, Defaulted on create. Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the account relationship share rule. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label assigned to the sharing rule to identify it. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | StaticFormulaCriteria | Type string Properties Create, Filter, Nillable, Sort, Update Description A way to further filter what data gets shared. This must be a deterministic formula and spanning is not allowed. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Must match the type of an account relationship for data to be shared according to the AccountToCriteriaField and the StaticForumulaCriteria. | # AccountShare Represents a sharing entry on an account. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only users with access to the Account object can access this object. Customer Portal users can't access this object. ## Fields The properties available for some fields depend on the default org-wide sharing settings. The properties listed are true for the default settings of such fields. | Field | Details | | --- | --- | | AccountAccessLevel | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the Account. The possible values are: - Read - Edit - All (This value isn't valid for create or update calls.) This field must be set to an access level that is at least equal to the organization’s default Account access level. In addition, either this field, the OpportunityAccessLevel field, or the CaseAccessLevel field must be set higher than the organization’s default access level. | | AccountId | Type reference Properties Create, Filter, Group, Sort Description ID of the Account associated with this sharing entry. This field can't be updated. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | CaseAccessLevel | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to cases associated with the account. The possible values are: - None - Read - Edit This field must be set to an access level that is at least equal to the organization’s default CaseAccessLevel. This field can't be updated via the API if the AccountAccessLevel field is set to All. You can't update this field for the associated account owner via the API. You must update the account owner’s CaseAccessLevel via the Salesforce user interface. | | ContactAccessLevel | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Level of access that the User or Group has to contacts associated with the account. The possible values are: - None - Read - Edit This field must be set to an access level that is at least equal to the organization’s default ContactAccessLevel. This field can't be updated via the API if the ContactAccessLevel field is set to “Controlled by Parent.” You can't update this field for the associated account owner using the API. You must update the account owner’s ContactAccessLevel via the Salesforce user interface. | | OpportunityAccessLevel | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to opportunities associated with the Account. The possible values are: - None - Read - Edit This field must be set to an access level that is at least equal to the organization’s default opportunity access level. This field can’t be updated via the API if the AccountAccessLevel field is set to All. You can't use the API to update this field for the associated Account owner. You must update the Account owner’s opportunityAccessLevel via the Salesforce user interface. | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Manual—The User or Group has access because a User with “All” access manually shared the Account with the user or group. - Owner—The User is the owner of the Account - Team—The User or Group has team access (is an AccountTeamMember). - Rule—The User or Group has access via an Account sharing rule. - GuestRule—The user or group has access via an Account guest user sharing rule. - ImplicitParent—The User or Group has access because they’re the owner of or have sharing access to records related to the account, such as opportunities, cases, contacts, contracts, or orders. - GuestParentImplicit—The guest user has access because they have access to records related to the Account, such as opportunities, cases, contacts, contracts, or orders. - LpuParentImplicit—The User has access because they have access to records related to the Account, which are owned by high-volume Experience Cloud site users and shared via a share group. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. - PortalImplicit—The Account is associated with the portal user. - ARImplicit—The User, who belongs to a partner or customer account, has access to the Account via an account relationship data sharing rule. - Territory2AssociationManual—With Sales Territories in API version 44.0 and earlier, the TerritoryManual reason code was written to AccountShare records when you manually assigned an account to a territory. In API version 45.0 and later, Territory2AssociationManual replaces all instances of TerritoryManual, and the Territory2AssociationManual reason code is written to AccountShare records when you manually assign an account to a territory. - Territory—The territory has access via a territory assignment rule. - TerritoryManual—Deprecated starting in API version 45.0 and replaced by the Territory2AssociationManual value. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the Account. This field can't be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object allows you to determine which users and groups can view or edit Account records owned by other users. If you attempt to create an AccountShare record that matches an existing record, the request updates any modified fields and returns the existing record. For example, the following code finds all accounts owned by a user and manually shares them to a portal user. QueryResult result = conn.query("SELECT Id FROM Account WHERE OwnerId = '005D0000001LPFB'"); // Create a new AccountShare object List shares = new ArrayList(); for (SObject rec : result.getRecords()) { AccountShare share = new AccountShare(); share.setAccountId(rec.getId()); //Set the portal user Id to share the accounts with share.setUserOrGroupId("003D000000QA8Tl"); share.setAccountAccessLevel("Edit"); share.setOpportunityAccessLevel("Read"); share.setCaseAccessLevel("Edit"); shares.add(share); } conn.create(shares.toArray(new AccountShare\[shares.size()\])); This code shares the accounts that the user owns at the time, but not those accounts that are owned later. For these types of shares, use an owner-based sharing rule, such as [AccountOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm "Represents the rules for sharing an account with a User other than the owner."). If an account is shared in multiple ways with a user, you don’t always see multiple sharing records. If a user has access to an account for one or more of the following RowCause values, the records in the AccountShare object are compressed into one record with the highest level of access. - ImplicitParent - Manual - Owner #### See Also - [Account](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm "Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners).") - [CaseShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseshare.htm "Represents a sharing entry on a Case.") - [LeadShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadshare.htm "Represents a sharing entry on a Lead.") - [OpportunityShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityshare.htm "Represents a sharing entry on an Opportunity.") # AccountTag Associates a word or short phrase with an Account. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage AccountTag stores the relationship between its parent TagDefinition and the Account being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. # AccountTeamMember Represents a User who is a member of an Account team. See also UserAccountTeamMember, which represents a User who is on the default account team of another user. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - This object is available only for Enterprise, Unlimited, and Performance Edition users who have enabled the account team functionality. - Customer Portal users can't access this object. ## Fields
Field Name Details
AccountAccessLevel
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Level of access that the User has to the Account. The possible values are:
  • Read
  • Edit
  • All
This field must be set to an access level that is at least equal to the organization’s default Account access level. In addition, the users’s AccountAccessLevel, ContactAccessLevel, OpportunityAccessLevel, or CaseAccessLevel field must be set higher than the organization’s default access level.
AccountId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. ID of the Account to which this user is a team member. Must be a valid account ID.
CaseAccessLevel
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Level of access that the User has to cases associated with the account. The possible values are:
  • None
  • Read
  • Edit
This field must be set to an access level that is at least equal to the organization’s default case access level. In addition, the users’s AccountAccessLevel, ContactAccessLevel, OpportunityAccessLevel, or CaseAccessLevel field must be set higher than the organization’s default access level. This field is available in API version 37.0 and later.
ContactAccessLevel
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Level of access that the User has to contacts associated with the account. The possible values are:
  • None
  • Read
  • Edit
  • Controlled By Parent
This field must be set to an access level that is at least equal to the organization’s default contact access level. In addition, the users’s AccountAccessLevel, ContactAccessLevel, OpportunityAccessLevel, or CaseAccessLevel field must be set higher than the organization’s default access level. If the org-wide default for contacts is set to Controlled By Parent, users can’t see or edit the Contact Access field. This field is available in API version 37.0 and later.
CurrencyIsoCode
Type
picklist
Properties
Filter, Restricted picklist
Description
Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the org.
IsDeleted
Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
Note

Note

An AccountTeamMember record that is deleted is not moved to the Recycle Bin. A deleted AccountTeamMember record can’t be undeleted unless the record was cascade-deleted when deleting a related Account. For directly deleted AccountTeamMember records, don’t use the isDeleted field to detect deleted records in SOQL queries or queryAll() calls.

The getDeleted() call also doesn’t show deleted account team members unless the record was deleted from an account related list or the Developer Console.
OpportunityAccessLevel
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Level of access that the User has to opportunities associated with the account. The possible values are:
  • None
  • Read
  • Edit
This field must be set to an access level that is at least equal to the organization’s default opportunity access level. In addition, the users’s AccountAccessLevel, ContactAccessLevel, OpportunityAccessLevel, or CaseAccessLevel field must be set higher than the organization’s default access level. This field is available in API version 37.0 and later.
PhotoURL
Type
URL
Properties
Filter, Nillable, Sort, Group
Description
Read only. Retrieves the users Chatter photo URL. This field is available in API version 37.0 and later.
TeamMemberRole
Type
picklist
Properties
Create, Filter, Nillable, Update
Description
Role associated with this team member. One of the valid team member roles defined for your organization. Label is Team Role.
Title
Type
string
Properties
Filter, Nillable, Sort, Group
Description
Read only. Retrieves the user’s title. This field is available in API version 37.0 and later.
UserId
Type
reference
Properties
Create, Filter
Description
Required. ID of the User who is a member of this account team. Must be a valid User ID.
## Usage Use this object to manage the team members of a particular Account and to specify team member roles for those users on that account. If team members are added by a user with group-based access, those members are removed after an account’s owner is changed. This applies even if the **Keep account team** option is selected. A Salesforce admin, the account owner, or someone higher in the role hierarchy should add team members to keep team members related to the account. Sharing rules grant access to individuals or to groups (public groups, queues, roles). That distinction matters for team member retention during ownership changes. If team members are added by a user with group-based access, those team members are removed when the account owner changes. This applies even if the **Keep account team**. To keep team members when ownership changes, one of these types of users must add the team members. - A Salesforce admin - A user with Modify All Data permission - The account owner - A user higher than the account owner in the owner’s direct role hierarchy chain (not a parallel branch) If you use [SOQL statements to query all records in an organization](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/langCon_apex_SOQL_query_all_rows.htm), the ALL ROWS keywords don’t query deleted account team member records. ## 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. [AccountTeamMemberChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 66.0) Change events are available for the object. #### See Also - [Account](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm "Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners).") # AccountTerritoryAssignmentRule An account assignment rule that assigns accounts to territories based on account fields. Available if Sales Territories has been enabled. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Users with the View Setup and Configuration permission can access this object. Users with the Manage Territories permission can edit this object. ## Fields | Field | Details | | --- | --- | | BooleanFilter | Type string Properties Create, Filter, Nillable, Update Description Advanced filter conditions that were specified for the rule in the online application. For example, “(1 AND 2) OR 3.” | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Update Description Indicates whether the rule is active (true) or inactive (false). Via the API, active rules run automatically when new accounts are created and existing accounts are edited. The exception is when the IsExcludedFromRealign field on an account is true, which prevents account assignment rules from evaluating that account. | | IsInherited | Type boolean Properties Create, Defaulted on create, Filter, Update Description Indicates whether the rule is an inherited rule (true) or a local rule (false). An inherited rule also acts upon territories below it in the territory hierarchy. A local rule is created at the immediate territory and only impacts the immediate territory. | | Name | Type string Properties Create, Filter, Update Description A name for the rule. Limit is 80 characters. | | TerritoryId | Type reference Properties Create, Filter, Update Description ID of the territory where accounts that satisfy this rule are assigned. | ## Usage A territory will not have any accounts (with the exception of manually assigned accounts) unless at least one account assignment rule is active for the territory. #### See Also - [AccountTerritoryAssignmentRuleItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountterritoryassignmentruleitem.htm "A row of selection criteria for an AccountTerritoryAssignmentRule object. Available if Sales Territories has been enabled.") - [Territory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory.htm "Represents a flexible collection of accounts and users where the users have at least read access to the accounts, regardless of who owns the accounts. Available if Sales Territories has been enabled. This object is available in API versions 7.0 to 52.0. Use Territory2 instead of Territory in API version 52.0 and later.") - [UserTerritory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userterritory.htm "Represents a User who has been assigned to a Territory.") # AccountTerritoryAssignmentRuleItem A row of selection criteria for an AccountTerritoryAssignmentRule object. Available if Sales Territories has been enabled. AccountTerritoryAssignmentRuleItem can be created or deleted if the BooleanFilter field on its corresponding AccountTerritoryAssignmentRule object is a null value. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Users with the View Setup and Configuration permission can access this object. Users with the Manage Territories permission can edit this object. ## Fields | Field | Details | | --- | --- | | Field | Type picklist Properties Create, Filter, Group, Sort, Update Description The standard or custom account field to use as a criteria. | | Operation | Type picklist Properties Create, Filter, Group, Sort, Update Description The criteria to apply, such as “equals” or “starts with.” | | RuleID | Type reference Properties Create, Filter, Update Description ID of the associated AccountTerritoryAssignmentRule. | | SortOrder | Type int Properties Create, Filter, Update Description The order in which this row is evaluated compared to other AccountTerritoryAssignmentRuleItem objects for the given AccountTerritoryAssignmentRule. | | Value | Type string Properties Create, Filter, Nillable, Update Description The field value(s) to evaluate, such as 94105 if the Field is Billing Zip/Postal Code. | ## Usage - Both standard and custom account fields can be used as criteria for account assignment rules. - A territory will not have any accounts (with the exception of manually assigned accounts) unless at least one account assignment rule is active for the territory. #### See Also - [AccountTerritoryAssignmentRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountterritoryassignmentrule.htm "An account assignment rule that assigns accounts to territories based on account fields. Available if Sales Territories has been enabled.") - [Territory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory.htm "Represents a flexible collection of accounts and users where the users have at least read access to the accounts, regardless of who owns the accounts. Available if Sales Territories has been enabled. This object is available in API versions 7.0 to 52.0. Use Territory2 instead of Territory in API version 52.0 and later.") - [UserTerritory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userterritory.htm "Represents a User who has been assigned to a Territory.") # AccountTerritorySharingRule Represents the rules for sharing an Account within a territory. ## 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 | | --- | --- | | AccountAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. The possible values are: - Read - Edit - All | | CaseAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target group for all child cases of the account. The possible values are: - None - Read - Edit | | ContactAccessLevel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A value that represents the type of access granted to the target group for all related contacts on the account. The possible values are: - None - Read - Edit ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is read only. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. This field is available in API version 24.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. Accounts owned by users in the source territory trigger the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | OpportunityAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target group for all opportunities associated with the account. The possible values are: - None - Read - Edit | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the user or group being given access, or, if a territory ID, the users assigned to that territory. | ## Usage Use this object to manage the sharing rules for a particular object. General sharing and territory-related sharing use this object. #### See Also - [Account](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm "Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners).") - [AccountShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm "Represents a sharing entry on an account.") # AccountUserTerritory2View Represents the view of the Users in Assigned Territories related list in Lightning Experience for Sales Territories. Available in API version 42.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Standard and partner users can access this object. ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier for the account associated with the Users in Assigned Territories related list. | | RoleInTerritory2 | Type picklist Properties Filter, Group, Nillable, Sort Description The role of each user in the Users in Assigned Territories related list. | | Territory2Id | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier for each territory in the Users in Assigned Territories related list. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier for each user in the Users in Assigned Territories related list. | ## Usage Use this object to show the users who are assigned to the territories assigned to an account. A filter criterion with one AccountId is required when you execute a SOQL query on this object. # ActionCadence Represents the definition of a cadence. This object is available in API version 45.0 and later. Use ActionCadence and its related objects to learn about an action cadence, including: - The current state of the action cadence. - The steps that the action cadence contains. - Which leads, contacts, or person accounts are assigned to the action cadence. The ActionCadence, ActionCadenceStep, ActionCadenceRule, and ActionCadenceRuleCondition objects define an action cadence and the steps that it contains. ActionCadenceTracker and ActionCadenceStepTracker track a prospect's movement through an active action cadence. By learning when the action cadence objects are created and deleted, you can make the most of the action cadence API. - An ActionCadence record is created when you use the Sales Engagement app to create a cadence. - An ActionCadenceStep record is created to represent a step. If the step is a branch step, then corresponding ActionCadenceRule and ActionCadenceRuleCondition records are also created. - An ActionCadenceTracker record is created when you assign a prospect to an action cadence. - An ActionCadenceStepTracker record is created each time the prospect moves to a new step. All of these action cadence records exist until you use the Sales Engagement app to delete an action cadence. If many prospects have been assigned to the action cadence, there can be many associated ActionCadenceTracker and ActionCadenceStepTracker records. In this case, deleting the action cadence can take some time. While the action cadence is being deleted, the value for the State field is Deleting on the ActionCadence record. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), ## Fields | Field | Details | | --- | --- | | ActivatedDate | Type date Properties Filter, Group, Nillable, Sort Description The date that the user activated the action cadence. ActionCadence objects are created in a draft state and must be manually activated before they’re used. | | ActiveTargets | Type int Properties Filter, Group, Nillable, Sort Description The total number of active targets that are currently assigned with this cadence. Available in API version 58.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description The description of this action cadence. | | ErrorMessage | Type string Properties Filter, Group, Nillable, Sort Description If there was an error when activating the action cadence, this field contains the error message. | | FolderId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the folder that contains the action cadence. Available in API version 49.0 and later. This is a polymorphic relationship field. Relationship Name Folder Relationship Type Lookup Refers To Folder, Organization, User | | FolderName | Type string Properties Filter, Nillable, Sort Description The name of the folder that contains the action cadence. Available in API version 49.0 and later. | | IsWaitAllowedBeforeDaisyChain | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the cadence is allowed to have a wait step before a daisy chain step (true) or not (false). The default value is false. | | LastEditedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time this object was last edited. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date this object was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date this action cadence was last viewed in the Sales Engagement app. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this action cadence. Every action cadence in an org must have a unique name. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the action cadence (typically the user who created it). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To change the owner of an action cadence, the new owner must have read access to action cadences enabled in their user profile. This field is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | State | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description This entity's state. Possible values are: - Active The user finished modifying the action cadence and has activated it. At this point, you can't make any more changes to the steps in the action cadence. - Deleting All records associated with this action cadence, including the ActionCadence record and all its related records, are being deleted. While in this state, the ActionCadence can’t be attached to a prospect. - Draft ActionCadence objects are in the draft state when they’re created. In this state, the ActionCadence can’t be assigned to any prospect. - Error An error occurred while trying to activate the action cadence. - Inactive The user deactivated the action cadence. New targets can’t be added to the action cadence. Existing targets continue in the action cadence until completion. | | SuccessfulCompletions | Type int Properties Filter, Group, Nillable, Sort Description The total number of successful dispositions this cadence has upon completion. For example, customer engaged or customer connected. Available in API version 58.0 and later. | | TotalSteps | Type int Properties Filter, Group, Nillable, Sort Description The number of total steps associated with this cadence. This value doesn’t include special step types such as root, branch, and daisy chain. Available in API version 58.0 and later. | | TotalTargets | Type int Properties Filter, Group, Nillable, Sort Description The total number of targets that have been assigned with this cadence. Available in API version 58.0 and later. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the type of ActionCadence. Available in API version 56.0 and later. Possible values are: - Standard Standard cadences can contain multiple steps and are usually built by sales managers in the Cadence Builder. - Quick Quick cadences can contain only one step, are built by reps for their personal use, and don't require the Cadence Builder. - SDR SDR cadences are built for Sales Development Representative workflows. | ## Usage Use ActionCadence to learn how many action cadences are currently active: select COUNT() from ActionCadence where State="Active" Retrieve all ActionCadence records that have "West Coast" in their name: SELECT ActionCadenceId FROM ActionCadence WHERE NAME LIKE '\[West Coast Cadence\]%' Retrieve all ActionCadence records owned by a specific user: SELECT ActionCadenceId FROM ActionCadence WHERE OwnerId = '' ## 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. [ActionCadenceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ActionCadenceOwnerSharingRule](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. [ActionCadenceShare](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. #### See Also - [ActionCadenceRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerule.htm "Represents the logic that a branch step uses to determine which branch an action cadence tracker follows in an action cadence. Use ActionCadenceRule to learn about a branch step, including its logic and what the next step is. This object is available in API version 48.0 and later.") - [ActionCadenceRuleCondition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerulecondition.htm "Represents the logic for a branch step. This object is available in API version 48.0 and later.") - [ActionCadenceStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencestep.htm "Represents a step in a cadence. Use ActionCadenceStep to learn which steps belong to a cadence, and how the steps are connected to each other. This object is available in API version 48.0 and later.") - [ActionCadenceStepTracker](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencesteptracker.htm "Represents a step in an active cadence for a specific cadence target. This object is available in API version 48.0 and later.") # ActionCadenceRule Represents the logic that a branch step uses to determine which branch an action cadence tracker follows in an action cadence. Use ActionCadenceRule to learn about a branch step, including its logic and what the next step is. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() The supported calls for ActionCadenceRule are inherited from ActionCadenceStep. ## Fields | Field | Details | | --- | --- | | ActionCadenceStepId | Type reference Properties Create, Filter, Group, Sort Description The ActionCadenceStep that this rule is associated with. This field is a relationship field. Relationship Name ActionCadenceStep Relationship Type Lookup Refers To ActionCadenceStep | | ConditionLogic | Type string Properties Create, Filter, Group, Sort, Update Description The logical operator used to evaluate the rule conditions. Possible values are: - AND If this rule has several conditions, all of them must be true for this step to be true. | | GlobalEventType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If the action cadence rule contains a global exit condition, this field contains the type of event that the rule represents. Possible values are: - EmailReply - EmailHardBounce - EmailSoftBounce - CallMeaningfulConnect - CallNotInterested - CallUnqualified - CallLeftVoicemail - CallCallBackLater This field is available in API version 49.0 and later. | | GraphState | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents the state of the ActionCadenceRule within the step graph, or sequence, of the related action cadence. Available in API version 53.0 and later. Possible values are: - Included—This step rule is part of the step graph. - Orphaned—This step rule was removed from the step graph before the action cadence was activated. Orphaned step rules are deleted upon activation. - Pending—This step rule has been created but hasn’t been added to the step graph. Pending step rules can be added to the step graph in the future. - Retired—This step rule was previously part of an active action cadence step graph and was removed during an edit after activation. Retired step rules can have associated step trackers. | | OutcomeNextStepName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The next step in the action cadence if this rule evaluates as true. If this rule evaluates as false, the next step is ActionCadenceStep.BranchDefaultStepName. | | ParentRuleName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the RuleName field of the previous rule in the action cadence. Must contain a valid rule name value unless this rule is the root rule. null if this rule is a root rule. This field is available in API version 49.0 and later. | | RuleName | Type string Properties Create, Filter, Group, Sort, Update Description The name given to the rule. Every rule in an action cadence must have a unique name. | | RuleType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of step that this rule applies to. Possible values are: - BranchStep — The rule evaluates the condition of a branch step. A branch step is an ActionCadenceStep record with the field type equal to Branch. - RepeatedStep— The rule evaluates the repeat steps for quick cadence. Available in API version 58.0 and later. - RootStep— The rule evaluates a global exit condition. - SubRootStep—Available in API version 58.0 and later. This field is available in API version 49.0 and later. | ## Usage Use ActionCadenceRule to see all the rules associated with a branch step: select RuleName from ActionCadenceRule where ActionCadenceStep.ActionCadence.Name = "High Priority CFO" #### See Also - [ActionCadence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadence.htm "Represents the definition of a cadence. This object is available in API version 45.0 and later.") - [ActionCadenceRuleCondition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerulecondition.htm "Represents the logic for a branch step. This object is available in API version 48.0 and later.") - [ActionCadenceStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencestep.htm "Represents a step in a cadence. Use ActionCadenceStep to learn which steps belong to a cadence, and how the steps are connected to each other. This object is available in API version 48.0 and later.") - [ActionCadenceStepTracker](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencesteptracker.htm "Represents a step in an active cadence for a specific cadence target. This object is available in API version 48.0 and later.") # ActionCadenceRuleCondition Represents the logic for a branch step. This object is available in API version 48.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() The supported calls for ActionCadenceRuleCondition are inherited from ActionCadenceStep. ## Fields | Field | Details | | --- | --- | | ActionCadenceRuleId | Type reference Properties Create, Filter, Group, Sort Description The ID of the ActionCadenceRule that this condition is associated with. | | Operator | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The conditional operator for this rule. Possible values are: - Equal | | Resource | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The field to evaluate. Possible values are: - CallDispositionCategory Use by branch steps. - EmailEngagement Used by ListenerBranch steps. | | RuleConditionName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the rule condition. Every rule condition in a cadence must have a unique name. | | Value | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The event that your cadence rule condition listens for to decide when the event is complete. Possible values for emails are: - EmailOpen - EmailLinkClick Possible values for calls are: - CallMeaningfulConnect - CallUnqualified - CallLeftVoicemail - CallNotInterested - CallCallBackLater | ## Usage Use ActionCadenceRuleContion to see all the rule conditions associated with a branch step: select RuleConditionName from ActionCadenceRuleCondition where ActionCadenceStepId= #### See Also - [ActionCadence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadence.htm "Represents the definition of a cadence. This object is available in API version 45.0 and later.") - [ActionCadenceRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerule.htm "Represents the logic that a branch step uses to determine which branch an action cadence tracker follows in an action cadence. Use ActionCadenceRule to learn about a branch step, including its logic and what the next step is. This object is available in API version 48.0 and later.") - [ActionCadenceStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencestep.htm "Represents a step in a cadence. Use ActionCadenceStep to learn which steps belong to a cadence, and how the steps are connected to each other. This object is available in API version 48.0 and later.") - [ActionCadenceStepTracker](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencesteptracker.htm "Represents a step in an active cadence for a specific cadence target. This object is available in API version 48.0 and later.") # ActionCadenceStep Represents a step in a cadence. Use ActionCadenceStep to learn which steps belong to a cadence, and how the steps are connected to each other. This object is available in API version 48.0 and later. An ActionCadenceStep record is created to represent a step. If the step is a branch step, then corresponding ActionCadenceRule and ActionCadenceRuleCondition records are also created. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note An ActionCadenceStep with IsOrphan equal to true can be part of a cadence but is never executed. To retrieve the steps that can be executed by the cadence, query for ActionCadenceStep records with IsOrphan equal to false. ActionCadenceStep records with IsOrphan equal to true are deleted. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActionCadenceId | Type reference Properties Create, Filter, Group, Sort Description The ID of the ActionCadence that this step belongs to. This field is a relationship field. Relationship Name ActionCadence Relationship Type Lookup Refers To ActionCadence | | AllCallsCallBackLater | Type int Properties Filter, Group, Nillable, Sort Description The number of calls having the call outcome **Call Back Later**. | | AllCallsLeftVoicemail | Type int Properties Filter, Group, Nillable, Sort Description The number of calls having the call outcome **Left Voicemail**. | | AllCallsMeaningfulConnect | Type int Properties Filter, Group, Nillable, Sort Description The number of calls having the call outcome **Meaningful Connect**. | | AllCallsNotInterested | Type int Properties Filter, Group, Nillable, Sort Description The number of calls having the call outcome **Not Interested**. | | AllCallsUncategorized | Type int Properties Filter, Group, Nillable, Sort Description The number of calls where the call outcome isn’t categorized. | | AllCallsUnqualified | Type int Properties Filter, Group, Nillable, Sort Description The number of calls having the call outcome **Unqualified**. | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that weren’t delivered successfully. This field is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails delivered. This field is a calculated field. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails returned for a permanent reason — for example, the email address doesn’t exist. This field is available in API version 50.0 and later. | | AllEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of links inside an email that the target clicked during this step. Multiple clicks on the same link count towards this total. This field is available in API version 50.0 and later. | | AllEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that the target opened while working on this step. Multiple opens of the same email count towards this total. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that were returned because the recipient set an out-of-office responder. Multiple replies count towards this total. This field is available in API version 50.0 and later. | | AllEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that targets replied to as part of this step. Multiple replies to the same email count towards this total, This field is available in API version 50.0 and later. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of sent emails. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that were returned for temporary reasons — for example, the email is too large. This field is available in API version 50.0 and later. | | AllEmailsTrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent by this user with engagement tracking enabled. | | AllEmailsUntrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent by this user without engagement tracking. | | AllManuallyCompletedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of steps manually completed. | | AllOnTimeCompletedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of steps completed on time. | | AllOverdueCompletedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of overdue steps that were completed. | | AllSkippedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of steps skipped. | | AllTotalCallsCount | Type int Properties Filter, Group, Nillable, Sort Description The number of calls that the sales rep made during this step. This field is a calculated field. | | BranchDefaultStepName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the default step. | | ChainedCadenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the ActionCadence for the linked action cadence. Available only if the step type is DaisyChain (meaning that another action cadence is connected to this action cadence). This field is a relationship field. Relationship Name ChainedCadence Relationship Type Lookup Refers To ActionCadence | | DayGroup | Type int Properties Filter, Group, Nillable, Sort Description Indicates the day offset relative to the previous cadence step. Available in API version 60.0 and later. | | GoToStepIntervalInMinutes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Contains information about when the step should be repeated next, in minutes. Available in API version 58.0 and later. | | GoToStepIterationLimit | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Contains the maximum number of repeat (goto) step iterations allowed. Available in API version 58.0 and later. | | GoToStepName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If this step’s original next step was removed during an edit after activation, this field specifies the updated next step. | | GraphState | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents the state of the ActionCadenceStep within the step graph, or sequence, of the action cadence. Possible values are: - Included—This step is part of the step graph. - Orphaned—This step was removed from the step graph before the action cadence was activated. Orphaned steps are deleted upon activation. - Pending—This step has been created but hasn’t been added to the step graph. Pending steps can be added to the step graph in the future. - Retired—This step was previously part of an active action cadence step graph and was removed during an edit after activation. Retired steps can have associated step trackers. | | HasVariant | Type boolean Properties Defaulted on create, Filter, Group, Sort Description This field is valid for email and call step types. If true, the step has email or call template variants. The template variants are defined in ActionCadenceStepVariant records. Available in API version 53.0 and later. The default value is false. | | IsImmediateWakeUp | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a listener branch is immediate wake up (true) or not (false). The default value is false. | | IsOrphan | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, this step isn’t executed by the action cadence and will be deleted. Steps with IsOrphan equal to true have ParentStepName equal to null. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To retrieve the active steps in an action cadence, include IsOrphan=false in your query. The default value is false. This field is available in API version 49.0 and later. This field is a calculated field. | | IsScheduledDueDateLocked | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether assignees can change the due date (true) or not (false). Available in API version 58.0 and later. The default value is false. | | IsScreenFlowActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the flow is active and can be executed (true) or not (false). The default value is false. | | IsStepAutomationActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the flow referenced in the StepAutmationReference field is active. If false, the flow isn’t active. Only active flows can be executed. The default value isfalse. This field is available in API version 56.0 and later. | | IsThreaded | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description This field is valid for email steps. Email steps have ActionCadence.StepType equal to SendAnEmail. If true, the email for this email step is sent as a reply to the email conversation from the previous email step. By sending the email as a reply to a previous email, customers see a "conversation" view of the emails. Only emails from the same action cadence are grouped as conversations. This field can’t be true for the first email step in an action cadence, because the first email from an action cadence must start a new conversation with the prospect. The default value is false. This field is available in API version 49.0 and later. | | MessageType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of message for this step. Possible values are: - Text | | MinuteGroup | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the minute offset relative to the previous cadence step. Available in API version 60.0 and later. | | ParentStepName | Type string Properties Filter, Group, Nillable, Sort Description The step name (ActionCadenceStep.StepName) of the previous step in the action cadence. Must contain a valid step name value unless this step is the root step. null if this step is a parent step. | | RootStepId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the root step for this action cadence. Every action cadence has exactly one root step (so that the Salesforce API can find all the steps for this cadence). This field is a relationship field. Relationship Name RootStep Relationship Type Lookup Refers To ActionCadenceStep | | ScheduledDaysUntilDue | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of days after which this current step is due. Available in API version 58.0 and later. | | ScheduledDaysUntilStart | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of days when this step starts after the previous step completes. For delays of greater than one day from ScheduledStartTimeInMinutes. Available in API version 58.0 and later. | | ScheduledStartDelayInMinutes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Any hard waits in minutes is captured in this field. Waits greater than 1 day need to set ScheduledDaysUntilStart. Available in API version 58.0 and later. | | ScheduledStartTimeInMinutes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The specific time of day when the step starts. The time represents minutes after 00:00. Available in API version 58.0 and later. | | ScreenFlowReference | Type string Properties Create, Filter, Group, Nillable, Sort Description The namespace\_\_fullname of the screen flow. Used to describe flow objects and launch flows client side. | | StepAutomationReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the flow that the step uses. Cadence steps can launch a cadence step flow as the step or as a cadence autolaunched flow when a rep completes the step. The format is namespace\_\_fullName. This field is available in API version 56.0 and later. | | StepComments | Type textarea Properties Create, Nillable, Update Description A comment that provides additional information about this step. | | StepName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique identifier for this step. Generated by Salesforce. | | StepTitle | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The title given to the step when it was created. | | SubCadenceName | Type string Properties Filter, Group, Nillable, Sort Description Specifies the sub-cadence branch or parallel track a cadence step belongs to. Expected values are Positive and Negative. Available in API version 60.0 and later. | | TemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description If a template was added to this step, this field contains the template's ID. For example, if this step is a call step it can contain a template for a call script. Or, if this step is an email step, it can contain a template for an email. This field is a polymorphic relationship field. Relationship Name Template Relationship Type Lookup Refers To CallTemplate, EmailTemplate | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of step. Possible values are: - AutoSendAnEmail — Salesforce automatically sends the specified email. - Branch — A branch step in the action cadence. - Copilot — The SDR agent action. - CreateTask — Used for custom steps. - DaisyChain — A daisy chain step. A daisy chain step connects this action cadence to another action cadence. It must be the last step in the path. - LinkedInConnection - LinkedInMail - ListenerBranch — A branch step for emails. - MakeACall — The sales rep must call the prospect at this step. - PlatformScreenFlow - Root — This step is the root step for the action cadence. - SendAMessage — The sales rep must send the prospect a message at this step. - SendAnEmail — The sales rep must send the prospect an email at this step. - Terminal — The engagement monitor. - Wait — A wait step tells the sales rep not to do anything at this point in the action cadence. | | TypeDetail | Type string Properties Filter, Group, Nillable, Sort Description More detail about the step type. If the step is a cadence step flow, this field contains the flow name. Otherwise, this field contains the same value as the Type field. This field is available in API version 56.0 and later. | | UniqueEmailsLinkClickedCount | Type reference Properties Filter, Group, Nillable, Sort Description The number of links inside an email that the target clicked during this step. Multiple clicks on the same link aren’t counted. This field is available in API version 50.0 and later. | | UniqueEmailsOpenedCount | Type reference Properties Filter, Group, Nillable, Sort Description The number of emails that the target opened as part of this step. Multiple openings of the same email aren’t counted. This field is available in API version 50.0 and later. | | UniqueEmailsRepliedCount | Type reference Properties Filter, Group, Nillable, Sort Description The number of emails that targets replied to as part of this step. Multiple replies to the same email aren’t counted. This field is available in API version 50.0 and later. | | WaitTimeInSeconds | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Required if the step type is Wait. The time in seconds for this step to wait. | ## Usage Use ActionCadenceStep to see what steps your action cadence has: select StepTitle from ActionCadenceStep where ActionCadence.ID= and IsOrphan=false ## 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. [ActionCadenceStepChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. #### See Also - [ActionCadence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadence.htm "Represents the definition of a cadence. This object is available in API version 45.0 and later.") - [ActionCadenceRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerule.htm "Represents the logic that a branch step uses to determine which branch an action cadence tracker follows in an action cadence. Use ActionCadenceRule to learn about a branch step, including its logic and what the next step is. This object is available in API version 48.0 and later.") - [ActionCadenceRuleCondition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerulecondition.htm "Represents the logic for a branch step. This object is available in API version 48.0 and later.") - [ActionCadenceStepTracker](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencesteptracker.htm "Represents a step in an active cadence for a specific cadence target. This object is available in API version 48.0 and later.") # ActionCadenceStepTracker Represents a step in an active cadence for a specific cadence target. This object is available in API version 48.0 and later. An ActionCadenceStepTracker record is created when a target moves to a new step in a cadence. Use ActionCadenceStepTracker to find information such as the step's current state, the reason it completed, and its type. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ActionCadenceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the ActionCadence that is related to the ActionCadenceStep. This field is a relationship field. Relationship Name ActionCadence Relationship Type Lookup Refers To ActionCadence | | ActionCadenceName | Type string Properties Filter, Group, Nillable, Sort Description The name of the related ActionCadence object. | | ActionCadenceStepId | Type reference Properties Filter, Group, Nillable, Sort Description ActionCadenceStepTracker is the runtime version of an ActionCadenceStep. This field contains the ID of the related ActionCadenceStep. This field is a relationship field. Relationship Name ActionCadenceStep Relationship Type Lookup Refers To ActionCadenceStep | | ActionCadenceTrackerId | Type reference Properties Filter, Group, Sort Description The ID of the related ActionCadenceTracker. This field is a relationship field. Relationship Name ActionCadenceTracker Relationship Type Lookup Refers To ActionCadenceTracker | | ActionTakenDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the action described in this step was taken. | | BranchIterationCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times a target has entered a specific branch within the cadence. This field is available in API version 62.0 and later. | | Channel | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The communication medium used for this step in an active cadence. This field is available in API version 62.0 and later. Possible values are: - Email | | CompletedById | Type reference Properties Filter, Group, Nillable, Sort Description The user ID of the sales rep who completed this step. A step can be assigned to several users before it’s completed. This field is available in API version 50.0 and later. This field is a relationship field. Relationship Name CompletedBy Relationship Type Lookup Refers To User | | CompletionDate | Type dateTime Properties Filter, Nillable, Sort Description The date this step completed. A step is completed either when the action is taken, or the step is skipped. | | CompletionReason | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The reason that this step completed: Possible values are: - AutomaticallyCompleted — The sales rep successfully completed this step and moved to the next one. Salesforce automatically marks this step as completed. - AutomaticallyExited — The step exited because a global exit condition occurred. This value is available in API version 49.0 and later. - ManuallyCompleted — The sales rep manually marked this step as completed. - ManuallySkipped — The sales rep skipped this step. | | DueDateTime | Type dateTime Properties Filter, Nillable, Sort Description Some steps have a due date to indicate when they must be completed. If this step has been assigned a due date, this field contains the date and time it is due. | | ErrorCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Possible values are: - AUTO\_EMAIL\_DAILY\_LIMIT\_REACHED - AUTO\_EMAIL\_ORG\_SETTING\_OFF - AUTO\_LIST\_MQ\_MAX\_RETRIES\_FAILED - BCC\_NOT\_ALLOWED\_IF\_BCC\_COMPLIANCE\_ENABLED - EAC\_CONFIG\_EMAIL\_CAPTURE\_OFF—Available in API version 66.0 and later. - EAC\_CONFIG\_IS\_NOT\_ACTIVE—Available in API version 66.0 and later. - EAC\_CONFIG\_LIMITED\_CAPTURE—Available in API version 66.0 and later. - EAC\_GLOBAL\_DATA\_SOURCE\_ERROR—EAC data source error - EMAIL\_ORG\_SETTING\_OFF - EXCHANGE\_MAX\_MAILBOX\_SIZE—Max Exchange mailbox size reached - EXCHANGE\_SEND\_AS\_DENIED - FETCH\_EMAIL\_THREAD\_FAILED - FIX\_WITH\_RECONNECT—Data connection failed - FROM\_ADDRESS\_FIELD\_IS\_ENCRYPTED—FromAddress field is encrypted - GOOGLE\_MAIL\_SERVICE\_NOT\_ENABLED—Gmail service not enabled - INITIAL\_OUTREACH\_ACCOUNT\_DEACTIVATED—Available in API version 66.0 and later. - INSUFFICIENT\_ACCESS\_ON\_TARGET—Available in API version 67.0 and later. - INVALID\_DRAFT—Invalid email draft - INVALID\_FROM\_ADDRESS - INVALID\_TARGET\_EMAIL - INVALID\_TEMPLATE\_ID - INVALID\_USER\_EMAIL - MAIL\_PROVIDER\_RATE\_LIMIT\_REACHED—Email provider rate limit reached - MALFORMED\_QUERY - MAX\_OUT\_EMAIL\_THREAD\_RETRY - MAX\_OUT\_LLMG\_RETRY - NON\_EMAIL\_UNKNOWN\_ERROR—Unknown error - NO\_ACTIVE\_ASDR\_AGENT - NO\_ATTACHMENT\_ACCESS - NO\_CONTENT\_VERSION\_ACCESS - NO\_LIST\_EMAIL\_PERMISSION - NO\_TARGET\_ACCESS - NO\_TOS\_SIQ - ORG\_WIDE\_AUTO\_EMAIL\_LIMIT\_REACHED - ORG\_WIDE\_DAILY\_EMAIL\_LIMIT\_REACHED - OTHER\_REQ\_FIELD\_MISSING—Other required field missing - PARDOT\_MERGE\_FIELD\_RENDERING\_ERROR - POST\_SEND\_EXCEPTION - RETRIES\_MAX\_EXCEEDED—Maximum retries exceeded - REVIEW\_CRITERIA\_FLOW\_EXECUTION\_FAILED—Available in API version 67.0 and later. - RETRY\_LATER - SCHEDULED\_EMAIL\_FAILED—Unknown error - SENDER\_MAILBOX\_NOT\_FOUND - SHARE\_LIMIT\_EXCEEDED - SOBO\_MEETING\_LINK\_GENERATION\_FAIL— Send as Seller (in Agentforce Lead Nurturing) can’t generate a meeting link. Available in API version 66.0 and later. - SOBO\_QNA\_NO\_ANSWER— Send as Seller (in Agentforce Lead Nurturing) can’t answer the prospect’s question. Available in API version 66.0 and later. - STORAGE\_LIMIT\_EXCEEDED—Available in API version 66.0 and later. - TARGET\_DO\_NOT\_CONTACT\_ON—Target has Do Not Contact on - TARGET\_EMAIL\_BOUNCED - TARGET\_EMAIL\_EMPTY - TARGET\_HAS\_INVALID\_ID - TARGET\_HAS\_OPT\_OUT\_EMAIL - TEMPLATE\_DELETED - TEMPLATE\_EMPTY—Email subject or body missing - TEMPLATE\_HAS\_INVALID\_MERGE\_FIELD - TEMPLATE\_IS\_INACTIVE - TEMPLATE\_MERGE\_FIELD\_RENDERING\_ERROR - TEMPLATE\_NOT\_PUBLIC—No access to template - TEMPLATE\_TOO\_LARGE - UNAUTHORIZED\_EMAIL\_DOMAIN—Available in API version 66.0 and later. - UNKNOWN—Email unknown error - USER\_HAS\_LOST\_HVS\_ACCESS - USER\_IS\_INACTIVE - USER\_NOT\_IN\_EAC\_CONFIG—Available in API version 66.0 and later. | | GoToStepIterationCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times the action cadence step tracker was created for the same step in a cadence. Available in API version 58.0 and later. | | IsActionTaken | Type boolean Properties Defaulted on create, Filter, Group, Sort Description true if the sales rep completed an action during this step, such as making a phone call, otherwise false. The default value is false. This field is a calculated field. | | MessageType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of messaging channel for this step. Available in API version 67.0 and later. Possible values are: - Text— SMS Message | | ReviewCriteriaFlowStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The execution status of the flow run to evaluate if a review is required for an email. Available in API version 67.0 and later. Possible values are: - Failed - NotExecuted - Success | | ReviewDisposition | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Determines what happens to an email when review before send is enabled and the review time duration has expired. Available in API version 67.0 and later. Possible values are: - CancelOutreach - SendAnyway | | ScheduledStartDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the step starts. Available in API version 58.0 and later. | | SecondsOverdue | Type int Properties Filter, Group, Nillable, Sort Description If this step has a due date that has passed, this field contains the number of seconds that has elapsed since the due date. Once a sales rep takes action on the cadence step, the value of this field is the number of seconds elapsed between the due date and the time the action was taken. This field is a calculated field. | | State | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The current state of this step. Possible values are: Possible values are: - Active— The current step that the sales rep is performing. There can only be one active step for a given target. - Approved—The step is approved. Available in API version 66.0 and later. - Cancelled—The sales rep canceled the step. Salesforce doesn’t run any canceled steps. - Completed—This step is finished. Either the work in the step completed, or the step was skipped. - Error—An error occurred while executing this step. - ExpiredApproved—The approval for this step has expired. Available in API version 67.0 and later. - InProgress—The sales rep has started the step, but it isn’t yet completed. - NeedsReview—The step needs a review. Available in API version 66.0 and later. - Paused—The sales rep paused the step. - Queued—Used for automated email steps. The email step has started but the email is waiting in the queue to be sent. - Scheduled—Used for email steps. An email can be scheduled to be sent later. | | StepTitle | Type string Properties Filter, Group, Nillable, Sort Description The name of the related step. | | StepType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of step to execute. Possible values are: - AutoSendAnEmail - Branch - Copilot - CreateTask - DaisyChain - LinkedInConnection - LinkedInMail - ListenerBranch - MakeACall - PlatformScreenFlow - Root - SendAMessage - SendAnEmail - SubRoot - Terminal - Wait | | TargetId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the prospect that is assigned to this cadence. This field is a polymorphic relationship field. Relationship Name Target Relationship Type Lookup Refers To Contact, Lead | | WasEverPaused | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the sales rep had ever paused this step (true), or not (false). This field is available in API version 50.0 and later. | ## Usage List all the steps that this prospect has completed in a given cadence: select StepTitle from ActionCadenceStepTracker where TargetID = and ActionCadenceId= and StepType="Completed" ## 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. [ActionCadenceStepTrackerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. #### See Also - [ActionCadence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadence.htm "Represents the definition of a cadence. This object is available in API version 45.0 and later.") - [ActionCadenceRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerule.htm "Represents the logic that a branch step uses to determine which branch an action cadence tracker follows in an action cadence. Use ActionCadenceRule to learn about a branch step, including its logic and what the next step is. This object is available in API version 48.0 and later.") - [ActionCadenceStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencestep.htm "Represents a step in a cadence. Use ActionCadenceStep to learn which steps belong to a cadence, and how the steps are connected to each other. This object is available in API version 48.0 and later.") - [ActionCadenceRuleCondition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerulecondition.htm "Represents the logic for a branch step. This object is available in API version 48.0 and later.") # ActionCadenceStepVariant Represents an email template or call script variant associated with an action cadence step. Email and call steps can have up to 3 variants associated so sales teams can compare the engagement results. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Sales Engagement and Allow Email Template and Call Script Variant Testing must be enabled. ## Fields | Field | Details | | --- | --- | | ActionCadenceStepId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related action cadence step. This is a relationship field. Relationship Name ActionCadenceStep Relationship Type Lookup Refers To ActionCadenceStep | | SplitPercentage | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of emails to send or calls to make using this email template or call script variant. The total for all variants must be 100%. | | TemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the associated email template or call script. This is a polymorphic relationship field. Relationship Name Template Relationship Type Lookup Refers To CallTemplate, EmailTemplate | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of the associated action cadence step. Possible values are: - AutoSendAnEmail - Branch - Copilot - CreateTask - DaisyChain - LinkedInConnection - LinkedInMail - ListenerBranch - MakeACall - PlatformScreenFlow—Available in version 55.0 and later. - Root - SendAMessage - SendAnEmail - Terminal - Wait Only email and call steps can have an associated action cadence step variant. | ## Usage Use ActionCadenceStepVariant to retrieve the email template or call script for an action cadence step: SELECT SplitPercentage, TemplateId FROM ActionCadenceStepVariant WHERE ActionCadenceStepId=:\[idValue\] Use ActionCadenceStepVariant to retrieve the call scripts from all call steps: SELECT SplitPercentage, TemplateId, ActionCadenceStepId FROM ActionCadenceStepVariant WHERE Type='MakeACall' # ActionCadenceTracker Represents an active cadence target. This object is available in API version 45.0 and later. An ActionCadenceTracker record is created when you add a target to a cadence. Use ActionCadenceTracker to learn about a running cadence target, including its state, current step, assigned prospect, and reason for completion. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ActionCadenceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related ActionCadence. Relationship Name ActionCadence Relationship Type Lookup Refers To ActionCadence | | CompletionDisposition | Type picklist Properties Filter, Group, Nillable, Sort Description The target’s disposition when it exited the action cadence. This field contains a value if the target’s State is Complete. Sales reps can set this value when removing a target from a cadence. This field is available in API version 51.0 and later. Possible values are: - Bad Data — Some of the target’s data is incorrect or invalid. - Contact Later — The target asked to be contacted at a later date. - Customer Connected —The sales rep contacted the target. - Customer Engaged —The target engaged with an email. - Disqualified— A sales rep determined that the target isn’t qualified. - Duplicate — The target has a duplicate lead, contact, or person account record. - Meeting Booked— The target has booked the meeting. - Meeting Requested— The target has requested for a meeting. - No Response — The target didn’t reply to any outreach. - Not Interested — The target stated a lack of interest. - Opt Out— The target has opted out. - Success — the cadence outreach was successful. | | CompletionReason | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The reason that the target completed the cadence. This field contains a value if the target’s State is Complete. Possible values are: - AutomaticallyExited — the target completed the action cadence because a global exit condition occurred. Available in API version 49.0 and later. - AutomaticallyExitedDeletedStep— the target completed the action cadence because a deleted step caused an exit condition. - AutomaticallyExitedInvalidParentStep— the target completed the action cadence because an invalid parent step caused an exit condition. - AutomaticallyExitedPreviouslyExecutedStep— — the target completed the action cadence because the step was already executed. Available in API version 60.0 and later. - DaisyChained — the target completed the action cadence because it’s connected to another action cadence. - LeadConverted — the target completed the action cadence because the lead converted. - ManuallyRemoved — the target completed the action cadence because the sales rep removed it from the cadence. - ManuallyRemovedNoAccess— reserved for future use. - NoMoreSteps — the target completed the action cadence because all the action cadence steps were completed. - ReviewExpired— the target completed the action cadence because the review expired. Available in API version 66.0 and later. | | CurrentStepId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the current ActionCadenceStepTracker. Relationship Name CurrentStep Relationship Type Lookup Refers To ActionCadenceStepTracker | | DaisyChainIteration | Type int Properties Filter, Group, Nillable, Sort Description The number of this action cadence in a sequence of linked action cadences followed by this target. This value starts at 1 with the initial action cadence. A target can follow a sequence of up to 10 linked action cadences. Available in API version 53.0 and later. | | ErrorMessage | Type string Properties Filter, Group, Nillable, Sort Description If an error occurs while this target is being completed, this field contains the error message. | | ExitGlobalRuleId | Type reference Properties Filter, Group, Nillable, Sort Description If a global exit condition occurs, a target completes. One example of a global exit condition is an email returned because of an invalid address. If the target completed because a global exit condition occurred, this field contains the ID of the ActionCadenceRule record that evaluated as true. This field is available in API version 49.0 and later. Relationship Name ExitGlobalRule Relationship Type Lookup Refers To ActionCadenceRule | | IsTrackerActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the action cadence target is active (true) or not (false). The default value is false. An action cadence target is active if the state is Running, Paused, Processing, or Initializing. Only active targets count against the org limit of 150,000 trackers. This field is available in API version 50.0 and later. | | LastCompletedStepId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the last completed ActionCadenceStepTracker. Relationship Name LastCompletedStep Relationship Type Lookup Refers To ActionCadenceStepTracker | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user who is assigned to complete the cadence steps for the target. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RelatedToAttributionType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Defines when the cadence is related to an opportunity or invoice. Available in API version 51.0 and later. Possible values are: - Activation—Attribute the opportunity to the cadence when the opportunity is created. - Collected—Attribute the value to the cadence after payment for the invoice is collected. - Collection Advancement—Attribute the value to the cadence when the invoice is out for collection. - Maturation—Attribute the opportunity to the cadence only when the opportunity stage advances. | | RelatedToId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related opportunity if there’s one. Available in API version 51.0 and later. This is a polymorphic relationship field. Relationship Name RelatedTo Relationship Type Lookup Refers To Opportunity, Invoice | | ScheduledResumeDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the action cadence tracker is going to resume after it’s paused or on a wait step. Available in API version 53.0 and later. | | State | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The state of the current action cadence tracker. Possible values are: - Complete - Error - Initializing - Paused - Processing—Salesforce is working on changing the state of this action cadence tracker. We recommend that you filter out steps that have this state from your dashboards. - Running | | TargetId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the target that is assigned to this action cadence. Relationship Name Target Relationship Type Lookup Refers To Contact, Lead | ## Usage Use ActionCadenceTracker to see what targets are currently assigned to an active action cadence. select TargetId from ActionCadenceTracker where ActionCadenceId= and State= "Running" ## 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. [ActionCadenceTrackerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ActionCadenceTrackerOwnerSharingRule](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. [ActionCadenceTrackerShare](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. # ActionCdncStpMonthlyMetric Represents the monthly engagement metrics for an action cadence step. This object is available in API version 49.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Sales Engagement must be enabled. ## Fields | Field | Details | | --- | --- | | ActionCadenceStepId | Type reference Properties Filter, Group, Sort Description The ID of the related action cadence step. This is a relationship field. Relationship Name ActionCadenceStep Relationship Type This is an overview-detail relationship field, where ActionCadenceStep is the master object. Refers To ActionCadenceStep | | AllCallsCallBackLater | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this step with the call result Call Back Later. | | AllCallsLeftVoicemail | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this step with the call result Left Voicemail. | | AllCallsMeaningfulConnect | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this step with the call result Meaningful Connect. | | AllCallsNotInterested | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this step with the call result Not Interested. | | AllCallsUncategorized | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this step with no call result specified. | | AllCallsUnqualified | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this step with the call result Unqualified. | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total of hard and soft bounced emails for this step in the month. This is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of successfully delivered emails for this step in the month. This is a calculated field. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of hard bounced emails for this step in the month. | | AllEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails containing a link clicked by the recipient for this step in the month. | | AllEmailsNotDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of sent emails that were bounced for all recipients on the email. Bounced emails aren’t marked as delivered. Available in API version 54.0 and later. | | AllEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails opened by the recipient for this step in the month. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that triggered an out-of-office reply for this step in the month. | | AllEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails replied to for this step in the month. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent for this step in the month. This is a calculated field. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails soft bounced for this step in the month. | | AllEmailsTrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with engagement tracking enabled for this step in the month. Available in API version 51.0 and later. | | AllEmailsUntrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent without engagement tracking for this step in the month. Available in API version 51.0 and later. | | AllTotalCallsCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of calls with all call results for this step in the month. This is a calculated field. | | DeliveredRecipientCount | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients that were successfully delivered an email. Available in API version 54.0 and later. This field is a calculated field. | | DeliveredRecipientRate | Type percent Properties Filter, Nillable, Sort Description The percentage of unique recipients that received an email you sent. Available in API version 54.0 and later. This field is a calculated field. | | HardBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with hard bounce tracking. Available in API version 54.0 and later. | | HasTemplateAssigned | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this step has an associated email template or call script. Available in API version 52.0 and later. The default value is 'false'. | | HrdBncTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with hard bounce tracking. Available in API version 54.0 and later. | | IsCompoundMetric | Type boolean Properties Defaulted on create, Filter, Group, Sort Description When true, indicates that this metric represents engagement for a combination of the action cadence step and a single email template. The value is true for all action cadence steps created in Summer ’21 and later. When false, indicates that the metric represents engagement for the action cadence step and all email templates used on the step. The value is false for all action cadence steps created in Spring ’21 and earlier. The default value is 'false'. Available in API version 52.0 and later. | | LinkClickTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with link click tracking. Available in API version 54.0 and later. | | LinkClkTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with link tracking. Available in API version 54.0 and later. | | Month | Type date Properties Filter, Group, Sort Description The month in which the engagement occurred. | | MonthInt | Type int Properties Filter, Group, idLookup, Sort Description The month in which the engagement occurred, in yyyymm format. | | OooTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with out-of-office tracking. Out-of-office tracking requires Inbox. Available in API version 54.0 and later. | | OpenTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with open tracking. Available in API version 54.0 and later. | | OpenTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with open tracking. Available in API version 54.0 and later. | | OutOfOfficeTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with out-of-office tracking. Available in API version 54.0 and later. | | RecipientReplies | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who replied to an email. Available in API version 54.0 and later. | | RecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of unique email recipients. Available in API version 54.0 and later. | | RecipientsHardBounced | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients that hard-bounced an email. Hard bounces can mean that the recipient's email address doesn't exist or is misspelled. Available in API version 54.0 and later. | | RecipientsOutOfOffice | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients that responded with an out-of-office reply. Available in API version 54.0 and later. | | RecipientsSoftBounced | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients that soft-bounced an email. A soft bounce often indicates a temporary issue with the recipient's email server, such as a full inbox. Available in API version 54.0 and later. | | ReplyTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with reply tracking. Available in API version 54.0 and later. | | ReplyTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with reply tracking. Available in API version 54.0 and later. | | SftBncTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with soft bounce tracking. Available in API version 53.0 and later. | | SoftBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with soft bounce tracking. Available in API version 54.0 and later. | | SomeEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of sent emails that were successfully delivered to at least one of its recipients. Available in API version 54.0 and later. This field is a calculated field. | | SomeEmailsDeliveredRate | Type percent Properties Filter, Nillable, Sort Description The percentage of sent and tracked emails that were successfully delivered to at least one of their recipients. Available in API version 54.0 and later. This field is a calculated field. | | TemplateId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the email template or call script associated with this step. Available in API version 52.0 and later. This is a polymorphic relationship field. Relationship Name Template Relationship Type Lookup Refers To CallTemplate, EmailTemplate | | TrackableRecipientSendHrdBncRt | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to unique recipients with hard bounce tracking that hard bounced. Available in API version 54.0 and later. This field is a calculated field. | | TrackableRecipientSendOooRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with out-of-office tracking that received out-of-office replies from unique recipients. Available in API version 54.0 and later. This field is a calculated field. | | TrackableRecipientSendReplyRt | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with reply tracking that received replies from unique recipients. Available in API version 54.0 and later. This field is a calculated field. | | TrackableRecipientSendSftBncRt | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to unique recipients with soft bounce tracking that soft-bounced. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendHardBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with hard bounce tracking that hard bounced. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendLinkClickRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with link tracking that had link clicks. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendOpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with open tracking that were opened by the recipient. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendOutOfOfficeRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with out-of-office tracking that received out-of-office replies. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendReplyRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with reply tracking that received replies. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendSoftBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with soft bounce tracking that soft bounced. Available in API version 54.0 and later. This field is a calculated field. | | UniqueEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who clicked a link in an email for this step in the month. | | UniqueEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who opened an email for this step in the month. | | UniqueEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who replied to an email for this step in the month. | # ActionLinkGroupTemplate Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking on an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. Every action link belongs to an action link group and action links within the group are mutually exclusive. This object is available in API version 33.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Only users with the “Customize Application” permission can modify or delete this object. ## Fields | Field Name | Details | | --- | --- | | Category | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The location of the action link group within the feed element. Values are: - Primary—The action link group is displayed in the body of the feed element. - Overflow—The action link group is displayed in the overflow menu of the feed element. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the action link group template to use in code. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | ExecutionsAllowed | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The number of times an action link can be executed. Values are: - Once—An action link can be executed only once across all users. - OncePerUser—An action link can be executed only once for each user. - Unlimited—An action link can be executed an unlimited number of times by each user. If the action link’s actionType is Api or ApiAsync, you can’t use this value. | | HoursUntilExpiration | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of hours from when the action link group is created until it's removed from associated feed elements and can no longer be executed. The maximum value is 8,760. | | IsPublished | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the action link group template is published. Action link group templates shouldn’t be published until at least one [ActionLinkTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionlinktemplate.htm "Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. This object is available in API version 33.0 and later.") is associated with it. Once set to true, this can’t be set back to false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the MasterLabel. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The name of the action link group template. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | ## Usage Define action link templates in Setup and use ConnectApi in Apex or Connect REST API to instantiate action links from the templates and to post feed elements with the action links. If you delete a published action link group template, you delete all related action link information which includes deleting all action links that were instantiated using the template from feed items. # ActionLinkTemplate Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. This object is available in API version 33.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Only users with the “Customize Application” permission can modify or delete this object. ## Fields | Field Name | Details | | --- | --- | | ActionLinkGroupTemplateId | Type reference Properties Create, Filter, Group, Sort Description ID of the [ActionLinkGroupTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionlinkgrouptemplate.htm "Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking on an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. Every action link belongs to an action link group and action links within the group are mutually exclusive. This object is available in API version 33.0 and later.") with which this action link template is associated. This is a relationship field. Relationship Name ActionLinkGroupTemplate Relationship Type Lookup Refers To ActionLinkGroupTemplate | | ActionUrl | Type textarea Properties Create, Update Description The action link URL. For example, a Ui action link URL is a Web page. A Download action link URL is a link to the file to download. Ui and Download action link URLs are provided to clients. An Api or ApiAsync action link URL is a REST resource. Api and ApiAsync action link URLs aren’t provided to clients. Links to Salesforce can be relative. All other links must be absolute and start with https://. Links to resources hosted on Salesforce servers can be relative, starting with a /. All other links must be absolute and start with https://. This field can contain context variables and binding variables in the form {!Bindings.key}, for example, https://www.example.com/{!Bindings.itemId}. Set the binding variable’s value when you instantiate the action link group from the template. | | Headers | Type textarea Properties Create, Nillable, Update Description Template for the HTTP headers sent when corresponding action links are invoked. This field can be used only for Api and ApiAsync action links. This field can contain context variables and binding variables in the form {!Bindings.key}. | | IsConfirmationRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, a confirmation dialog appears before the action is executed. | | IsGroupDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, action links derived from this template are the default or primary action in their action groups. There can be only one default action per action group. | | Label | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A custom label to display on the action link button. If none of the LabelKey values make sense for an action link, use a custom label. Set the LabelKey field to None and enter a label name in the Label field. Action links have four states: new, pending, success, and failed. These strings are appended to the label for each state: - _Label_ - _Label_ Pending - _Label_ Success - _Label_ Failed For example, if the value of Label is “Call Home,” the values of the four action link states are: Call Home, Call Home Pending, Call Home Success, and Call Home Failed. If LabelKey has any value other than None, the Label field is empty. | | LabelKey | Type string Properties Create, Filter, Group, Sort, Update Description Key for the set of labels to display for these action link states: new, pending, success, failed. For example, the Approve set contains these labels: Approve, Pending, Approved, Failed. For a complete list of keys and labels, see [Action Link Labels](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_appendices_action_links_labels.htm "HTML (New Window)") in the Connect REST API Developer Guide. If none of the label key values make sense for an action link, set this field to None and enter a custom label name in the Label field. | | LinkType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of action link. One of these values: - Api—The action link calls a synchronous API at the action URL. Salesforce sets the status to SuccessfulStatus or FailedStatus based on the HTTP status code returned by your server. - ApiAsync—The action link calls an asynchronous API at the action URL. The action remains in a PendingStatus state until a third party makes a request to /connect/action-links/actionLinkId to set the status to SuccessfulStatus or FailedStatus when the asynchronous operation is complete. - Download—The action link downloads a file from the action URL. - Ui—The action link takes the user to a web page at the action URL. | | Method | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description HTTP method for the action URL. One of these values: - HttpDelete—Returns HTTP 204 on success. Response body or output class is empty. - HttpGet—Returns HTTP 200 on success. - HttpHead—Returns HTTP 200 on success. Response body or output class is empty. - HttpPatch—Returns HTTP 200 on success or HTTP 204 if the response body or output class is empty. - HttpPost—Returns HTTP 201 on success or HTTP 204 if the response body or output class is empty. Exceptions are the batch posting resources and methods, which return HTTP 200 on success. - HttpPut—Return HTTP 200 on success or HTTP 204 if the response body or output class is empty. Ui and Download action links must use HttpGet. | | Position | Type int Properties Create, Filter, Group, Sort, Update Description An integer specifying the position of the action link template relative to other action links in the group. 0 is the first position. | | RequestBody | Type textarea Properties Create, Nillable, Update Description Template for the HTTP request body sent when corresponding action links are invoked. This field can be used only for Api and ApiAsync action links. This field can contain context variables and binding variables in the form {!Bindings.key}. | | UserAlias | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If you selected CustomUser or CustomExcludedUser for UserVisibility, this field is the alias for the custom user. Use the alias in a template binding to specify the custom user when an action link group is created using the template. | | UserVisibility | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Who can see the action link. This value is set per action link, not per action link group. One of these values: - Creator—Only the creator of the action link can see the action link. - Everyone—Everyone can see the action link. - EveryoneButCreator—Everyone but the creator of the action link can see the action link. - Manager—Only the manager of the creator of the action link can see the action link. - CustomUser—Only the custom user can see the action link. - CustomExcludedUser—Everyone but the custom user can see the action link. | ## Usage Create action link templates in Setup. Use Apex classes in the ConnectApi namespace or Connect REST API to instantiate action links from templates and to post feed elements with the action links. For information about action links, see [Working with Action Links](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/pages/connectapi_features_action_links.htm?search_text=working%20with%20action%20links "HTML (New Window)") in the Apex Developer Guide or the Connect REST API Developer Guide. # ActionPlan Represents the instance of an action plan, a set of tasks created from an action plan template. This object is available in API version 44.0 and later. ## Supported Calls create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()undelete()update()upsert() ## Special Access Rules The user must have “Edit” permissions on ActionPlan records in order to create or update action plans line. The user must have “Edit” permissions on ActionPlan records to delete an action plan. Some of the fields are available when Subscription Management is enabled. ## Fields | Field Name | Details | | --- | --- | | ActionPlanState | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The status of work being done for the action plan. Possible values are: - Canceled - Complete - In Progress - Not Started The default value is Not Started. | | ActionPlanTemplateVersionId | Type reference Properties Create, Filter, Group, Sort Description The ID of the version of the action plan template used to create this action plan. At creation, the referenced action plan template must be in the published state. | | ActionPlanType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The action plan’s type. Possible values are: - Industries - Sales—This value is available in API version 63.0 and later with the Sales Action Plans add-on license and the Sales Action Plans default permission set. - Service | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the action plan is locked or not. | | IsUsingHolidayHours | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether task completion dates have been calculated by incrementing the task offset for each non-work day, excluding recurring holidays. | | LastReferencedDate | Type dateTime Properties Filter, Nllable, Sort Description The most recent date on which a user referenced this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the action plan can be edited or not. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the action plan. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this record. | | ProcessType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the processing type that determines the default logic for downstream action plans. | | StartDate | Type date Properties Create, Default on create, Filter, Group, Sort Description The start date of the action plan. | | TargetId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the parent object record that relates to this action plan. For API version 63.0 and later, supported parent objects are Account, AccountPlanObjective, Applicant, ApplicationForm, ApplicationFormProduct, Asset, BusinessLicense, BusinessMilestone, Campaign, Case, ChangeRequest, Claim, Contact, Contract, FinancialGoal, Incident, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity, PersonLifeEvent, Problem, ResidentialLoanApplication, WorkOrder, and WorkOrderLineItem. For API version 62.0 and later, supported parent objects are ApplicationFormEvaluation and VettingEvaluation. For API version 48.0 and later, supported parent objects are Account, AssetsAndLiabilities, BusinessMilestone, Campaign, Card, Case, Claim, Contact, Contract, Financial Account, Financial Goal, Financial Holding, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity, PersonLifeEvent, ResidentialLoanApplication, and Visit as well as custom objects with activities enabled. For API version 47.0 and later, supported parent objects are Account, BusinessMilestone, Campaign, Case, Claim, Contact, Contract, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity, PersonLifeEvent, and Visit as well as custom objects with activities enabled. For API version 46.0 and later, supported parent objects are Account, Campaign, Case, Contact, Contract, Lead, and Opportunity as well as custom objects with activities enabled. For API version 45.0 and earlier, the only supported parent object is Account. | | Version | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The number used to track updates and revisions to the action plan template or plan. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ActionPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [ActionPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ActionPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ActionPlanOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ActionPlanShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ActionPlanItem Represents the instance of an action plan item.This object is available in API version 44.0 and later. ## Supported Calls create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()undelete()update()upsert() ## Fields | Field Name | Details | | --- | --- | | ActionPlanId | Type reference Properties Create, Filter, Group, Sort Description The ID of the action plan that this item belongs to. | | ActionPlanTemplateItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the action plan template item this item was created from. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan item is locked or not. The default value is false. | | IsRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan item is required or not. | | ItemEntityType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of object used with the item. This field is available in API version 61.0 and later. Possible values are: - AssessmentTask—Assessment Task - DocumentChecklistItem—Document Checklist Item - Event\-Available only with sales action plans in API version 63.0 and later with the Sales Action Plans add-on license and the Sales Action Plans default permission set. - GenericVisitTask—Generic Visit Task - OtherComponentTask—Other Component Task - RecordAction - SignatureTask—Signature Task - Task | | ItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the record created by this action plan item. This field is a polymorphic relationship field. Relationship Name Item Refers To DocumentChecklistItem, Event, RecordAction, Task | | ItemState | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The action plan item’s work state. Possible values are: - Canceled - Completed - Deleted - In Progress - Pending | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this action plan item. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ActionPlanItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [ActionPlanItemFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ActionPlanItemHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ActionPlanItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ActionPlanItemShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ActionPlanTemplate Represents the instance of an action plan template. This object is available in API version 44.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Apex triggers aren't supported for ActionPlanTemplate.You can't use the API to retrieve list views for this object. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ActionPlanType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description This action plan template’s type. Possible values are: - Industries - Sales—This value is available in API version 63.0 and later with the Sales Action Plans add-on license and the Sales Action Plans default permission set. - Service | | Category | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the category that the action plan template belongs to. Available in API version 64.0 and later. Possible values are: - Onboarding - Application | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of this action plan template. | | EstimatedCompletionDays | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The estimated number of days to complete the action plan. Available in API version 64.0 and later. | | FileBasedTemplatePath | Type string Properties Filter, Group, Nillable, Sort Description The path of the file based template using which the action plan template is created. Available in API version 64.0 and later. | | IsAdHocItemCreationEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether users can add tasks or other items to generated action plans (true) or not (false). | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan template is locked or not. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan template can be edited or not. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this action plan template. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this action plan template. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ProcessType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the processing type that determines the default logic for downstream action plans. | | SourceType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the source type to which the action plan template belongs to. Available in API version 64.0 and later. Possible values are: - CRM - MigratedFromSandbox | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of this action plan template. Possible values are: - Draft - Final—Published - Obsolete - ReadOnly | | Subcategory | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The subcategory to which the action plan template belongs. Available in API version 64.0 and later. Possible values are: - Product Onboarding - Customer Onboarding | | TargetEntityType | Type picklist Properties Create, Defaulted on create, Group, Restricted picklist, Sort Description The parent object this action plan template relates to. Possible values are organized by the API version in which they were introduced. Values are available in all versions after introduction unless noted otherwise. API Version 62.0 and later with Financial Services: - AccountPlanObjective - FinancialDeal - PartyProfile API Version 62.0 and later with Public Sector Solutions: - ApplicationFormEvaluation - VettingEvaluation API version 60.0 and later with Education Cloud - ProgramEnrollment API version 58.0 and later with Health Cloud - CareBarrier API version 58.0 and later with Nonprofit Cloud: - Benefit - Program API Version 58.0 and later with Public Sector Solution and Education Cloud: - ApplicationDecision - ApplicationReview - Benefit - Program API Version 56.0 and later with Automotive Cloud: - Account - Asset - Asset Account Participant - Asset Contact Participant - Asset Milestone - Fleet - Lead - Opportunity - Record Alert - Vehicle - Case - Claim - Contact API Version 58.0 and later with Grantmaking: - ApplicationDecision - ApplicationReview - Benefit - Budget - BudgetAllocation - CareBarrier - FundingAward - FundingAwardAmendment - FundingAwardRequirement - FundingDisbursement - FundingOpportunity - Program API Version 52.0 and later: - BusinessLicenseApplication - IndividualApplication - PublicComplaint - RegulatoryCodeViolation - ViolationEnforcementAction API Version 47.0 and later: - BusinessMilestone - Claim - InsurancePolicy - InsurancePolicyCoverage - PersonLifeEvent - Visit API Version 46.0 and later: - Campaign—Unsupported for Grantmaking. - Case - Contact - Contract - Lead - Opportunity - Custom objects with activities enabled API Version 44.0 and later: Account | | UniqueName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name for this action plan template. This field is unique within your organization. | | Version | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The number used to track updates and revisions to the action plan template or plan. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ActionPlanTemplateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [ActionPlanTemplateFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ActionPlanTemplateHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ActionPlanTemplateOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ActionPlanTemplateShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ActionPlanTemplateItem Represents the instance of an item on an action plan template version. This object is available in API version 44.0 and later. ## Supported Calls create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()search()undelete()update()upsert() ## Fields | Field Name | Details | | --- | --- | | ActionPlanTemplateVersionId | Type reference Properties Create, Filter, Group, Sort, Description The version of the action plan template this item is for. | | DisplayOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The order in which this item is displayed within the action plan template version. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the task created from this template item is active. The default value is false. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan template item is locked or not. The default value is false. | | IsRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the task created from this template item is required. The default value is false. | | ItemEntityType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of action plan template item entity.. Possible values are: - Document Checklist Item - Event—This value is available in API version 63.0. - RecordAction - Task | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan template item can be edited or not. The default value is false. | | Name | Type string Properties Create, Filter, Group, Sort, idLookup, Update Description The unique identifier for this action plan template item record. | | UniqueName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name for this action plan template item. This field is unique within your organization. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ActionPlanTemplateItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [ActionPlanTemplateItemFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ActionPlanTemplateItemHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ActionPlanTemplateItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ActionPlanTemplateItemShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ActionPlanTemplateItemValue Represents the value associated with an action plan template item. This object is available in API version 44.0 and later. ## Supported Calls create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()search()undelete()update()upsert() ## Fields | Field Name | Details | | --- | --- | | ActionPlanTemplateItemId | Type reference Properties Create, Filter, Group, Sort Description The ID of the action plan template item that this value relates to. Relationship Name ActionPlanTemplateItem Relationship Type Master-detail Refers To ActionPlanTemplateItem (the master object) | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the task created from this template item is active. The default value is false. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan template item value is locked or not. The default value is false. | | ItemEntityFieldName | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The name of the field on the action plan template item that this value is for. Available fields include: - AssessmentTask.AssessmentTaskDefinitionId—Assessment Task Definition ID - AssessmentTask.AssignedToId—AssignedTo ID - AssessmentTask.Description—Description - AssessmentTask.EndTime—End Time - AssessmentTask.IsRequired—Required - AssessmentTask.Name—Name - AssessmentTask.OwnerId—Owner ID - AssessmentTask.ParentId—Visit ID - AssessmentTask.ReferenceRecordId—ReferenceRecord ID - AssessmentTask.SequenceNumber—Sequence - AssessmentTask.StartTime—Start Time - AssessmentTask.Status—Status - AssessmentTask.TaskDefinitionId—TaskDefinition ID - AssessmentTask.TaskType—Task Type - DocumentChecklistItem.Comments—Comments - DocumentChecklistItem.DocumentCategoryId—Document Category ID - DocumentChecklistItem.DocumentTypeId—Document Type ID - DocumentChecklistItem.Instruction—Instructions - DocumentChecklistItem.IsAccepted—Accepted - DocumentChecklistItem.IsFrozen—Frozen - DocumentChecklistItem.IsRequired—Required - DocumentChecklistItem.Name—Name - DocumentChecklistItem.OwnerId—Owner ID - DocumentChecklistItem.ParentRecordId—Parent Record ID - DocumentChecklistItem.ReceivedDocumentId—Received Document ID - DocumentChecklistItem.Status—Status - DocumentChecklistItem.ValidatedById—User ID - DocumentChecklistItem.ValidationDateTime—Validation Date Time - DocumentChecklistItem.WhoId—Who ID - Event.ActivityDate—Due Date Only - Event.ActivityDateTime—Due Date Time - Event.Description—Description - Event.DurationInMinutes—Duration - Event.EndDateTime—End Date Time - Event.EventSubtype—Event Subtype - Event.IsAllDayEvent—All-Day Event - Event.IsPrivate—Private - Event.IsRecurrence—Create Recurring Series of Events - Event.IsReminderSet—Reminder Set - Event.Location—Location - Event.OwnerId—Assigned To ID - Event.Recurrence2PatternText—Recurrence Pattern - Event.RecurrenceDayOfMonth—Recurrence Day of Month - Event.RecurrenceDayOfWeekMask—Recurrence Day of Week Mask - Event.RecurrenceEndDateOnly—Recurrence End - Event.RecurrenceInstance—Recurrence Instance - Event.RecurrenceInterval—Recurrence Interval - Event.RecurrenceMonthOfYear—Recurrence Month of Year - Event.RecurrenceStartDateTime—Recurrence Start - Event.RecurrenceTimeZoneSidKey—Recurrence Time Zone - Event.RecurrenceType—Recurrence Type - Event.ReminderDateTime—Reminder Date/Time - Event.ShowAs—Show Time As - Event.StartDateTime—Start Date Time - Event.Subject—Subject - Event.Type—Type - Event.WhatId—Related To ID - Event.WhoId—Name ID - GenericVisitTask.DefinitionReferenceId—Generic Visit Task ID - GenericVisitTask.Description—Description - GenericVisitTask.EndDateTime—End Date Time - GenericVisitTask.IsRequired—Required - GenericVisitTask.Name—Name - GenericVisitTask.OwnerId—Owner ID - GenericVisitTask.Sequence—Sequence - GenericVisitTask.StartDateTime—Start Date Time - GenericVisitTask.Status—Status - GenericVisitTask.VisitId—Visit ID - OtherComponentTask.Description—Description - OtherComponentTask.FullyQualifiedName—Fully Qualified Name - OtherComponentTask.Name—Name - OtherComponentTask.OwnerId—Owner ID - OtherComponentTask.ParentTaskId—Assessment Task ID - OtherComponentTask.ParticipantRoleId—ParticipantRole ID - RecordAction.ActionDefinition—Action Definition - RecordAction.ActionType—Action Type - RecordAction.FlowDefinition—Interaction Definition ID - RecordAction.FlowInterviewId—FlowInterview ID - RecordAction.IsMandatory—Is Mandatory - RecordAction.IsUiRemoveHidden—Hide Remove Action in UI - RecordAction.Order—Order - RecordAction.ParticipantRoleId—ParticipantRole ID - RecordAction.Pinned—Pinned - RecordAction.RecordId—Parent Record ID - RecordAction.Status—Status - SignatureTask.Description—Description - SignatureTask.Name—Name - SignatureTask.ParentTaskId—Assessment Task ID - Task.APT\_Custom\_Text\_1\_c\_\_c—APT Custom Text - 1 - Task.ActivityDate—Due Date Only - Task.Boolean\_Test\_\_c—Boolean Test - Task.CallDisposition—Call Result - Task.CallDurationInSeconds—Call Duration - Task.CallObject—Call Object Identifier - Task.CallType—Call Type - Task.Custom\_Picklist\_\_c—Custom Picklist - Task.Description—TEstActivityDEs - Task.IsRecurrence—Create Recurring Series of Tasks - Task.IsReminderSet—Reminder Set - Task.OwnerId—Assigned To ID - Task.Priority—Priority - Task.RecurrenceDayOfMonth—Recurrence Day of Month - Task.RecurrenceDayOfWeekMask—Recurrence Day of Week Mask - Task.RecurrenceEndDateOnly—Recurrence End - Task.RecurrenceInstance—Recurrence Instance - Task.RecurrenceInterval—Recurrence Interval - Task.RecurrenceMonthOfYear—Recurrence Month of Year - Task.RecurrenceRegeneratedType—Repeat This Task - Task.RecurrenceStartDateOnly—Recurrence Start - Task.RecurrenceTimeZoneSidKey—Recurrence Time Zone - Task.RecurrenceType—Recurrence Type - Task.ReminderDateTime—Reminder Date/Time - Task.Status—Status - Task.Subject—Subject - Task.TaskSubtype—Task Subtype - Task.Type—Type - Task.WhatId—Related To ID - Task.WhoId—Name ID - Task.test\_\_c—test - Task.text\_3\_\_c—text 3 | | ItemEntityType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of action plan template item. Possible values are: - Document Checklist Item - Event—Available in API version 63.0 and later with the Sales Action Plans add-on license and the Sales Action Plans default permission set. - RecordAction - Task | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan template item value can be edited or not. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique identifier for this record. | | ValueFormula | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A formula used to calculate the value for this action plan template item. | | ValueLiteral | Type textarea Properties Create, Filter, Nillable, Update Description The value for this action plan template item. | ## 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. [ActionPlanTemplateItemValueChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [ActionPlanTemplateItemValueFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ActionPlanTemplateItemValueHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ActionPlanTemplateItemValueOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ActionPlanTemplateItemValueShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ActionPlanTemplateVersion Represents the version of an action plan template. This object is available in API version 44.0 and later. ## Supported Calls create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()search ( )undelete()update()upsert() ## Fields | Field Name | Details | | --- | --- | | ActionPlanTemplateId | Type reference Properties Create, Filter, Group, Sort, Group Description The ID of the action plan template this version represents. | | ActivationDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Description The date and time at which this version became active. | | InactivationDateTime | Type dateTime Properties Create, Filter, Nillable, Sort Description The date and time at which this version became inactive. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan template version is locked or not. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort, , Sort Description The most recent date on which a user referenced this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this action plan template version can be edited. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update, Description The name of this version item. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The action plan template version’s state. Possible values are: - Draft - Final – Published - Obsolete - ReadOnly | | Version | Type int Properties Create, Defaulted on create, Filter, Group, Sort Description The index number of this action plan template version. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ActionPlanTemplateVersionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [ActionPlanTemplateVersionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ActionPlanTemplateVersionHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ActionPlanTemplateVersionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ActionPlanTemplateVersionShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ActiveFeatureLicenseMetric Represents the number of active, assigned, and purchased feature licenses in the org. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ActiveUserCount | Type int Properties Filter, Group, Nillable, Sort Description Number of users assigned this feature license who have logged in within the last 30 days. | | AssignedUserCount | Type int Properties Filter, Group, Nillable, Sort Description Number of users assigned this feature license. | | FeatureType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Type of feature license. Possible values are: - AvantgoUser—AvantGo User - ChatterAnswersUser—Chatter Answers User - InteractionUser—Flow User - JigsawProspectingUser—Data.com User - KnowledgeUser—Knowledge User - LiveAgentUser—Chat User - MarketingUser—Marketing User - MobileUser—Apex Mobile User - OfflineUser—Offline User - SFContentUser—Salesforce CRM Content User - SiteforceContributorUser—Site.com Contributor User - SiteforcePublisherUser—Site.com Publisher User - SupportUser—Service Cloud User - WirelessUser—Wireless User - WorkDotComUserFeature—WDC User | | MetricsDate | Type date Properties Filter, Group, Sort Description Date that feature license metrics were collected. | | TotalLicenseCount | Type int Properties Filter, Group, Nillable, Sort Description The number of feature licenses in the organization. | # ActivePermSetLicenseMetric Represents the number of active, assigned, and purchased permission set licenses in the org. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ActiveUserCount | Type int Properties Filter, Group, Nillable, Sort Description Number of users assigned this permission set license who have logged in within the last 30 days. | | AssignedUserCount | Type int Properties Filter, Group, Nillable, Sort Description Number of users assigned this permission set license. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description The unique name of this permission set license object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The label of the permission set license. | | MetricsDate | Type date Properties Filter, Group, Sort Description Date that permission set license metrics were collected. | | PermissionSetLicenseId | Type reference Properties Filter, Group, Sort Description The ID of the permission set license. This is a relationship field. Relationship Name PermissionSetLicense Relationship Type Lookup Refers To PermissionSetLicense | | TotalLicenses | Type int Properties Filter, Group, Nillable, Sort Description The total number of this permission set licenses that are available to your org. | # ActiveProfileMetric Represents the profile associated with the active, assigned, and purchased user licenses. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ActiveUserCount | Type int Properties Filter, Group, Nillable, Sort Description Number of users assigned this profile who have logged in within the last 30 days. | | AssignedUserCount | Type int Properties Filter, Group, Nillable, Sort Description Number of users assigned this profile. | | MetricsDate | Type date Properties Filter, Group, Sort Description Date that profile metrics were collected. | | ProfileId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the profile. This is a relationship field. Relationship Name Profile Relationship Type Lookup Refers To Profile | | UserLicenseId | Type reference Properties Filter, Group, Sort Description The ID of the user license. This is a relationship field. Relationship Name UserLicense Relationship Type Lookup Refers To UserLicense | # ActiveScratchOrg Represents an active scratch org. This object is available in API version 41.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description A description of this scratch org. | | Edition | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The org edition of this scratch org. Possible values are Group, Developer, Enterprise, and Professional. This field is read only. | | ExpirationDate | Type date Properties Filter, Group, Nillable, Sort Description Date when the scratch org expires. This field is read only. | | Features | Type textarea Properties Nillable Description The features enabled in this scratch org, such as MultiCurrency. See the Salesforce DX Developer Guide for the full list of valid features. This field is read only. | | HasSampleData | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Specifies whether the scratch org contains sample data. If set to true, the sample data is similar to the data in a Salesforce free trial org. | | LastLoginDate | Type date Properties Filter, Group, Nillable, Sort Description The date of the last user login to the scratch org. This field is read only. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. This field is read only. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. This field is read only. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The auto-generated ID of this scratch org. This field is read only. | | Namespace | Type string Properties Filter, Group, Nillable, Sort Description The namespace associated with this scratch org. This field is read only. | | OrgName | Type string Properties Filter, Group, Nillable, Sort Description The name of the scratch org. This field is read only. | | OwnerId | Type reference Properties Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this scratch org. This field is read only. | | ScratchOrg | Type string Properties Filter, Group, Sort Description The org ID of the scratch org. This field is read only. | | ScratchOrgInfoId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The id of the associated ScratchOrgInfo object. This field is read only. | | SignupEmail | Type email Properties Filter, Group, Nillable, Sort Description The email address of the Administration user. This field is read only. | | SignupInstance | Type string Properties Filter, Group, Nillable, Sort Description The Salesforce instance on which this scratch org resides. This field is read only. | | SignupTrialDays | Type int Properties Filter, Group, Nillable, Sort Description The number of days between the scratch org's creation and expiration. This field is read only. | | SignupUsername | Type string Properties Filter, Group, Nillable, Sort Description The username of the Administration user of the scratch org. This field is read only. | | Snapshot | Type string Properties Filter, Group, Nillable, Sort Description If this scratch org was created from a scratch org snapshot, then this field contains either the name or ID of the snapshot. Specifically, the name corresponds to the Name field of the snapshot’s record in the OrgSnapshot standard object; the ID corresponds to the record ID. If this scratch org wasn’t created from a snapshot, this field is empty. This field is read only. This field is available in API version 61.0 and later. | ## Usage Salesforce automatically creates an instance of this object after a ScratchOrgInfo record moves to the Active state. The new ActiveScratchOrg gets many of its field values from the ScratchOrgInfo object with which it’s associated. When you delete an ActiveScratchOrg record, its associated scratch org is deleted and its associated ScratchOrgInfo record is moved to the Deleted state. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [ActiveScratchOrgFeed](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. [ActiveScratchOrgHistory](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. [ActiveScratchOrgShare](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. #### See Also - [ScratchOrgInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scratchorginfo.htm "Represents a scratch org and its audit log. Use this object to create a scratch org and keep a log of its creation and deletion. This object is available in API version 41.0 and later.") - [NamespaceRegistry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_namespaceregistry.htm "Represents a namespace that you can link to scratch orgs that were created from your org’s Dev Hub. You use the namespace when developing, packaging, and releasing an app. You can’t create this object with the API. Use the Link Namespace action in the Dev Hub graphical interface to insert a NamespaceRegistry record. This object is available in API version 41.0 and later.") - [_Salesforce DX Developer Guide_](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev " Salesforce DX Developer Guide - HTML (New Window)") # ActivityFieldHistory Represents a change in a field value for a tracked object or field. This object is a big object. This object is available in API version 55.0 and later. ## Supported Calls delete()describeSObjects(), query(), retrieve() ## Special Access Rules To see this object, users must have ViewAllData permissions. ## Fields | Field | Details | | --- | --- | | ActivityId | Type reference Properties Filter, Sort Description The ID of the task or event that changed. This field is a polymorphic relationship field. Relationship Name Activity Refers To Event, Task | | ChangedById | Type reference Properties Filter, Sort Description The ID of the user who made the change. This field is a relationship field. Relationship Name ChangedBy Refers To User | | ChangedDate | Type dateTime Properties Filter, Sort Description The date the field value changed. | | DataType | Type picklist Properties Restricted picklist Description The type of the field with the changed value. Possible values are: - Address - AnyType - AutoNumber - Base64 - BitVector - Boolean - Content - Currency - DataCategoryGroupReference - DateOnly - DateTime - Division - Double - DynamicEnum - Email - EncryptedBase64 - EncryptedText - EntityId - EnumOrId - ExternalId - Fax - File - HtmlMultiLineText - HtmlStringPlusClob - InetAddress - Json - Location - MultiEnum - MultiLineText - Namespace - Percent - PersonName - Phone - Raw - RecordType - SfdcEncryptedText - SimpleNamespace - StringPlusClob - Switchable\_PersonName - Text - TimeOnly - Url - YearQuarter | | FieldName | Type string Properties Filter, Sort Description The name of the field changed. | | IsDataAvailable | Type boolean Properties Defaulted on create Description Indicates whether valid data is available in the old and new value fields. This field is false if, for example, the fields are encrypted or the changed values are too large, such as for Description field types. The default value is false. | | NewValueDateTime | Type dateTime Properties Nillable Description The new value for date type fields. | | NewValueNumber | Type double Properties Nillable Description The new value for number type fields. | | NewValueText | Type string Properties Nillable Description The new value for all other field types that are not a date or number type. | | OldValueDateTime | Type dateTime Properties Nillable Description Old value for date type fields. | | OldValueNumber | Type double Properties Nillable Description Old value for number type fields. | | OldValueText | Type string Properties Nillable Description The old value for all other field types that are not a date or number type. | | Operation | Type picklist Properties Restricted picklist Description The operation of the field value change. Possible values are: - delete - update | ## Indexed Fields When you're querying ActivityFieldHistory with SOQL, you must specify indexed fields in the WHERE clause filter starting from the first field defined in the index. If you specify a partial list of indexed fields, don't leave any gaps between indexed fields after the first field. Here are the indexed fields for ActivityFieldHistory, listed from first to last in the index order. 1\. ActivityId 2\. ChangedDate 3\. ChangedById 4\. FieldName 5\. ActivityFieldChange For example, this SOQL query succeeds because the first three indexed fields are in the WHERE clause. SELECT ActivityId, OldValueText, NewValueText, FieldName, ChangedDate FROM ActivityFieldHistory WHERE ActivityId = 'SomeId' AND ChangedDate >= :startDate AND ChangedDate <= :endDate ORDER BY ChangedDate If you remove the ActivityId field from the WHERE clause, the query fails. SELECT ActivityId, OldValueText, NewValueText, FieldName, ChangedDate FROM ActivityFieldHistory WHERE ChangedDate >= :startDate AND ChangedDate <= :endDate ORDER BY ChangedDate #### See Also - [Big Objects Implementation Guide: SOQL with Big Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.bigobjects.meta/bigobjects/big_object_querying.htm "Big Objects Implementation Guide: SOQL with Big Objects - html (New Window)") - [Big Objects Implementation Guide: Big Objects](https://developer.salesforce.com/docs/atlas.en-us.254.0.bigobjects.meta/bigobjects/big_object.htm "Big Objects Implementation Guide: Big Objects - html (New Window)") # ActivityHistory This read-only object is displayed in a related list of closed activities—past events and closed tasks—related to an object. It includes activities for all contacts related to the object. ActivityHistory fields for phone calls are only available if your organization uses Salesforce CRM Call Center. ## Supported Calls describeSObjects() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields
Field Details
AccountId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the related account, which is determined as follows:
  • The account associated with the WhatId, if it exists; or
  • The account associated with the WhoId, if it exists; otherwise
  • null

For information on IDs, see ID Field Type.

This is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
ActivityDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
Indicates one of the following:
  • The due date of a task
  • The due date of an event if IsAllDayEvent is set to true
This field has a time stamp that is always set to midnight in the Universal Time Coordinated (UTC) time zone. The time stamp doesn’t represent the time of the activity; don’t attempt to alter it to accommodate time zone differences. Label is Date.
ActivityDateTime
Type
dateTime
Properties
Aggregate, Filter, Nillable, Sort
Description
Contains the event’s due date if the IsAllDayEvent flag is set to false. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate. Label is Due Date Time.

The value for this field and StartDateTime must match, or one of them must be null.
ActivitySubtype
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Provides standard subtypes to facilitate creating and searching for specific activity subtypes. This field isn’t updateable.
Possible values are:
  • Task
  • Email
  • Call
  • Event
  • LinkedIn —Available in API version 56.0 and later.
  • List Email
ActivityType
Type
picklist
Properties
Filter, Group, Nillable, Sort
Description

Represents one of the following values: Call, Email, Meeting, or Other. Label is Type. These are default values, and can be changed.

ActivityType is the union of TaskType and EventType. If the same activity appears in both dynamic picklists, duplicate activities appear.

TaskType and EventType can each have a Call type. Internally, they are distinct from each other.
AlternateDetailId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of a record the activity is related to which contains more details about the activity. For example, an activity can be related to an EmailMessage record.
This is a relationship field.
Relationship Name
AlternateDetail
Relationship Type
Lookup
Refers To
EmailMessage
CallDisposition
Type
string
Properties
Filter, Group, Nillable, Sort
Description

Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit is 255 characters.

CallDurationInSeconds
Type
int
Properties
Filter, Group, Nillable, Sort
Description

Duration of the call in seconds.
CallObject
Type
string
Properties
Filter, Group, Nillable, Sort
Description

Name of a call center. Limit is 255 characters.
CallType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description

The type of call being answered: Inbound, Internal, or Outbound.
CompletedDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time the task was saved with a Closed status.
  • For insert, if the task is saved with a Closed status the field is set. If the task is saved with an Open status the field is set to NULL.
  • For update, if the task is saved with a new Closed status, the field is reset.

    If the task is saved with a new non-closed status, the field is reset to NULL.

    If the task is saved with the same closed status (that is, unchanged) there is no change to the field.

Note

Note

The status is a dynamic enum. If the Closed mapping is changed it won’t cause an update of existing tasks. Only new insert/update operations are affected.
ConnectionReceivedId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the PartnerNetworkConnection that shared this record with your organization. This field is available only if your organization has enabled Salesforce to Salesforce and only in API versions 28.0 and later.
ConnectionSentId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the PartnerNetworkConnection that your organization shared this record with. This field is available only if your organization has enabled Salesforce to Salesforce, and only in API versions 28.0 and later. The value is always null. You can use the PartnerNetworkRecordConnection object to forward records to connections.
Description
Type
textarea
Properties
Nillable
Description

Contains a description of the event or task. Limit is 32 KB.
Division
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled.
DurationInMinutes
Type
int
Properties
Filter, Group, Nillable, Sort
Description

Indicates the duration of the event or task.
EndDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates the end date and time of the event or task. Available in versions 27.0 and later. This field is optional, depending on the following:
  • If IsAllDayEvent is true, you can supply a value for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time. If both fields are null, the duration defaults to one day.
  • If IsAllDayEvent is false, a value must be supplied for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time.
IsAllDayEvent
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If the value of this field is set to true, then the activity is an event spanning a full day, and the ActivityDate defines the date of the event. If the value of this field is set to false, then the activity may be an event spanning less than a full day, or it may be a task. The default value of this field is false. Label is All-Day Event.
IsClosed
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a task is closed (true) or not closed (false). The default value of this field is false. This field is set indirectly by setting the Status field on the task—each picklist value has a corresponding IsClosed value. Label is Closed.
IsDeleted
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

Indicates whether the activity has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
IsHighPriority
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates a high-priority task. This field is derived from the Priority field. The default value of this field is false.
IsOnlineMeeting
Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the activity represents an online meeting (true) or not (false).
Note

Note

This field is not available in API version 16.0 or later.
IsReminderSet
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a reminder is set for an activity (true) or not (false).The default value of this field is false.
IsTask
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

If the value of this field is set to true, then the activity is a task. If the value is set to false, then the activity is an event. The default value of this field is false. Label is Task.

IsVisibleInSelfService
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

If the value of this field is set to true, then the activity can be viewed in the self-service portal. The default value of this field is false. Label is Visible in Self-Service.

Location
Type
string
Properties
Filter, Group, Nillable, Sort
Description

If the activity is an event, then this field contains the location of the event. If the activity is a task, then the value is null.
OwnerId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

Indicates the ID of the user or group who owns the activity.

This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Calendar, Group, User
PrimaryAccountId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Contains the AccountId value from the activity record. Available in API versions 30.0 and later to organizations that use Shared Activities.
PrimaryWhoId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Contains the WhoId value from the activity record. Available in API versions 30.0 and later to organizations that have enabled Shared Activities.
Priority
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Indicates the priority of a task, such as high, normal, or low. The default value of this field is Normal.
ReminderDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Represents the time when the reminder is scheduled to fire, if IsReminderSet is set to true. If IsReminderSet is set to false, then the user may have deselected the reminder checkbox in the Salesforce user interface, or the reminder has already fired at the time indicated by the value.
StartDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description

Indicates the start date and time of the event.

Available in versions 29.0 and later.

If the event’s IsAllDayEvent flag is set to true (indicating an all-day event), then the time stamp in StartDateTime is always set to midnight in the Coordinated Universal Time (UTC) time zone.
Note

Note

Don’t attempt to alter the time stamp to account for any time zone differences.

If the event’s IsAllDayEvent flag is set to false, then you must translate the time portion of the time stamp in StartDateTime to or from a local time zone for the user or the application, as appropriate. The translation must be in the Coordinated Universal Time (UTC) time zone.

If this field has a value, then ActivityDate and ActivityDateTime either must be null or must match the value of this field.

If the activity is a task, StartDateTime is null
Status
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description

Indicates the current status of a task,. The default value of this field is Not Started. Each predefined status field sets a value for IsClosed. To obtain picklist values, query TaskStatus.

Possible values are:
  • Completed
  • Deferred
  • In Progress
  • Not Started
  • Waiting on someone else
Subject
Type
combobox
Properties
Filter, Nillable, Sort
Description

Contains the subject of the task or event.
WhatId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The WhatId represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. WhatIds are polymorphic. Polymorphic means a WhatId is equivalent to the ID of a related object. The label is Related To ID.

This is a polymorphic relationship field.
Relationship Name
What
Relationship Type
Lookup
Refers To
Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CommSubscriptionConsent, ContactEncounter, ContactEncounterParticipant, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem, CreditMemo, DelegatedAccount, DocumentChecklistItem, EnrollmentEligibilityCriteria, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, ListEmail, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PartyConsent, PersonLifeEvent, PlanBenefit, PlanBenefitItem, ProcessException, Product2, ProductItem, ProductRequest, ProductRequestLineItem, ProductTransfer, PurchaserPlan, ReceivedDocument, ResourceAbsence, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, Shift, Shipment, ShipmentItem, Solution, Visit, VisitedParty, VolunteerProject, WorkOrder, WorkOrderLineItem
WhoId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is Name ID.

If Shared Activities is enabled, the value of this field is the ID of the related lead or primary contact. If you add, update, or remove the WhoId field, you might encounter problems with triggers, workflows, and data validation rules that are associated with the record. The label is Name ID.

If your organization uses Shared Activities, when you query activities in API version 30.0 or later, the returned value of the WhoId field matches the value in the queried object, not necessarily in the activity record itself.

If Shared Activities is enabled, the value of this field is not populated and the field PrimaryWhoId should be queried instead.

This is a polymorphic relationship field.
Relationship Name
Who
Relationship Type
Lookup
Refers To
Contact, Lead
## Usage Query activities that are related to an object 1. Optionally, issue a describe call against the object whose activities you wish to query, to get a suggestion of the correct SOQL to use. 2. Issue a SOQL relationship query with a main clause that references the object, and an inner clause that references the activity history; for example: SELECT (SELECT ActivityDate, Description FROM ActivityHistories) FROM Account WHERE Name Like 'XYZ%' The user interface enforces sharing rules, filtering out related-list items that a user doesn’t have permission to see. The following constraints on users who don’t have the “View All Data” permission help prevent performance issues. - In the main clause of the relationship query, you can reference only one record. For example, you can’t filter on all records where the account name starts with “A.” Instead, you must reference a single account record. SELECT (SELECT ActivityDate, Description FROM ActivityHistories ORDER BY ActivityDate DESC NULLS LAST, LastModifiedDate DESC LIMIT 500) FROM Account WHERE Name = 'Acme' LIMIT 1 - In the inner clause of the query, you can’t use WHERE. - In the inner clause of the query, you must specify a limit of 500 or fewer on the number of rows that are returned in the list. - In the inner clause of the query, you must sort on ActivityDate in descending order and LastModifiedDate in descending order. You can optionally display nulls last. For example: ORDER BY ActivityDate DESC NULLS LAST, LastModifiedDate DESC. #### See Also - [Task](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm "Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities.") # ActivityMetric Represents activities that were added to Salesforce automatically by Einstein Activity Capture and manually by users. This object is available in API version 45.0. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Unless otherwise noted, Einstein Activity Capture and Activity Metrics must be enabled. ## Fields | Field | Details | | --- | --- | | BaseId | Type reference Properties Create, Defaulted on create, Filter, Group, idLookup, Sort Description The ID of the record that the activities apply to. | | BaseType | Type string Properties Filter, Group, Nillable, Sort Description The entity that corresponds to the BaseId | | FirstCallDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date when the first call was made. This field is available only to Sales Engagement users. Einstein Activity Capture and Activity Metrics aren’t required. | | FirstEmailDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date when the first email was sent. This field is available only to Sales Engagement users. Einstein Activity Capture and Activity Metrics aren’t required. | | InactiveDays | Type int Properties Filter, Group, Nillable, Sort Description Indicates the number of days since the most recent activity was completed. This field is derived from the Last Activity Date field. | | LastActivityDateLastModDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates when the LastActivityDateTime field was last modified. | | LastActivityDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date when the most recent activity was completed. | | LastCallDateLastModDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates when the LastCallDateTime field was last modified. | | LastCallDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date when the most recent call was made through Sales Dialer or Inbox. | | LastEmailDateLastModDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates when the LastEmailDateTime field was last modified. | | LastEmailDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date when the most recent email was sent or received. | | LastEmailReceivedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date when the most recent email was received. Available in API version 54.0 and later. | | LastEmailSentDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date when the most recent email was sent. Available in API version 54.0 and later. | | LastEventDateLastModDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates when the LastEventDateTime field was last modified. | | LastEventDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date when the most recent event was completed. | | LastTaskDateLastModDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates when the LastTaskDateTime field was last modified. | | LastTaskDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date when the last task was completed. | | NextActivityDateLastModDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates when the NextActivityDateTime field was last modified. | | NextActivityDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date of the next scheduled task or event. Only open tasks in the future are included. | ## Usage Use this object to see data about sales activities that were added to Salesforce manually and by Einstein Activity Capture. Activity Metric fields are derived from your activity data. For example, the Inactive Days field indicates the number of days since the most recent activity was completed. Create a trigger that notifies a user when there isn’t any activity on an account for a certain amount of time. # ActivityUsrConnectionStatus Represents the status of the email connections for Einstein Activity Capture users. You can also see whether users accepted the required terms of service to capture emails. This object is available in API version 54.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, enable Einstein Activity Capture in your org. ## Fields | Field | Details | | --- | --- | | ConfigurationName | Type string Properties Filter, Group, Nillable, Sort Description The name of the Einstein Activity Capture configuration that the user is assigned to. | | ConnectivityStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the user’s email connection. Possible values are: - ACTIVE - DISABLED - INITIALIZING - NEEDSATTENTION - NEEDSATTENTIONGLOBAL (used when an org-level connection isn’t working) - NEEDSATTENTIONHYBRID (used when both org-level and user-level connections aren’t working) - PENDING - PROCESSING | | ContactsSynced | Type int Properties Filter, Group, Nillable, Sort Description The number of contacts synced after midnight between Salesforce and the user’s Microsoft or Google email account. This field is available in API version 59.0 and later. | | EmailAddress | Type string Properties Filter, Group, Nillable, Sort Description The email address that’s used to capture and sync data between Salesforce and the user’s Microsoft or Google account. | | EventsSynced | Type int Properties Filter, Group, Nillable, Sort Description The number of events synced after midnight between Salesforce and the user’s Microsoft or Google email account. This field is available in API version 59.0 and later. | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description This field is reserved for future use. | | GlobalOauthTermsState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the user’s terms of service status. When emails are enabled for Einstein Activity Capture, each user must accept the terms of service. Possible values are: - ACCEPTED - DECLINED - PENDING This field is available only if you use an org-level OAuth 2.0 or a service account authentication method. In connection report CSV files downloaded from Einstein Activity Capture Status & Metrics, this field is labeled Global Auth User Email Consent Status. | | IsTermsOfServiceAccepted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user has accepted the Einstein Activity Capture terms of service or not. When emails are enabled for Einstein Activity Capture, each user must accept the terms of service. The default value is false. This field is available only if you use a user-level authentication method. In connection report CSV files downloaded from Einstein Activity Capture Status & Metrics, this field is labeled User Auth Terms of Service Accepted. | | RecommendedActionDescription | Type string Properties Filter, Nillable, Sort Description Recommended action to take when the user’s ConnectivityStatus is NEEDSATTENTION. Available in API version 58.0 and later. | | RecommendedActionTitle | Type string Properties Filter, Group, Nillable, Sort Description Reason for the user's ConnectivityStatus when the status is NEEDSATTENTION. Available in API version 58.0 and later. | | UserId | Type string Properties Filter, Group, Nillable, Sort Description ID of the user. | | UserName | Type string Properties Filter, Group, Nillable, Sort Description The username of the Einstein Activity Capture user. | | UserOnboardingStatus | Type string Properties Filter, Group, Nillable, Sort Description The initial sync status when the user connects Salesforce with their external email account and syncs data for the first time. This field is available in API version 59.0 and later. Possible values are: - NOT\_STARTED - IN\_PROGRESS - NOT\_CONFIGURED - COMPLETE - FAILED | # AdditionalNumber Represents an optional additional number for a call center. This additional number is visible in the call center's phone directory. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | CallCenterId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description System field that contains the ID of the user who created the call center associated with this additional number. If value is null, this additional number is displayed in every call center's phone directory. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the additional number, such as Conference Room B. Limit: 255 characters. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the additional number. Limit: 80 characters. | | Phone | Type phone Properties Create, Filter, Nillable, Group, Sort, Update Description The phone number that corresponds to this additional number. | ## Usage Create an additional number for a call center directory. Use this object if the number is not easily categorized as a User, Contact, Lead, Account, or the other object. Examples include phone queues or conference rooms. # Address Represents a mailing, billing, or home address. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The following access checks must be enabled: - Industries Insurance - Retail Execution - Industries Visit - Field Service - Order Management - Perms: FulfillmentOrder, OrderSummary,AdvancedOrderManagement, OrderCCS - Prefs: OrdersEnabled, EnhancedCommerceOrders - Public Sector - Employee Experience - Contact Tracing For Employees You can create an address only when creating a location. ## Fields | Field Name | Details | | --- | --- | | Address | Type address Properties Filter, Nillable Description The full address. | | AddressType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Picklist of address types. The values are: - Mailing - Shipping - Billing - Home | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The address city. | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The address country. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of the address. | | DrivingDirections | Type string Properties Create, Filter, Nillable, Sort, Update Description Directions to the address. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | LocationType | Type picklist Properties Create, Defaulted on create, Filter, Filter, Group, Sort, Update Description Picklist of location types. The available values are: - Warehouse (default) - Site - Van - Plant | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the address. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description A lookup field to the parent location. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Location | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The address postal code. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The address state. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The address street. | | TimeZone | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Picklist of available time zones. | ## Usage ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important “Address” in Salesforce can also refer to the Address compound field found on many standard objects. When referencing the Address object in your Apex code, always use Schema.Address instead of Address to prevent confusion with the standard Address compound field. If referencing both the address object and the Address field in the same snippet, you can differentiate between the two by using System.Address for the field and Schema.Address for the object. ## Associated Object This object has the following associated object. 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. [AddressHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) (API version 62.0) History is available for tracked fields of the object. # Address Compound Fields Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior. The Address type extends the Location type, the data type used for compound geolocation fields. Using API 30.0 and later, standard addresses are available in the SOAP and REST APIs as a compound field of type Address, a structured data type that combines these fields.
Field Type Description
Accuracy picklist Accuracy level of the geocode for the address. For example, this field is known as MailingGeocodeAccuracy on Contact.
City string The city component of the address. For example, this field is known as MailingCity on Contact.
Country string The country component of the address. For example, this field is known as MailingCountry on Contact.
CountryCode picklist The ISO country code for the address. For example, this field is known as MailingCountryCode on Contact.

For Standard Address Fields, CountryCode is only available when state and country/territory picklists are enabled in your organization.

For Custom Address Fields, CountryCode is always available, whether or not state and country/territory picklists are enabled in your organization.

Latitude double Used with Longitude to specify the precise geolocation of the address. For example, this field is known as MailingLatitude on Contact.
Longitude double Used with Latitude to specify the precise geolocation of the address. For example, this field is known as MailingLongitude on Contact.
PostalCode string The postal code for the address. For example, this field is known as MailingPostalCode on Contact.
State string The state component of the address. For example, this field is known as MailingState on Contact.
StateCode picklist The ISO state code for the address. For example, this field is known as MailingStateCode on Contact.

StateCode is available only when state and country/territory picklists are enabled in your organization.

Street textarea The street component of the address. For example, this field is known as MailingStreet on Contact.
Address fields are provided on many standard objects, such as Account, Contact, Quote, and User. Some objects provide fields for multiple addresses. For example, Account provides four different addresses. In this case, address field names are prefixed with the type of address, for example, BillingAddress and ShippingAddress. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Standard address compound fields are read-only, and are only accessible using the SOAP and REST APIs. To learn about the limitations of compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). When an address is geocoded, its latitude and longitude fields are populated with coordinates. A related geolocation field is also populated. Typically, geocoding service providers geocode addresses, and rate the accuracy of the geocodes. The accuracy subfield GeocodeAccuracy stores the accuracy data for a geocoded location. External geolocation apps can get the accuracy level of a geocoded address via the API. When you retrieve an address via the API, any accuracy data is included. You can also retrieve the accuracy information by itself, if needed. Like its parent, the compound Address field, the GeocodeAccuracy field is only available for standard address fields on standard objects. ## Custom Address Fields If you enabled Custom Address Fields, the Address field type is available in Object Manager when you add a custom field. Custom address fields mimic the behavior or standard address fields with some limitations. For more information, see the [Custom Address Fields Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.caf_dev_guide.meta/caf_dev_guide/caf_dev_guide.htm). ## Retrieving Compound Address Fields Using compound fields can simplify code that works with addresses, especially for SOQL queries. SOQL SELECT clauses can reference addresses directly, instead of all of the individual component fields. SELECT Name, BillingAddress FROM Account To write a SOQL query that’s compatible with API versions earlier than 30.0, as well as API 30.0 and later, use the individual fields: SELECT Name, BillingStreet, BillingCity, BillingState, BillingPostalCode, BillingCountry, BillingLatitude, BillingLongitude FROM Account Compound address field values are returned as a structured data type, Address. Code that works with compound address fields must reference the individual components of the returned value. See the code sample below. ## Retrieve a Standard Address Compound Field with the SOAP API This Java method uses the Salesforce SOAP API to retrieve and display the Mailing Address for a list of contacts. // Modified version of code in the SOAP API QuickStart private void querySample() { String soqlQuery = "SELECT FirstName, LastName, MailingAddress FROM Contact"; try { QueryResult qr = connection.query(soqlQuery); boolean done = false; if (qr.getSize() > 0) { System.out.println("\\nLogged-in user can see " + qr.getRecords().length + " contact records."); while (!done) { System.out.println(""); SObject\[\] records = qr.getRecords(); for (int i = 0; i < records.length; ++i) { Contact con = (Contact) records\[i\]; String fName = con.getFirstName(); String lName = con.getLastName(); // Access the compound address field MailingAddress Address addr = (Address) con.getMailingAddress(); String streetAddr = ""; if (null != addr) streetAddr = addr.getStreet(); if (fName == null) { System.out.println("Contact " + (i + 1) + ": " + lName + " -- " + streetAddr); } else { System.out.println("Contact " + (i + 1) + ": " + fName + " " + lName + " -- " + streetAddr); } } if (qr.isDone()) { done = true; } else { qr = connection.queryMore(qr.getQueryLocator()); } } } else { System.out.println("No records found."); } } catch (ConnectionException ce) { ce.printStackTrace(); } } ## Using Compound Address Fields as Locations Compound address fields include latitude and longitude fields. Address fields can be used as locations in SOQL WHERE and ORDER BY clauses. For example, here’s a SOQL query that uses the GEOLOCATION function to retrieve the 10 accounts closest to San Francisco. SELECT Id, Name, BillingAddress FROM Account WHERE DISTANCE(BillingAddress, GEOLOCATION(37.775,-122.418), 'mi') < 20 ORDER BY DISTANCE(BillingAddress, GEOLOCATION(37.775,-122.418), 'mi') LIMIT 10 ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note In Developer, Professional, Enterprise, Unlimited, and Performance editions, Salesforce can automatically add or update geolocation fields for Account, Contact, Lead, and WorkOrder records. To use this feature, your administrator must enable the geo data integration rule for each object. For all other objects and editions, set values for latitude and longitude by using SOQL, SOAP or REST API, or a geocoding service. You can then use address fields as locatable values. To find geocoding services, search AppExchange. # AgentQltyEvalFormCondition Defines a single condition in a quality evaluation criterion. Each condition evaluates an interaction attribute such as the assigned queue, agent skill, or contact reason against expected values. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, you must be assigned QualityManagementEnabled org perm. ## Fields | Field | Details | | --- | --- | | AgentQltyEvalFormCriteriaId | Type reference Properties Create, Filter, Group, Sort Description ID of the associated agent quality evaluation form criteria. This field is a relationship field. Relationship Name AgentQltyEvalFormCriteria Relationship Type Master-detail Refers To AgentQltyEvalFormCriteria (the master object) | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the agent quality evaluation form condition. | | Operator | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Operator used for the evaluation form condition to compare interaction attributes against expected values. Possible values are: - Equals - EqualsAll | | SequenceNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Order position in the evaluation form criteria. Referenced when the CriteriaType field is set to CustomLogic. | | SourceField | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Interaction attribute to evaluate. For example, specify Queue to evaluate the routing queue. | | Value | Type textarea Properties Create, Nillable, Update Description The expected value or set of values used to evaluate the interaction attribute, based on ConditionType. - Single-Value Operators: Accepts a single string - Multi-Value Operators: Accepts a semicolon-delimited string of values | # AgentQltyEvalFormCriteria Defines a named rule with evaluation criteria and priority settings to map incoming interactions to the appropriate evaluation form. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, you must be assigned QualityManagementEnabled org perm. ## Fields | Field | Details | | --- | --- | | CriteriaType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Logic to evaluate the conditions in the criterion. Possible values are: - And: Default combination logic - CustomLogic: Evaluates conditions defined in the LogicalExpression field - Or | | Description | Type textarea Properties Create, Nillable, Update Description Brief, human-readable summary to describe the purpose or scope of this criteria. | | DeveloperName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Unique API name of the agent quality evaluation form criteria. | | LogicalExpression | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Custom boolean expression that combines conditions by their SequenceNumber. Required only if the criteria type is set to CustomLogic. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the agent quality evaluation form criteria. | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Determines the evaluation sequence if an interaction matches multiple criteria. Lower numerical values indicate higher priority. For example, priority 1 takes precedence over priority 5. | | RelatedFormId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description OmniProcess evaluation form automatically assigned to the interaction when the criterion matches. This field is a relationship field. Relationship Name RelatedForm Refers To OmniProcess | ## Usage Each named rule includes criteria specifying the interaction channel, the evaluation form to use, and the conditions required for the criteria to apply. When an interaction matches multiple criteria, the Priority field determines which evaluation form is applied. You can define exactly one criterion as the default fallback for interactions that don't match any defined criteria. # AgentWork Represents a work assignment that’s been routed to an agent. If the work is transferred to another agent, a new AgentWork record is created. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. ## Fields
Field Details
AcceptDateTime
TypedateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the work item was accepted.
ActiveTime
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The amount of time an agent is actively working on a work item in their console. Active time is tracked only for tasks routed using the tab-based capacity model. It's tracked only when the work tab is open and in focus in the console. If the agent switches console tabs, the time spent on the other tabs isn't counted. Active time continues to count if you switch to a new browser tab or window. Active time stops when the agent closes the work item or the after conversation work time ends, whichever happens first.
AcwExtensionCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of times that an agent extended the After Conversation Work (ACW) timer. This field is available in API version 55.0 and later.
AcwExtensionDuration
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The length of time (in seconds) that the After Conversation Work (ACW) timer was extended each time that the agent extended the timer. This field is available in API version 55.0 and later.

To find the total extension duration, multiply this field by AcwExtensionCount or use AfterConversationActualTime.

AfterConversationActualTime
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of seconds an agent spent on After Conversation Work (ACW) after customer contact ended. This field is available in API version 52.0 and later.
AgentCapacityWhenDeclined
Type
double
Properties
Filter, Nillable, Sort
Description
The agent’s capacity when declining work, either explicitly or through push timeout.
AssignedDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the work item was assigned to an agent
BotId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the Enhanced Einstein Bot or AI agent that performed the work. This is a relationship field. This field is available in API version 52.0 and later.
Relationship Name
Bot
Relationship Type
Lookup
Refers To
BotDefinition
BotType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the type of bot. Valid values are:
  • Bot. Refers to an Einstein bot.
  • ExternalCopilot. Refers to an AI agent with whom your customers can interact.
The default value is Bot. This field is available in API version 63.0 and later.
CancelDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the work item was canceled.
CapacityModel
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the capacity model used to determine agent capacity. Valid values are StatusBased and TabBased. This field is available in API version 50.0 and later.

A work item consumes agent capacity only if it was first assigned to the agent by Omni-Channel using queues or skills.
CapacityPercentage
Type
percent
Properties
Create, Filter, Nillable, Sort
Description
The percentage of an agent’s capacity that’s consumed when this work item is in progress. Valid values are from 0 to 100.
The agent can receive a new work item only if they have enough available capacity for the item. Voice calls must have a capacity percentage of 100, so an agent on a call doesn’t receive new work items until the call ends.
CapacityWeight
Type
double
Properties
Create, Filter, Nillable, Sort
Description
The amount of an agent’s capacity that’s consumed when this work item is in progress.
For example, if cases are assigned a capacity weight of 2, an agent with a capacity of 6 can accept up to 3 cases before the agent is at capacity and can’t receive new work items.
Voice calls must use the entire capacity weight.
CloseDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the work item was closed.
DeclineDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time when the agent declined this record.
DeclineReason
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The provided reason for why an agent declined the work request.
ExternalBotId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the third-party bot that handles the work item. This is a relationship field. This field is available in API version 64.0 and later.
Relationship Name
ExternalBot
Relationship Type
Lookup
Refers To
ExternalConversationBotDef
HandleTime
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The amount of time an agent had the work item open, calculated by CloseDateTime – AcceptedDateTime. Handle time stops when the agent closes the work item or the after conversation work time ends, whichever happens first.
IsConference
Type
boolean
Properties
Filter, Group, Sort
Description
Indicates whether the agent was conferenced on the work item by another agent (true) or not (false ). The default value is false. Available in API version 44.0 and later. This field is accessible in Reports, but not via the API.
IsInterruptible
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a work item consumes interruptible or primary capacity. The default value is false. Available in API version 57.0 and later when the Interruptible Capacity feature is enabled.
IsOwnerChangeInitiated
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a work item owner change triggered the direct assignment of the work item to the agent. The default value is false. Status-Based Capacity Model has to be turned on to use this field. This field is available in API version 50.0 and later.
IsPreferredUserRequired
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a work item stays with the preferred user even when the user isn’t available. The default value is false. This field is available in API version 50.0 and later.
IsStatusChangeInitiated
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a work item status change triggered the direct assignment of the work item to the agent. The default value is false. Status-Based Capacity Model has to be turned on to use this field. This field is available in API version 50.0 and later.
IsTransfer
Type
boolean
Properties
Filter,Group, Sort
Description
Indicates whether the agent received the work item through transfer from another agent (true) or not (false). The default value is false. Available in API version 38.0 and later. This field is accesible in Reports, but not via the API.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
An automatically generated ID number that identifies the record.
OriginalGroupId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the queue that the work assignment was originally routed to. This field is a relationship field.
Relationship Name
OriginalGroup
Relationship Type
Lookup
Refers To
Group
OriginalQueueId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the queue that the work assignment was originally routed to. Due to API changes, OriginalQueueId is no longer recommended. Use OriginalGroupId instead.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of the AgentWork. This field is a polymorphic relationship field. This field is available in API version 50.0 and later.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PausedCapacityPercentage
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
The percentage of an agent’s capacity that’s consumed when this work item is paused. The paused capacity feature is available with status-based capacity and Enhanced Omni-Channel only. This field is available in API version 62.0 and later.
PausedCapacityWeight
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
The amount of an agent’s capacity that’s consumed when this work item is paused. The paused capacity feature is available with status-based capacity and Enhanced Omni-Channel only. This field is available in API version 62.0 and later.
PendingServiceRoutingId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the PendingServiceRouting from which the AgentWork was created. This field is a relationship field. This field is available in API version 50.0 and later.
Relationship Name
PendingServiceRouting
Relationship Type
Lookup
Refers To
PendingServiceRouting
PreferredUserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the preferred user to handle the work. This field is a relationship field. This field is available in API v46.0 and later.
Relationship Name
PreferredUser
Relationship Type
Lookup
Refers To
User
PushTimeout
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The time limit set for an agent to respond to an item before it’s pushed to another agent. The time limit is measured in seconds. This field is available in API version 36.0 and later.
Effective API version 57.0, for inbound Voice calls, this field represents the time limit set for an agent to respond to a call before it’s declined. The value must be between 0 and 20. The value is capped at 20, so any number greater than that is treated as 20 seconds. This applies to the following telephony models:
  • Salesforce Voice with Amazon Connect
  • Salesforce Voice with Partner Telephony from Amazon Connect
PushTimeoutDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time (in UTC) when the push timeout event occurred. This field is available in API version 36.0 and later.
RequestDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates when the work was requested.
RoutingModel
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Determines how incoming work items are routed to agents assigned to a service channel. Possible values are:
  • ExternalRouting
  • LeastActive
  • MostAvailable
RoutingPriority
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The order in which work items from the queue that are associated with the routing configuration are routed to agents.
RoutingType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of Omni-Channel routing. Possible values are:
  • QueueBased
  • SkillsBased
SecondaryRoutingPriority
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Indicates the secondary routing priority.
ServiceChannelId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the service channel that’s associated with the work assignment. This field is a relationship field.
Relationship Name
ServiceChannel
Relationship Type
Lookup
Refers To
ServiceChannel
ShouldSkipCapacityCheck
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
Indicates whether to skip checking an agent’s available capacity (true) or not (false) when an externally routed work item is created. This field is used when agents can simultaneously handle work from both Omni-Channel queues and queues using external routing.
When true, the receiving agent can exceed their set capacity to accept the item, but they don’t receive more Omni-Channel routed work. When false, the receiving agent can’t exceed their set capacity and must have enough open capacity to accept the item.
The default value is false.
SpeedToAnswer
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The amount of time between when the work was requested and when an agent accepted it.
Status
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The working status of the work item. Valid values are:
  • Assigned – The item is assigned to the agent but hasn’t been opened.
  • Canceled – The item no longer needs to be routed. For example: a chat visitor cancels their Omni-Channel routed chat request before it reaches an agent.
  • Closed – The item is closed.
  • Declined – The item was assigned to the agent but the agent explicitly declined it.
  • DeclinedOnPushTimeout – The item was declined because push time-out is enabled and the item request timed out with the agent.
  • Opened – The agent opened the item.
  • Transferred–The item was transferred from an agent to another agent, queue, or skill.
  • Unavailable – The item was assigned to the agent but the agent became unavailable (went offline or lost connection).
TargetAcceptDateTime
Type
dateTime
Properties
Filter, Nillable, Sort, Update
Description
The date and time by when a rep must accept a work item. Influences backlog ordering by prioritizing work items with earlier target acceptance deadlines. The field can be dynamically set using Flow for each work item during the routing process. This allows for flexible prioritization based on case urgency, customer tier, or other business rules. Available in API version 65.0 and later.
TransferRequesterId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user ID of the rep who reassigned the work using the Reassign action. This field is populated in reassigned AgentWork records only, not the original AgentWork record. This is a relationship field. This field is available in API version 63.0 and later.
Relationship Name
TransferRequester
Relationship Type
Lookup
Refers To
User
UserId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the user that the work item was assigned to. This field is a relationship field.
Relationship Name
User
Relationship Type
Lookup
Refers To
User
WorkItemId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the object that’s routed to the agent through Omni-Channel.
This field is a polymorphic relationship field.
Relationship Name
WorkItem
Relationship Type
Lookup
Refers To
Custom objects and these standard objects: Account, Activity, Case, Claim, ClaimCoverage, ClaimRecovery, Contact, ContactRequest, CustomEntityData, Incident, Lead, LiveChatTranscript, MessagingSession, Opportunity, Orchestration Work Items, Order, PaymentRequest, PersonTraining,Referral, SocialPost, SwarmMember, and VoiceCall. WorkOrder is available in version 58.0 and later.
## Usage AgentWork records can only be deleted if they have the status Closed, Declined, or Unavailable. They can’t be deleted if their status is Assigned or Opened because they’re active in Omni-Channel. When AgentWork records are created, they have the status Assigned. After a record is created, it’s automatically pushed to the assigned agent. While the metadata for AgentWork indicates support for upsert() and update(), these calls aren’t used with AgentWork because none of its fields can be updated. Apex triggers are supported with AgentWork. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [AgentWorkChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 63.0) Change events are available for the object. [AgentWorkOwnerSharingRule](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. [AgentWorkShare](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. #### See Also - [_Salesforce Help_: Understand the Details of the Routing Lifecycle](https://help.salesforce.com/s/articleView?id=service.omnichannel_psr_lifecycle.htm&type=5&language=en_US " Salesforce Help: Understand the Details of the Routing Lifecycle - HTML (New Window)") # AgentWorkConversationalData Stores conversation data for agent work sessions, such as agent interactions, transfer information, and operational metrics. This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules You must have the Agentforce Contact Center Admin (Salesforce Voice) permission set enabled in your org. ## Fields | Field | Details | | --- | --- | | AgentChannelRecordingId | Type reference Properties Filter, Group, Nillable, Sort Description Identifier for the recording associated with the agent channel conversation. This field is a relationship field. Relationship Name AgentChannelRecording Refers To VoiceCallRecording | | AgentConnectDateTime | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the agent connected to the conversation. | | AgentCustomerMergeTime | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the service rep and customer conversations are merged after consultation. | | AgentDisconnectDateTime | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the agent disconnected from the conversation. | | AgentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of an agent or a rep involved in the conversation. This field is a polymorphic relationship field. Relationship Name Agent Refers To BotDefinition, ExternalConversationBotDef, User | | AgentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of agent handling the conversation. Possible values are: - ExternalBot - Human - InternalBot | | AgentWorkId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the AgentWork record associated with the conversational data. This field is a relationship field. Relationship Name AgentWork Refers To AgentWork | | AverageJitter | Type int Properties Filter, Group, Nillable, Sort Description Average inter-arrival jitter of RTP packets on the agent leg over the entire call duration, measured in milliseconds. Higher values indicate inconsistent packet timing, which can cause audio choppiness. This field is available in API version 68.0 and later, and only in Salesforce Voice (Native Telephony). | | AveragePacketLoss | Type percent Properties Filter, Nillable, Sort Description Average percentage of RTP packets lost on the agent leg over the entire call duration. Higher values indicate sustained network degradation, which can cause audio gaps. This field is available in API version 68.0 and later, and only in Salesforce Voice (Native Telephony). | | ChannelSessionRecordId | Type reference Properties Filter, Group, Nillable, Sort Description Identifier of the channel session for the conversation. This field is a relationship field. Relationship Name ChannelSessionRecord Refers To VoiceCall | | LongestPauseDuration | Type int Properties Filter, Group, Nillable, Sort Description Duration of the longest pause during the conversation, measured in seconds. | | MaximumJitter | Type int Properties Filter, Group, Nillable, Sort Description Maximum inter-arrival jitter of RTP packets on the agent leg, measured in milliseconds over rolling 5-second windows. Captures sudden, temporary timing spikes that cause brief audio choppiness, even if the overall call average appears stable. This field is available in API version 68.0 and later, and only in Salesforce Voice (Native Telephony). | | MaximumPacketLoss | Type percent Properties Filter, Nillable, Sort Description Maximum percentage of RTP packets lost on the agent leg, measured over rolling 5-second windows. Captures sharp bursts of packet loss that call-wide averages can mask. This field is available in API version 68.0 and later, and only in Salesforce Voice (Native Telephony). | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the agent work conversational data record. | | NextAgentWorkConvId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the next record in a sequence of conversations. This field is a relationship field. Relationship Name NextAgentWorkConv Refers To AgentWorkConversationalData | | OwnerId | Type reference Properties Filter, Group, Sort Description ID of the owner of the conversational data record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | OwnershipEndDateTime | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when ownership of the conversation ended. | | OwnershipStartDateTime | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when ownership of this conversation started. | | PauseCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of times the conversation was paused. | | PrevAgentWorkConvId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the previous record in a sequence of conversations. This field is a relationship field. Relationship Name PrevAgentWorkConv Refers To AgentWorkConversationalData | | QualityScore | Type double Properties Filter, Nillable, Sort Description Value of the Mean Opinion Score (MOS) that measures voice call quality. | | TotalPauseDuration | Type int Properties Filter, Group, Nillable, Sort Description Total duration of all pauses during the conversation, measured in seconds. | | TransferType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of transfer for the conversation. Possible values are: - Cold - Warm | # AgentWorkSkill Represents a skill used to route a work assignment to an agent. AgentWorkSkill is used for reporting and represents the result of a routing decision. This object is available in API version 42.0 and later. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. ## Fields | Field | Details | | --- | --- | | AgentWorkId | Type reference Properties Filter, Group, Sort Description The AgentWork object associated with this skill. | | IsAdditionalSkill | Type boolean Properties Defaulted on create, Filter, Group, Sort Description After a designated timeout period, a skill marked as additional is dropped from Omni-Channel routing. The case is then routed to the best-matched agent, even if the agent doesn’t have all the skills. The default value is false. Available in API version 48.0 and later. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An automatically generated ID number that identifies the record. | | SkillId | Type reference Properties Filter, Group, Sort Description The skill that is required or additional. | | SkillLevel | Type double Properties Filter, Sort Description The level of the required or additional skill. Skill levels can range from 1 to 10. Depending on your business needs, you might want the skill level to reflect years of experience, certification levels, or license classes. | | SkillPriority | Type int Properties Aggregatable, Filter, Group, Nillable, Sort Description For additional skills, specifies the order in which skills are dropped if after the specified timeout no agent with that skill is available. Higher priority-value skills are dropped first. Lower priority-value skills, for example 0, are dropped last. Skills with the same priority value are dropped as a group. You can set skill priority using attribute setup for skills-based routing or Apex code. | | WasDropped | Type boolean Properties Filter, Group, Sort Description For skills marked as additional, indicates if the skill was dropped from Omni-Channel routing because an agent with this skill was not available. The default value is false. Available in API version 48.0 and later. | ## 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. [AgentWorkSkillChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # AIApplication Represents an AI application such as Einstein Prediction Builder. This object is available in API version 50.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the application. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, Sort Description Label that identifies the AI application throughout the Salesforce user interface. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Specifies the namespace of the application if installed with a managed package. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Status of the AI application. Possible values are: - Disabled - Enabled - Migrated | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of application. Possible values are: - PredictionBuilder | # AIApplicationConfig Additional prediction information related to an AI application. This object is available in API version 50.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the application. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, Sort Description Label that identifies the AI application throughout the Salesforce user interface. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Specifies the namespace of the application config, if installed with a managed package. | # AiGenActionItem Represents business actions suggested by generative AI. AI-generated action items are sent to either agents for automatic execution or human users for review, depending on org preference and if there are any errors in the process. This object is available in API version 64.0 and later. ## Supported Calls create( ), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert ( ) ## Special Access Rules Agentforce Pipeline Management must be enabled. Only the agent user can create AiGenActionItem records. ## Fields | Field | Details | | --- | --- | | ActionItemOwnerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The ID associated with the owner of the AI-generated action item. The owner can be an agent or human user, and can change during the review and execution process. By default, the owner is an agent or queue. This field is a polymorphic relationship field. Relationship Name ActionItemOwner Refers To Group, User | | ActionResult | Type textarea Properties Create, Nillable, Update Description The result generated when the agent action is executed. | | AgentType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The specific agent that processes the AI-generated action item. | | AiGenActionItemInfoId | Type reference Properties Filter, Group, Nillable, Sort, Update Description Required. The ID of the AI-generated action item information record associated with this action item. Available in API version 67.0 and later. This field is a relationship field. Relationship Name AiGenActionItemInfo Refers To AiGenActionItemInfo | | BotDefinitionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The bot record with a template name that matches the value in the Sales Management agent template. This field is a relationship field. Relationship Name BotDefinition Refers To BotDefinition | | BotVersionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The bot version from the bot record with an ID that matches the ID of the Sales Management agent bot record. This field is a relationship field. Relationship Name BotVersion Refers To BotVersion | | Description | Type string Properties Create, Filter, Nillable, Sort, Update Description The explanation of why the action item has been suggested. The description provides additional context to guide human users and agents in their decision-making. | | ExpirationDate | Type dateTime Properties Create, Filter, Sort, Update Description Required. The date that the action item expires and is deleted. AI-generated action items are no longer visible to users after 14 days and removed from records after 30 days. | | GeneratedResponseIdRef | Type string Properties Filter, Group, Nillable, Sort Description The ID of generated result in the GenAIGeneration DMO. This field can be used by human users to provide feedback on the AI-generated action item. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ParentId | Type reference Properties Filter, Group, Sort, Update Description Required. The ID of the record that the AI-generated action item is associated with. Available in API version 67.0 and later. This field is a polymorphic relationship field. Relationship Name Parent Refers To Account, Opportunity | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The status of the AI-generated action item. | | Subject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The subject line that displays to users indicating what the action item is. | | SuggestedNewValue | Type textarea Properties Nillable, Update Description The new field value suggested by generative AI for the action item. Available in API version 67.0 and later. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Required. The category that the action item falls under. This field can be used to search for specific action items, such as field updates or follow-up sales emails. | | UnmodActionItemOutput | Type textarea Properties Nillable Description Required. The unmodified output for the action item produced by AI, whether from a prompt template or other generation method. | | Utterance | Type textarea Properties Nillable, Update Description The user utterance or prompt that generated this action item. Available in API version 67.0 and later. | # AiGenActionItemInfo Represents the contextual information for AI-generated actions. It tracks the agent recommendations, their rationale, and the current action status. This object is available in API version 67.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules Agentforce Pipeline Management must be enabled. Only the agent user can create AiGenActionItem records. ## Fields | Field | Details | | --- | --- | | ActionItemOwnerId | Type reference Properties Filter, Group, Nillable, Sort Description The ID associated with the owner of the AI-generated action item. The owner can be an agent or human user, and can change during the review and execution process. By default, the owner is an agent or queue. This field is a polymorphic relationship field. Relationship Name ActionItemOwner Refers To Group, User | | AgentType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. The specific agent that suggests and processes the AI-generated action item. | | BotDefinitionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the agent definition that can execute the AI-generated action item. This field is a relationship field. Relationship Name BotDefinition Refers To BotDefinition | | BotVersionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the agent version that can execute the AI-generated action item. This field is a relationship field. Relationship Name BotVersion Refers To BotVersion | | CustomAgentActionName | Type string Properties Filter, Group, Nillable, Sort Description The name of the custom agent action. | | ExpirationDate | Type dateTime Properties Filter, Sort Description Required. The timestamp when the AI-generated action item expires. | | FieldName | Type string Properties Filter, Group, Nillable, Sort Description The name of the field to update when the AI-generated action item is a field update. | | GeneratedResponseIdRef | Type string Properties Filter, Group, Nillable, Sort Description The ID of generated result in the GenAIGeneration DMO. This field can be used by human users to provide feedback on the AI-generated action item. | | OriginalValue | Type textarea Properties Nillable Description The original value of the field before it's updated by the AI-generated action item. | | ParentId | Type reference Properties Filter, Group, Sort Description Required. The record that the AI-generated action item is for. This field is a polymorphic relationship field. Relationship Name Parent Refers To Account, Opportunity | | ParentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Required. The object that the AI-generated action item is for. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. The status of the AI-generated action item. | | Subject | Type string Properties Filter, Group, Sort Description Required. The subject line that displays to users indicating what the action item is. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. The type of AI-generated action item. For example, field update or custom agent action. | # AIInsightAction Represents an Einstein prediction insight action. This object is available in API version 47.0 and later. An Einstein insight is created every time an Einstein feature, such as Prediction Builder, makes a prediction. An insight is represented by a root AIRecordInsight and the following child objects: AIInsightAction, AIInsightFeedback, AIInsightReason, and AIInsightValue. AIInsightAction is a one-to-many child of AIRecordInsight. AIInsightAction contains information about predicted actions for this particular insight. AIInsightAction has one or more AIInsightValue children which contain predicted values for the action. For example, an AIInsightAction could represent a quick action, and have a child AIInsightValue with the recommended value used by the quick action. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Prediction insight objects are only available in orgs that have Einstein features, such as Prediction Builder or Case Classification, enabled. ## Fields | Field | Details | | --- | --- | | ActionId | Type reference Properties Filter, Group, Nillable, Sort Description The unique ID of the associated action, such as the ID of a Macro. This is a polymorphic relationship field. Relationship Name Action Relationship Type Lookup Refers To ApexClass, AuraDefinitionBundle | | ActionName | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The ID of the action. For example, a value of “Case.SendEmail” indicates a send email quick action on Case. | | AiRecordInsightId | Type reference Properties Filter, Group, Sort Description The unique ID of the associated AIRecordInsight. This is a relationship field. Relationship Name AiRecordInsight Relationship Type Lookup Refers To AIRecordInsight | | Confidence | Type double Properties Filter, Nillable, Sort Description Relative confidence strength of the generated prediction insight. Higher values (near 1.0) indicate stronger confidence. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the AIInsightAction. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of action. Possible values are: - InvocableAction—Invocable Action - Macro—Macro - QuickAction—Quick action. - StandardAction—Standard Action. An example standard action would be to update a record. | ## Usage When an Einstein feature makes a prediction and saves the results, the following events happen in a single atomic operation: - An AIRecordInsight record is created and populated with information about the prediction insight. AIInsightAction, AIInsightReason, and AIInsightValue records are also created and made children of the AIRecordInsight record. - If the Einstein feature uses AI prediction fields, prediction result values are written to the target AI prediction field. - An AIPredictionEvent platform event is created, and any subscriber to AIPredictionEvent is notified. When Einstein writes prediction results back to AI prediction fields, record save custom logic, such as Apex triggers, workflow rules, and assignment rules, aren’t run. To add custom logic based on Einstein prediction results, use a platform event subscriber, such as Process Builder, to get notifications for AIPredictionEvents that contain references to Einstein insight objects. Custom fields can’t be added to Einstein insight objects. Einstein insights contain information about target fields and predicted value. Your org may have created Einstein predictions that are associated with target fields with field-level security restrictions. To control how users access Einstein insights records, use Salesforce data access features such as user profiles and permission sets. # AIInsightFeedback Represents an Einstein prediction insight feedback. This object is available in API version 47.0 and later. An Einstein insight is created every time an Einstein feature, such as Prediction Builder, makes a prediction. An insight is represented by a root AIRecordInsight and the following child objects: AIInsightAction, AIInsightFeedback, AIInsightReason, and AIInsightValue. AIInsightFeedback is a one-to-many child of AIRecordInsight. AIInsightFeedback contains information about explicit and implicit feedback collected from users for a particular insight. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Prediction insight objects are only available in orgs that have Einstein features, such as Prediction Builder or Case Classification, enabled. ## Fields | Field | Details | | --- | --- | | ActualValue | Type string Properties Filter, Group, Nillable, Sort Description The raw feedback value. This field is null when no recommendation is selected. | | AiFeedback | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The feedback user sentiment. Possible values are: - Negative—Negative feedback - Neutral—Neutral feedback - Positive—Positive feedback | | AiInsightFeedbackType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The nature of the feedback. Possible values are: - Explicit—Explicit feedback. For example, a user applies and saves an Einstein recommendation on a case. - Implicit—Implicit feedback. For example, a user edits or updates a case field without viewing or applying field recommendations from Einstein. | | AiRecordInsightId | Type reference Properties Filter, Group, Sort Description The unique ID of the associated AIRecordInsight. This is a relationship field. Relationship Name AiRecordInsight Relationship Type Lookup Refers To AIRecordInsight | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the AIInsightFeedback. | | Rank | Type int Properties Filter, Group, Nillable, Sort Description The feedback score. | | ValueId | Type reference Properties Filter, Group, Nillable, Sort Description The unique ID of the associated AIInsightValue. This is a polymorphic relationship field. Relationship Name Value Relationship Type Lookup Refers To AIInsightAction, AIInsightValue | ## Usage Salesforce creates AIInsightFeedback records based on user responses to predictions after the prediction has been created. User feedback, such as a thumbs up/down response or accepting a recommended value, results in the creation of a feedback record in which the feedback type is explicit. An implicit feedback record is created when Einstein makes a recommendation but the field is updated in another way, for example, by a process. Once the AIInsightFeedback record has been created, it’s immutable. Custom fields can’t be added to Einstein insight objects. # AIInsightReason Represents an Einstein prediction insight reason. This object is available in API version 47.0 and later. An Einstein insight is created every time an Einstein feature, such as Prediction Builder, makes a prediction. An insight is represented by a root AIRecordInsight and the following child objects: AIInsightAction, AIInsightFeedback, AIInsightReason, and AIInsightValue. AIInsightReason is a one-to-many child of AIInsightValue. AIInsightReason contains details about how Einstein predicted an insight value. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Prediction insight objects are only available in orgs that have Einstein features, such as Prediction Builder or Case Classification, enabled. ## Fields | Field | Details | | --- | --- | | AiInsightValueId | Type reference Properties Filter, Group, Sort Description The unique ID of the associated AIInsightValue. This is a relationship field. Relationship Name AiInsightValue Relationship Type Lookup Refers To AIInsightValue | | Contribution | Type double Properties Filter, Nillable, Sort Description The contribution weight for this insight reason. | | FeatureType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the feature, such as BOOL. | | FeatureValue | Type string Properties Filter, Group, Nillable, Sort Description The value of the feature, such as TRUE or FALSE. | | FieldName | Type string Properties Filter, Group, Nillable, Sort Description The name of the field the insight uses for its evaluation. | | FieldValue | Type string Properties Filter, Group, Nillable, Sort Description The value for the field the insight uses for its evaluation. | | Intensity | Type double Properties Filter, Nillable, Sort Description The intensity weight for this insight reason. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the AIInsightReason. | | Operator | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The logical operator the insight uses to compare the field value with the expression value. For example, if the prediction evaluates whether the fieldValue for the field bonus\_\_c is greater than $5,000, the logical operator is greater than. | | ReasonLabelKey (Beta) | Type string Properties Filter, Group, Nillable, Sort Description The key used to map an Einstein Key Accounts Identification (Beta) insight phrase or phrases to the correct messaging template. | | RelatedInsightReasonId (Beta) | Type reference Properties Filter, Group, Nillable, Sort Description The ID used to relate multiple insights to a single model reason in the Einstein Key Accounts Identification (Beta) feature. This is a relationship field. Relationship Name RelatedInsightReason Relationship Type Lookup Refers To AIInsightReason | | SortOrder (Beta) | Type int Properties Filter, Group, Nillable, Sort Description A number value used to organize the phrases in the model’s insights message in the Einstein Key Accounts Identification (Beta) feature. | | Variance | Type double Properties Filter, Nillable, Sort Description The variance weight for this insight reason. | ## Usage When an Einstein feature makes a prediction and saves the results, the following events happen in a single atomic operation: - An AIRecordInsight record is created and populated with information about the prediction insight. AIInsightAction, AIInsightReason, and AIInsightValue records are also created and made children of the AIRecordInsight record. - If the Einstein feature uses AI prediction fields, prediction result values are written to the target AI prediction field. - An AIPredictionEvent platform event is created, and any subscriber to AIPredictionEvent is notified. When Einstein writes prediction results back to AI prediction fields, record save custom logic, such as Apex triggers, workflow rules, and assignment rules, aren’t run. To add custom logic based on Einstein prediction results, use a platform event subscriber, such as Process Builder, to get notifications for AIPredictionEvents that contain references to Einstein insight objects. Custom fields can’t be added to Einstein insight objects. Einstein insights contain information about target fields and predicted value. Your org may have created Einstein predictions that are associated with target fields with field-level security restrictions. To control how users access Einstein insights records, use Salesforce data access features such as user profiles and permission sets. # AIInsightValue Represents an Einstein prediction insight value. This object is available in API version 47.0 and later. An Einstein insight is created every time an Einstein feature, such as Prediction Builder, makes a prediction. An insight is represented by a root AIRecordInsight and the following child objects: AIInsightAction, AIInsightFeedback, AIInsightReason, and AIInsightValue. AIInsightValue is a one-to-many child of AIRecordInsight. AIInsightValue represents a predicted value of a predicted insight. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Available when Einstein features such as Prediction Builder or Case Classification are enabled. To access an AIInsightValue record, you must have access to the related AIRecordInsight record. To grant a user the right to create an AIInsightValue record, you can use the AICreateInsightObjects or the CreateAIInsights permission. ## Fields | Field | Details | | --- | --- | | AiInsightActionId | Type reference Properties Filter, Group, Nillable, Sort Description The unique ID of the associated AIInsightAction. This is a relationship field. Relationship Name AiInsightAction Relationship Type Lookup Refers To AIInsightAction | | AiRecordInsightId | Type reference Properties Filter, Group, Sort Description The unique ID of the associated AIRecordInsight. This is a relationship field. Relationship Name AiRecordInsight Relationship Type Lookup Refers To AIRecordInsight | | Confidence | Type double Properties Filter, Nillable, Sort Description Relative confidence strength of the generated prediction insight. Higher values (near 1.0) indicate stronger confidence. | | Field | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The name of the target field Einstein is making predictions for, such as “AnnualRevenue”. | | FieldValueLowerBound | Type textarea Properties Nillable Description The lower bound value. | | FieldValueUpperBound | Type textarea Properties Nillable Description The upper bound value. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the AIInsightValue. | | SobjectLookupValueId | Type reference Properties Filter, Group, Nillable, Sort Description The unique ID of the value object, if this insight value references an object. This is a relationship field. Relationship Name SobjectLookupValue Relationship Type Lookup Refers To Account, Accreditation, ActivationTarget, Address, AlternativePaymentMethod, ApiAnomalyEventStore, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, AssociatedLocation, AuthorizationForm, AuthorizationFormConsent, AuthorizationFormDataUse, AuthorizationFormText, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CampaignMember, CardPaymentMethod, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CodeSetBundle, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionRate, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContactPointAddress, ContactPointConsent, ContactPointEmail, ContactPointPhone, ContactPointTypeConsent, ContactRequest, ContentVersion, Contract, CoverageBenefit, CoverageBenefitItem, CredentialStuffingEventStore, CreditMemo, CreditMemoLine, DataUseLegalBasis, DataUsePurpose, DelegatedAccount, DigitalWallet, DocumentChecklistItem, DuplicateRecordItem, DuplicateRecordSet, EmailMessage, EngagementChannelType, EnrollmentEligibilityCriteria, Event, HealthCareDiagnosis, HealthCareProcedure, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Idea, Identifier, IdentityDocument, Image, Individual, IndividualApplication, Invoice, InvoiceLine, Lead, Location, LocationTrustMeasure, MemberPlan, MessagingEndUser, OperatingHours, Opportunity, OpportunityContactRole, OpportunityLineItem, Order, OrderItem, OtherComponentTask, PartyConsent, Payment, PaymentAuthAdjustment, PaymentAuthorization, PaymentGateway, PaymentGroup, PaymentLineInvoice, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, Pricebook2, PricebookEntry, ProcessException, Product2, ProductConsumptionSchedule, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, PurchaserPlan, PurchaserPlanAssn, QuickText, ReceivedDocument, Recommendation, Refund, RefundLinePayment, ReportAnomalyEventStore, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderItemAdjustment, ReturnOrderItemTax, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SessionHijackingEventStore, SharingRecordCollection, Shift, Shipment, ShipmentItem, SkillRequirement, SocialPersona, SocialPost, Solution, Task, TimeSlot, UnitOfMeasure, UserProvisioningRequest, VideoCall, Visit, VisitedParty, Visitor, VoiceCall, VolunteerProject, WorkBadge, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkThanks, WorkType, WorkTypeGroup, WorkTypeGroupMember | | SobjectType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the value object, such as Account or Case, if this insight value references an object. | | Value | Type textarea Properties Nillable Description The prediction result insight value. | | ValueType | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The data type of the prediction result insight value. Possible values are: - Boolean—Boolean - Currency—Currency - DateTime—DateTime - Enum—Enum - Lookup—Lookup - Number—Number - String—String | ## Usage When an Einstein feature makes a prediction and saves the results, the following events happen in a single atomic operation: - An AIRecordInsight record is created and populated with information about the prediction insight. AIInsightAction, AIInsightReason, and AIInsightValue records are also created and made children of the AIRecordInsight record. - If the Einstein feature uses AI prediction fields, prediction result values are written to the target AI prediction field. - An AIPredictionEvent platform event is created, and any subscriber to AIPredictionEvent is notified. When Einstein writes prediction results back to AI prediction fields, record save custom logic, such as Apex triggers, workflow rules, and assignment rules, aren’t run. To add custom logic based on Einstein prediction results, use a platform event subscriber, such as Process Builder, to get notifications for AIPredictionEvents that contain references to Einstein insight objects. Custom fields can’t be added to Einstein insight objects. Einstein insights contain information about target fields and predicted value. Your org may have created Einstein predictions that are associated with target fields with field-level security restrictions. To control how users access Einstein insights records, use Salesforce data access features such as user profiles and permission sets. # AiJobRun Represents an execution instance of an AI job. This object tracks the overall status and manages the lifecycle of the job from initiation to completion. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time when the job run ends. | | ErrorCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If the job run fails, this field indicates the specific error that occurred. | | ErrorMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Contains a detailed, human-readable message that explains the reason for the job run failure. | | JobType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Defines the job's logic. Possible values are: - PromptTemplate | | Label | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A user-defined name or label for the job run, which can be used for identification and tracking. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique, system-generated identifier for the AiJobRun record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user group that owns the AiJobRun record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time when the job run's status changes to InProgress. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Tracks the lifecycle of the job run. Valid values are: - New: The job run has been created. - ReadyToStart: The job run is ready for the user to initiate processing. - Queued: The job run is queued to start. - InProgress: The job run is currently processing. - Completed: The job run completed. - Failed: The job run failed. - Aborted: The job run was aborted by the user. - Archived: The job run was archived by the user. | | Target | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A metadata field used to specify job-specific details, such as a PromptTemplateId, PromptTemplateName, or ModelId. This provides further context for the job execution. | # AiJobRunItem Stores an individual item associated with a parent AiJobRun, including the inputs and resulting response. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AiJobRunId | Type reference Properties Create, Filter, Group, Sort, Update Description A required reference to the parent AiJobRun record that this item belongs to. This field is a relationship field. Relationship Name AiJobRun Refers To AiJobRun | | ErrorCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If processing for this item fails, this field contains a numeric code indicating the error. | | ErrorMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Contains a detailed, human-readable message that explains the reason for the job run item failure. | | Input | Type textarea Properties Create, Update Description Contains the input data for a single item within the job run. For example, in a PromptTemplate job, this is the JSON input for the prompt template. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique, system-generated identifier for the AiJobRunItem record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user or group that owns the AiJobRunItem record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | PreprocessedInput | Type textarea Properties Create, Nillable, Update Description Stores an intermediate version of the input data after the preprocessing step. For example, this field could be a hydrated JSON prompt. | | Response | Type textarea Properties Create, Nillable, Update Description Contains the generated response for the job item after processing is complete. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Tracks the status of the individual job item. Valid values are: - Ready: The default value. The job run item is ready to start processing. - Completed: Processing for the job run item is complete. - Failed: Processing for the job run item failed. | # AiModelLanguage An object that stores language related information that is generated for each AI model. This object is available in API version 55.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules For Einstein Reply Recommendations: - Requires the Einstein Reply Recommendations org permissions, Einstein Reply Recommendations org pref, and Admin user or user with Einstein Reply Manager permissions. ## Fields | Field | Details | | --- | --- | | ApplicationType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Type of application using the AI model. Possible values are: - ARTICLE\_RECOMMENDATION - EAR\_FOR\_CONVERSATION - EAR\_FOR\_VOICE - FAQ - REPLY\_RECOMMENDATION - USE\_CASE\_EXPLORER - UTTERANCE\_RECOMMENDATION | | ExternalAiModelId | Type reference Properties Filter, Group, Sort Description ID of the AI model used to generate predictions. This field is a relationship field. Relationship Name ExternalAiModel Relationship Type Lookup Refers To ExternalAIModel | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Languages supported by this AI model. Possible values are: - Arabic - Chinese-simplified - Chinese-traditional - Dutch - English - French - German - Italian - Japanese - Korean - Polish - Portuguese - Russian - Spanish - Thai - Turkish | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description AI model name. | | ServingStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description Determines if the language is enabled or disabled for this AI model. | | TranscriptCount | Type int Properties Filter, Group, Sort Description Transcript count detected for each language. | # AIRecordInsight Represents an Einstein prediction insight. This object is available in API version 47.0 and later. An Einstein insight is created every time an Einstein feature, such as Prediction Builder, makes a prediction. An insight is represented by a root AIRecordInsight and the following child objects: AIInsightAction, AIInsightFeedback, AIInsightReason, and AIInsightValue. AIRecordInsight contains information on the Einstein prediction, the AI prediction field where results were written, and other details such as the type of prediction. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules Prediction insight objects are available in orgs that have Einstein features, such as Prediction Builder or Case Classification, enabled. ## Fields | Field | Details | | --- | --- | | AiApplicationId | Type reference Properties Filter, Group, Nillable, Sort Description The unique ID of the AiApplication that generated this prediction. This is a relationship field. Relationship Name AiApplication Relationship Type Lookup Refers To AIApplication | | Confidence | Type double Properties Filter, Nillable, Sort Description Relative confidence strength of the generated prediction insight, from 0.0 to 1.0. Higher values (near 1.0) indicate stronger confidence. | | MlPredictionDefinitionId | Type reference Properties Filter, Group, Nillable, Sort Description This field is a relationship field. Relationship Name MlPredictionDefinition Relationship Type Lookup Refers To MLPredictionDefinition | | ModelId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the model to use when generating the insight. This field is a polymorphic relationship field. Relationship Name Model Relationship Type Lookup Refers To MLModel | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the AIRecordInsight. | | PredictionField | Type string Properties Filter, Group, Nillable, Sort Description The label of the field that Einstein is making predictions for, such as “Case.IsEscalated”. | | RunGuid | Type string Properties Filter, Group, Sort Description A unique identifier for the Einstein process that made the prediction. | | RunStartTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time the Einstein prediction process was started. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of this insight. Possible values are: - Defunct—The insight has been consumed by the Einstein feature that owns the prediction. For example, Case Classification marks an insight as defunct if a predicted recommendation was presented to a user and the user either accepted or ignored the recommendation. This behavior ensures that the same recommendation isn’t presented multiple times to the user. - New—The insight hasn’t been consumed by the Einstein feature. | | TargetField | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The field to which prediction results are written. Case Classification doesn’t use this field. | | TargetId | Type reference Properties Filter, Group, Sort Description The unique ID of the record Einstein is making predictions for. This is a relationship field. Relationship Name Target Relationship Type Lookup Refers To Account, Accreditation, ActivationTarget, Address, AlternativePaymentMethod, ApiAnomalyEventStore, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, AssociatedLocation, AuthorizationForm, AuthorizationFormConsent, AuthorizationFormDataUse, AuthorizationFormText, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CampaignMember, CardPaymentMethod, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CodeSetBundle, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionRate, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContactPointAddress, ContactPointConsent, ContactPointEmail, ContactPointPhone, ContactPointTypeConsent, ContactRequest, ContentVersion, Contract, CoverageBenefit, CoverageBenefitItem, CredentialStuffingEventStore, CreditMemo, CreditMemoLine, DataUseLegalBasis, DataUsePurpose, DelegatedAccount, DigitalWallet, DocumentChecklistItem, DuplicateRecordItem, DuplicateRecordSet, EmailMessage, EngagementChannelType, EnrollmentEligibilityCriteria, Event, HealthCareDiagnosis, HealthCareProcedure, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Idea, Identifier, IdentityDocument, Image, Individual, IndividualApplication, Invoice, InvoiceLine, Lead, Location, LocationTrustMeasure, MemberPlan, MessagingEndUser, OperatingHours, Opportunity, OpportunityContactRole, OpportunityLineItem, Order, OrderItem, OtherComponentTask, PartyConsent, Payment, PaymentAuthAdjustment, PaymentAuthorization, PaymentGateway, PaymentGroup, PaymentLineInvoice, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, Pricebook2, PricebookEntry, ProcessException, Product2, ProductConsumptionSchedule, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, PurchaserPlan, PurchaserPlanAssn, QuickText, ReceivedDocument, Recommendation, Refund, RefundLinePayment, ReportAnomalyEventStore, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderItemAdjustment, ReturnOrderItemTax, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SessionHijackingEventStore, SharingRecordCollection, Shift, Shipment, ShipmentItem, SkillRequirement, SocialPersona, SocialPost, Solution, Task, TimeSlot, UnitOfMeasure, UserProvisioningRequest, VideoCall, Visit, VisitedParty, Visitor, VoiceCall, VolunteerProject, WorkBadge, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkThanks, WorkType, WorkTypeGroup, WorkTypeGroupMember | | TargetSobjectType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of the target object, such as Account or Case. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of insight. Possible values are: - Action—An insight that indicates a suggested action, such as sending an email. - Lookup—An insight that indicates a related value not directly related to the target object and field. - MultiValue—An insight with multiple values, such as a multi-class classification. - SimilarRecord—An insight that indicates similar or duplicate records. - SingleValue—A single value insight, such as a regression number or a score. | | ValidUntil | Type dateTime Properties Filter, Nillable, Sort Description The day and time this insight is valid until. After this day and time, the insight might no longer be valid due to new prediction results from new or changed data. If this field is null, this insight never expires. | ## Usage When an Einstein feature makes a prediction and saves the results, the following events happen in a single atomic operation: - An AIRecordInsight record is created and populated with information about the prediction insight. AIInsightAction, AIInsightReason, and AIInsightValue records are also created and made children of the AIRecordInsight record. - If the Einstein feature uses AI prediction fields, prediction result values are written to the target AI prediction field. - An AIPredictionEvent platform event is created, and any subscriber to AIPredictionEvent is notified. When Einstein writes prediction results back to AI prediction fields, record save custom logic, such as Apex triggers, workflow rules, and assignment rules, aren’t run. To add custom logic based on Einstein prediction results, use a platform event subscriber, such as Process Builder, to get notifications for AIPredictionEvents that contain references to Einstein insight objects. Custom fields can’t be added to Einstein insight objects. Einstein insights contain information about target fields and predicted value. Your org may have created Einstein predictions that are associated with target fields with field-level security restrictions. To control how users access Einstein insights records, use Salesforce data access features such as user profiles and permission sets. ## Considerations for Case Classification To generate reports on the effectiveness of Einstein Case Classification predictions, use the root AIRecordInsight object and its child objects, [AIInsightFeedback](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_aiinsightfeedback.htm "HTML (New Window)") and [AIInsightValue](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_aiinsightvalue.htm "HTML (New Window)"). For example, you can determine how many cases received predictions, or how often agents accepted or rejected them. - To determine how many cases received recommendations, the AIRecordInsight table identifies the case and contains a row for each field and each recommendation. In AIRecordInsight, the TargetId field contains the case ID. The PredictionField indicates which case field is being predicted. Each field value recommendation is contained in a separate AIInsightValue object with AIRecordInsight as the parent. For a picklist field, Einstein creates AIInsightValue objects with up to 10 field value recommendations. However, just the top three predictions appear to agents in the Einstein Field Recommendations component. - To learn whether agents acted on any of the top three predictions, use the AIInsightFeedback object. When an agent updates fields after viewing Einstein’s recommendations, or when Einstein applies a recommendation automatically, the object’s AiInsightFeedbackType field contains Explicit. If the agent updates fields without viewing the predictions, such as on the case details tab, AiInsightFeedbackType is set to Implicit. When the agent applies the recommended value, the object’s AiFeedback field is set to Positive; if the agent applies a different value, AiFeedback is Negative. # AIResearchPromptResult Represents the research result generated by Agentforce or by a generative AI feature from a standard or custom prompt template. This object is available in API version 64.0 and later. When an Agentforce or a generative AI feature researches a record and saves the results, an AIResearchPromptResult record is created and populated with information about the researched record. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Research results are only available in orgs that have Agentforce or generative AI features enabled. ## Fields | Field | Details | | --- | --- | | AiGenActionItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The business action suggested by generative AI. This field is a polymorphic relationship field. Relationship Name AiGenActionItem Refers To AiGenActionItem | | IsToxicityDetected | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the generated response contains toxic language (true) or not (false). The default value is false. | | LatestErrorMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The error message that displays if the result can't be generated. | | LatestGenResponseIdRef | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the most recently generated result in the GenAIGeneration object. The object is derived from the Data Cloud data model object (DMO). | | LatestGenerationDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that the result was most recently generated. | | LatestResult | Type textarea Properties Create, Nillable, Update Description The AI-generated result. | | LatestSafetyScore | Type double Properties Create, Filter, Nillable, Sort, Update Description Overall safety score for the generated research. A higher value means the generated response is more likely to be safe. Minimum value of 0.0. Maximum value of 1.0. | | LatestStatus | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the generated result. Possible values are: - Generating - Success - Failed | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the generated research result. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ReferenceRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The record ID that the research result was generated for. This field is a polymorphic relationship field. Relationship Name ReferenceRecord Refers To Account, Contact, Lead, Opportunity | | StandardPromptTemplate | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The standard prompt template used to generate the result. | | Version | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The prompt template version number. | ## 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. [AIResearchPromptResultFeed](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. [AIResearchPromptResultHistory](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. [AIResearchPromptResultOwnerSharingRule](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. [AIResearchPromptResultShare](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. # AllowedEmailDomain Represents an allowed email domain for users in your organization. You can define an allowlist to restrict the email domains allowed in a user’s Email field. This object is available in API version 29.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules You must have the “Manage Internal Users” user permission to use this object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you don't see this object, contact your Salesforce representative to enable it. ## Fields | Field | Details | | --- | --- | | Domain | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description An allowed email domain for users. | # AlternativePaymentMethod Represents a payment method that isn’t cash, a debit card, or a credit card. This object defines methods that aren’t defined by the [CardPaymentMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cardpaymentmethod.htm "Represents a credit card or debit card payment method, which implements the PaymentMethod object. This object is available in API version 48.0 and later.") or [DigitalWallet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_digitalwallet.htm "Represents a customer’s digital wallet service. Salesforce Payments can use a digital wallet as a payment source when processing payments through a payment gateway. This object is available in API version 48.0 and later.") objects. Examples of alternative payment methods include CashOnDeliver, Klarna, and Direct Debit. AlternativePaymentMethod functions the same as any other type of payment method for processing transactions through a payment gateway. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account for the alternative payment method. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | AlternativePaymentMethod​Number | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Salesforce ID number for the alternative payment method. | | AuditEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address of the payment owner where audit information about payments is sent. | | BankAccountHolderType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Determines if the bank account is held by a business or an individual. Possible values are: - Business - Individual | | BankAccountType | Type string Properties Filter, Group, Nillable, Sort Description Type of bank account such as a checking or savings account. | | BillingFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first name of the payment method owner, based on their billing address details. This field is available in API version 58.0 and later. | | BillingLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last name of the payment method owner, based on their billing address details. This field is available in API version 58.0 and later. | | BillingName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first and last name of the payment method owner, based on their billing address details. This field is available in API version 58.0 and later. | | Comments | Type textarea Properties Create, Nillable, Update Description Users can add comments to provide additional details about a record. Maximum of 1000 characters. | | CompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Company name for this payment method. Part of the payment method’s address. | | Email | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the payment method holder. | | ExtendedPaymentMethodType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Other alternative payment methods used for the transaction. This field is available in API version 66.0 and later. | | GatewayToken | Type encryptedstring Properties Create, Nillable, Update Description Tokenized form of the alternative payment method, returned by the gateway. Stored as encrypted text. | | GatewayTokenDetails | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A unique tokenized ID generated by the payment gateway when this payment method first interacts with the gateway. Used to identify the payment method during future transactions. | | IpAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description IP address for the payment method owner. | | IsAutoPayEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the payment method can be used for recurring payments (True) or not (False). The default value is False. This field is available in API v55.0 and later. For orgs that upgraded from v54.0, you must add this field to the Alternative Payment Method page layout in the UI. It isn't automatically added. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user only accessed this record or list view (LastReferencedDate) but not viewed it. | | MacAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Mac Address of the payment method holder. | | NickName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description User-defined nickname for this payment method. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who owns the alternative payment method. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaymentGatewayId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the payment gateway entity used to handle transactions from this payment method. This field is a relationship field. Relationship Name PaymentGateway Relationship Type Lookup Refers To PaymentGateway | | PaymentMethodAddress | Type address Properties Filter, Nillable Description Full address associated with the alternative payment method. For more information about address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | PaymentMethodCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Payment method address details. | | PaymentMethodCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Payment method address details. | | PaymentMethodDetails | Type string Properties Create, Filter, Group, Nillable, Sort Description Optional information about the payment method type. This field is available in API version 57.0 and later. | | PaymentMethodGeocode​Accuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the payment method address. An accuracy level contains information about the location of a latitude and longitude. For more information about geolocation fields, see [Geolocation Compound Field](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_geolocation.htm "Geolocation fields are accessible in the SOAP and REST APIs as a Location—a structured compound data type—or as individual latitude and longitude elements."). Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | PaymentMethodLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Latitude of the payment method address. Used with the PaymentMethodLongitude to specify the precise geolocation of the address. For details about geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | PaymentMethodLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Longitude of the payment method address. Used with the PaymentMethodLatitude to specify the precise geolocation of the address. For details about geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | PaymentMethodPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the address for this payment method. | | PaymentMethodState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the address for this payment method. | | PaymentMethodStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the address for this payment method. | | PaymentMethodSubType | Type string Properties Create, Filter, Group, Nillable, Sort Description More information about the payment method. For example, if the PaymentMethodType is Visa, this field can be a digital wallet. This field is available in API version 57.0 and later. | | PaymentMethodType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Payment method used for the transaction, such as Visa, Mastercard, EPS, SepaDebit, and Klarna. This field is available in API version 57.0 and later. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the payment method's owner. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Indicates whether the payment method was created in Salesforce or externally. Required. Possible values are: - External: Select this value if you create the alternative payment method record through any method other than the Salesforce Payments Connect API. - Salesforce: Select this value if you use Salesforce Payments Connect API to create the alternative payment method record. | | SavedPaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the saved payment method record. Relationship Name SavedPaymentMethod Relationship Type Lookup Refers To SavedPaymentMethod | | StandardEntryClassCode | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A three-letter code that indicates how a customer or a business initiated and authorized an ACH payment. Possible values are: - CCD—Corporate credit or debit entry - PPD—Pre-arranged payment and deposit entry - TEL—Telephone-initiated entry - WEB—Internet or mobile-initiated entry | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The state of the payment method. Required. Possible values are: - Active—The Payments platform can use the alternative payment method to make payments. Active alternative payment methods can't be deleted. - Canceled—The Payments platform can no longer use the payment method to make payments. A value of Canceled can't be changed back to Active or Inactive - InActive—The Payment platform currently can't use the payment method to make payments. Admins can change this value to Active or Canceled when needed. | # AnalyticsAssetAction Represents a Tableau Next asset action. This object is available in API version 67.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | ActionType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of asset action. Possible values are: - filter - flow - navigate - parameter - recordaction | | AssetId | Type reference Properties Filter, Group, Sort Description The ID of the asset the action is associated with. This field is a polymorphic relationship field. Relationship Name Asset Relationship Type Master-detail Refers To AnalyticsDashboardWidget, AnalyticsVisualization | | EventType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The widget event type that triggers the action. Possible values are: - click - select | | Version | Type double Properties Filter, Nillable, Sort Description The version of the asset action. | # AnalyticsChangeEventLog Analytics Change Event Logs represent route or page changes made in the CRM Analytics. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AnalyticsMode | Type string Properties Filter, Group, Nillable, Sort Description The location where the dashboard is displayed. In the Salesforce mobile app, embedded dashboards are logged as embedded first. | | AnalyticsSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session. | | AnalyticsTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The time when this log line was generated. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | IsMobile | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the dashboard is displayed in mobile (true) or not (false). | | IsNew | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The field indicates that this action opens a new tab (true) or goes back to a previously opened tab (false). The default value is false. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | PageContext | Type string Properties Filter, Group, Nillable, Sort Description The name of the component hosting the main content of the page. For example: clients:cardsContainer. | | PageIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the CRM Analytics dashboard page. | | RecordIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The Salesforce ID of the CRM Analytics object. | | ReopenCount | Type int Properties Filter, Group, Nillable, Sort Description If IsNew is false, the number of times that an existing page opens. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SavedViewIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the CRM Analytics dashboard saved view. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | TabIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the particular Analytics tab in the user interface. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Type | Type string Properties Filter, Group, Nillable, Sort Description The type of Apex callout. For example: REST or AJAX. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character Identifier of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | ViewMode | Type string Properties Filter, Group, Nillable, Sort Description The view mode for the CRM Analytics asset. Possible values include view - edit - present - JSON - print | # AnalyticsContainerWidgetDef Represents a Tableau Next dashboard container widget definition. This object is available in API version 67.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | AnalyticsDashboardWidgetId | Type reference Properties Filter, Group, Sort Description The ID of the dashboard widget. This field is a relationship field. Relationship Name AnalyticsDashboardWidget Relationship Type Master-detail Refers To AnalyticsDashboardWidget | | BackgroundSourceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the background source for the container. This field is a relationship field. Relationship Name BackgroundSource Refers To ContentAsset | # AnalyticsDashboard Represents a Tableau Next dashboard. This object is available in API version 64.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), search() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | AnalyticsWorkspaceId | Type reference Properties Filter, Group, Sort Description The ID of the Tableau Next workspace the dashboard is associated with. This field is a relationship field. Relationship Name AnalyticsWorkspace Refers To AnalyticsWorkspace | | Description | Type textarea Properties Nillable Description The description of the dashboard. | | DeveloperName | Type string Properties Filter, Group, Sort Description The API name of the dashboard. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The supported languages for the visualization. There are over 50+ supported language and dialect values. | | LastDraftModifiedDate | Type dateTime Properties Filter, Nillable, Sort Description The last modified date for the dashboard in draft mode. | | LastPublishedDate | Type dateTime Properties Filter, Nillable, Sort Description The last published date for the dashboard. | | MasterLabel | Type string Properties Filter, Group, idLookup, Sort Description The label for the dashboard. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix for the dashboard. | | OwnerId | Type reference Properties Filter, Group, Sort Description The user ID of the user who created the dashboard. This field is a relationship field. Relationship Name Owner Refers To User | | Style | Type textarea Properties Nillable Description The widget style for the dashboard, represented as a JSON string. For example, {"widgetStyle":{"backgroundColor":"#ffffff","borderEdges":\[\],"borderColor":"#cccccc","borderWidth":1,"borderRadius":0}} | | TemplateAssetSourceName | Type string Properties Filter, Group, Nillable, Sort Description If the dashboard was created from a template, this is name of the asset source. | | TemplateSource | Type string Properties Filter, Group, Nillable, Sort Description If the dashboard was created from a template, this is name of the template. | | Version | Type double Properties Filter, Nillable, Sort Description The API version for the dashboard. | # AnalyticsDashboardWidget Represents a Tableau Next dashboard widget. This object is available in API version 67.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | AnalyticsDashboardId | Type reference Properties Filter, Group, Sort Description The ID of the Tableau Next dashboard the widget is associated with. This field is a relationship field. Relationship Name AnalyticsDashboard Relationship Type Master-detail Refers To AnalyticsDashboard (the master object) | | Label | Type string Properties Filter, Group, Nillable, Sort Description The label for the widget. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of widget. Possible values are: - button - container - extension - filter - image - metric - parameter - summary - text - visualization | | WidgetName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the widget. | # AnalyticsDownloadEventLog AnalyticsDownloadEventLog represent downloads made from lens and dashboard in the CRM Analytics. This object is available in API version 61.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AnalyticsSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session. | | AnalyticsTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The time when this log line was generated. | | AssetIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The asset ID from the user download. | | AssetType | Type string Properties Filter, Group, Nillable, Sort Description The asset type from the user download. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatasetIdentifiers | Type string Properties Filter, Group, Nillable, Sort Description A comma-separated list of used dataset IDs. | | DownloadFormat | Type string Properties Filter, Group, Nillable, Sort Description The format of the data for export. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | RecordCount | Type int Properties Filter, Group, Nillable, Sort Description The number of records exported. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Globally unique identifier for a given request. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # AnalyticsInteractEventLog Analytics Interact Event Log represents route or page changes made in the CRM Analytic UI. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AnalyticsSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session. | | AnalyticsTimestamp | Type datetime Properties Filter, Nillable, Sort Description The time when this log line was generated. | | ClickCount | Type int Properties Filter, Group, Nillable, Sort Description The number of clicks performed on a page in the CRM Analytics UI. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | ReadTime | Type double Properties Filter, Nillable, Sort Description The amount of time a user spent on a particular tab. | | RecordIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of the CRM Analytics object. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times a user returned to a particular page. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | TabIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the particular Analytics tab in the UI. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | TotalTime | Type double Properties Filter, Nillable, Sort Description The total amount of time (in milliseconds) a tab is open. | | Type | Type string Properties Filter, Group, Nillable, Sort Description The CRM Analytics object type. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | ViewMode | Type string Properties Filter, Group, Nillable, Sort Description The view mode for the CRM Analytics asset. Possible values include view - edit - present - JSON - print | ## Usage This event type is captured when a tab is closed. It collates the interaction statistics over the life of the tab, including total open time, read time, and so on. These statistics are aggregated as you go to other tabs and then return, and logged only when the tab is closed. # AnalyticsLicensedAsset Represents a licensed Analytics asset. In this context, Analytics is CRM Analytics, Sonic, or Mulesoft Data Path. Available in API version 52.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ConsumerNamespace | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The consumer namespace for the asset. The possible values are: - Industries | | LicenseType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The license type for the asset. The possible values are: - Aqs (Analytics Query Service) - Cdp (Data Cloud) - DataPipelineQuery (Data Pipeline Query) - EinsteinAnalytics (CRM Analytics) - MulesoftDataPath (Mulesoft DataPath) - Sonic (Salesforce Data Pipelines) The default value is EinsteinAnalytics. | # AnalyticsPerfEventLog Analytics Perf Event Log helps track trends in your Analytics performance. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AnalyticsSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session. | | AnalyticsTimestamp | Type datetime Properties Filter, Nillable, Sort Description The time when this log line is generated. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | EffectivePageTime | Type double Properties Filter, Nillable, Sort Description The experienced page time in milliseconds. | | IsInitialLoad | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event is for the initial load of the Dashboard (true) or not (false). The default value is false. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | QueriedName | Type string Properties Filter, Group, Nillable, Sort Description The asset title or query string. | | RecordIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of the CRM Analytics object. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | TabIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the particular Analytics tab in the UI. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | ViewMode | Type string Properties Filter, Group, Nillable, Sort Description The view mode for the CRM Analytics asset. Possible values include view - edit - present - JSON - print | # AnalyticsVisualization Represents a Tableau Next viusalization. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | AnalyticsWorkspaceId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the Tableau Next workspace the visualization is associated with. This field is a relationship field. Relationship Name AnalyticsWorkspace Refers To AnalyticsWorkspace | | Description | Type string Properties Create, Nillable, Update Description The description of the visualization. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the visualization. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The supported languages for the visualization. There are over 50+ supported language and dialect values. | | LastDraftModifiedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last modified date for the visualization in draft mode. | | LastPublishedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last published date for the visualization. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The label for the visualization. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix for the visualization. | | OwnerId | Type reference Properties Create, Filter, Group, Sort Description The user ID of the user who created the visualization. This field is a relationship field. Relationship Name Owner Refers To User | | TemplateAssetSourceName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If the visualization was created from a template, this is name of the asset source. | | TemplateSource | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If the visualization was created from a template, this is name of the template. | | Version | Type double Properties Create, Filter, Nillable, Sort, Update Description The API version for the visualization. | # AnalyticsVizField Represents a Tableau Next viusalization field. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | AdHocCalc | Type textarea Properties Create, Nillable, Update Description An ad-hoc calculation for the visualization field. | | DisplayCategory | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The display category for the visualization field. Possible values are: - Continuous—continuous - Discrete—discrete | | FieldKey | Type string Properties Create, Filter, Group, Sort, Update Description The key for the visualization field. | | Function | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The function for the visualization field. Possible values are: - Avg - Count - CountD - DatePartDay - DatePartHour - DatePartMinute - DatePartMonth - DatePartQuarter - DatePartSecond - DatePartWeek - DatePartWeekDay - DatePartYear - DateTruncDay - DatePartHour - DatePartMinute - DateTruncMonth - DateTruncQuarter - DateTruncWeek - DateTruncYear - FiscalDatePartMonth - FiscalDatePartQuarter - FiscalDatePartWeek - FiscalDatePartYear - FiscalDateTruncMonth - FiscalDateTruncQuarter - FiscalDateTruncWeek - FiscalDateTruncYear - Max - Mdy - Median - Min - My - Stdev - Stdevp - Sum - UserAgg - Var - Varp | | HierarchyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The hierarchy name for the visualization field. | | Label | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The label for the visualization field. | | PositionName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The position name for the visualization field. | | Positional | Type textarea Properties Create, Nillable, Update Description The positional text for the visualization field. | | Role | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The role for the visualization field. Possible values are: - Dimension - Measure | | SemanticFieldApiName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API for the field in the semantic model. | | SemanticObjectApiName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name for object the field belongs to in the semantic model. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type for the visualization field. Possible values are: - Field - MapPosition - MeasureNames - MeasureValues | | UniqueIndex | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique index value for the visualization field. This field is a calculated field. | | VisualizationId | Type reference Properties Create, Filter, Group, Sort Description The ID of the visualization the field belongs to. This field is a relationship field. Relationship Name Visualization Relationship Type Master-detail Refers To AnalyticsVisualization (the master object) | # AnalyticsVizViewDef Represents a Tableau Next viusalization view definition. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the visualization view definition. | | IsOriginal | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the view definition is original (true) or not (false). The default value is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The supported languages for the visualization view definition. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The label for the visualization view definition. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix for the visualization view definition. | | OwnerId | Type reference Properties Create, Filter, Group, Sort Description The user ID of the user who created the visualization view definition. This field is a relationship field. Relationship Name Owner Refers To User | | Version | Type double Properties Create, Filter, Nillable, Sort, Update Description The API version for the visualization view definition. | | VisualizationId | Type reference Properties Create, Filter, Group, Sort, Update Description This field is a relationship field. Relationship Name Visualization Refers To AnalyticsVisualization | # AnalyticsWorkspace Represents a Tableau Next workspace. This object is available in API version 54.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), search() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Nillable Description The description for the workspace. | | DeveloperName | Type string Properties Filter, Group, Sort Description The API name for the workspace. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The supported languages for the workspace. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, idLookup, Sort Description The label for the workspace. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix for the workspace. | # AnalyticsWorkspaceAsset Represents a Tableau Next asset in a workspace. This object is available in API version 54.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | ActivePromotionRequestId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the active promotion request for the workspace asset. This field is a relationship field. Relationship Name ActivePromotionRequest Refers To DataAssetPromotionRequest | | AnalyticsWorkspaceId | Type reference Properties Filter, Group, Sort Description The ID of the Tableau Next workspace the asset is associated with. This field is a relationship field. Relationship Name AnalyticsWorkspace Relationship Type Master-detail Refers To AnalyticsWorkspace (the master object) | | AssetId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the asset. This field is a polymorphic relationship field. Relationship Name Asset Refers To AnalyticsDashboard, AnalyticsVisualization | | AssetType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of asset. Possible values are: - AnalyticsDashboard—Analytics Dashboard - AnalyticsVisualization—Analytics Visualization - MktCalculatedInsightObject—Calculated Insight Object - MktDataConnection—Data Cloud Connection - MktDataLakeObject—Data Lake Object - MktDataModelObject—Data Model Object - SemanticModel—Semantic Model | | AssetUsageType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of usage for the asset. Possible values are: - Created - Referenced | | HistoricalPromotionStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The historical promotion status for the asset. Possible values are: - pending - promoted - unpromoted | | MetadataSourceType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The source type of the asset metadata. Possible values are: - Promoted - Reused | # Announcement Represents a Chatter group announcement. This object is available in API version 30.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ExpirationDate | Type dateTime Properties Create, Filter, Sort, Update Description Required. The date on which the announcement expires. Announcements display on the group UI until 11:59 p.m. local time on the selected date. | | FeedItemId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the FeedItem that contains the content of the announcement. Announcements are stored as text posts. This is a relationship field. Relationship Name FeedItem Relationship Type Lookup Refers To FeedItem | | ParentId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the parent CollaborationGroup that the announcement belongs to. An announcement can belong only to a single Chatter group. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To CollaborationGroup | | SendEmails | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Set to true to email all group members when an announcement is posted to the group. The default is false. This requires the user to have the “Send announcement on email” permission. This field is available in API version 36.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is currently available to select customers through a pilot program. To be nominated to join this pilot program, contact Salesforce. Additional terms and conditions may apply to participate in the pilot program. Please note that pilot programs are subject to change, and as such, we cannot guarantee acceptance into this pilot program or a particular time frame in which this feature can be enabled. Any unreleased services or features referenced in this document, press releases, or public statements are not currently available and may not be delivered on time or at all. Customers who purchase our services should make their purchase decisions based upon features that are currently available. | ## Usage Group owners, managers, and users with the “Modify All Data” permission can use the Announcement object to create, edit, and delete group announcements. Creating a group announcement is a three-step process. 1. Use the FeedItem object to create a text post with the announcement’s content. Use the CollaborationGroup record you want to post the announcement to as the parent of this feed item. 2. Next, use the feed item ID and an expiration date to create the announcement record. 3. Finally, update the AnnouncementId field in the CollaborationGroup record with the ID of the announcement you created. To delete the group announcement, simply delete the AnnouncementId value in the CollaborationGroup record. To restore a group announcement, update the AnnouncementId field for a group with the announcement’s ID. The expiration date for the announcement should be in the future and the feed item used to create the announcement should be parented by the same group. # Apex Callout Event Type Apex Callout events contain details about callouts (external requests) during Apex code execution. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
BOT_IDENTIFIER
Type
string
Description
The ID of the bot.
BOT_SESSION_IDENTIFIER
Type
string
Description
The bot session ID.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ApexCallout.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
METHOD
Type
String
Description
The HTTP method of the callout.
Example
For example: GET, POST, PUT, and so on.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
PLANNER_IDENTIFIER
Type
string
Description
The ID of the agent planner.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_SIZE
Type
Number
Description
The size of the callout request body, in bytes.
RESPONSE_SIZE
Type
Number
Description
The size of the callout response, in bytes.
RUN_TIME
Type
Number
Description
Not used for this event type. Use the TIME field instead.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
STATUS_CODE
Type
Number
Description
The HTTP status code for the response.
SUCCESS
Type
Boolean
Description
Indicates if the HTTP callout was sent and a response was returned (1) or not (0).
TIME
Type
Number
Description
The amount of time that the request took in milliseconds (ms).
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
TYPE
Type
String
Description
The type of Apex callout.
For example: REST or AJAX.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
URL
Type
String
Description
The callout endpoint URL.
Example
www.salesforce.com
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Apex Execution Event Type Apex Execution events contain details about Apex classes that are used. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
BOT_IDENTIFIER
Type
string
Description
The ID of the bot.
BOT_SESSION_IDENTIFIER
Type
string
Description
The bot session ID.
CALLOUT_TIME
Type
Number
Description
Time spent waiting on webservice callouts, in milliseconds.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. If the user’s session context isn't available, this field returns a blank value.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_TOTAL_TIME
Type
Number
Description
Time (in milliseconds) spent waiting for database processing in aggregate for all operations in the request. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTRY_POINT
Type
String
Description
The entry point for this Apex execution.
Example
  • GeneralCloner.cloneAndInsertRecords
  • VF- /apex/CloneUser
EVENT_TYPE
Type
String
Description
The type of event. The value is always ApexExecution.
EXEC_TIME
Type
Number
Description
The end-to-end Apex execution time (in milliseconds).
IS_LONG_RUNNING_REQUEST
Type
Boolean
Description
Indicates whether the request is counted against your org’s concurrent long-running Apex request limit (true) or not (false).
Note

Note

Asynchronous Apex jobs (batch, queueable, scheduled, and future), background processes, and bulk API requests aren’t counted against the concurrent long-running limit.

LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
NUMBER_SOQL_QUERIES
Type
Number
Description
The number of SOQL queries that were executed during the event.

This value is the aggregate across all namespaces, and can exceed the per-namespace limits. For test executions, the aggregate total value across all test methods executed in the request is used. If you’re using this value to track limit consumption, consider filtering out test execution quiddities (indicated by the QUIDDITY field).

ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
PLANNER_IDENTIFIER
Type
string
Description
The ID of the agent planner.
QUIDDITY
Type
String
Description
The type of outer execution associated with this event.
Example
  • A–ACS Batch Apex
  • B–Bulk API and Bulk API 2.0
  • BA–Start method of a Batch Apex job
  • C–Scheduled Apex
  • CI–Commerce Integration
  • DL– Discoverable Login page
  • E–Inbound Email Service
  • F–Future
  • FC–Function Callback
  • H–Apex REST
  • I–Invocable Action
  • K–Quick Action
  • L–Lightning
  • M–Remote Action
  • P–Not used in API version 63.0 and later.
  • PEPC–Platform Event Publish Callback
  • PI–Post install script for a managed package
  • Q–Queueable
  • QTXF–Transaction Finalizer for Queueable
  • R–Synchronous uncategorized (which is where all transactions not specified elsewhere end up)
  • S–QueryLocator Batch Apex (Batch Apex jobs run faster when the start method returns a QueryLocator object that doesn't include related records via a subquery. See Batch Apex Best Practices in Using Batch Apex.)
  • TA–Tests Async
  • TD–Tests Deployment
  • TS–Tests Synchronous
  • UD–Undefined is the default when an event hasn’t been assigned a more descriptive quiddity.
  • V–Visualforce
  • W–SOAP Webservices
  • X–Execute Anonymous
Note

Note

Implementations of the Process.Plugin interface use the quiddity value R.

REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.

Requests with a value over five seconds are considered long-running requests for the purposes of the Concurrent Long-Running Apex Limit.

Note

Note

HTTP callout processing time isn't included when calculating the 5-second limit. We pause the timer for the callout and resume it when the callout completes.

SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Apex Inline Event Type This event type is reserved for future use. This object is available in API version 66.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Because this event type is reserved for future use, it captures no data. # Apex REST API Event Type Apex REST API events capture information about every Apex REST API request. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). For information about Apex REST, see [Introduction to Apex REST](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_rest_intro.htm "HTML (New Window)"). ## Fields
FieldDetails
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CONNECTED_APP_ID
Type
String
Description
The 15-character ID of the connected app associated with the API call. For example, 0H4RM00000000Kr0AI.
CLIENT_NAME
Type
String
Description
The name of the client that’s using Salesforce services.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type
Set
Description
API objects that are accessed.
For example: Account, Opportunity, Contact, and so on.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ApexRestApi.
EXCEPTION_MESSAGE
Type
String
Description
The returned exception message, used to debug issues. Provide this message when seeking support.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
MEDIA_TYPE
Type
String
Description
The media type of the response.
METHOD
Type
String
Description
The HTTP method of the request.
For example: GET, POST, PUT, and so on.
NUMBER_FIELDS
Type
Number
Description
The number of fields or columns, where applicable.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
QUERY
Type
String
Description
The data that was queried.
REQUEST_SIZE
Type
Number
Description
The size of the callout request body, in bytes.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RESPONSE_SIZE
Type
Number
Description
The size of the callout response, in bytes.
ROWS_PROCESSED
Type
Number
Description
The number of rows that were processed in the request.
For example: 150.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
STATUS_CODE
Type
Number
Description
The HTTP status code for the response.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_AGENT
Type
Number
Description
The numeric code for the type of client used to make the request (for example, the browser, application, or API).
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Apex SOAP Event Type Apex SOAP events contain details about custom SOAP web service calls. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CLASS_NAME
Type
String
Description
The Apex class name. If the class is part of a managed package, this string includes the package namespace.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CLIENT_NAME
Type
String
Description
The name of the client that’s using Salesforce services. This field is an optional parameter that can be passed in API calls. If blank, the caller didn't specify a client in the CallOptions header.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_TOTAL_TIME
Type
Number
Description
Time (in milliseconds) spent waiting for database processing in aggregate for all operations in the request. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ApexSoap.
LIMIT_USAGE_PERCENT
Type
Number
Description
The percentage of Apex SOAP calls that were made against the organization’s limit.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
METHOD_NAME
Type
String
Description
The name of the calling Apex method.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
QUERY
Type
String
Description
The SOQL query, if one was performed.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.

Requests with a value over five seconds are considered long-running requests for the purposes of the Concurrent Long-Running Apex Limit.

Note

Note

HTTP callout processing time isn't included when calculating the 5-second limit. We pause the timer for the callout and resume it when the callout completes.

SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Apex Trigger Event Type Apex Trigger events contain details about triggers that fire in an organization. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
BOT_IDENTIFIER
Type
String
Description
The ID of the bot.
BOT_SESSION_IDENTIFIER
Type
String
Description
The bot session ID.
CLIENT_IP
Type
String
Description
The IP address of the client that is using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds is used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_TOTAL_TIME
Type
Number
Description
Time (in milliseconds) spent waiting for database processing in aggregate for all operations in the request. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type
String
Description
The name of the object affected by the trigger.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ApexTrigger.
EXEC_TIME
Type
Number
Description
The end-to-end Apex execution time (in milliseconds).
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
ORGANIZATION_ID
Type
ID
Description
The 15-character ID of the organization.
For example: 00D000000000123.
PLANNER_IDENTIFIER
Type
String
Description
The ID of the agent planner.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
RUN_TIME
Type
Number
Description
This field is always null. To view the end-to-end Apex execution time (in milliseconds), refer to the EXEC_TIME field.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. The timezone is GMT.
TRIGGER_ID
Type
String
Description
The 15-character ID of the trigger that was fired.
TRIGGER_NAME
Type
String
Description
For triggers coming from managed packages, TRIGGER_NAME includes a namespace prefix separated with a . character. If no namespace prefix is present, the trigger is from an unmanaged trigger.
Examples:

  • examplePackage.managedExampleTrigger - Managed trigger from the examplePackage namespace

  • unmanagedExampleTrigger - Unmanaged trigger
TRIGGER_TYPE
Type
String
Description
The type of this trigger.
Possible Values
  • AfterInsert
  • AfterUpdate
  • BeforeInsert
  • BeforeUpdate
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
ID
Description
The 15-character ID of the user who is using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the user who is using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Apex Unexpected Exception Event Type The Apex Unexpected Exception event type captures information about unexpected exceptions in Apex code execution. This event type is available in the EventLogFile object in API version 45.0 and later. Unexpected exception information is not captured in the EventLogFile object with @IsTest and anonymous Apex. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | EVENT\_TYPE | Type String Description The type of event. The value is always ApexUnexpectedException. | | EXCEPTION\_CATEGORY | Type String Description The category of the unexpected Apex exception. Provides a breakdown of unhandled exceptions based on the type. For example, the LimitException exception type is split into subcategories that indicate if you exceeded a limit, such as the total heap size or CPU time. Possible values: - Subcategories of LimitException that indicate the Apex limit you’ve exceeded. Examples: - LimitException: CpuTime: Maximum CPU time on the Salesforce servers. - LimitException: HeapSize: Total heap size. - LimitException: Queries: Total number of SOQL queries issued. - LimitException: QueryRows: Total number of records retrieved by SOQL queries. - LimitException: DmlStatements: Total number of DML statements issued. - LimitException: Callouts: Total number of callouts (HTTP requests or web services calls) in a transaction. See [Execution Governors and Limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_gov_limits.htm) for other limits. - CustomException: Unhandled [custom exception](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_exception_custom.htm). - An Apex exception that isn’t limit-related; see [Exception Class and Built-In Exceptions](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_classes_exception_methods.htm) This field is available in API version 57.0 and later. Example LimitException: CpuTime | | EXCEPTION\_MESSAGE | Type Text Description The exception’s message. Example Divide by 0 | | EXCEPTION\_TYPE | Type String Description The class type of the unexpected exception. Example System.MathException | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the org. For example: 00D000000000123. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | STACK\_TRACE | Type Text Description The stack trace for the exception. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If the exception is thrown from a managed package, STACK\_TRACE is omitted. Example Class.OpportunityUtility.insert: line 22, column 1 AnonymousBlock: line 1, column 1 | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 2024-08-08T06:08:02.755+0000. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | USER\_ID | Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | USER\_ID\_DERIVED | Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API. For example: 00590000000I1SNIA0. | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # ApexCalloutEventLog Apex Callout event logs contain details about callouts (external requests) during Apex code execution. This object is available in API version 55.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | BotIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the bot. | | BotSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The bot session ID. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | IsSuccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the callout request was successful. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | Method | Type string Properties Filter, Group, Nillable, Sort Description The HTTP method of the callout. For example: GET, POST, PUT, and so on. | | PlannerIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the agent planner. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestId. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestSize | Type double Properties Filter, Nillable, Sort Description The size of the callout request body, in bytes. | | RequestTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | ResponseSize | Type double Properties Filter, Nillable, Sort Description The size of the callout response, in bytes. | | RunTime | Type double Properties Filter, Nillable, Sort Description Not used for this event type. Use the RequestTime field instead. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | StatusCode | Type int Properties Filter, Group, Nillable, Sort Description The returned status code of the request. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Type | Type string Properties Filter, Group, Nillable, Sort Description The type of Apex callout. For example: REST or AJAX. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | Url | Type string Properties Filter, Nillable, Sort Description The callout endpoint URL. For example, www.salesforce.com. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # ApexClass Represents an Apex class. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search()update(), upsert() ## Fields | Field | Details | | --- | --- | | ApiVersion | Type double Properties Create, Filter, Sort, Update Description The API version for this class. Every class has an API version specified at creation. | | Body | Type textarea Properties Create, Nillable, Update Description The Apex class definition. Limit: 1 million characters. | | BodyCrc | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The CRC (cyclic redundancy check) of the class or trigger file. | | IsValid | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether any dependent metadata has changed since the class was last compiled (true) or not (false). The default value is false. | | LengthWithoutComments | Type int Properties Create, Filter, Group, Sort, Update Description Length of the class without comments. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the class. Limit: 255 characters | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The current status of the Apex class. The following string values are valid: - Active—The class is active. - Deleted—The class is marked for deletion. This is useful for managed packages, because it allows a class to be deleted when a managed package is updated. - Inactive—This option is unused and is only supported for ApexTrigger. For more information, see the [Metadata API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/ "HTML (New Window)"). | ## Usage Although Apex classes and triggers have the Create and Update field properties, a runtime exception occurs if you try to create, update, or delete them using the API. Instead, use the Salesforce Extensions for Visual Studio Code or the Ant Migration Tool to create or update Apex classes or triggers. Apex classes and triggers can’t be created, edited, or deleted in a production org. See [Deploying Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_deploying.htm). #### See Also - [ApexTrigger](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextrigger.htm "Represents an Apex trigger.") - [_Developer Guide_: Apex Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/ " Developer Guide: Apex Developer Guide - html (New Window)") # ApexComponent Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as and . Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as and . For information, see the [Visualforce Developers Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.pages.meta/pages/ "html (New Window)"). ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ApiVersion | Type double Properties Create, Filter, Sort, Update Description The API version for this custom component. Every custom component has an API version specified at creation. If the API version is less than 15.0 and ApiVersion is not specified, ApiVersion defaults to 15.0. | | ControllerKey | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier for the controller associated with this custom component: - If the ControllerType parameter is set to Standard or StandardSet, this value is the name of the sObject that defines the controller. - If the ControllerType parameter is set to Custom, this value is the name of the Apex class that defines the controller. | | ControllerType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of controller associated with this Visualforce custom component. Possible values include: - Not Specified, for custom components defined without a value for the controller attribute on the tag - Standard, a value that can't be used with custom components or errors may occur - StandardSet, a value that can't be used with custom components or errors may occur - Custom, for components that have a value for the controller attribute on the tag | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the Visualforce custom component. | | Markup | Type textarea Properties Create, Update Description The Visualforce markup, HTML, Javascript, and any other Web-enabled code that defines the content of the custom component. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The text used to identify the Visualforce custom component in the Setup area of Salesforce. The Label for this field is **Label**. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of this Visualforce custom component. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | ## Usage Use custom components to encapsulate a common design pattern and then reuse that pattern several times in one or more Visualforce pages. All users who can view Visualforce pages can view custom components, but the “Customize Application” permission is required to create or update custom components. #### See Also - [ApexPage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexpage.htm "Represents a single Visualforce page.") - [StaticResource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_staticresource.htm "Represents a static resource that can be used in Visualforce markup.") - [_Developer Guide_: Visualforce Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.pages.meta/pages/ " Developer Guide: Visualforce Developer Guide - html (New Window)") # ApexEmailNotification Stores a Salesforce user ID or external email address to be notified when unhandled Apex exceptions occur. This object is available in API version 35.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Each ApexEmailNotification contains either an email or a user ID, but not both. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(),upsert() ## Fields | Field | Details | | --- | --- | | Email | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The external email address to which the notification is sent. Mutually exclusive with the UserId field. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user to which the notification is sent. Mutually exclusive with the Email field. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Usage To notify users of your org at the email addresses they have on record, use UserId. To notify external users or alternate email addresses, use Email. # ApexExecutionEventLog Apex Execution event logs contain details about Apex classes that are used. This object is available in API version 55.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | BotIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the bot. | | BotSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The bot session ID. | | CalloutTime | Type double Properties Filter, Nillable, Sort Description Time spent waiting on webservice callouts, in milliseconds. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. If the user’s session context isn't available, this field returns a blank value. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description Time (in milliseconds) spent waiting for database processing in aggregate for all operations in the request. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | EntryPoint | Type string Properties Filter, Group, Nillable, Sort Description The entry point for this Apex execution. For example, GeneralCloner.cloneAndInsertRecords or VF- /apex/CloneUser. | | ExecutionTime | Type double Properties Filter, Nillable, Sort Description The end-to-end Apex execution time (in milliseconds). | | IsLongRunningRequest | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the request is counted against your org’s concurrent long-running Apex request limit (true) or not (false). Asynchronous Apex jobs (batch, queueable, scheduled, and future), background processes, and bulk API requests are not counted against the concurrent long-running limit. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | PlannerIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the agent planner. | | Quiddity | Type string Properties Filter, Group, Nillable, Sort Description The type of outer execution associated with this event. For example: - A–ACS Batch Apex - C–Scheduled Apex - E–Inbound Email Service - F–Future - H–Apex REST - I–Invocable Action - K–Quick Action - L–Lightning - M–Remote Action - P–Bulk Apex jobs running in parallel - Q–Queueable - R–Synchronous uncategorized (which is where all transactions not specified elsewhere end up) - S–QueryLocator Batch Apex (Batch Apex jobs run faster when the start method returns a QueryLocator object that doesn't include related records via a subquery. See Batch Apex Best Practices in [Using Batch Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_batch_interface.htm#apex_batch_best_practices "HTML (New Window)").) - T–Tests Apex - V–Visualforce - W–SOAP Webservices - X–Execute Anonymous Implementations of the Process.Plugin interface use the quiddity value R. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestId. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time the request took, as measured by SFDC code. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | SoqlQueryCount | Type int Properties Filter, Group, Nillable, Sort Description The number of SOQL queries that were executed during the event. This value is the aggregate across all namespaces, and can exceed the per-namespace limits. For test executions, the aggregate total value across all test methods executed in the request is used. If you are using this value to track limit consumption, consider filtering out test execution quiddities (indicated by the Quiddity field). | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # ApexExtlCalloutEventLog Apex Extl Callout EventLog represent external data callouts via custom adapters for Salesforce Connect. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, Nillable, Sort Description Action performed by the callout. | | ExecutionTime | Type double Properties Filter, Nillable, Sort Description The end-to-end Apex execution time in milliseconds. | | FetchTime | Type double Properties Filter, Nillable, Sort Description Duration (in milliseconds) it takes to retrieve the query results from the external system. | | IsSuccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the query was successful (true) or not (false). The default value is false. | | Message | Type string Properties Filter, Nillable, Sort Description Error or warning message associated with the failed call. | | ObjectType | Type string Properties Filter, Group, Nillable, Sort Description The type of event. The value is always BulkApi2. | | QueryFilter | Type string Properties Filter, Group, Nillable, Sort Description Field expressions to filter the rows to return. Corresponds to WHERE in SOQL queries. | | QueryLimit | Type double Properties Filter, Nillable, Sort Description Maximum number of rows to return for a query. Corresponds to LIMIT in SOQL queries. | | QueryOffset | Type double Properties Filter, Nillable, Sort Description Number of rows to skip when paging through a result set. Corresponds to OFFSET in SOQL queries. | | QueryOrderBy | Type string Properties Filter, Group, Nillable, Sort Description Field or column to use for sorting query results, and whether to sort the results in ascending (default) or descending order. Corresponds to ORDER BY in SOQL queries. | | QuerySelect | Type string Properties Filter, Group, Nillable, Sort Description Comma-delineated list of fields being queried. Corresponds to SELECT in SOQL queries. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RowCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of records in the result set. | | RowsFetched | Type double Properties Filter, Nillable, Sort Description Number of rows fetched by the callout. | | Subqueries | Type double Properties Filter, Nillable, Sort Description Number of subqueries this query has been split into. | | Throughput | Type double Properties Filter, Nillable, Sort Description Number of records retrieved in one second. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | TotalTime | Type double Properties Filter, Nillable, Sort Description How long it takes (in milliseconds) to prepare and execute the query and to retrieve the query results. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # ApexInlineEventLog This object is reserved for future use. This object is available in API version 66.0 and later. # ApexLog Represents a debug log containing information about a transaction, including information about Apex, Visualforce, and workflow and validation rules. This object is available in API version 19.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Application | Type string Properties Filter, Group, Sort Description This value depends on the client type that triggered the log. - For API clients, this value is the client ID. - For browser clients, this value is Browser. | | DurationMilliseconds | Type int Properties Filter, Group, Sort Description Duration of the transaction in milliseconds. | | Location | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the location of the origin of the log. Values are: - Monitoring—Log is generated as part of debug log monitoring. These types of logs are maintained for seven days or until a user deletes them. - SystemLog—Log is generated from the Developer Console. These types of logs are maintained for 24 hours or until the user clears them. | | LogLength | Type int Properties Filter, Group, Sort Description Length of the log in bytes. | | LogUserId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user whose actions triggered the debug log. This is a polymorphic relationship field. Relationship Name LogUser Relationship Type Lookup Refers To User | | Operation | Type string Properties Filter, Group, Sort Description Name of the operation that triggered the debug log, such as APEXSOAP, Apex Sharing Recalculation, and so on. | | Request | Type string Properties Filter, Group, Sort Description Request type. Values are: - API—Request came from the API - Application—Request came from the Salesforce user interface | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the request that triggered the debug log. Use this request identifier to correlate multiple debug logs triggered by the same request. | | StartTime | Type dateTime Properties Filter, Sort Description Start time of the transaction. | | Status | Type string Properties Filter, Group, Sort Description Status of the transaction. This value is either Success, or the text of an unhandled Apex exception. | ## Usage You can read information about this object, as well as delete it, but you can't update or insert it. #### See Also - [ApexClass](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexclass.htm "Represents an Apex class.") - [ApexTrigger](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextrigger.htm "Represents an Apex trigger.") - [_Developer Guide_: Apex Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/ " Developer Guide: Apex Developer Guide - html (New Window)") # ApexPage Represents a single Visualforce page. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ApiVersion | Type double Properties Create, Filter, Sort, Update Description The API version for this page. Every page has an API version specified at creation. If the API version is less than 15.0 and ApiVersion is not specified, ApiVersion defaults to 15.0. | | ControllerKey | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier for the controller associated with this page: - If the ControllerType parameter is set to Standard or StandardSet, this value is the name of the sObject that defines the controller. - If the ControllerType parameter is set to Custom, this value is the name of the Apex class that defines the controller. | | ControllerType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of controller associated with this Visualforce page. Possible values include: - Not Specified, for pages defined with neither a standardController nor a controller attribute on the tag - Standard, for pages defined with the standardController attribute on the tag - StandardSet, for pages defined using the standardController and recordSetVar attribute on the tag - Custom, for pages defined with the controller attribute on the tag | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the Visualforce page. | | IsAvailableInTouch | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if Visualforce tabs associated with the Visualforce page can be used in the Salesforce mobile app (true) or not (false). (Use of this field for Salesforce Touch is deprecated.) This field is available in API version 27.0 and later. Standard object tabs that are overridden with a Visualforce page aren’t supported in the Salesforce mobile app, even if you set this field for the page. The default Salesforce app page for the object is displayed instead of the Visualforce page. | | IsConfirmationTokenRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether GET requests for the page require a CSRF confirmation token (true) or not (false). This field is available in API version 28.0 and later. If you change this field’s value from false to true, links to the page require a CSRF token to be added to them, or the page will be inaccessible. | | Markup | Type textarea Properties Create, Update Description The Visualforce markup, HTML, Javascript, and any other Web-enabled code that defines the content of the page. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The text used to identify the Visualforce page in the Setup area of Salesforce. The Label is **Label**. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of this Visualforce page. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | ## Usage Use Visualforce pages to add custom content that extends the base Salesforce application functionality. All users in Visualforce-enabled organizations can view Visualforce pages, but the “Customize Application” permission is required to create or update them. #### See Also - [ApexComponent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexcomponent.htm "Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as and .") - [StaticResource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_staticresource.htm "Represents a static resource that can be used in Visualforce markup.") - [_Developer Guide_: Visualforce Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.pages.meta/pages/ " Developer Guide: Visualforce Developer Guide - html (New Window)") # ApexPageInfo Represents metadata about a single Visualforce page. This object is available in API version 48.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules As of Summer '20 and later, this object can only be accessed by users who can view a particular Visualforce page, and users with the View Setup and Configuration permission. ## Fields | Field | Details | | --- | --- | | ApexPageId | Type string Properties Filter, Group, Sort Description ID for the Visualforce page. | | ApiVersion | Type double Properties Filter, Sort Description The API version for the page. Every page has an API version specified at creation. If the API version is less than 15.0 and ApiVersion is not specified, ApiVersion defaults to 15.0. | | Description | Type textarea Properties Filter, Nillable, Sort Description Description of the Visualforce page. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description For internal use only. | | IsAvailableInTouch | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if Visualforce tabs associated with the Visualforce page can be used in the Salesforce app (true) or not (false). The default value is false. | | IsShowHeader | Type string Properties Filter, Group, Nillable, Sort Description The showHeader value for the Visualforce page. This will be “unknown” if the Visualforce page uses an expression to compute showHeader. The default value is true. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The text used to identify the Visualforce page in the Setup area of Salesforce. | | Name | Type string Properties Filter, Group, Sort Description Developer name of the Visualforce page. | | NameSpacePrefix | Type string Properties Filter, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, the namespace prefix is set to the namespace prefix of the org for all objects that support it. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If an object is in an installed managed package, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In non-Developer Edition orgs, NamespacePrefix is only set for objects that are part of an installed managed package. Objects outside of an installed managed package do not have a namespace prefix. | ## Usage Use ApexPageInfo to query limited metadata about Visualforce pages. Some of this metadata corresponds to settings for a Visualforce page available in Visualforce Pages. To access Visualforce Pages, from Setup, in the Quick Find box, enter Custom Code. Then, select Visualforce Pages. Other values are only available via API. Use ApexPageInfo in [Visualforce pages](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_apexpage.htm "HTML (New Window)") to add custom content that extends the base Salesforce application functionality. Users can only query ApexPageInfo records if they can display the associated Visualforce page, or if they have the View Setup & Configuration permission. Allow users to view Visualforce pages by modifying their user profile or assigning permission sets. # ApexRestApiEventLog Apex REST API event logs capture information about every Apex REST API request. This object is available in API version 55.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseBlocks | Type double Properties Filter, Nillable, Sort Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance. | | DatabaseCpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DatabaseCpuTime. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | ExceptionMessage | Type string Properties Filter, Nillable, Sort Description The exception message for a SOAP API request. An exception message gives details about errors in handling an API request, such as why an API request failed. For example: common.exception.ApiException: startDate cannot be more than 30 days ago. | | FieldCount | Type int Properties Filter, Group, Nillable, Sort Description The number of fields or columns, where applicable. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | MediaType | Type string Properties Filter, Group, Nillable, Sort Description The media type of the response. | | Method | Type string Properties Filter, Group, Nillable, Sort Description The apex method name. | | ObjectName | Type string Properties Filter, Group, Nillable, Sort Description API objects that are accessed. For example: Account, Opportunity, Contact, and so on. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestId. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestSize | Type double Properties Filter, Nillable, Sort Description The size of the callout request body, in bytes. | | RequestStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | ResponseSize | Type double Properties Filter, Nillable, Sort Description The size of the callout response, in bytes. | | RowsProcessed | Type int Properties Filter, Group, Nillable, Sort Description The number of rows that were processed in the request. For example: 150. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time the request took, as measured by SFDC code. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | StatusCode | Type int Properties Filter, Group, Nillable, Sort Description The HTTP status code for the response. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API.For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # ApexSoapApiEventLog Apex SOAP event logs contain details about custom SOAP web service calls. This object is available in API version 55.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClassName | Type string Properties Filter, Group, Nillable, Sort Description The Apex class name. If the class is part of a managed package, this string includes the package namespace. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | ClientName | Type string Properties Filter, Group, Nillable, Sort Description The name of the client that’s using Salesforce services. This field is an optional parameter that can be passed in API calls. If blank, the caller didn't specify a client in the CallOptions header. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description Time (in milliseconds) spent waiting for database processing in aggregate for all operations in the request. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | MethodName | Type string Properties Filter, Group, Nillable, Sort Description The name of the calling Apex method. | | QueryString | Type string Properties Filter, Nillable, Sort Description The SOQL query, if one was performed. | | RateLimitUsage | Type double Properties Filter, Nillable, Sort Description The percent of the current usage of your rate limit. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same **RequestIdentifier**. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestStatus | Type String Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. Requests with a value over five seconds are considered long-running requests for the purposes of the Concurrent Long-Running Apex Limit. HTTP callout processing time isn't included when calculating the 5-second limit. We pause the timer for the callout and resume it when the callout completes. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # ApexTestQueueItem Represents a single Apex class in the Apex job queue. This object is available in API version 23.0 and later. This object is available in API version 23.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules In API version 49.0 and later, users must have the View Setup and Configuration permission to access this object. ## Fields | Field Name | Description | | --- | --- | | ApexClassId | Type reference Properties Create, Filter, Group, Sort Description The Apex class whose tests are to be executed. This is a relationship field. Relationship Name ApexClass Relationship Type Lookup Refers To ApexClass | | ExtendedStatus | Type string Properties Filter, Nillable, Sort Description The pass rate of the test run. For example: “(4/6)”. This means that four out of a total of six tests passed. If the class fails to execute, this field contains the cause of the failure. | | ParentJobId | Type reference Properties Filter, Group, Nillable, Sort Description Points to the AsyncApexJob that represents the entire test run. If you insert multiple Apex test queue items in a single bulk operation, the queue items share the same parent job. This means that a test run can consist of the execution of the tests of several classes if all the test queue items are inserted in the same bulk operation. | | ShouldSkipCodeCoverage | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to opt out of collecting code coverage information during Apex test runs. Available in API version 43.0 and later. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The status of the job. Valid values are: - Holding1 - Queued - Preparing - Processing - Aborted - Completed - Failed 1 This status applies to batch jobs in the Apex flex queue. | | TestRunResultId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the associated [ApexTestRunResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestrunresult.htm "Contains summary information about all the test methods that were run in a particular Apex job. This object is available in API version 37.0 and later.") object. | ## Usage Insert an ApexTestQueueItem object to place its corresponding Apex class in the Apex job queue for execution. The Apex job executes the test methods in the class. To abort a class that is in the Apex job queue, perform an update operation on the ApexTestQueueItem object and set its Status field to Aborted. If you insert multiple Apex test queue items in a single bulk operation, the queue items share the same parent job. This means that a test run can consist of the execution of the tests of several classes if all the test queue items are inserted in the same bulk operation. # ApexTestResult Repres ents the result of an Apex test method execution. This object is available in API version 23.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules In API version 49.0 and later, users must have the View Setup and Configuration permission to access this object. ## Fields | Field Name | Details | | --- | --- | | ApexClassId | Type reference Properties Create, Filter, Group, Sort, Update Description The Apex class whose test methods were executed. This is a relationship field. Relationship Name ApexClass Relationship Type Lookup Refers To ApexClass | | ApexLogId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Points to the ApexLog for this test method execution if debug logging is enabled; otherwise, null. This is a relationship field. Relationship Name ApexLog Relationship Type Lookup Refers To ApexLog | | ApexTestRunResultId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the [ApexTestRunResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestrunresult.htm "Contains summary information about all the test methods that were run in a particular Apex job. This object is available in API version 37.0 and later.") that represents the entire test run. This is a relationship field. Relationship Name ApexTestRunResult Relationship Type Lookup Refers To ApexTestRunResult | | AsyncApexJobId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Points to the AsyncApexJob that represents the entire test run. This field points to the same object as [ApexTestQueueItem.ParentJobId](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestqueueitem.htm "Represents a single Apex class in the Apex job queue. This object is available in API version 23.0 and later."). This is a relationship field. Relationship Name AsyncApexJob Relationship Type Lookup Refers To AsyncApexJob | | IsTestSetup | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the results are for a test setup method. The default is false. | | Message | Type string Properties Create, Filter, Nillable, Sort, Update Description The exception error message if a test failure occurs; otherwise, null. | | MethodName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The test method name. | | Outcome | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The result of the test method execution. Can be one of these values: - Pass - Fail - CompileFail - Skip | | QueueItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Points to the [ApexTestQueueItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestqueueitem.htm "Represents a single Apex class in the Apex job queue. This object is available in API version 23.0 and later."), which is the class that this test method is part of. This is a relationship field. Relationship Name QueueItem Relationship Type Lookup Refers To ApexTestQueueItem | | RunTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The time it took the test method to run, in milliseconds. | | StackTrace | Type string Properties Create, Filter, Nillable, Sort, Update Description The Apex stack trace if the test failed; otherwise, null. | | TestCategory | Type string Properties Filter, Group, Nillable, Sort Description The category of the test class. This field is available in API version 65.0 and later. Possible values are: - Apex—run Apex tests. - Flow—run flow tests. - IntegrationTest—run integration tests. This field is available as a Developer Preview in API version 67.0 and later. See [Apex Integration Tests for Agentforce and Data 360 Services (Developer Preview)](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_testing_integration_testing.htm) in the Apex Developer Guide. | | TestName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the test class. This field is available in API version 65.0 and later. | | TestNamespace | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The namespace of the test class. Apex tests are in the default namespace, so theTestNamespace value for Apex tests is null. Flow tests are in the [FlowTesting](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_namespace_flowtesting.htm) namespace. If a flow test is in a namespaced package or org, the TestNamespace value is FlowTesting.. This field is available in API version 65.0 and later. | | TestTimestamp | Type dateTime Properties Create, Filter, Sort, Update Description The start time of the test method. | ## Usage You can query the fields of the ApexTestResult record that corresponds to a test method executed as part of an Apex class execution. Each ApexTestResult record represents a single test method execution. For example, if an Apex test class contains six test methods, six ApexTestResult records are created. These records are in addition to the ApexTestQueueItem record that represents the Apex class. Each ApexTestResult record has an associated [ApexTestResultLimits](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestresultlimits.htm "Captures the Apex test limits used for a particular test method execution. An instance of this object is associated with each ApexTestResult record. This object is available in API version 37.0 and later.") record, which captures the Apex limits used during execution of the test method. # ApexTestResultLimits Captures the Apex test limits used for a particular test method execution. An instance of this object is associated with each ApexTestResult record. This object is available in API version 37.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules In API version 49.0 and later, users must have the View Setup and Configuration permission to access this object. ## Fields | Field Name | Details | | --- | --- | | ApexTestResultId | Type reference Properties Create, Filter, Group, Sort Description The ID of the associated [ApexTestResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestresult.htm "Repres ents the result of an Apex test method execution. This object is available in API version 23.0 and later.") object. This is a relationship field. Relationship Name ApexTestResult Relationship Type Lookup Refers To ApexTestResult | | AsyncCalls | Type int Properties Create, Filter, Group, Sort, Update Description The number of asynchronous calls made during the test run. | | Callouts | Type int Properties Create, Filter, Group, Sort, Update Description The number of callouts made during the test run. | | Cpu | Type int Properties Create, Filter, Group, Sort, Update Description The amount of CPU used during the test run, in milliseconds. | | Dml | Type int Properties Create, Filter, Group, Sort, Update Description The number of DML statements made during the test run. | | DmlRows | Type int Properties Create, Filter, Group, Sort, Update Description The number of rows accessed by DML statements during the test run. | | Email | Type int Properties Create, Filter, Group, Sort, Update Description The number of email invocations made during the test run. | | LimitContext | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates whether the test run was synchronous or asynchronous. | | LimitExceptions | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates whether your org has any limits that differ from the default limits. | | MobilePush | Type int Properties Create, Filter, Group, Sort, Update Description The number of mobile push calls made during the test run. | | QueryRows | Type int Properties Create, Filter, Group, Sort, Update Description The number of rows queried during the test run. | | Soql | Type int Properties Create, Filter, Group, Sort, Update Description The number of SOQL queries made during the test run. | | Sosl | Type int Properties Create, Filter, Group, Sort, Update Description The number of SOSL queries made during the test run. | ## Usage The ApexTestResultLimits object is populated for each test method execution, and it captures the limits used between the Test.startTest() and Test.stopTest() methods. If startTest() and stopTest() aren’t called, limits usage isn’t captured. Note the following: - The associated test method must be run asynchronously. - Limits for asynchronous Apex operations (batch, scheduled, future, and queueable) that are called within test methods aren’t captured. - Limits are captured only for the default namespace. # ApexTestRunResult Contains summary information about all the test methods that were run in a particular Apex job. This object is available in API version 37.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules In API version 49.0 and later, users must have the View Setup and Configuration permission to access this object. ## Fields | Field Name | Details | | --- | --- | | AsyncApexJobId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The parent Apex job ID for the result. This is a relationship field. Relationship Name AsyncApexJob Relationship Type Lookup Refers To AsyncApexJob | | ClassesCompleted | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of classes executed during the test run. | | ClassesEnqueued | Type int Properties Create, Filter, Group, Sort, Update Description The total number of classes enqueued during the test run. | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time at which the test run ended. | | IsAllTests | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether all Apex test classes were run. | | JobName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for future use. | | MethodsCompleted | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of methods completed during the test run. This value is updated after each class is run. | | MethodsEnqueued | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of methods enqueued for the test run. This value is initialized before the test runs. | | MethodsFailed | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of methods that failed during this test run. This value is updated after each class is run. | | Source | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The source of the test run, such as the Developer Console. | | StartTime | Type dateTime Properties Create, Filter, Sort, Update Description The time at which the test run started. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the test run. Values include: - Queued - Preparing - Processing - Aborted - Completed - Failed | | TestSetupTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The time it took the setup methods to run, in milliseconds. | | TestTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The time it took the test to run, in milliseconds. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user who ran the test run. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | # ApexTestSuite Represents a suite of Apex classes to include in a test run. A TestSuiteMembership object associates each class with the suite. This object is available in API version 36.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules In API version 49.0 and later, users must have the View Setup and Configuration permission to access this object. ## Fields | Field Name | Description | | --- | --- | | TestSuiteName | Type string Properties Create, Filter, Group, Sort, Unique, Update Description The name of the Apex test suite. This label appears in the user interface. This value is case-sensitive and must be unique. | ## Usage Insert a TestSuiteMembership object using an API call to associate an Apex class with an ApexTestSuite object. (ApexTestSuite and TestSuiteMembership aren’t editable through Apex DML.) To remove the class from the test suite, delete the TestSuiteMembership object. If you delete an Apex test class or test suite, all TestSuiteMembership objects that contain that class or suite are deleted. The following SOQL query returns the membership object that relates this Apex class to this test suite. SELECT Id FROM TestSuiteMembership WHERE ApexClassId = '01pD0000000Fhy9IAC' AND ApexTestSuiteId = '05FD00000004CDBMA2' #### See Also - [TestSuiteMembership](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_testsuitemembership.htm "Associates an Apex class with an ApexTestSuite. This object is available in API version 36.0 and later.") # ApexTrigger Represents an Apex trigger. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ApiVersion | Type double Properties Create, Filter, Sort, Update Description The API version for this trigger. Every trigger has an API version specified at creation. | | Body | Type textarea Properties Create, Nillable, Update Description The Apex trigger definition. Limit: 1 million characters. | | BodyCrc | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The CRC (cyclic redundancy check) of the class or trigger file. | | IsValid | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether any dependent metadata has changed since the trigger was last compiled (true) or not (false). | | LengthWithoutComments | Type int Properties Create, Filter, Group, Sort, Update Description Length of the trigger without comments | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the trigger. Limit: 255 characters | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The current status of the Apex trigger. The following string values are valid: - Active—The trigger is active. - Inactive—The trigger is inactive, but not deleted. - Deleted—The trigger is marked for deletion. This is useful for managed packages, because it allows a class to be deleted when a managed package is updated. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Inactive is not valid for ApexClass. For more information, see the [Metadata API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/ "HTML (New Window)") . | | TableEnumOrId | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the object associated with the trigger, such as Account or Contact. | | UsageAfterDelete | Type boolean Properties Create, Filter, Update Description Specifies whether the trigger is an after delete trigger (true) or not (false). | | UsageAfterInsert | Type boolean Properties Create, Filter, Update Description Specifies whether the trigger is an after insert trigger (true) or not (false). | | UsageAfterUndelete | Type boolean Properties Create, Filter, Update Description Specifies whether the trigger is an after undelete trigger (true) or not (false). | | UsageAfterUpdate | Type boolean Properties Create, Filter, Update Description Specifies whether the trigger is an after update trigger (true) or not (false). | | UsageBeforeDelete | Type boolean Properties Create, Filter, Update Description Specifies whether the trigger is a before delete trigger (true) or not (false). | | UsageBeforeInsert | Type boolean Properties Create, Filter, Update Description Specifies whether the trigger is a before insert trigger (true) or not (false). | | UsageBeforeUpdate | Type boolean Properties Create, Filter, Update Description Specifies whether the trigger is a before update trigger (true) or not (false). | | UsageIsBulk | Type boolean Properties Create, Filter, Update Description Specifies whether the trigger is defined as a bulk trigger (true) or not (false). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is not used for Apex triggers saved using Salesforce API version 10.0 or higher: all triggers starting with that version are automatically considered bulk, and this field will always return true. | ## Usage Although Apex classes and triggers have the Create and Update field properties, a runtime exception occurs if you try to create, update, or delete them using the API. Instead, use the Salesforce Extensions for Visual Studio Code or the Ant Migration Tool to create or update Apex classes or triggers. Apex classes and triggers can’t be created, edited, or deleted in a production org. See [Deploying Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_deploying.htm). #### See Also - [ApexClass](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexclass.htm "Represents an Apex class.") - [_Developer Guide_: Apex Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/ " Developer Guide: Apex Developer Guide - html (New Window)") # ApexTriggerEventLog Apex Trigger event logs contain details about triggers that fire in an organization. This object is available in API version 55.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | BotIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the bot. | | BotSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The bot session ID. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that is using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description Time (in milliseconds) spent waiting for database processing in aggregate for all operations in the request. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | ExecutionTime | Type double Properties Filter, Nillable, Sort Description The end-to-end Apex execution time (in milliseconds). | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | ObjectName | Type string Properties Filter, Group, Nillable, Sort Description The name of the object affected by the trigger. | | PlannerIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the agent planner. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | RequestStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. Requests with a value over five seconds are considered long-running requests for the purposes of the Concurrent Long-Running Apex Limit. HTTP callout processing time isn't included when calculating the 5-second limit. We pause the timer for the callout and resume it when the callout completes. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | TriggerIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the trigger that was fired. | | TriggerName | Type string Properties Filter, Group, Nillable, Sort Description For triggers coming from managed packages, TriggerName includes a namespace prefix separated with a . character. If no namespace prefix is present, the trigger is from an unmanaged trigger. For example: - examplePackage.managedExampleTrigger—Managed trigger from the examplePackage namespace - unmanagedExampleTrigger—Unmanaged trigger | | TriggerType | Type string Properties Filter, Group, Nillable, Sort Description The type of this trigger. Possible values are: - AfterInsert - AfterUpdate - BeforeInsert - BeforeUpdate | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who is using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # ApexTypeImplementor Represents Apex classes that directly or indirectly implement an interface. Using a SOQL query, this object gets information about public or global classes and only global classes for installed managed packages. This object is available in API version 54.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | ApexClassId | Type reference Properties Filter, Group, Sort Description The foreign key to the outer class that contains the Apex class implementing the interface. This is a relationship field. Relationship Name ApexClass Relationship Type Lookup Refers To ApexClass | | ClassName | Type string Properties Filter, Group, Sort Description Apex class name that implements the interface. For an inner class that implements the interface, the outer class and inner name separated by a period. | | ClassNamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix of the class that implements the interface. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description A unique identifier for the interface and implementor. | | InterfaceApexClassId | Type reference Properties Filter, Group, Nillable, Sort Description The foreign key to the outer class that contains the Apex class defining the interface. Null for built-in system interfaces, such as System.Batchable. This is a relationship field. Relationship Name InterfaceApexClass Relationship Type Lookup Refers To ApexClass | | InterfaceName | Type string Properties Filter, Group, Sort Description The interface name for which Apex class implementation is retrieved. For an inner interface, the outer Apex class name and the inner interface name separated by a period. | | InterfaceNamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix of the class that defines the interface. | | IsConcrete | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the implementing class is abstract (false) or not (true). | ## Usage ApexTypeImplementor considers access modifiers based on the context, such as the namespace from which the ApexTypeImplementor entity is queried. These are additional usage considerations. - In installed managed packages, you get information about all global implementors in the org, and public implementors from the managed package itself. - ApexTypeImplementor appropriately filters classes that are annotated with @Deprecated. For example it respects the package version dependency settings of a class when queried from that class. - ApexTypeImplementor returns implementors where ApexClass.IsValid is set to False (invalid classes) in addition to when it’s set to True. Classes that don’t compile or execute can be returned. An implementor class is only guaranteed to be usable if ApexClass.IsValid is set to True for the implementor. - If a package is installed but not yet compiled because Compile on Deploy is disabled, ApexTypeImplementor returns no values until compilation is complete. In environments like sandboxes where Compile on Deploy can be disabled, you must perform a manual compilation to get complete results. - To avoid cross-namespace collisions, always specify an InterfaceNamespacePrefix as a WHERE clause in SOQL queries for ApexTypeImplementor. Otherwise, the query includes all namespaces instead of only the current namespace. If a package contains an interface with the same name as an interface in a different namespace, a query without a specified InterfaceNamespacePrefix can return false implementors that can’t be assigned to the interface. For example, say a managed package contains a global interface named RoundingStrategy and a global class named HalfDown that implements RoundingStrategy. If a subscriber org has an interface that’s also named RoundingStrategy, then the query \[SELECT ApexClass.Id FROM ApexTypeImplementor WHERE InterfaceName = 'RoundingStrategy'\], if performed in the subscriber org, can return the ID of HalfDown instead of an implementor in the subscriber org. To avoid this issue, perform a query that specifies a InterfaceNamespacePrefix: \[SELECT ApexClass.Id FROM ApexTypeImplementor WHERE InterfaceName = 'RoundingStrategy' AND InterfaceNamespacePrefix = 'PackageNamespace'\]. ## Example This example demonstrates how an interface allows flexibility in a configuration, record, or user-driven selection of the rounding strategy to apply. The multiple implementations of the interface can be discovered using ApexTypeImplementor and the specific implementation chosen based on user requirements. // Common interface that all rounding strategies will implement public interface RoundingStrategy { Decimal round(Decimal toRound); } public abstract class RoundingStrategies { public class Ceiling implements RoundingStrategy { public Decimal round(Decimal toRound) { return toRound.round(System.RoundingMode.CEILING); } } public class HalfDown implements RoundingStrategy { public Decimal round(Decimal toRound) { return toRound.round(System.RoundingMode.HALF\_DOWN); } } public class TwoDecimalPlaces implements RoundingStrategy { public Decimal round(Decimal toRound) { return toRound.setScale(2, System.RoundingMode.HALF\_UP); } } } List interfaceImpls = \[ SELECT ClassName, ClassNamespacePrefix FROM ApexTypeImplementor WHERE InterfaceName = 'RoundingStrategy' and IsConcrete = true and InterfaceNamespacePrefix = '' ORDER BY ClassName ASC NULLS LAST\]; // For example, an admin can be presented with a list of Apex classes // that can be applied. Simulated selection of 2 decimal places ApexTypeImplementor selectedRoundingStrategy = interfaceImpls\[2\]; System.assertEquals('RoundingStrategies.TwoDecimalPlaces', selectedRoundingStrategy.ClassName); // Create an instance of the class that implements the interface RoundingStrategy rs = (RoundingStrategy) Type.forName(selectedRoundingStrategy.ClassNamespacePrefix, selectedRoundingStrategy.ClassName).newInstance(); Decimal rounded = rs.round(7.1459); System.assertEquals(7.15, rounded); # ApexUnexpectedExcpEventLog Apex Unexpected Excp Event Log captures information about unexpected exceptions in Apex code execution. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ApexEntityName | Type string Properties Filter, Group, Nillable, Sort | | ExceptionCategory | Type string Properties Filter, Group, Nillable, Sort Description The category of the unexpected Apex exception. For example, the LimitException exception type is split into subcategories that indicate if you exceeded a limit, such as the total heap size or CPU time. Possible values: - Subcategories of LimitException that indicate the Apex limit you’ve exceeded. Examples: - LimitException: CpuTime: Maximum CPU time on the Salesforce servers. - LimitException: HeapSize: Total heap size - LimitException: Queries: Total number of SOQL queries issued. - LimitException: QueryRows: Total number of records retrieved by SOQL queries. - LimitException: DmlStatements: Total number of DML statements issued. - LimitException: Callouts: Total number of callouts (HTTP requests or web services calls) in a transaction. | | ExceptionMessage | Type string Properties Filter, Nillable, Sort Description The exception message for a SOAP API request. An exception message gives details about errors in handling an API request, such as why an API request failed. For example: common.exception.ApiException: startDate cannot be more than 30 days ago. | | ExceptionType | Type string Properties Filter, Group, Nillable, Sort Description The class type of the unexpected exception. For example: System.MathException | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | StackTrace | Type string Properties Filter, Nillable, Sort Description The stack trace for the exception. For example: Class.OpportunityUtility.insert: line 22, column 1 AnonymousBlock: line 1, column 1 | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | UserId | Type reference Properties Nillable Description The origin user’s unique ID. For example, 005000000000123. A polymorphic relationship field. Relationship Name User Relationship Type Lookup Refers To User | # API Field Properties Fields on objects represent the details of each object and are analogous to columns in a database table. Each field on each object has one or more of the following properties: | Property | Description | | --- | --- | | Aggregatable | Can be used by one of the SOQL aggregate functions. | | Autonumber | The API creates an autonumber. | | Create | Value for the field can be specified during create using the API. | | Defaulted on create | If no other value is specified when created, a default value is supplied. | | Delete | Value for the field can be deleted using the API. | | Filter | Can be used as filter criteria in a SOQL query FROM or WHERE clause. | | Group | Can be included in the GROUP BY clause of a SOQL query (true) or not (false). Available in API version 18.0 and later. | | idLookup | Can be used to specify a record in an upsert call. The Id field of each object has this property and some Name fields. There are exceptions, so check for the property in any object you wish to upsert. | | Namepointing | Indicates whether the field's value is the Name of the parent of this object (true) or not (false). Used for objects whose parents can be more than one type of object. For example, a task can have an account or a contact as a parent. | | Nillable | The field can contain a null value. | | Query | The field can be queried with SOQL using the API. | | Restricted picklist | A picklist whose values are restricted to those values defined by a Salesforce admin. Users can’t load unapproved values through the API. | | Retrieve | Value of the field can be retrieved using the API. | | Sort | Indicates whether a query can sort on this field (true) or not (false). | | Update | Can be updated using the API. | # API Total Usage API Total usage events contain details about Platform SOAP API, Platform REST API, and Bulk API requests. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
API_CLIENT_CATEGORY
Type
String
Description
The category of the client making the API request.
Possible values are:
  • AGENTFORCE_AGENT—API request is from an Agentforce agent.
  • EXTERNAL_APPLICATION—API request is from an external app defined in the org.
  • LIGHTNING_UI—API request is from the Lightning UI.
  • SALESFORCE—API request is from an internal Salesforce app or service.
  • UNKNOWN—API request is from an unrecognized category.
  • SALESFORCE_HOSTED_MCP—API request is from a Salesforce Hosted MCP Server.
API_FAMILY
Type
String
Description
The API family. Possible values are REST, SOAP, Bulk, ApexREST, DirectApexREST or DirectAura. ApexREST indicates an Apex REST call. DirectApexREST indicates an Apex REST Agent Action call. DirectAura indicates an AuraEnabled Apex Agent Action call.
API_RESOURCE
Type
String
Description
The API method or resource. For example, describeSObjects for SOAP, or /v21.0/sobjects/Account/001xx000003DGQW for REST.
API_VERSION
Type
Number
Description
The API version. For example, 21.0.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CLIENT_NAME
Type
String
Description
The name of the client making the API request. Includes values passed via the Sforce-Call-Options header.
CONNECTED_APP_ID
Type
String
Description
The ID of the connected app making the API request.
If the connected app ID includes the prefix 0H4, append it to the connected app ID in the My Domain URL to access app details (https://MyDomainName.my.salesforce.com/0H4xxxxxxxxxxxx). If, however, the connected app ID uses the prefix 888, contact Salesforce Customer Support for app details.
CONNECTED_APP_NAME
Type
String
Description
The name of the connected app making the API request.
COUNTS_AGAINST_API_LIMIT
Type
Boolean
Description
Whether the request counted against the API limit (true) or not (false).
ENTITY_NAME
Type
Set
Description
The name of the object accessed by the API request.
For example: Account, Opportunity, Contact, and so on.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ApiTotalUsage.
HTTP_METHOD
Type
String
Description
The HTTP method. For example, GET.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
STATUS_CODE
Type
Number
Description
The HTTP response status code for the request.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the API.
For example: 00530000009M943
USER_NAME
Type
String
Description
The username of the user who's using Salesforce services through the API.
# ApiTotalUsageEventLog API Total Usage Event Log contains details about Platform SOAP API, Platform REST API, and Bulk API requests. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ApiFamily | Type string Properties Filter, Group, Nillable, Sort Description The API family. For example, REST, SOAP, or Bulk. | | ApiResource | Type string Properties Filter, Group, Nillable, Sort Description The API method or resource. For example, describeSObjects for SOAP. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | ClientName | Type string Properties Filter, Group, Nillable, Sort Description The name of the client making the API request. | | ConnectedAppIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the connected app making the API request. | | HttpMethod | Type string Properties Filter, Group, Nillable, Sort Description The HTTP method. For example, GET. | | IsApiLimitCounted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the request counted against the API limit (true) or not (false). The default value is false. | | IsExternalApplicationSoapApiLogin | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The default value is false. | | ObjectName | Type string Properties Filter, Group, Nillable, Sort Description The name of the object accessed by the API request. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | StatusCode | Type int Properties Filter, Group, Nillable, Sort Description The HTTP response status code for the request. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # AppAnalyticsQueryRequest Represents a request for AppExchange App Analytics data. AppExchange App Analytics is available for packages that passed security review and are registered to a License Management App (LMA). Usage data is provided as package usage logs, as month-based package usage summaries, or as point-in-time subscriber snapshots. Usage logs, monthly usage summaries, and subscriber snapshots are downloadable comma-separated value (.csv) files. For information on how to optimize your use of App Analytics, see [AppExchange App Analytics Best Practices](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/app_analytics_best_practices.htm "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Usage data from [Government Cloud and Government Cloud Plus](https://www.salesforce.com/solutions/industries/government1/products/government-cloud/ "HTML (New Window)") orgs isn’t available in App Analytics. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules See [Get Started with AppExchange App Analytics](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/app_analytics_intro_2gp.htm "HTML (New Window)") in the Second-Generation Managed Packaging Developer Guide. ## Fields | Field Name | Details | | --- | --- | | AvailableSince | Type dateTime Properties Create, Filter, Nillable, Sort Description An optional value used to limit the requested results file to data newly arrived in the data lake after the specified date and time. This field is always transferred in the Coordinated Universal Time (UTC) time zone. Use the AvailableSince field as part of your catch-up query strategy. AvailableSince must be later than StartTime and EndTime, if specified. AvailableSince must be earlier than now. A query must include StartTime,AvailableSince, or both. For example, to schedule a catch-up query on 2021-04-03T18:00:00Z for this date range: - StartTime=2021-03-29T00:00:00Z - EndTime=2021-03-30T00:00:00Z Valid AvailableSince values range from 2021-03-30T00:00:00Z to 2021-04-03T18:00:00Z. For more information on AvailableSince and catch-up queries, read [AppExchange App Analytics Best Practices](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/app_analytics_best_practices.htm "HTML (New Window)"). | | DataType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of usage data being requested. Valid values include: - PackageUsageLog - PackageUsageSummary - SubscriberSnapshot ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note In Summer ’20, we changed the enum names from CustomObjectUsageSummary and CustomObjectUsageLog to PackageUsageSummary and PackageUsageLog. If you wrote integrations using CustomObjectUsageSummary or CustomObjectUsageLog, they continue to work only with v47 and earlier. After you upgrade to v48, you must update the DataType to PackageUsageSummary and PackageUsageLog. | | DownloadExpirationTime | Type dateTime Properties Filter, Nillable, Sort Description The time when the download URL is no longer valid. The expiration time is 60 minutes after the query is completed. | | DownloadSize | Type long Properties Filter, Group, Nillable, Sort Description The size of the AppExchange App Analytics results file available for download, in bytes. | | DownloadUrl | Type textarea Properties Nillable Description URL that the user can download data from. Populated after the request is completed. This URL expires and is removed after the expiration time is reached. | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort Description Enter end time in format yyyy-MM-ddTHH:mm:ss. Example: 2019-04-15T12:00:00 For Package Usage Summaries, we recommend that StartTime corresponds to midnight UTC at beginning of the desired month and EndTime corresponds to midnight UTC at the beginning of the following month. For example, to retrieve the Package Usage Summary for December 2024 specify: - StartTime=2024-12-01T00:00:00Z - EndTime=2025-01-01T00:00:00Z | | ErrorMessage | Type string Properties Filter, Group, Nillable, Sort Description Stores error message text that results from this query. | | FileCompression | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The file compression format of your requested results file. FileCompression and FileType must align. If FileType is csv, FileCompression defaults to none and can be none or gzip. If FileType is parquet, FileCompression is snappy by default and can be snappy, gzip, or none. Valid values include: - gzip - snappy - none | | FileType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The data format of your requested results file. The default is csv. FileCompression and FileType must align. If FileType is csv, FileCompression defaults to none and can be none or gzip. If FileType is parquet, FileCompression is snappy by default and can be snappy, gzip, or none. Valid values include: - csv - parquet | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated name of the App Analytics query request. | | OrganizationIds | Type string Properties Create, Filter, Group, Nillable, Sort Description Optional. Enter up to 16 comma-separated org IDs without spaces between IDs. Or enter up to 15 comma-separated org IDs with spaces between the IDs. To request data for all the orgs the package is installed in, leave the field blank. | | PackageIds | Type string Properties Create, Filter, Group, Nillable, Sort Description Optional. Enter up to 16 comma-separated package IDs without spaces between IDs. Or enter up to 15 comma-separated package IDs with spaces between the IDs. Use the subscriber package ID that begins with 033. To retrieve a list of your second-generation managed package IDs, run sf package list --verbose in Salesforce CLI. To request data on all packages registered to this License Management App, leave the field blank. | | QuerySubmittedTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the App Analytics query request was received for processing, in Coordinated Universal Time (UTC). QuerySubmittedTime is read only. | | RequestState | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Status of the query request. Valid values are: - New - Pending - Complete - Expired - Failed - NoData | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort Description Enter start time in format yyyy-MM-ddTHH:mm:ss. All App Analytics query requests must include StartTime or AvailableSince or both. Example: 2019-04-14T12:00:00 For Package Usage Summaries, we recommend that StartTime corresponds to midnight UTC at beginning of the desired month and EndTime corresponds to midnight UTC at the beginning of the following month. For example, to retrieve the Package Usage Summary for December 2024 specify: - StartTime=2024-12-01T00:00:00Z - EndTime=2025-01-01T00:00:00Z | ## Usage To request usage data, log in to the License Management Org (LMO) that your package is registered to, and initiate the API request from the LMO. In a 24-hour period, you can download a maximum 20 GB of AppExchange App Analytics data. See [Download Package Usage Logs, Package Usage Summaries, and Subscriber Snapshots](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/app_analytics_download_mp_logs.htm "HTML (New Window)") in the Second Generation Managed Packaging Developer Guide. If requests to view package usage log or subscriber snapshot data are inactive for 90 days, we reserve the right to stop collecting this data. To resume data collection, log a support case in the [Salesforce Partner Community](https://partners.salesforce.com "HTML (New Window)"). For product, specify **Partner Programs & Benefits**. For topic, specify **ISV Technology Request**. # AppDefinition Represents the metadata of an app and its navigation items. Metadata is returned only for apps that the current user can access. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field Name | Details | | --- | --- | | Description | Type string Properties Filter, Group, Nillable, Sort Description The optional description of the application. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description The developer name of the application. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description A unique virtual Salesforce ID for the application. | | HeaderColor | Type string Properties Filter, Group, Nillable, Sort Description The header color in the application. Specify the color with a hexadecimal code, such as #0000FF for blue. | | Id | Type ID Properties Defaulted on create, Filter, Group, idLookup, Sort Description A default Salesforce ID. | | IsLargeFormFactorSupported | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the Large form factor is set in the CustomApplication metadata. | | IsMediumFormFactorSupported | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the Medium form factor is set in the CustomApplication metadata. | | IsNavAutoTempTabsDisabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the navigation automatically creates temporary tabs settings. | | IsNavPersonalizationDisabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether navigation personalization is disabled. | | IsNavTabPersistenceDisabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether workspace tabs are cleared for each new console session. | | IsOmniPinnedViewEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the Omni-Channel component is enabled in sidebar view. The default is false. | | IsOverrideOrgTheme | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether to override the global theme for the org. When true, the color scheme and logo that the user has set are used. When false, the global theme for the org is used, even if the user has set a color scheme and logo. | | IsSmallFormFactorSupported | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the Small form factor is set in the CustomApplication metadata. | | Label | Type string Properties Filter, Nillable, Sort Description The localized label value corresponding to the MasterLabel field. | | LogoUrl | Type url Properties Filter, Group, Nillable, Sort Description The logo URL of the application as selected by the admin. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The non-translated label entered when the application was created. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace of the application. | | NavType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of navigation for the application. The value Standard is for Lightning Experience. The value Console is for Salesforce console. A null value is for Salesforce Classic. | | UiType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the type of custom application. The value Aloha is for Salesforce Classic, and Lightning is for Lightning Experience. | | UtilityBar | Type string Properties Filter, Group, Nillable, Sort Description The ID of the utility bar associated with this application. | # AppExchange Object Prefixes and the API If you have an unmanaged package and a managed package version becomes available, the API names of custom fields, custom objects, and Scontrol objects in the package change. A namespace prefix is added to each component to make it unique: _name_\_\_c becomes _prefix_\_\__name_\_\_c. To move from an unmanaged package to a managed package version of the same application, export your data, uninstall the old package, and install the new package. Then review the name changes and import your data with the relevant mapping. For details, see the [ISVforce Guide](https://resources.docs.salesforce.com/264/latest/en-us/sfdc/pdf/salesforce_packaging_guide.pdf "Adobe Acrobat PDF (New Window)"). # AppExtension Represents a connection between the Field Service mobile app and another app, typically for passing record data to the Salesforce mobile app or other apps. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | AppExtensionLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label in the UI for the app extension. | | AppExtensionName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the app extension. | | FieldServiceMobileSettingsId | Type reference Properties Create, Filter, Group, Sort Description The ID of a set of field service mobile settings. | | InstallationUrl | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The URL that takes the user to the app install location, such as the App Store or Google Play. | | LaunchValue | Type string Properties Create, Filter, Group, Sort, Update Description A value directing the Field Service app to the appropriate app extension. The Launch Value can be a static URL or a dynamic value that you can represent with certain tokens. These tokens pass field information from the record that the user is currently viewing. The basic format for these tokens is based on the field names; for example: **{!$Name}**. | | ScopedToObjectTypes | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the types of records from which the app extension can be activated. Scoping an app extension to an object lets users activate the app extension from records of the specified type. For example, to scope to both work orders and service appointments you would use the value WorkOrder,ServiceAppointment. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A picklist of types of app extensions: iOS, Android, Flow, and Lightning Apps | ## 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. [AppExtensionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. Available in API version 55.0 and later. # ApplicationFormTemplate Represents the fields to capture application metadata as a template which is used in application tracking and processing. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only with the EAndU Cloud Program Access permission set. ## Fields
Field Details
ApprovalFlowName

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The name of the flow that must be launched to approve the applications associated with the application form template.
ApplicationType

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: Specifies the type of application or template.

Possible values are:

  • Contractor
  • EVCharger—EV Charger
  • EnergyEfficiency—Energy Efficiency
  • NewConnection—New Connection

The default value is NewConnection.
ApprovalLimitAmount

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: Amount up to which the approver has the authority to approve applications.
ApprovalFlowName

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The name of the flow that must be launched to approve the applications associated with the application form template.
ApproverId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The user who must approve the application payout.

This field is a relationship field.

Relationship Name: Approver

Relationship Type: Lookup

Refers To: User
Description

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The description of the application form template.
Name

Type: string

Properties: Create, Filter, Group, idLookup, Sort, Update

Description: The name of the application form template.
## 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. [ApplicationFormTemplateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML\" (New Window)") Change events are available for the object. [ApplicationFormTemplateFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML\" (New Window)") Feed tracking is available for the object. [ApplicationFormTemplateHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ApplicationFormTemplateOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ApplicationFormTemplateShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # AppMenuItem Represents the organization’s default settings for items in the app menu or App Launcher. ## Supported Calls delete(), describeSObjects(), query(), retrieve(), update() ## Fields | Field | Details | | --- | --- | | ApplicationId | Type reference Properties Filter, Group, Nillable, Sort Description The 15-character ID for the menu item. | | CanvasAccessMethod | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The access method for the canvas app. Values can be: - Get—OAuth Webflow - Post—Signed Request | | CanvasEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the app menu item is a canvas app (true) or not (false). The default setting is false. | | CanvasOptions | Type string Properties Filter, Group, Nillable, Sort Description Represents the options enabled for a canvas connected app. The options are: - PersonalEnabled—The app is enabled as a canvas personal app. - HideHeader—The publisher header, which contains the “What are you working on?” text, is hidden. - HideShare—The publisher **Share** button is hidden. This field is available in API version 34.0 and later. | | CanvasReferenceId | Type string Properties Filter, Group, Nillable, Sort Description The canvas app unique identifier. | | CanvasSelectedLocations | Type string Properties Filter, Group, Nillable, Sort Description The selected locations for the canvas app which define where the canvas app can appear in the user interface. For example: Chatter,ChatterFeed,Publisher,ServiceDesk | | CanvasUrl | Type url Properties Filter, Group, Nillable, Sort Description The URL of the canvas app. | | Description | Type string Properties Filter, Group, Nillable, Sort Description A description of this menu item. | | IconUrl | Type url Properties Filter, Group, Nillable, Sort Description The icon for the menu item’s application. | | InfoUrl | Type url Properties Filter, Group, Nillable, Sort Description The URL for more information about the application. | | IsAccessible | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the current user is authorized to use the app. The default setting is false. | | IsRegisteredDeviceOnly | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, indicates that the app is available to registered devices only. The default setting is false. Available in API version 49.0 and later. | | IsUsingAdminAuthorization | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the app is pre-authorized for certain users by the administrator. The default setting is false. | | IsVisible | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description If true, the app is visible to users of the organization. The default setting is false. | | Label | Type string Properties Filter, Group, Nillable, Sort Description The app’s name. | | LogoUrl | Type url Properties Filter, Group, Nillable, Sort Description The logo for the menu item’s application. The default is the initials of the Label value. | | MobileAppBinaryId | Type string Properties Filter, Group, Nillable, Sort Description The URL for the Mobile App Binary file. | | MobileAppInstallUrl | Type url Properties Filter, Group, Nillable, Sort Description The location mobile users are directed to install the app. Available in API version 49.0 and later. | | MobileAppInstalledDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that a user installed a mobile app. Available in API version 49.0 and later. | | MobileAppInstalledVersion | Type string Properties Filter, Group, Nillable, Sort Description The version of the user’s installed mobile app. Available in API version 49.0 and later. | | MobileAppVer | Type string Properties Filter, Group, Nillable, Sort Description The version number of the mobile app. Available in API version 49.0 and later. | | MobileDeviceType | Type string Properties Filter, Group, Nillable, Sort Description The supported device form factors for the mobile app. Available in API version 49.0 and later. | | MobileMinOsVer | Type string Properties Filter, Group, Nillable, Sort Description The minimum version required for the app. Available in API version 49.0 and later. | | MobilePlatform | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The mobile platform for the app. Possible values include: - android – Android - ios – iOS Available in API version 49.0 and later. | | MobileStartUrl | Type url Properties Filter, Group, Nillable, Sort Description The location mobile users are directed to after they’ve authenticated. This field is used with connected apps and Experience Builder sites. For sites only, this location is a fully qualified domain name. For other apps, it’s a relative URL. | | Name | Type string Properties Filter, Group, Nillable, Sort Description The API name of the item. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values: - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | SortOrder | Type int Properties Filter, Group, Sort Description The index value that controls where this item appears in the menu. For example, a menu item with a sort order of 5 appears between items with sort order values of 3 and 9. | | StartUrl | Type url Properties Filter, Group, Nillable, Sort Description For a connected app, the location users are directed to after they’ve authenticated. Otherwise, the application’s default start page. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of application represented by this item. The types are: - ConnectedApplication - Network - ServiceProvider - TabSet | | UserSortOrder | Type int Properties Filter, Group, Nillable, Sort Description The index value that represents where the user set this item in the menu (or App Launcher). For example, an item with a sort order value of 5 appears between items with sort order values of 3 and 9. This value is separate from SortOrder so you can create logic incorporating both values. For example, if you want the user-sorted items to appear first, followed by the organization order for the rest, use: SELECT ApplicationId,SortOrder,UserSortOrder FROM AppMenuItem order by userSortOrder NULLS LAST, sortOrder NULLS LAST | ## Usage Use this read-only object to view an entry in the Lightning Platform app menu or the App Launcher. You can create a SOQL query to retrieve all items, even items the user does not see from the user interface. There are many ways you can use AppMenuItem. Here are some examples: - Build your own App Launcher or app menu in Salesforce. Create a custom page showing all the apps you have access to and that lets you run them using single sign-on. - Build your own App Launcher or app menu on a tablet or mobile app. You can have your own app for launching applications on various mobile devices. - Build an app launcher into your company’s intranet. There’s no need to have it run on Salesforce because Salesforce APIs let you integrate with Salesforce programmatically and build an app launcher. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip To get metadata information about apps and their tabs, use the Apex Schema.describeTabs() method, REST API /vXX.X/tabs/ resource, or SOAP API describeTabs() call. # AppointmentAssignmentPolicy Stores information about resource assignment rules. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | FullName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the AppointmentAssignmentPolicy object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the appointment assignment policy. Possible values are: - Possible values are: - da (Danish) - de (German) - en\_US (English) - es (Spanish) - es\_MX (Spanish - Mexican) - fi (Finnish) - fr (French) - it (Italian) - ja (Japanese) - ko (Korean) - nl\_NL (Dutch) - no (Norwegian) - pt\_BR (Portuguese - Brazilian) - ru (Russian) - sv (Swedish) - th (Thai) - zh\_CN (Chinese - Simplified) - zh\_TW (Chinese - Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for the appointment assignment policy. | | PolicyApplicableDuration | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The frequency at which the utilization of service resources is calculated. This field is available in API version 53.0 and later. Possible values are: - Parameter-Based - Monthly - Weekly The default value is Parameter-Based. | | PolicyType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of appointment assignment policy. Possible values are: - loadBalancing | | UtilizationFactor | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the count type for the resource utilization. This field is available in API version 53.0 and later. Possible values are: - NumberOfAppointments - TotalAppointmentDuration The default value is TotalAppointmentDuration. | # AppointmentScheduleAggr Records the utilization of a service resource, by date, for the Load Balancing appointment assignment policy. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AppointmentDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date of the appointment. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name or ID of the AppointmentScheduleAggr object. | | ResourceUtilizationCount | Type integer Properties Filter, Group, Nillable, Sort Description The number of appointments scheduled for a service resource. Available in API version 53.0 and later. This is a calculated field. | | ServiceResourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service resource associated with the appointment scheduling aggregate. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | | TotalResourceUtilization | Type double Properties Filter, Nillable, Sort Description The number of minutes for which the service resource has scheduled appointments. This is a calculated field. | | UsageType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specify the usage type of the AppointmentScheduleAggr object. Possible values are: - FSL\_Daily - FSL\_Monthly - FSL\_Weekly - LightningScheduler The default value is 'LightningScheduler'. | ## 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. [AppointmentScheduleAggrOwnerSharingRule](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. [AppointmentScheduleAggrShare](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. # AppointmentScheduleLog Stores service appointments of each service Resource. This object is used to calculate the utilization of a service resource for the AppointmentScheduleAggr object. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AppointmentDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date of the appointment. | | AppointmentScheduleAggrId | Type reference Properties Create, Filter, Group, Sort Description The appointment scheduling aggregate associated with the appointment scheduling log. This is a relationship field. Relationship Name AppointmentScheduleAggr Relationship Type Lookup Refers To AppointmentScheduleAggr | | IsUsedForResourceUtilization | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the appointment scheduling log is used for deriving the appointment scheduling aggregate. The default value is 'false'. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name or ID of the AppointmentScheduleLog object. | | RelatedRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service appointment, resource absence, event, or any other related record associated with the appointment scheduling log. This is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To Event, ServiceAppointment | | ResourceUtilization | Type double Properties Create, Filter, Nillable, Sort, Update Description The number of minutes the service resource already has scheduled appointments for. | | ServiceResourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service resource associated with the appointment scheduling log. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | | UsageType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specify the product associated with the AppointmentScheduleLog object. Possible values are: - FSL\_Daily—FSL - Daily - FSL\_Monthly—FSL - Monthly - FSL\_Weekly—FSL - Weekly - LightningScheduler—Lightning Scheduler The default value is 'LightningScheduler'. | ## 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. [AppointmentScheduleLogChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AppointmentScheduleLogFeed](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. [AppointmentScheduleLogHistory](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. [AppointmentScheduleLogOwnerSharingRule](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. [AppointmentScheduleLogShare](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. # AppointmentSchedulingPolicy Represents a set of rules for scheduling appointments using Salesforce Scheduler. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AppointmentAssignmentPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The name or ID of the appointment assignment policy. This is a relationship field, available in version 52.0 and later. Relationship Name AppointmentAssignmentPolicy Relationship Type Lookup Refers To AppointmentAssignmentPolicy | | AppointmentStartTimeInterval | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The proposed time interval in minutes between appointment start times. For example, set the interval to 15. Appointments can then begin at the top of the hour and at 15-minute intervals thereafter (10:00 AM, 10:15 AM, 10:30 AM, and so on). Possible values are: - 5 - 10 - 15 - 20 - 30 - 45 - 60 - 90 - 120 - 150 - 180 - 240 - 300 - 360 - 420 - 480 | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the AppointmentSchedulingPolicy object. | | ExtCalEventHandlerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of the custom Apex class that checks service resources’ external calendar events and returns the time slots where service resources are already booked. Available in API version 50.0 and later. This is a relationship field. Relationship Name ExtCalEventHandler Relationship Type Lookup Refers To ApexClass | | IsOrgDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this scheduling policy is the default appointment scheduling policy for Lightning Scheduler appointments in this org. | | IsSvcTerrOpHoursWithShiftsUsed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this scheduling policy considers the intersection of shifts and service territory operating hours when determining the availability of service resources for appointments (true). The default value is false. Available in API version 56.0 and later. | | IsSvcTerritoryMemberShiftUsed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this scheduling policy considers shifts of service territory members when determining the availability of service resources for appointments (true). The default value is false. Available in API version 56.0 and later. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the appointment scheduling policy. Possible values are: - Possible values are: - da (Danish) - de (German) - en\_US (English) - es (Spanish) - es\_MX (Spanish - Mexican) - fi (Finnish) - fr (French) - it (Italian) - ja (Japanese) - ko (Korean) - nl\_NL (Dutch) - no (Norwegian) - pt\_BR (Portuguese - Brazilian) - ru (Russian) - sv (Swedish) - th (Thai) - zh\_CN (Chinese - Simplified) - zh\_TW (Chinese - Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for the appointment scheduling policy. | | ShouldConsiderCalendarEvents | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this policy checks the Salesforce calendar for resource availability. The default value is 'false'. | | ShouldEnforceExcludedResource | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy prevents excluded service resources from being assigned to appointments. | | ShouldEnforceRequiredResource | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows only required service resources to be assigned to appointments. | | ShouldMatchSkill | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows only required service resources who have certain skills to be assigned to appointments. | | ShouldMatchSkillLevel | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows only required service resources who have certain skills and skill levels to be assigned to appointments. | | ShouldRespectVisitingHours | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy prevents users from scheduling appointments outside of an account’s visiting hours. | | ShouldUsePrimaryMembers | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows only service resources who are primary members of a service territory to be assigned to appointments. | | ShouldUseSecondaryMembers | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows service resources who are secondary members of a service territory to be assigned to appointments. | # AppointmentTopicTimeSlot Represents a lookup to a work type or a work type group for a time slot This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AppointmentTopicTimeSlotKey | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Non-editable validating field used to ensure no two rows have the same time slot and work type or work type group values in an instance. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name or ID of the AppointmentTopicTimeSlot object. | | OperatingHoursId | Type reference Properties Filter, Group, Nillable, Sort Description The operating hours that contain the time slot. This is a relationship field. Relationship Name OperatingHours Relationship Type Lookup Refers To OperatingHours | | TimeSlotId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the time slot. This is a relationship field. Relationship Name TimeSlot Relationship Type Lookup Refers To TimeSlot | | WorkTypeGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work type group associated with this time slot. This is a relationship field. Relationship Name WorkTypeGroup Relationship Type Lookup Refers To WorkTypeGroup | | WorkTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work type associated with this time slot. This is a relationship field. Relationship Name WorkType Relationship Type Lookup Refers To WorkType | ## 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. [AppointmentTopicTimeSlotChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AppointmentTopicTimeSlotFeed](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. [AppointmentTopicTimeSlotHistory](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. [AppointmentTopicTimeSlotOwnerSharingRule](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. [AppointmentTopicTimeSlotShare](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. # Approval Represents an approval request for a Contract. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is read-only and is specific to approvals on the Contract object. It isn't equal to or involved in the approval processes represented by the ProcessInstance, which is more powerful. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | ApproveComment | Type string Properties Filter, Nillable, Sort Description Text entered by the user when they approved or rejected this approval request. Required. Limit: 4,000 characters. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | OwnerId | Type reference Properties Filter, Group, Sort Description Required. ID of the User being asked to approve or reject the approval request. Must be a valid User ID. Required. | | ParentId | Type reference Properties Filter, Group, Sort Description Required. ID of the Contract associated with this approval request. Must be a valid contract ID. | | RequestComment | Type string Properties Filter, Nillable, Sort Description Text entered by the User who created the approval request. Optional. This field can't be updated after the Approval has been created. Limit: 4,000 characters. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. Status of this approval request. One of the following picklist values: - Pending—Specified only when the Approval request is created (create() call) - Approved—Specified only when the Approval request is approved (update() call) - Rejected—Specified when the Approval request is rejected (update() call) or when it is created (create() call) and immediately rejected for archival/historical purposes. | ## Usage This object allows client applications to programmatically handle approval requests for a Contract. Initially, to request a Contract approval, a client application might create a new Approval request record, specifying the ParentId, OwnerId (user approving or rejecting the request), Status (Pending), and (optionally) RequestComment fields. Note that when a client application creates the first approval request, if the value of the Contract Status field is Draft, then the Approval Status for this record is automatically changed to In Approval Process (see ContractStatus for more information). A client application might subsequently update an existing Approval request, specifying the Status (Approved or Rejected) and an ApproveComment (required); the RequestComment field can't be updated. Updating an Approval record (either to approve or reject) requires the client application to be logged in with “Approve Contract” permission. To update an Approval request, its Status must be Pending—a client application can't update an Approval that has already been Approved or Rejected. To re-submit an approval request for a given Contract, a client application must create a new, separate Approval record and repeat the approval process. Once a Contract has been approved (not rejected), the Contract LastApprovedDate field is automatically updated, however the Contract Status field isn't updated, it keeps the value InApproval. An approved Contract must be activated explicitly. Client applications can activate a Contract by setting the value in its Status field to Activated, or a User can activate a Contract via the Salesforce user interface. A Contract can have multiple approval requests in various states (Pending, Approved, and Rejected). In addition, one User can have multiple approval requests associated with the same Contract. Client applications can't explicitly deleteApproval records. Approval records are deleted automatically if the parent Contract is deleted. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # ApprovalAlertContentDef Represents the mapping that links specific user-created email templates to different notification events such as initial assignment or reassignment within an Advanced Approvals flow. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available in Enterprise, Professional, Unlimited, and Developer Editions where Advanced Approvals is enabled. ## Fields | Field | Details | | --- | --- | | ApprovalFlowApiName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the approval workflow. | | ApprovalStepApiName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique API name of the approval step. | | EmailTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The email template that's associated with an approval step in the approval workflow. This field is a relationship field. Relationship Name EmailTemplate Refers To EmailTemplate | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the approval alert content definition. | | NotificationReason | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The reason within an approval step's lifecycle that triggers the notification for which an email is sent. For example, when an approval work item is moved from one user to another, a reassignment notification email is sent to the user. Possible values are: - ApprovalCreationSuccess - ApprovalStepAssignment - ApprovalStepAssignmentToDelegate - ApprovalStepReassignment - ApprovalStepReassignmentToDelegate - ApprovalSubmissionApprovedOrRejectedStatusUpdate - ApprovalWorkItemStatusUpdate - AutoApprovalConfirmation | ## 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. [ApprovalAlertContentDefHistory](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. # ApprovalDelegation Represents an approval delegation that transfers a user's approval responsibilities to another user, group, or queue for a specified date range. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in Enterprise, Unlimited, and Developer Editions where Advanced Approvals is enabled. ## Fields | Field | Details | | --- | --- | | Comments | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The comments added by the user creating the delegation record. | | DelegatedFromUserId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user delegating their approval responsibilities to another user, group, or queue. This field is a relationship field. Relationship Name DelegatedFromUser Refers To User | | DelegatedToId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user, group, or queue receiving the delegated approval responsibilities. This field is a polymorphic relationship field. Relationship Name DelegatedTo Refers To Group (Type = Regular), Group (Type = Queue), User | | EndDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the delegation becomes inactive, adjusted according to the delegator's timezone. If left empty, the delegation remains active indefinitely. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated name of the approval delegation record, for example AD-000000001. | | StartDate | Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the delegation becomes active, adjusted according to the delegator's timezone. | ## Associated Objects [ApprovalDelegationHistory](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. # ApprovalSubmission Represents the instance of an approval request that's submitted for a record of the related object. This object is available in API version 62.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Special Access Rules This object is available for users with a Salesforce user license of type Salesforce in Enterprise, Performance, Unlimited, and Developer Editions. ## Fields | Field | Details | | --- | --- | | Comments | Type textarea Properties Nillable, Update Description The comments that the user adds when they submit the request for approval. | | DoesSendApprovalEmail | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates whether approval request emails are sent to approvers and delegates (true) or not (false). The default value is false. | | FlowOrchestrationInstanceId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The ID of the flow orchestration instance record that's associated with the approval. This field is a relationship field. Relationship Name FlowOrchestrationInstance Refers To FlowOrchestrationInstance | | IsEligibleForSmartApproval | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the approval submission is eligible for smart approval (true) or not (false). The default value is false. This field is only available with Advanced Approvals enabled. | | IsSmartApprovalRun | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this approval submission either is run in smart approval mode (true) or not (false). The default value is false. This field is only available with Advanced Approvals enabled. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The sequentially-generated name of the approval submission record, for example AS-000000001. | | OwnerId | Type reference Properties Filter, Group, Sort, Update Description The ID of the user or the group that owns the approval submission record. This field is a polymorphic relationship field. Relationship Name Owner Refers To User | | RelatedRecordId | Type reference Properties Filter, Group, Nillable, Sort, Update Description Required. The API name of the related record that’s submitted for approval. Relationship Name RelatedRecord Refers To The objects that you have access to for approvals. | | RelatedRecordObjectName | Type string Properties Filter, Group, Nillable, Sort, Update Description Required. The type of record that was submitted for approval. | | SmartApprvlBasisSubmissionId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The previous approval submission used as reference for the auto-approval evaluation. This field is a relationship field. This field is only available with Advanced Approvals enabled. Relationship Name SmartApprvlBasisSubmission Refers To ApprovalSubmission | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description Required. The status of the approval. Valid values are: - Approved - Canceled - Errored - InProgress - Recalled - Rejected - Suspended | | SubmittedById | Type reference Properties Filter, Group, Nillable, Sort, Update Description Required. The ID of the user who submitted the record for approval. This field is a relationship field. Relationship Name SubmittedBy Refers To User | ## 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. [ApprovalSubmissionShare](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. [ApprovalSubmissionHistory](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. # ApprovalSubmissionDetail ApprovalSubmissionDetail contains additional information about operations happening during the approval lifecycle. It will not hold any information that’s already captured in the existing ApprovalSubmission and ApprovalWorkItem entities. This object is available in API version 62.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() update() ## Special Access Rules This object is available in Enterprise, Performance, Unlimited, and Developer Editions for users with access to the Approval Submission object. ## Fields | Field | Details | | --- | --- | | ActionChannelName | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The name of the channel where the action was performed. Valid values are: - Agent: This value is available with ITSM - ApprovalRecord - Email - InvocableAction - ScreenFlow - Slack - System | | ActionContext | Type string Properties Filter, Group, Nillable, Sort, Update Description The context of the action taken for the item assigned for approval. For example, if the approval has been reassigned the string would be Reassigned from User Id - . | | ActionName | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The action taken for the item assigned for approval. Valid values are: - Cancel - Override - Reassign - Recall - Review | | ActionPerformedById | Type reference Properties Filter, Group, Nillable, Sort, Update Description The ID of the user who performed the action on the item submitted for approval. This field is a relationship field. Relationship Name ActionPerformedBy Refers To User | | ActionPerformerRole | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The role of the user who performed the action on the item submitted for approval. Valid values are: - Admin - Assignee - Delegate - Submitter - System | | ApprovalSubmissionId | Type reference Properties Filter, Group, Sort Description The approval submission that's associated with the detail record. This field is a relationship field. Relationship Name ApprovalSubmission Relationship Type Master-detail Refers To ApprovalSubmission (the master object) | | ApprovalWorkItemId | Type reference Properties Filter, Group, Nillable, Sort Description The approval assignment associated with the detail record. This field is a relationship field. Relationship Name ApprovalWorkItem Refers To ApprovalWorkItem | | Comments | Type textarea Properties Nillable, Update Description The comments that the user adds when they cancel, review, reassign or recall the request. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The sequentially-generated name of the approval submission detail record, for example ASD-000000026. | ## 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. [ApprovalSubmissionDetailHistory](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. # ApprovalWorkItem Contains run-time information about each step in an approval workflow, such as assignees and their decisions regarding the object's approval. Has a master-detail relationship with ApprovalSubmission. This object is available in API version 61.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() update() ## Special Access Rules This object is available in Enterprise, Performance, Unlimited, and Developer Editions. ## Fields | Field | Details | | --- | --- | | ApprovalChainName | Type string Properties Filter, Group, Nillable, Sort, Update Description The name of the related approval chain. This field is populated when there are multiple approval chains that are run in parallel. This field is only available with Advanced Approvals enabled. | | ApprovalConditionName | Type string Properties Filter, Group, Nillable, Sort, Update Description The name of the condition that assigns the work item to a user or group for approval. | | ApprovalSubmissionId | Type reference Properties Filter, Group, Sort Description The approval submission that's associated with this item. This field is a relationship field. Relationship Name ApprovalSubmission Relationship Type Master-detail Refers To ApprovalSubmission (the master object) | | AssignedToId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The user, group, or queue that was assigned the work item. This field is a polymorphic relationship field. Relationship Name AssignedTo Refers To Group (Type = Regular), Group (Type = Queue), User | | Comments | Type textarea Properties Nillable, Update Description The comments that the user adds when they review or override the work item. | | FlowOrchestrationWorkItemId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The identifier of the associated flow orchestration work item. This field is a relationship field. Relationship Name FlowOrchestrationWorkItem Refers To FlowOrchestrationWorkItem | | IsAutoReviewed | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the work item was auto-reviewed (true) or not (false). The default value is false. This field is only available with Advanced Approvals enabled. | | IsEligibleForAutoApproval | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether custom logic is used for auto-approval of this approval work item (true) or not (false). This field is only available with Advanced Approvals enabled. | | IsEligibleForSmartApproval | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the approval work item is eligible for smart approval (true) or not (false). The default value is false. This field is only available with Advanced Approvals enabled. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The sequentially-generated name of the related record that’s submitted for approval, for example AWI-000000001. | | ParentWorkItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent approval work item. When multiple group members receive child work items, this field links each child to its parent. This field is available in API version 67.0 and later. Relationship Name ParentWorkItem Relationship Type Lookup Refers To ApprovalWorkItem | | RelatedRecordId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The API name of the related record that's submitted for approval. Relationship Name RelatedRecord Refers To The objects that you have access to for approvals. | | RelatedRecordObjectName | Type string Properties Filter, Group, Nillable, Sort, Update Description The name of the related record that's submitted for approval. | | ReviewedById | Type reference Properties Filter, Group, Nillable, Sort, Update Description The identifier of the user that reviewed the work item. This field is a relationship field. Relationship Name ReviewedBy Refers To User | | ReviewedDate | Type dateTime Properties Filter, Nillable, Sort, Update Description The date and time when the work item was reviewed. | | SmartApprovalBasisWorkItemId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The previous approval work item used as a reference for the auto-approval evaluation. This field is a relationship field. This field is only available with Advanced Approvals enabled. Relationship Name SmartApprovalBasisWorkItem Refers To ApprovalWorkItem | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The status of the approval work item. Possible values are: - Approved - Assigned - Canceled - Errored—Error - Recalled - Rejected - Withdrawn | ## 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. [ApprovalWorkItemHistory](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. # ApprovalWorkItemCondition Represents a condition for starting and concluding an approval step that's evaluated as part of the smart approval process. This object is available in API version 64.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules This object is available in Enterprise, Professional, Unlimited, and Developer Editions where Advanced Approvals is enabled with the Modify All Data or the Approval Admin user permission. ## Fields | Field | Details | | --- | --- | | ApprovalWorkItemCriteriaId | Type reference Properties Filter, Group, Sort Description The approval work item criteria associated with the approval work item condition. The approval work item criteria defines the logic by which the approval conditions are evaluated. This field is a relationship field. Relationship Name ApprovalWorkItemCriteria Relationship Type Master-detail Refers To ApprovalWorkItemCriteria (the master object) | | ConditionSequencePosition | Type int Properties Filter, Group, Nillable, Sort, Update Description The order in which the condition is evaluated relative to other conditions that are part of the requirement logic. | | HasEvaluationSucceeded | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the first value (left side) evaluates against the second value (right side) successfully (true) or not (false). The default value is false. | | IsConditionExcluded | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the condition must be excluded from evaluation (true) or not (false) in an auto-approval process. The default value is false. | | LeftValue | Type textarea Properties Nillable, Update Description The first value of the condition that's evaluated against the second value. | | LeftValueDataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The data type of the first operand (left side) in this condition. Possible values are: - Apex - Boolean - Currency - Date - DateTime—Date/Time - MultiSelectPicklist—Multi-Select Picklist - Number - Other - Picklist - Text - Time | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The sequentially-generated name of the approval work item condition record, for example AWCO-000000071. | | OperatorType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The operator for the condition. Possible values are: - Contains - EndsWith - Equal - GreaterThan - GreaterThanOrEqualTo - HasError - In - IsBlank - IsChanged - IsEmpty - IsNull - LessThan - LessThanOrEqualTo - None - NotEqualTo - NotIn - StartsWith - WasSelected - WasSet - WasVisited | | RightValue | Type textarea Properties Nillable, Update Description The second value (right side) of the condition that's evaluated against the first value. | | RightValueDataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The data type of the second operand for the condition. Possible values are: - Apex - Boolean - Currency - Date - DateTime—Date/Time - MultiSelectPicklist—Multi-Select Picklist - Number - Other - Picklist - Text - Time | # ApprovalWorkItemCriteria Represents the logic by which a smart approval request is evaluated. This object is available in API version 64.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules This object is available in Enterprise, Professional, Unlimited, and Developer Editions where Advanced Approvals is enabled with the Modify All Data or the Approval Admin user permission. ## Fields | Field | Details | | --- | --- | | ApprovalStepApiName | Type string Properties Filter, Group, Sort, Update Description The unique API name of the approval step that uses the logic in the approval work item criteria. | | ApprovalWorkItemId | Type reference Properties Filter, Group, Sort Description The parent approval work item associated with the approval work item criteria. This field is a relationship field. Relationship Name ApprovalWorkItem Relationship Type Master-detail Refers To ApprovalWorkItem (the master object) | | CriteriaType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether the requirement logic is for an entry or exit condition. Possible values are: - Entry - Exit | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The sequentially-generated name of the approval work item criteria record, for example AWCR-000000071. | | RequirementLogic | Type string Properties Filter, Group, Nillable, Sort, Update Description The requirement logic of all entry or exit conditions. | # AppTabMember Represents the list of tabs for each of the available apps. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field Name | Details | | --- | --- | | AppDefinitionId | Type string Properties Filter, Nillable, Sort Description The ID of the AppDefinition object. This is a relationship field. Relationship Name AppDefinition Relationship Type Lookup Refers To AppDefinition | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description A unique virtual Salesforce ID for the color. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description The number used to sort this tab in the application. | | TabDefinitionId | Type string Properties Filter, Nillable, Sort Description The ID of the TabDefinition object. This is a relationship field. Relationship Name TabDefinition Relationship Type Lookup Refers To TabDefinition | | WorkspaceDriverField | Type string Properties Filter, Group, Nillable, Sort Description Refers to the workspace mapping in the CustomApplication Metadata API object. | # ApptBundleAggrDurDnscale Sums the duration of the bundle members, reduced by a predefined percentage. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Field Service must be enabled. - Bundling must be enabled in the Field Service Settings. - The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled. ## Fields | Field | Details | | --- | --- | | BundleAggregationPolicyId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent appointment bundle aggregation policy. This is a relationship field. Relationship Name BundleAggregationPolicy Relationship Type Lookup Refers To ApptBundleAggrPolicy | | FromBundleMemberNumber | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The number of the first bundle member to which the downscale is applied. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | MaxReduction | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum reduction that can be applied to a bundle member. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the appointment bundle aggregation downscale policy. | | PercentageOfReduction | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The percentage of duration reduction. | | ToBundleMemberNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of the last bundle member to which the downscale is applied. | # ApptBundleAggrPolicy Policy that defines how the property values of the bundle members are aggregated and assigned to the bundle. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Field Service must be enabled. - Bundling must be enabled in the Field Service Settings. - The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled. ## Fields | Field | Details | | --- | --- | | AggregationAction | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The aggregation action to be performed. Possible values are: All default and custom Service Appointment fields. | | AggregationFieldType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The target field type in the bundle to which the aggregation is directed. Possible values are: - Boolean - Date - Numeric - Picklist - Picklist-Multi - Skills - String | | AggregationOrder | Type int Properties Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update Description The order the aggregation is triggered. | | BundleFieldName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Name of the target field in the bundle where the value is taken from the bundle member. Possible values are: All default and custom Service Appointment fields. | | BundleMemberAddiFieldName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Name of an additional source field that is connected to the initial source field in the bundle member from which the value is taken. Possible values are: All default and custom Service Appointment fields. | | BundleMemberFieldName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Name of the source field in the bundle member from which the value is taken. Possible values are: All default and custom Service Appointment fields. | | BundlePolicyId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent bundle policy. This is a relationship field. Relationship Name BundlePolicy Relationship Type Lookup Refers To ApptBundlePolicy | | ConstantValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The constant value that is used in the aggregation. | | DateValue | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents how the date value will be determined. Possible values are: - End of Day - Now - Null - Start of Day | | DoesAllowDuplicateStrings | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if you want to allow the same string to appear more than once when using the 'Sum based on Bundle Members' action type. | | DownscaleSortDirection | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Applies only if the Set Downscaled Duration action is set. The downscaling sorting direction of the bundle member service appointments, according to their duration. Possible values are: - Ascending - Descending | | FilterCriteriaId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The active recordset filter criteria used for aggregating the bundle members. This is a relationship field. Relationship Name FilterCriteria Relationship Type Lookup Refers To RecordsetFilterCriteria | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | MaxBundleDuration | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum bundle duration that can be accumulated from the bundle members (after downscaling). | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the appointment bundle aggregation policy. | | ShouldUpdateOnCreationOnly | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if you want to update the field in the bundle only when it is created. | # ApptBundleConfig Represents the general parameters that define the behavior of the bundle. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Field Service must be enabled. - Bundling must be enabled in the Field Service Settings. - The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled. ## Fields | Field | Details | | --- | --- | | AddToBundleStatuses | Type multipicklist Properties Create, Defaulted on create, Filter, Nillable, Update Description The statuses of service appointment that are allowed to be bundled. Possible values are: - Accepted - Canceled - Cannot Complete - Completed - Dispatched - In Progress - None - Rejected - Scheduled The default value is None. | | BundleStatusesToPropagate | Type multipicklist Properties Create, Defaulted on create, Filter, Nillable, Update Description The bundle statuses that when updated are inherited by the bundle members. Possible values are: - Accepted - Canceled - Cannot Complete - Completed - Dispatched - In Progress - None - Rejected - Scheduled The default value is None. | | CriteriaForAutoUnbundlingId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The criteria that causes a bundle service appointment to be unbundled. This is a relationship field. Relationship Name CriteriaForAutoUnbundling Relationship Type Lookup Refers To RecordsetFilterCriteria | | DoesAddTravelTime | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If the bundle members aren’t in the same location, add travel time between them to the bundle’s duration according to their sort order. The default value is false. | | DoesDeleteEmptyBundles | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If the bundle has no remaining bundle members, the bundle is deleted. | | EmptyBundleStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The status from the Canceled category that a bundle service appointment changes to if it has no remaining bundle members, but still appears in the appointment list. Possible values are determined by the org’s statuses. The default value is None. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | MemberStatusesNotToPropagate | Type multipicklist Properties Create, Defaulted on create, Filter, Nillable, Update Description The bundle member statuses that aren’t overridden when the bundle's status is updated. Possible values are: - Accepted - Canceled - Cannot Complete - Completed - Dispatched - In Progress - None - Rejected - Scheduled The default value is None. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Appointment Bundle Config. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RemoveFromBundleStatuses | Type multipicklist Properties Create, Defaulted on create, Filter, Nillable, Update Description The statuses of service appointments that are allowed to be removed from a bundle. Possible values are: - Accepted - Canceled - Cannot Complete - Completed - Dispatched - In Progress - None - Rejected - Scheduled The default value is None. | | StatusOnRemovalFromBundle | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The status that a service appointment is given when it’s removed from a bundle. Possible values are: - Accepted - Canceled - Cannot Complete - Completed - Dispatched - In Progress - None - Rejected - Scheduled The default value is None. | | StatusesNotToUpdateOnUnbundle | Type multipicklist Properties Create, Defaulted on create, Filter, Nillable, Update Description The statuses that aren’t updated when a bundle is unbundled. Possible values are: - Accepted - Canceled - Cannot Complete - Completed - Dispatched - In Progress - None - Rejected - Scheduled The default value is None. | # ApptBundlePolicy Policy that defines how the bundling of service appointments should be handled. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Field Service must be enabled. - Bundling must be enabled in the Field Service Settings. - The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled. ## Fields | Field | Details | | --- | --- | | BundleEndTimeFieldName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If IsTimeCalcByBundleDurationField is true, this field represents the name of the field used for entering the end time of the bundle. | | BundleStartTimeFieldName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If IsTimeCalcByBundleDurationField is true, this field represents the name of the field used for entering the start time of the bundle. | | CanAllowSchleDepndInBundle | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description This field is reserved for future use. | | ConstantTimeValue | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description If IsTimeCalcByBundleDurationField is true, this field represents the total time of the bundle as a preset constant value. | | FilterCriteriaId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The active recordset filter criteria used for the bundle members. Only service appointments that meet the criteria can be bundled. This is a relationship field. Relationship Name FilterCriteria Relationship Type Lookup Refers To RecordsetFilterCriteria | | IsAutomaticBundling | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the policy is relevant for automatic bundling. | | IsManualBundling | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the policy is relevant for manual bundling. The default value is ‘false’. | | IsTimeCalcByBundleDurationFld | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the bundle’s duration is validated. If true, the bundle’s start time is subtracted from the bundle’s end time. If the result is a negative value, it uses ConstantTimeValue as the bundle’s duration. The default value is ‘false’. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | LimitAmountOfBundleMembers | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The maximum number of bundle members that can be included in a bundle. | | LimitDurationOfBundle | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum duration of a bundle. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the bundle policy. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Priority | Type int Properties Create, Filter, Group, idLookup, Sort, Update Description The priority level that this bundle policy should be given when the bundle policies are analyzed using the automatic mode. | # ApptBundlePolicySvcTerr Represents a link between the BundlePolicy and the ServiceTerritory. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Field Service must be enabled. - Bundling must be enabled in the Field Service Settings. - The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled. ## Fields | Field | Details | | --- | --- | | BundlePolicyId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent bundle policy. This is a relationship field. Relationship Name BundlePolicy Relationship Type Lookup Refers To ApptBundlePolicy | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the appointment bundle service territory. | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service territory. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | # ApptBundlePropagatePolicy Policy that defines which property values are inherited from the bundle to the bundle members or are assigned as constant values in the bundle members. 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 - Field Service must be enabled. - Bundling must be enabled in the Field Service Settings. - The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled. ## Fields | Field | Details | | --- | --- | | AdditionalConstantValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The additional constant value that is connected to the initial constant value to be added to the bundle members. | | BundleFieldName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Name of the source field in the bundle from which the value is taken. Possible values are: All default and custom Service Appointment fields. | | BundleMemberFieldName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Name of the target field in the bundle member where the value is inherited from the bundle. Possible values are: All default and custom Service Appointment fields. | | BundlePolicyId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent bundle policy. This field is a relationship field. Relationship Name BundlePolicy Relationship Type Lookup Refers To ApptBundlePolicy | | ConstantValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The constant value to be added to the bundle members. | | DateValue | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents how the date value is determined. Possible values are: - End of Day - Now - Null - Start of Day | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the appointment bundle propagation policy. | | ShouldAddConstantValue | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if you want to enable adding a constant value to the bundle members. | | ShouldUpdateOnAdd | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if you want to enable updating the fields of the bundle members when they are added to the bundle. | | ShouldUpdateOnRemove | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if you want to enable updating the fields of the bundle members when they are removed from the bundle. | | ShouldUpdateOnUnbundle | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if you want to enable updating the fields of the bundle members when performing the Unbundle action. | # ApptBundleRestrictPolicy Policy that defines the restrictions that are considered while forming a bundle. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Field Service must be enabled. - Bundling must be enabled in the Field Service Settings. - The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled. ## Fields | Field | Details | | --- | --- | | BundlePolicyId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent bundle policy. This is a relationship field. Relationship Name BundlePolicy Relationship Type Lookup Refers To ApptBundlePolicy | | DoesAllowEmpty | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Allows a bundle member service appointment with an empty Restriction Field Name to be bundled. | | DoesRestrictAutomaticMode | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if you want to apply this restriction when using the automatic mode. | | DoesRestrictManualMode | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if you want to apply this restriction when using the manual mode. | | IsRestrictByDateOnly | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if you want the bundle to be restricted according to the calendar date only, ignoring the time of day. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the appointment bundle restriction policy. | | RestrictionFieldName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Name of the field in the service appointment used for applying the restriction. Possible values are: All default and custom Service Appointment fields. | # ApptBundleSortPolicy Policy that defines the properties by which the bundle members are sorted within the bundle. Can also be used in the automatic mode for determining the order of the automatic selection of bundle members. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Field Service must be enabled. - Bundling must be enabled in the Field Service Settings. - The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled. ## Fields | Field | Details | | --- | --- | | BundlePolicyId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent bundle policy. This is a relationship field. Relationship Name BundlePolicy Relationship Type Lookup Refers To ApptBundlePolicy | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the appointment bundle sort policy. | | SortDirection | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The order of the appointments in a bundle Possible values are: - Ascending - Descending | | SortFieldName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Name of the field in the service appointment used for sorting the bundle members. Possible values are: All default and custom Service Appointment fields. | | SortOrder | Type int Properties Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update Description The order of fields used for sorting the bundle members. | | SortType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The applied sort type for arranging the bundle. Sort for Automatic Bundling defines the order that automated bundling uses to examine the candidate service appointments to be bundled. Sort Within a Bundle defines the order of bundle members. It’s also used when you unbundle to define the order that the service appointments are scheduled on the Gantt. Possible values are: - SortForAutomaticBundling—Sort For Automatic Bundling - SortWithinaBundle—Sort Within a Bundle | # AppUsageAssignment Provides application context for a record. A record can have different allowed actions or different related objects when it’s created for different applications. For example, a Revenue Lifecycle Management order has a related RevenueLifecycleManagement AppUsageAssignment, so Salesforce knows it can create assets for that order. Available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AppUsageType | Type string Properties Create, Filter, Group, Sort Description The application context for the record. Allowed values are determined by the available licenses. For example, the RevenueLifecycleManagement and BuyNow AppUsageTypes are available with the Subscription Management license. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Autogenerated name for the AppUsageAssignment. | | RecordId | Type reference Properties Create, Filter, Group, Sort Description The record that the AppUsageAssignment provides context for. For example, the order record. This is a relationship field. Relationship Name Record Relationship Type Lookup Refers To - Order in API version 58.0 and later - Asset, Contract, Quote in API version 59.0 and later - WebCart in API version 60.0 and later - OrderSummary in API version 61.0 and later | # ArchiveActivity Represents metadata retrieved for a single archive process initiated by an action. Retrieved metadata can include status tracking, start and end times, record counts, and monitoring and auditing outcomes. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules This object is Read-Only and can't be deleted. Storage consumed by this object doesn't count toward your org's data storage limits. ## Fields | Field | Details | | --- | --- | | ArchivePolicyId | Type reference Properties Filter, Group, Sort Description ID of the associated policy that triggered the process. Links each execution back to its configuration. | | AttemptedRootRecordsCount | Type long Properties Filter, Sort Description The number of root records that the action tried to process. Excludes records that were filtered out before processing. The field type changed from int to long in API version 67.0. | | EndTime | Type dateTime Properties Filter, Sort Description The date and time that the process completed successfully or was terminated. | | FailedCount | Type long Properties Filter, Sort Description The number of records that failed to process due to errors, such as validation failures, missing references, or system exceptions. The field type changed from int to long in API version 67.0. | | FailureReason | Type textarea Properties Filter, Group, Sort Description The reason that the process failed or didn't complete successfully. Can contain system error messages, stack traces, or policy enforcement details. The field type changed from string to textarea in API version 67.0. | | Name | Type string Properties Filter, Group, Sort Description The name of the action instance. | | ProgressIcon | Type string Properties Filter, Sort Description Progress indicator with color coding. This field is a calculated field. Available in API version 67.0 and later. | | ProgressPercentage | Type double Properties Filter, Sort Description The percentage of records processed successfully. | | RecordsSizeInMb | Type string Properties Filter, Sort Description Estimated total size, in megabytes (MB), of the records processed during an action, including metadata and payload. The field type changed from double to string in API version 67.0. | | RootEntityName | Type string Properties Filter, Sort Description The API name of the Salesforce object that was archived, purged, or processed. Available in API version 67.0 and later. | | SkippedRootRecordsCount | Type long Properties Filter, Sort Description The number of root records skipped due to validation errors, exclusion filters, or data protection thresholds. The field type changed from int to long in API version 67.0. | | StartTime | Type dateTime Properties Filter, Sort Description The date and time that the action started. | | Status | Type picklist Properties Filter, Group, Sort Description Status of the current activity. Valid values are: - Aborted—Process manually aborted during policy run. - Aborting—The Aborted process started. - API limit reached—Process stopped because it exceeded API rate limits or usage thresholds. Available in API version 67.0 and later. - Archive Timeout—Process automatically stopped because it took too long to execute a specific task, or the entire run. - Completed—Process completed successfully, and all records were processed. - Ended—Process finished execution. Available in API version 67.0 and later. - Ended with Delete Failures—Process completed, but failed to delete one or more items. - Ended with Errors—Process finished, but some records weren't processed. A CSV of the failed records can be downloaded from the Execution Details‌ page. - Failed—Process failed, and no records were archived. A CSV of the failed records is available on the Activities tab. - No Records—Process found no records matching the policy criteria. - Pending—Process is queued and waiting for execution. - Process Exceeds 23h—Activity started and ran successfully until it reached a time limit. When a policy is set to run daily, this status indicates partial success before exceeding the time limit. - Process Exceeds 120h—Activity started and ran successfully until it reached a time limit. When a policy is set to run one time in a five-day period, this status indicates partial success before exceeding the time limit. - Process Exceeds 168h—Activity started and ran successfully until it reached a time limit. When a policy is set to run weekly, this status indicates partial success before exceeding the time limit. - Query Timeout—Process stopped because the database query took too long. - Running—Process is actively executing its tasks. - Skipped—Process was bypassed and did not execute. Available in API version 67.0 and later. - Started—Process is running. - Too Many Failures—Process was abandoned after too many records failed to read or delete. | | SucceededCount | Type long Properties Filter, Sort Description The number of records processed successfully. The field type changed from int to long in API version 67.0. | | TotalRecordCount | Type long Properties Filter, Sort Description The total number of records initially selected for processing, including successful, failed, and skipped records. The field type changed from int to long in API version 67.0. | | Type | Type picklist Properties Filter, Group, Sort Description Specifies the type of archive process to be executed. This static enum categorizes the purpose or mode of the run. Valid values are: - Analyzer - Archive - Archive-fail-to-delete - Estimate - Export - Export-and-download - Export-to-external-bucket - Import-data-archive - Import-data-load - Index-request - None - Purge - Purge-by-retention - Purge-estimation - RTBF-SDK - Unarchive - Unarchive-retry - Unarchive-sdk - Mask-sdk—Available in API version 67.0 and later. | # ArchivePolicyDefinition Represents a data lifecycle policy in Salesforce. Each record defines the scope, frequency, and rules that govern automated archiving or purging of records from a root entity, such as Contact or Lead. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Create, update, and delete operations are restricted to the Archive Admin profile. All other profiles have read-only access to this object. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important In API version 68.0, changes to ArchivePolicyDefinition records through the API don't affect policy execution. This object provides a representation of each policy for auditing and reporting. Archiving and purging behavior is controlled solely through the policy setup flow on the Archive Policies tab. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Archive policies created before API version 68.0 can show incomplete field values on the ArchivePolicyDefinition object. The Archive back end is the source of truth for these policies, and their field values aren't copied to this object in version 68.0. Policies created in version 68.0 or later show complete field values. ## Fields | Field | Details | | --- | --- | | ArchivePolicyRelObjSelection | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines the policy object selection method. Available in API version 68.0 and later. Valid values are: - CompleteHierarchy—Archives all related objects. - CustomSelection—Specifies which related objects to include using the RelatedObjects field. - SingleLevel—Archives only the root entity records without related objects. | | ContentDocumentObject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of the Salesforce content object to include when IsArchiveRelatedFiles is enabled. If the root object is ContentDocument, this field specifies the secondary object used to filter which content documents to archive. For example, archive only content documents attached to Cases or Accounts. Available in API version 68.0 and later. | | DataProtectionThreshold | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies a retention buffer, in days, during which recently updated or sensitive records aren't archived or deleted. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The purpose or scope of the policy. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the policy. This name must be unique in Salesforce, begin with a letter, and contain only underscores and alphanumeric characters. | | FilterConditions | Type textarea Properties Create, Nillable, Update Description Additional Salesforce Object Query Language (SOQL) filter conditions that refine which records are eligible for archiving or purging. These conditions are appended to the Query field using AND logic. Available in API version 68.0 and later. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the policy is active and eligible for execution. Only active policies can run through scheduled or manual processes. The default value is false. | | IsAnalyzed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the policy has been analyzed by the Archive Storage Analyzer. The default value is false. When set to true, the policy has undergone analysis to optimize storage and performance. Available in API version 68.0 and later. | | IsArchiveRelatedFiles | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether to archive related files along with the root entity records. When set to true, any attached files or attachments are archived when a root record or any of its child records are archived. When set to false, files aren't archived. The default value is false. Available in API version 68.0 and later. | | IsBoostEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether performance boosting is enabled for this policy. When set to true, the policy runs eight parallel activities to improve execution speed. The default value is false. Available in API version 68.0 and later. | | IsLogFailuresAndContinue | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether to log individual record failures and continue processing or to roll back the entire transaction on error. When set to true, if a deletion fails, the archived record remains in production. A duplicate record then exists in both the archive and production environments. This option is recommended when archive jobs involve root records with more than 800 related objects. When set to false, any failure rolls back the entire transaction. The default value is false. Available in API version 68.0 and later. | | IsSoftDeleted | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the policy has been soft deleted. Soft deleted policies are marked for deletion but not removed permanently. The default value is false. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for this policy. This value is the policy name that you enter. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Reserved for internal use. This field is null for Archive policies in core Salesforce. It's populated only if the policy is part of an installed managed package, enabling policy deployment and copying to other orgs. Available in API version 68.0 and later. | | PreviewFields | Type textarea Properties Create, Nillable, Update Description Semicolon-separated list of field API names displayed in the Preview Table. The Preview feature runs the policy's SOQL query and shows matching records with the fields specified here. For example, Id;Description;Name. Available in API version 68.0 and later. | | Query | Type textarea Properties Create, Nillable, Update Description A complete SOQL query that defines the set of records to archive or purge based on the policy rules. Determines which records are eligible for processing. | | QueryLimit | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of root records this policy can process in a single run. | | RelatedObjects | Type textarea Properties Create, Nillable, Update Description JSON object that specifies which related objects to include in archive operations when ArchivePolicyRelObjSelection is set to CustomSelection. The relationships array lists each parent-to-child relationship to archive. In each entry, childName is the child object to archive, parentObject is the object it's related to, and fieldName is the lookup or master-detail field on the child object that references the parent. For example: {"relationships":\[{"parentObject":"Account","childName":"Case","fieldName":"AccountId"},{"parentObject":"FeedItem","childName":"FeedAttachment","fieldName":"RecordId"}\]}. Leave empty when using the CompleteHierarchy selection method. To identify valid relationship fields, query the object metadata to find lookup or master-detail fields that reference the parent object. Available in API version 68.0 and later. | | RetentionMonths | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of months to retain archived records before they are eligible for permanent deletion. This value is added to RetentionYears to calculate the total retention period. For example, if RetentionYears is 3 and RetentionMonths is 6, records are retained for 3 years and 6 months (42 months total). Valid values are 0 through 11. Available in API version 68.0 and later. | | RetentionSource | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the source date used to calculate the retention period for archived records. Available in API version 68.0 and later. Accepted values are: - ArchivedDate—Retention period starts from when the record was archived. This value is the default. - CreatedDate—Retention period starts from when the record was originally created. - LastModifiedDate—Retention period starts from when the record was last modified. | | RetentionYears | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of years to retain archived records before they are eligible for permanent deletion. This value is added to RetentionMonths to calculate the total retention period. For example, if RetentionYears is 3 and RetentionMonths is 6, records are retained for 3 years and 6 months (42 months total). Valid values are 0 or greater. Available in API version 68.0 and later. | | RootEntityName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the Salesforce object targeted by the policy. | | RunFrequency | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies how often the policy runs—manually or on a regular interval. Enables automation for recurring data lifecycle operations. Valid values are: - Daily - Monthly - None—For manual policy runs. - Weekly | | Schedule | Type textarea Properties Create, Nillable, Update Description JSON object that represents when the policy runs, based on the RunFrequency setting. It specifies the frequency, the day of the week or month, and the time of day in UTC (Coordinated Universal Time). The Archive UI displays this time translated to the time zone of your Salesforce org. For example, this schedule represents a policy that runs on the second day of every month at 01:00 UTC: {"frequency":"Monthly","day\_of\_month":2,"time\_to\_schedule":"01:00"}. For a weekly schedule, the day of the week is a number from 0 through 6, where 0 represents Sunday. This field is null when RunFrequency is set to None. Available in API version 68.0 and later. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Process type that the policy executes. Valid values are: - Archiving - Import - None - Purge | # Article Type\_\_DataCategorySelection A data category selection represents a data category that classifies an article. This object is available in API version 19.0 and later. This object can be used to associate an article with data categories from a data category group or to query the category selections for an article. The object name is variable and has a syntax of Article Type\_\_DataCategorySelection, where Article Type is the Object Name for the article type associated with the article. For example, Offer\_\_DataCategorySelection represents the association between the Offer article type and its data categories. Every article is associated with an article type. ## Supported Calls create(), delete(), describeSObjects(), query(), getDeleted(), retrieve() ## Special Access Rules Knowledge must be enabled in your org. Not available in Lightning Knowledge. Users can only access, create or delete data category selection visible to their role, permission set, or profile. If a user has partial visibility on an article's categorization, only the visible categories are returned. ## Fields | Field Name | Details | | --- | --- | | DataCategoryGroupName | Type DataCategoryGroupReference Properties Create Description Unique name of the data category group which has categories associated with the article. | | DataCategoryName | Type DataCategoryGroupReference Properties Create Description Unique name of the data category associated with the article. | | ParentId | Type reference Properties Create, Filter Description ID of the article associated with the data category selection. | ## Usage Every article in Salesforce Knowledge can be categorized. A data category selection represents a category that has been selected to classify an article. You can use the Article Type\_\_DataCategorySelection object to query and manage article categorization in your org. Client applications can create a categorization for an article with a Draft status. They can also delete and query article categorizations. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When using Article Type\_\_DataCategorySelection to classify an article, you can't select both a category (for example USA) and one of its descendants (California) or ascendant categories (North America). In this case, only the first category is selected. Answers zones use QuestionDataCategorySelection to classify questions. ## SOQL Sample The following SOQL query returns the data category selections used to classify the article whose ID is ka0D000000005ApIAI. SELECT Id,DataCategoryName, ParentId FROM Offer\_\_DataCategorySelection WHERE ParentId='ka0D000000005ApIAI' This clause only returns category unique names. To retrieve category labels use the following clause: SELECT Id,toLabel(DataCategoryName), ParentId FROM Offer\_\_DataCategorySelection WHERE ParentId='ka0D000000005ApIAI' ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip You can also use relationship queries to retrieve categorizations from an article type. #### See Also - [QuestionDataCategorySelection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_questiondatacategoryselection.htm "A data category selection represents a data category that classifies a question.") # Asset Represents an item of commercial value, such as a product sold by your company or a competitor, that a customer has purchased. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description (Required) ID of the Account associated with this asset. Must be a valid account ID. Required if ContactId isn’t specified. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | Address | Type address Properties Filter, Nillable Description Represents the physical address or geolocation of the asset. | | AssetLevel | Type int Properties Filter, Group, Nillable, Sort Description The asset’s position in an asset hierarchy. If the asset has no parent or child assets, its level is 1. Assets that belong to a hierarchy have a level of 1 for the root asset, 2 for the child assets of the root asset, 3 for their children, and so forth. On assets created before the introduction of this field, the asset level defaults to –1. After the asset record is updated, the asset level is calculated and automatically updated. | | AssetProvidedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account that provided the asset, typically a manufacturer. This field is a relationship field. Relationship Name AssetProvidedBy Relationship Type Lookup Refers To Account | | AssetServicedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account in charge of servicing the asset. This field is a relationship field. Relationship Name AssetServicedBy Relationship Type Lookup Refers To Account | | AssetTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset type associated with the asset. This field is a relationship field. This field is available in API version 62.0 and later for users with the Health Cloud Appointment Management permission set. Relationship Name AssetType Relationship Type Lookup Refers To AssetType | | Availability | Type percent Properties Filter, Nillable, Sort Description The percentage of expected uptime where the asset was available for use. | | AveragetimetoRepair | Type double Properties Create, Filter, Nillable, Sort, Update Description Represents the number of hours it typically takes to repair an asset after a failure. | | AveragetimeBetweenFailure | Type double Properties Create, Filter, Nillable, Sort, Update Description Represents the number of hours that typically elapses before the asset is likely to fail again. | | AverageUptimePerDay | Type double Properties Create, Filter, Nillable, Sort, Update Description The average number of hours per day the asset is expected to be available for use. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city detail for the address. | | ConsequenceOfFailure | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The business impact associated with the asset’s failure. Using this field, you can address the asset’s health and take action using [Flows](https://help.salesforce.com/s/articleView?id=platform.flow.htm&type=5&language=en_US). To enable this field, use Object Manager to update the field availability. Make sure that the field is visible for field-level security and for page layout. To learn more, see [What Determines Field Access](https://help.salesforce.com/s/articleView?id=platform.customize_fieldaccess.htm&type=5&language=en_US). The picklist values aren’t predefined in orgs created before Winter ’22 that aren’t Field Service enabled. This field is available in API version 53.0 and later. Possible values are: - Insignificant - Minor - Moderate - Major - Critical | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required if AccountId isn’t specified. ID of the Contact associated with this asset. Must be a valid contact ID that has an account parent (but doesn’t need to match the asset’s AccountId). This field is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | Country | Type String Properties Create, Filter, Group, Nillable, Sort, Update Description The country detail for the address. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the invoice. The default value is USD. This field is available in API version 55.0 and later. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled. | | CurrentAmount | Type currency Properties Filter, Nillable, Sort Description Reserved for future use. This field is available in API version 50.0 and later. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled. | | CurrentLifecycleEndDate | Type dateTime Properties Filter, Nillable, Sort Description Represents the end of the period shown as current. System-populated field inherited from the end date of the current asset state period. If that field is empty, as with an evergreen subscription, the Current Lifecycle End Date field is also empty. This field is available in API version 50.0 and later. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled. | | CurrentMrr | Type currency Properties Filter, Nillable, Sort Description The asset’s monthly recurring revenue during the current asset state period. System-populated field inherited from the monthly recurring revenue on the current asset state period. If no asset state period is current, the value is 0. Label is Current Monthly Recurring Revenue. This field is available in API version 50.0 and later. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled. | | CurrentQuantity | Type double Properties Filter, Nillable, Sort Description The asset’s quantity during the current asset state period. System-populated field inherited from the quantity on the current asset state period. If no asset state period is current, the value is 0. This field is available in API version 50.0 and later. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the asset. | | DigitalAssetStatus | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Status of digital tracking of the asset. The default picklist includes the following values: - On - Off - Warning - Error | | ExternalIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the matching record in an external system. This field is available in API version 49.0 and later. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address. | | HasLifecycleManagement | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if this asset is a lifecycle-managed asset, otherwise false. You can’t switch an asset to a lifecycle-managed asset or the reverse. This field is system populated. The default value is false. This field is available in API version 50.0 and later. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled. | | InstallDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when the asset was installed. | | IsCompetitorProduct | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this Asset represents a product sold by a competitor (true) or not (false). The default value is false. Its UI label is Competitor Asset. | | IsInternal | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the asset is produced or used internally (true) or not (false). The default value is false. Its UI label is Internal Asset. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the asset was last modified. Its UI label is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the asset was last viewed. | | Latitude | Type double Properties Create, Filter, Group, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address. | | LifecycleEndDate | Type dateTime Properties Filter, Nillable, Sort Description Represents the end of the asset’s lifecycle. System-populated field inherited from the end date of the final asset state period. If that field is empty, as with an evergreen subscription, the lifecycle has no end date. This field is available in API version 50.0 and later. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled. | | LifecycleStartDate | Type dateTime Properties Filter, Nillable, Sort Description Represents the beginning of the asset’s lifecycle. System-populated field inherited from the start date of the earliest asset state period. This field can’t be edited. When a new asset action affects the start date of an asset state period, the period is deleted and a new one is generated. This field is available in API version 50.0 and later. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled. | | LocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset’s location. Typically, this location is the place where the asset is stored, such as a warehouse or van. If you have access to the location entity, it doesn’t necessarily mean you can access the location id field. To access the location, you must have userHasLocation user access. | | Longitude | Type double Properties Create, Filter, Group, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address. | | ManufactureDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the asset was manufactured. This field is available from API version 49.0 and later. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description (Required) Name of the asset. Label is Asset Name. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The asset’s owner. By default, the asset owner is the user who created the asset record. Its UI label is Asset Owner. This field is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset’s parent asset. Its UI label is Parent Asset. This field is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Asset | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code for the address. | | Price | Type currency Properties Create, Filter, Nillable, Sort, Update Description Price paid for this asset. | | PricingSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Pricing source to use when amending or renewing an asset. Valid values are: - LastTransaction—Last Transaction - PriceBookListPrice—Price Book or List Price Available in API version 60.0 and later. | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description (Optional) ID of the Product2 associated with this asset. Must be a valid Product2 ID. Its UI label is Product. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductCode | Type string Properties Filter, Group, Nillable, Sort Description The product code of the related product. | | ProductDescription | Type string Properties Filter, Sort, Nillable Description The product description of the related product. | | ProductFamily | Type picklist Properties Filter, Group, Sort, Nillable Description The product family of the related product. | | PurchaseDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date on which this asset was purchased. | | Quantity | Type double Properties Create, Filter, Nillable, Sort, Update Description Quantity purchased or installed. The Quantity field value isn’t set by Customer Asset Lifecycle Management. Instead, you can populate the field as you need. | | QuantityIncreasePricingType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specify which pricing type to use when the quantity of this asset is increased. Its UI label is Pricing Type for Quantity Increase. This field is available in API version 56.0 and later. This field is available when Revenue Cloud is enabled. Possible values are: - LastNegotiatedPrice—Available in API version 58.0 and later. - ListPrice | | RecordTypeId | Type reference Properties Create, Filter, Group, Sort, Update Description The unique identifier for the asset. This field is a relationship field. Relationship Name RecordType Relationship Type Lookup Refers To RecordType | | Reliability | Type percent Properties Filter, Nillable, Sort Description The percentage of expected uptime where the asset wasn’t subject to unplanned downtime. | | RenewalPricingType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The price used when renewing a subscription. Its UI label is Pricing Type for Renewal. This field is available in API version 55.0 and later. This field is available when Revenue Cloud is enabled. Possible values are: - LastNegotiatedPrice - ListPrice | | RenewalTerm | Type double Properties Create, Filter, Nillable, Sort, Update Description With Renewal Term Unit, defines the default subscription term for renewal quotes. This field is available in API version 55.0 and later. This field is available when Revenue Cloud is enabled. | | RenewalTermUnit | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of time for a subscription term. This field is available in API version 55.0 and later. This field is available when Revenue Cloud is enabled. Possible values are: - Annual—Available in API version 58.0 and later. —UI label is Years. - Months | | SalesStoreId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the RetailStore or WebStore associated with this Asset. This field is a polymorphic relationship field. To access this field, your org must have a Salesforce Order Management license or a B2B Commerce License. This field is available in API v60.0 and later. Relationship Name SalesStore Relationship Type Lookup Refers To RetailStore, WebStore | | SerialNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Serial number for this asset. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state detail for the address. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Customizable picklist of values. The default picklist includes the following values: - Purchased - Shipped - Installed - Registered - Obsolete | | StatusReason | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The explanation of the device status. This field is available from API version 49.0 and later. Possible values are: - Not Ready - Off - Offline - Online - Paused - Standby | | StockKeepingUnit | Type string Properties Filter, Group, Nillable, Sort Description The SKU assigned to the related product. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street detail for the address. | | SumDowntime | Type double Properties Filter, Nillable, Sort Description Accumulated downtime (planned and unplanned), determined as follows: - When only UptimeRecordStart is set, the sum of all downtime from UptimeRecordStart - When UptimeRecordStart and UptimeRecordEnd are set, the sum of all downtime from UptimeRecordStart to UptimeRecordEnd Otherwise, downtime isn’t accumulated. | | SumUnplannedDowntime | Type double Properties Filter, Nillable, Sort Description Accumulated unplanned downtime, determined as follows: - When only UptimeRecordStart is set, the sum of all unplanned downtime from UptimeRecordStart - When UptimeRecordStart and UptimeRecordEnd are set, the sum of all unplanned downtime from UptimeRecordStart to UptimeRecordEnd Otherwise, unplanned downtime isn’t accumulated. | | TotalLifecycleAmount | Type currency Properties Filter, Nillable, Sort Description The total amount of revenue for the asset, including revenue from each stage in the asset lifecycle. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled. | | UptimeRecordEnd | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date until which SumDowntime and SumUnplannedDowntime are accumulated. | | UptimeRecordStart | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date from which SumDowntime and SumUnplannedDowntime are accumulated. | | UsageEndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when usage for this asset ends or expires. | | Uuid | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique ID for the asset. This field is available in API version 49.0 and later. | ## Usage Use this object to track products sold to customers. With asset tracking, a client application can quickly determine which products were previously sold or are currently installed at a specific account. You can also create hierarchies of up to 10,000 assets. For example, suppose that your company wants to renew and upsell opportunities on products sold in the past. Similarly, your company can track competitive products in a customer environment where products can be replaced or swapped out. Asset tracking is also useful for product support, providing detailed information to assist with product-specific support issues. For example, the PurchaseDate or SerialNumber can indicate whether a given product has certain maintenance requirements, including product recalls. Similarly, the UsageEndDate can indicate when the asset was removed from service or when a license or warranty expires. If an application creates an Asset record, it must specify a Name and either an AccountId, ContactId, or both. With REST API, use the getRelatedListInfo function to get information about related lists on the asset. Note that when requesting information about PrimaryAssets, the response is labeled Related Assets, and the response for RelatedAssets is labeled Primary Assets. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, those objects are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. [AssetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 44.0) Change events are available for the object. [AssetFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [AssetHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [AssetOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetownersharingrule.htm "Represents the rules for sharing an Asset with users other than the owner. This object is available in API version 33.0 and later.") Sharing rules are available for the object. [AssetShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetshare.htm "Represents a sharing entry on an Asset. This object is available in API version 33.0 and later.") Sharing is available for the object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # AssetAction Represents a change made to a lifecycle-managed asset. The fields can’t be edited. This object is available in API version 50.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules To use Customer Asset Lifecycle Management APIs, you must have the Access Customer Asset Lifecycle Management APIs permission and Read access to the Asset, Asset Action, Asset Action Source, and Asset State Period objects. ## Fields | Field | Details | | --- | --- | | ActionDate | Type dateTime Properties Filter, Sort Description The date when an asset action change is recorded. This date can differ from the start date of the related asset state period. For example, suppose that a customer cancels a subscription in June, and the subscription expires in October. The date the customer cancels the subscription (June) is the action date of the asset action. The cancellation's effective date (October) is the start date of the asset state period. | | ActualTaxChange | Type currency Properties Filter, Nillable, Sort Description The rollup of actual tax from all asset action sources. This field is populated by the system. Label is **Change in Actual Tax**. This field is a calculated field. | | AdjustmentAmountChange | Type currency Properties Filter, Nillable, Sort Description The rollup of adjustment amount from all asset action sources. This field is populated by the system. Label is **Change in Adjustment Amount**. This field is a calculated field. | | Amount | Type currency Properties Filter, Sort Description The delta in the total asset amount resulting from an asset action. | | AssetActionNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The ID of the asset action. Label is **Name**. | | AssetId | Type reference Properties Filter, Group, Sort Description The ID of the related lifecycle-managed asset. Label is **Asset**. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | CanRollBack | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the last asset action can be rolled back (true). If this property is set to false, the asset and the last asset action can’t be rolled back. The default value is false. This field is available in API version 65.0 and later. | | CategoryEnum | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The business category of the asset action, for use in reporting. Asset action totals are broken out by the picklist values on this required field, and those totals are in turn reflected on assets. These categories are available and aren’t customizable. Label is **Business Category**. Possible values are: - Cancellations - Cross-Sells - Downgrades Indicates a transition to a lower-level version or tier of an asset. - Downsells Indicates a negative quantity amendment or a decreased Line Item total price with no change in quantity. - Initial Sale Indicates that the asset is initially purchased by an account. - Other - Renewals - Swaps Indicates the exchange of one asset for another. Applies to both swapped-out and swapped-in actions. - Terms And Conditions Changes - Transfers Indicates that an asset is transferred from one account to another. - Upgrades Indicates a transition to a higher-level version or tier of an asset. - Upsells Indicates a positive quantity amendment or an increased Line Item total price with no change in quantity. | | EstimatedTaxChange | Type currency Properties Filter, Nillable, Sort Description The rollup of estimated tax from all asset action sources. This field is populated by the system. Label is **Change in Estimated Tax**. This field is a calculated field. | | MrrChange | Type currency Properties Filter, Sort Description The delta in the asset’s monthly recurring revenue resulting from an asset action. For example, suppose that the MRR during an asset state period is $200 and the next asset action adds $100. Then this field’s value is $100. Label is **Change in Monthly Recurring Revenue**. | | ProductAmountChange | Type currency Properties Filter, Nillable, Sort Description The rollup of product amount from all asset action sources. This field is populated by the system. Label is **Change in Product Amount**. This field is a calculated field. | | QuantityChange | Type double Properties Filter, Sort Description The delta in the asset quantity resulting from an asset action. For example, suppose that the asset quantity during an asset state period is 20 and the next asset action adds 10. Then this field’s value is 10. Label is **Change in Quantity**. | | RolledbackAssetAction | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The last asset action rolled back in the current rollback transaction. This field is available in API version 65.0 and later. | | SubtotalChange | Type currency Properties Filter, Nillable, Sort Description The rollup of subtotal from all asset action sources. This field is populated by the system. Label is **Change in Subtotal**. This field is a calculated field. | | Subtype | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The subtype of the action on the asset. Valid values are: - DowngradeFrom—Available in API version 66.0 and later. - DowngradeTo—Available in API version 66.0 and later. - FieldAmendment - Rollback - StartDateAdjustment - SwapIn—Available in API version 66.0 and later. - SwapOut—Available in API version 66.0 and later. - TransferFrom - TransferTo - UpgradeFrom—Available in API version 66.0 and later. - UpgradeTo—Available in API version 66.0 and later. This field is available in API version 65.0 and later. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description The sum of the current and previous asset action amount. This field is populated by the system. This field is a calculated field. | | TotalCancellationsAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Cancellations. This field is populated by the system. | | TotalCrossSellsAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Cross-Sells. This field is populated by the system. | | TotalDowngradesAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Downgrades. This field is populated by the system and is available in API version 66.0 and later. | | TotalDownsellsAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Downsells. This field is populated by the system. | | TotalInitialSaleAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Initial Sale. This field is populated by the system. | | TotalMrr | Type currency Properties Filter, Nillable, Sort Description The sum of the monthly recurring revenue for the current and previous asset action. This field is populated by the system. Label is **Total Monthly Recurring Revenue**. | | TotalOtherAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Other. This field is populated by the system. | | TotalQuantity | Type double Properties Filter, Nillable, Sort Description The sum of the changes in quantity for the current and previous asset action. This field is populated by the system. | | TotalRenewalsAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Renewals. This field is populated by the system. | | TotalSwapsAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Swaps. This field is populated by the system and is available in API version 66.0 and later. | | TotalTermsAndConditionsAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Terms and Conditions Changes. This field is populated by the system. Label is **Total Terms and Conditions Changes Amount**. | | TotalTransfersAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Transfers. This field is populated by the system. | | TotalUpgradesAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Upgrades. This field is populated by the system and is available in API version 66.0 and later. | | TotalUpsellsAmount | Type currency Properties Filter, Nillable, Sort Description The sum of current and previous asset action amounts categorized as Upsells. This field is populated by the system. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The REST API used to generate the asset action. This field is populated by the system. Valid values are: - Cancel - Change - Convert - Generate | # AssetActionSource Represents an optional way to record what transactions caused changes to lifecycle-managed assets. Use it to trace financial and other information about asset actions. This object supports Salesforce order products and work order line items, and transaction IDs from other systems. The fields can’t be edited. This object is available in API version 50.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(). ## Special Access Rules To use Customer Asset Lifecycle Management APIs, you must have the Access Customer Asset Lifecycle Management APIs permission and Read access to the Asset, Asset Action, Asset Action Source, and Asset State Period objects. ## Fields | Field | Details | | --- | --- | | ActualTax | Type currency Properties Filter, Nillable, Sort Description The region-specific tax amount determined at time of the order. This field is not used for price and tax calculations. | | AdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description An adjustment to the product amount, such as a discount. | | AssetActionId | Type reference Properties Filter, Group, Sort Description The related asset action, that is, the change caused by an asset action source transaction. This field is a relationship field. Relationship Name AssetAction Relationship Type Lookup Refers To AssetAction | | AssetActionSourceNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The ID of the asset action source. Label is **Name**. | | BillingReference | Type string Properties Filter, Group, Nillable, Sort Description The ID of the OrderItem or OrderItemDetail record that this AssetActionSource record is created for. | | BillingTerm | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of billing frequency units to combine into a billing period item. This field is available in API version 68.0 and later. | | Discount | Type percent Properties Filter, Nillable, Sort Description The discount, expressed as a percentage, that's applied to the asset. This field is available in API version 62.0 and later. | | DiscountAmount | Type currency Properties Filter, Nillable, Sort Description The discount, expressed as currency, that's applied to the asset. This field is available in API version 62.0 and later. | | EffectiveGrantDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the resources associated with the asset were granted. This field is available in orgs that have Revenue Cloud when Rate Management is enabled. This field is available in API version 62.0 and later. | | EndDate | Type dateTime Properties Filter, Nillable, Sort Description The end date of the service or change. | | EstimatedTax | Type currency Properties Filter, Nillable, Sort Description The estimate of the region-specific tax amount made at time of the transaction. | | ExternalReference | Type string Properties Filter, Group, Nillable, Sort Description The ID of an asset action source transaction originating in a system outside of Salesforce. | | ExternalReferenceDataSource | Type string Properties Filter, Group, Nillable, Sort Description A system outside of Salesforce that contains asset action source transactions. | | LegalEntityId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the legal entity record associated with the asset action source transaction. This field is a relationship field. This field is available in API version 62.0 and later. Relationship Name LegalEntity Relationship Type Lookup Refers To LegalEntity | | ListPrice | Type currency Properties Filter, Nillable, Sort Description List price for the order product. Value is inherited from the associated PriceBookEntry upon order product creation. | | NetUnitPrice | Type currency Properties Filter, Nillable, Sort Description The final adjusted unit price, inclusive of all adjustments, but exclusive of tax. The unit price after all price adjustments are applied. | | ObligatedAmount | Type currency Properties Filter, Nillable, Sort Description When a line amount is prorated, this amount shows the service amount that’s been consumed. | | OriginalLineNumber | Type int Properties Filter, Group, Nillable, Sort Description The number of the original order item detail line. Salesforce uses this information to create a record to amend, renew, or cancel an order. This field is available in API version 64.0 and later. Relationship Name OrderItemDetail Relationship Type Lookup Refers To LineNumber | | PeriodBoundary | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Boundary delimiters for periods. It determines when a period starts and/or ends. Valid values are: - AlignToCalendar - Anniversary - DayOfPeriod - LastDayOfPeriod | | PeriodBoundaryDay | Type int Properties Filter, Group, Nillable, Sort Description The number specifying the day number when Period Boundary is a specific day in a week/month/year. It only applies when PeriodBoundary is set to "day of period.” | | PeriodBoundaryStartMonth | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Field is populated based on input in the StartDate, PeriodBoundary, and PeriodBoundaryDay when BillingFrequency2 is Annual or by manual user entry. Possible values are: 1-January 2-February 3-March 4-April 5-May 6-June 7-July 8-August 9-September 10-October 11-November 12-December | | PricebookEntryId | Type reference Properties Filter, Group, Nillable, Sort Description PricebookEntry is used as a lookup for price information in order to pre-populate OrderItem's ListPrice and UnitPrice. | | PricingTermCount | Type double Properties Filter, Nillable, Sort Description Number of pricing terms is this subscription product. | | ProductAmount | Type currency Properties Filter, Nillable, Sort Description The product amount after the asset action source transaction. | | ProductSellingModelId | Type reference Properties Filter, Group, Nillable, Sort Description Specifies the product selling model type. Foreignkey to ProductSellingModel entity. | | ProrationPolicyId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the ProrationPolicy used for pricing. | | Quantity | Type double Properties Filter, Nillable, Sort Description The product quantity or the change in product quantity after the asset action source transaction. | | ReferenceEntityItemId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of an asset action source transaction originating in Salesforce. The transaction can be an order product or a work order line item. This field is a polymorphic relationship field. Relationship Name ReferenceEntityItem Relationship Type Lookup Refers To OrderItem, WorkOrderLineItem | | SegmentIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the ramp segment associated with the asset action source transaction. The maximum supported length is 255 characters from API version 67.0 and later. This field is available in API version 62.0 and later. | | StartDate | Type dateTime Properties Filter, Nillable, Sort Description The start date of the service or change. | | Subtotal | Type currency Properties Filter, Nillable, Sort Description The sum of the product amount and the adjustment amount. This field is a calculated field. | | TaxTreatmentId | Type reference Properties Filter, Group, Nillable, Sort Description Lookup to Tax Treatment entity. It's used to calculate tax. | | TotalLineAmount | Type currency Properties Filter, Nillable, Sort Description The price of the line before any price adjustments were applied. SalesTransactionItem: ProratedStartingTotal / StartingPriceTotal. Note: TotalPrice is computed using the UnitPrice, which includes discounts (price adjustments), while TotalLineAmount doesn’t include price adjustments. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description Calculated by the pricing engine for ARC. Summation of TotalAdjustmentAmount plus TotalLineAmount for this item. | | TransactionDate | Type dateTime Properties Filter, Nillable, Sort Description The date of a source transaction, such as an order date. | | UnitPrice | Type currency Properties Filter, Nillable, Sort Description The unit price of the item before any discounts or tax calculation. | # AssetAttribute Stores asset attributes to track and analyze asset conditions to improve their uptime. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), update() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Sort Description The ID of the asset. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | AttributeDefinitionId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the attribute definition for this asset attribute. This field is a relationship field. Relationship Name AttributeDefinition Relationship Type Lookup Refers To AttributeDefinition | | AttributeName | Type string Properties Filter, Group, Sort Description The name given to the asset attribute in the UI by the user. | | AttributePicklistValueId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the attribute picklist value if the attribute is a picklist type. This field is a relationship field. Relationship Name AttributePicklistValue Relationship Type Lookup Refers To AttributePicklistValue | | AttributeValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the value of an asset attribute, for example 5-TB storage . | | ExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An auto-generated ID of the attribute record saved in an external system (for example an HBase database). This field is reserved and used for internal purpose. | ## Usage Add asset descriptors to the AssetAttribute object instead of creating multiple custom attributes on an asset. This helps scale to a high asset volume in the system. ## 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. [AssetAttributeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 62.0) Change events are available for the object. #### See Also - [AttributeDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributedefinition.htm "Represents a product, asset, or object attribute, for example, a hardward specification or software detail. This object is available in API version 57.0 and later.") - [AttributePicklist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklist.htm "Represents a custom picklist for an asset attribute. This object is available in API version 57.0 and later.") - [AttributePicklistValue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklistvalue.htm "Represents the values of an asset attribute picklist. This object is available in API version 57.0 and later.") - [RecordsetFltrCritMonitor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordsetfltrcritmonitor.htm "Monitors whether the value of an asset attribute is within the threshold of a recordset filter criteria (RFC). You can monitor one or more RFCs for an Asset. This object is available in API version 57.0 and later.") # AssetContractRelationship Represents a relationship between an asset and a contract. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available in Enterprise, Unlimited, and Developer Editions of Revenue Cloud. ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the asset related to the contract. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | ContractId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the contract related to the asset. This field is a relationship field. Relationship Name Contract Relationship Type Lookup Refers To Contract | | EndDate | Type dateTime Properties Create, Filter, Sort, Update Description The end date and time of the relationship between contract and asset. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. The associated UI label is **Last Modified Date**. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user accessed this record or list view (LastReferencedDate) but didn’t view it. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated number assigned to AssetContractRelationship. (Read Only) | | StartDate | Type dateTime Properties Create, Filter, Sort, Update Description The start date and time of the relationship between contract and asset. | ## 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. [AssetContractRelationshipFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [AssetContractRelationshipHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. # AssetDowntimePeriod Represents a period during which an asset is not able to perform as expected. Downtime periods include planned activities, such as maintenance, and unplanned events, such as mechanical breakdown. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssetDowntimePeriodNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique number of this asset downtime period record. | | AssetId | Type reference Properties Create, Filter, Group, Sort Description The ID of the asset this asset downtime period record is for. | | Description | Type textarea Properties Create, Nillable, Update Description The description of this asset downtime period. | | DowntimeType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of this asset downtime period. Possible values are: - Planned - Unplanned | | EndTime | Type dateTime Properties Create, Filter, Sort, Update Description The time this asset downtime period ended. | | IsExcluded | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether this asset downtime period is excluded from the calculation of accumulated downtime and accumulated unplanned downtime, and therefore not included in availability and reliability calculations. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | StartTime | Type dateTime Properties Create, Filter, Sort, Update Description The time this asset downtime period started. | # AssetOwnerSharingRule Represents the rules for sharing an Asset with users other than the owner. This object is available in API version 33.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## 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 | | --- | --- | | AssetAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. The possible values are: - Read - Edit | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. Cases owned by users in the source group trigger the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the target user or group. Target users or groups are given access. | ## Usage Use this object to manage the sharing rules for assets. General sharing uses this object. #### See Also - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") # AssetRateAdjustment Stores the tier rate adjustments for the asset rate card entries.This object is available in API version 62.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() ## Special Access Rules This object is available in orgs where Revenue Cloud is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of rate adjustment. Valid values are: - Amount—Adjusts rate by using a specific amount. - Override—Adjusts rate by using the override rate. - Percentage—Adjusts rate by using a percentage. | | AdjustmentValue | Type double Properties Create, Filter, Sort, Update Description The value of the adjustment. | | AssetRateCardEntryId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent asset rate card entry record associated with the asset rate adjustment. This field is a relationship field. Relationship Name AssetRateCardEntry Relationship Type Master-detail Refers To AssetRateCardEntry (the master object) | | LowerBound | Type double Properties Create, Filter, Nillable, Sort, Update Description The minimum quantity for the adjustment to be applicable. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the asset rate adjustment. | | UpperBound | Type double Properties Create, Filter, Nillable, Sort, Update Description The maximum quantity for the adjustment to be applicable. | # AssetRateCardEntry Stores the negotiated rate card entries that are associated with an asset in Revenue Cloud. This object is available in API version 62.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() ## Special Access Rules This object is available in orgs where Revenue Cloud is enabled. ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Sort Description The ID of the asset rate card entry record. This field is a relationship field. Relationship Name Asset Relationship Type Master-detail Refers To Asset (the master object) | | BindingObjectFormula | Type string Properties Filter, Group, Nillable, Sort Description The formula that returns the ID of the associated binding object, if specified. If binding object isn't added, the formula returns the asset ID of the asset related to this asset rate card entry. This field is read-only. Available in API version 65.0 and later. | | BindingObjectId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the binding object associated with the asset rate card entry. Available in API version 65.0 and later. This field is a relationship field. Relationship Name BindingObject Refers To Asset | | BindingObjectRateOrder | Type double Properties Create, Filter, Nillable, Sort, Update Description The order that determines the applicable binding object rate when multiple rates are defined for an Anchor binding object within a effective period. Available in API version 65.0 and later. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ID of the binding object associated with the asset rate card entry. Possible values are: - AED - UAE Dirham - AUD - Australian Dollar - BRL - Brazilian Real - CAD - Canadian Dollar - EUR - Euro - GBP - British Pound - INR - Indian Rupee - JPY - Japanese Yen - SEK - Swedish Krona - USD - U.S. Dollar The default value is USD. Available in API version 65.0 and later. | | EndDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the rate card's time period becomes inactive. The rate card becomes inactive at 11:59:00 PM on the end date. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number assigned to the asset rate card entry. Read-only. | | NegotiatedRate | Type double Properties Create, Filter, Sort, Update Description The base negotiated rate used to charge overage consumption. | | RateCardEntryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the rate card entry record containing the catalog rates that's associated with the asset rate card entry. This field is a relationship field. Relationship Name RateCardEntry Refers To RateCardEntry | | RateCardId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the rate card record that's associated with the asset rate card entry. This field is a relationship field. Relationship Name RateCard Refers To RateCard | | RateUnitOfMeasureId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the unit of measure record that's associated with the asset rate card entry. This field is a relationship field. Relationship Name RateUnitOfMeasure Refers To UnitOfMeasure | | StartDate | Type dateTime Properties Create, Filter, Sort, Update Description The date when the rate card's time period becomes active. The rate card becomes active at 12:00:00 AM on the start date. | | UsageResourceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the usage resource record that's associated with the asset rate card entry. This field is a relationship field. Relationship Name UsageResource Refers To UsageResource | # AssetRelationship Represents a non-hierarchical relationship between assets due to an asset modification; for example, a replacement, upgrade, or other circumstance. In Revenue Lifecycle Management, this object represents an asset or assets grouped in a bundle or set. This object is available in API version 41.0 and later. Asset relationships appear in the Primary Assets and Related Assets related lists on asset records in the UI. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Some fields are available only in Revenue Cloud. Field availability is noted in the field detail column. ## Fields | Field Name | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Sort Description The unique identifier of the new asset, which is the asset that is taking the place of the existing asset. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | AssetRelationshipNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the asset relationship. | | AssetRole | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes the position of the main asset relative to the other assets in the relationship. This field is available in API version 58.0 and later. This field is available in orgs with Revenue Cloud. Possible values are: - Add-on—The main asset is an add-on. - Bundle—The main asset is the bundle parent. - Set—The asset is the main asset in the set. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the asset. The default value is USD. | | FromDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the new asset was installed. | | GroupingKey | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Read-only field used to indicate the bundle that an asset belongs to. For example, if two assets have the same GroupingKey value, then it means that the assets are bundled together. This field is available in API v.60.0 and later. This field is available in orgs with Revenue Cloud. | | ProductRelationshipTypeId | Type reference Properties Filter, Group, Nillable, Sort Description The unique identifier of the record that describes the relationship between the main and associated assets. This field is available in API version 58.0 and later. This field is available in orgs with Revenue Cloud. This field is a relationship field. Relationship Name ProductRelationshipType Relationship Type Lookup Refers To ProductRelationshipType | | ProductRelatedComponent | Type reference Properties Filter, Group, Nillable, Sort Description The product related component that’s associated with the asset relationship. This field is a relationship field. This field is available in API 60.0 and later in Revenue Cloud. Relationship Name ProductRelatedComponent Relationship Type Lookup Refers To ProductRelatedComponent | | RelatedAssetId | Type reference Properties Create, Filter, Group, Sort, Update Description The existing asset that is being modified. This field is a relationship field. Relationship Name RelatedAsset Relationship Type Lookup Refers To Asset | | RelatedAssetPricing | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether the price of the related asset is included in the bundle price. Valid values are: - IncludedInBundlePrice - NotIncludedInBundlePrice This field is available in API version 59.0 and later in Revenue Cloud. | | RelatedAssetQtyScaleMethod | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies how the quantity of the related asset changes relative to the quantity of the parent asset. Valid values are: - Constant - Proportional This field is available in API version 59.0 and later in Revenue Cloud. | | RelatedAssetRole | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes the position of the associated asset relative to other assets in the relationship. This field is available in API version 58.0 and later. This field is available in orgs with Revenue Cloud. Valid values are: - Add-on—The main asset is an add-on. - Bundle—The main asset is the bundle parent. - Set—The asset is the main asset in the set. - Simple—The asset is purchased individually and isn’t associated with variations. - Variation Parent——The main asset is the variation parent. | | RelationshipType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of relationship between the existing asset and the new asset. This field comes with three values—Replacement, Upgrade, and Crossgrade—, but you can create more values in Setup. Possible values are: - Crossgrade—The new asset is a crossgrade of an existing asset. For example, changing a subscription to a plan with the same service, but that runs for a longer amount of time. - Replacement—The new asset is replacing an existing asset. For example, a customer’s faulty widget that was under warranty is being replaced with a new one. - Upgrade—The new asset is an upgrade of an existing asset. For example, upgrading a customer’s existing subscription plan to a new plan with more services. The default value is Replacement. | | ToDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the modified asset is uninstalled. | ## 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. [AssetRelationshipChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 62.0) Change events are available for the object. [AssetRelationshipFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [AssetRelationshipHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [AssetRelationshipOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") (API version 58.0) Sharing rules are available for the object. [AssetRelationshipShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") (API version 58.0) Sharing is available for the object. # AssetShare Represents a sharing entry on an Asset. This object is available in API version 33.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Customer Portal users can’t access this object. ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field | Details | | --- | --- | | AssetAccessLevel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Level of access that the User or Group has to the Asset. The possible values are: - Read - Edit - All This value is not valid for creating or deleting records. This field must be set to an access level that is higher than the organization’s default access level for cases. | | AssetId | Type reference Properties Filter, Group, Sort Description ID of the Asset associated with this sharing entry. This field can't be updated. This is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | RowCause | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Manual—The User or Group has access because a user with “All” access manually shared the Asset with them. - Owner—The User is the owner of the Asset. - Rule—The User or Group has access via an Asset sharing rule. - GuestRule—The User or Group has access via an Asset guest user sharing rule. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. | | UserOrGroupId | Type reference Properties Filter, Group, Sort Description ID of the User or Group that has been given access to the Asset. This field can't be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object allows you to determine which users and groups can view and edit Asset records owned by other users. If you attempt to create a new record that matches an existing record, request updates any modified fields and returns the existing record. # AssetStatePeriod Represents a time span when an asset has the same quantity, amount, and monthly recurring revenue (MRR). An asset has as many asset state periods as there are changes to it (asset actions) during its lifecycle. The dashboard and related pages show the current asset state period. The fields can’t be edited. This object is available in API version 50.0 and later. ## Supported Calls createable(), deletable(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), updateable(). ## Special Access Rules Customer Asset Lifecycle Management APIs require the Access Customer Asset Lifecycle Management APIs permission and read access to the Asset, Asset Action, Asset Action Source, and Asset State Period objects. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Createable, Filter, Sort, Updateable Description An asset’s total amount during an asset state period. Revenue Management doesn't set or use this field's value currently. | | ApplUnitPriceUpliftPct | Type percent Properties Create, Filter, Nillable, Sort, Update Description The unit price uplift percent that’s applied to the asset state period, used for ramp pricing. This field is available in API version 68.0 and later. | | AssetId | Type reference Properties Createable, Filter, Group, Sort Description The asset related to an asset state period. Label is **Asset**. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | AssetStatePeriodNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The ID of the asset state period. Label is **Name**. | | BillingFrequency | Type picklist Properties Createable, Filter, Group, Nillable, Restricted picklist, Sort, Updateable Description The time period that indicates how often the line item is billed. Possible values are: - Annual - Monthly - Quarterly - Semi-Annual Available in API version 65.0 and later. | | BindingInstanceTargetId | Type reference Properties Createable, Filter, Group, Nillable, Sort, Updateable Description The ID of a custom product target for a usage-based quote line item, order item, or asset allocation. This field is a polymorphic relationship field. Relationship Name BindingInstanceTarget Refers To Account, Asset, BindingObjectCustomExt, Contract | | Discount | Type percent Properties Createable, Filter, Nillable, Sort, Updateable Description Editable number from 0 to 100. Available in API version 65.0 and later. | | DiscountAmount | Type currency Properties Createable, Filter, Nillable, Sort, Updateable Description The fixed amount discount to apply to the line item. Available in API version 65.0 and later. | | EndDate | Type dateTime Properties Createable, Filter, Nillable, Sort, Updateable Description The end date and time of an asset state period. On an asset that is an evergreen subscription, the last asset state period has no end date. | | LegalEntityId | Type reference Properties Createable, Filter, Group, Nillable, Sort, Updateable Description The ID of the related legal entity. This field is a relationship field. Relationship Name LegalEntity Refers To LegalEntity | | Mrr | Type currency Properties Createable, Filter, Sort, Updateable Description An asset’s monthly recurring revenue during an asset state period. | | PriceRevisionPolicy | Type reference Properties Createable, Filter, Group, Sort, Updateable Description Specifies the price uplift policy associated with this asset state period. This field is a relationship field. This field is available in API version 65.0 and later. Relationship Name Price Revision Policy Relationship Type Lookup Refers To PriceRevisionPolicy | | Quantity | Type double Properties Createable, Filter, Sort, Updateable Description The total quantity of an asset during an asset state period. | | RampIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ramp record used to group order item segments for this asset state period. This field is available in orgs that have Revenue Management with the Ramp Deals setting enabled. The maximum supported length is 255 characters from API version 67.0 and later. This field is available in API version 62.0 and later. | | RampUpliftType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The pricing uplift calculation type for ramp segments. Valid values are: - Compound - Standard This field is available in API version 68.0 and later. | | SegmentIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The order item segment for this asset state period. This field is available in orgs that have Revenue Management with the Ramp Deals setting enabled. The maximum supported length is 255 characters from API version 67.0 and later. This field is available in API version 62.0 and later. | | SegmentName | Type string Properties Createable, Filter, Group, Nillable, Sort, Updateable Description The name of the order item segment for this asset state period. This field is available in orgs that have Revenue Management with the Ramp Deals setting enabled. The maximum supported length is 255 characters from API version 67.0 and later. This field is available in API version 62.0 and later. | | SegmentType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Updateable Description The period for the order item segment for this asset state period. Valid values are: - Custom - Free Trial - Yearly The default value is Yearly. This field is available in orgs that have Revenue Management with the Ramp Deals setting enabled. This field is available in API version 62.0 and later. | | StartDate | Type dateTime Properties Createable, Filter, Sort, Updateable Description The start date and time of an asset state period. | | UnitPrice | Type currency Properties Createable, Filter, Nillable, Sort, Updateable Description The price per unit for the line item. Available in API version 65.0 and later. Revenue Management won't populate this field in API version 66.0 and later. | | UnitPriceUplift | Type percent Properties Createable, Filter, Nillable, Sort, Updateable Description Indicates the percentage increase of a line item's unit price. Available in API version 65.0 and later. | # AssetStatePeriodAttribute Represents a virtual object that holds the key-value pair of the asset attribute in a specified asset state period. This object is a child object of AssetStatePeriod. This object is available in API version 60.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules This object is available in Enterprise, Unlimited, and Developer Editions of Revenue Cloud with the [Access Lifecycle-Managed Assets user permission](https://help.salesforce.com/s/articleView?id=ind.rev_cloud_asset_migration_permission.htm&language=en_US). This object is editable only through API and not the UI. ## Fields | Field | Details | | --- | --- | | AssetStatePeriodId | Type reference Properties Filter, Group, Sort Description The asset state period that's associated with the asset attribute. This field is a relationship field. Relationship Name AssetStatePeriod Relationship Type Master-detail Refers To AssetStatePeriod (the master object) | | AttributeDefinitionId | Type reference Properties Filter, Group, Sort Description The attribute definition that's associated with the asset state period attribute. This field is a relationship field. Relationship Name AttributeDefinition Relationship Type Lookup Refers To AttributeDefinition | | AttributeName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the asset attribute. | | AttributePicklistValueId | Type reference Properties Filter, Group, Nillable, Sort Description The value specified in the picklist type field that corresponds to the attribute in the AttributePicklistValue object. This field is a relationship field. Relationship Name AttributePicklistValue Relationship Type Lookup Refers To AttributePicklistValue | | AttributeValue | Type string Properties Filter, Group, Nillable, Sort Description The value of the asset state period attribute. For example, a shirt can have the value of blue, which indicates the shirt's color, or it can have the value of small, which indicates the shirt's size. You can use this field to filter records only if the DataType value in the related AttributeDefinitionId record is Text. If the DataType value is Picklist, use the value in the AttributePicklistValueId field for filtering. You can’t use this field to filter records if the DataType value is Checkbox, Currency, Date, Datetime, Multipicklist, Number, or Percent. | ## Usage This object doesn’t support custom fields, validation rules, or triggers. In SOQL queries, you can filter records by using Id and AttributeDefinition. You can’t use AttributeValue in the WHERE clause. # AssetTag Associates a word or short phrase with an Asset. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage AssetTag stores the relationship between its parent TagDefinition and the Asset being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. # AssetTokenEvent The documentation has moved to [AssetTokenEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_assettokenevent.htm "HTML (New Window)") in the Platform Events Developer Guide. # AssetWarranty Defines the warranty terms applicable to an asset along with any exclusions and extensions. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Sort Description The ID of the asset this warranty term applies to. | | AssetWarrantyNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The identifier of the asset warranty record. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which this warranty term expires. | | ExchangeType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of exchange offered by this warranty term. | | Exclusions | Type textarea Properties Create, Nillable, Update Description Description of any exclusions. | | ExpensesCovered | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of expenses covered. | | ExpensesCoveredEndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which cover for expenses ends. | | IsTransferable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Defines whether the warranty term can be transferred to a new owner. | | LaborCovered | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of labor covered. | | LaborCoveredEndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which cover for labor ends. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the asset warranty term was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the asset warranty term was last viewed. | | PartsCovered | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of parts covered. | | PartsCoveredEndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which cover for parts ends. | | Pricebook2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the price book item associated with this asset warranty term. | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description The date on which cover under this warranty term starts. | | WarrantyTermId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the warranty term this asset warranty term extends. | | WarrantyType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of the warranty. | ## 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. [AssetWarrantyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") Change events are available for the object. # AssignedResource Represents a service resource who is assigned to a service appointment in Field Service and Lightning Scheduler. Assigned resources appear in the Assigned Resources related list on service appointments. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ActualTravelTime | Type double Properties Create, Filter, Nillable, Sort, Update Description The number of minutes that the service resource needs to travel to the assigned service appointment. You can enter a value with up to two decimal places. | | ApptAssistantInfoUrl | Type textarea Properties Create, Nillable, Update Description The URL that contains the status of the mobile worker approaching the service appointment, the Community URL, and the expiry of the URL. Available in version 51.0 and later. | | AssignedResourceNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the resource assignment. | | EstimatedTravelTime | Type double Properties Create, Filter, Nillable, Sort, Update Description The estimated number of minutes needed for the service resource to travel to the service appointment they’re assigned to. You can enter a value with up to two decimal places. | | LocationStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the mobile worker approaching the service appointment. When the location status changes to one of these values, a status update containing ApptAssistantInfoUrl is sent to the customer. Available in version 51.0 and later. Possible values are: - EnRoute - LastMile | | IsPrimaryResource | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the service resource is a primary resource or not. The default value is false. Available in API version 47.0 and later. | | ServiceAppointmentId | Type reference Properties Create, Filter, Group, Sort Description The service appointment that the resource is assigned to. This is a relationship field. Relationship Name ServiceAppointment Relationship Type Lookup Refers To ServiceAppointment | | ServiceCrewId | Type reference Properties Create, Update, Filter, Group, Sort, Nillable Description The service crew that the resource is assigned to. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Since service resources can represent crews or individuals, appointments are typically assigned to crews in the following way: 1. Create a service resource of the Crew type that represent the crew. 2. Create an assigned resource on the service appointment and select the crew resource in the ServiceResourceId field. As an alternative, you can assign appointments to crew members separately. This lets you track each member’s travel time and see a list of the crew members in the Assigned Resources related list. To take this approach, create an assigned resource for each crew member. List the crew member in the ServiceResourceId field and the crew they belong to in the ServiceCrewId field. | | ServiceResourceId | Type reference Properties Create, Update, Filter, Group, Sort Description The resource who is assigned to the service appointment. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | | Transaction | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last transaction ID of the scheduling and optimization request that updated this object. The transaction ID is automatically generated and populated by the Enhanced Scheduling and Optimization engine. Available in API version 63.0 and later. | ## Usage You can assign multiple service resources to a service appointment. Service resources who are assigned to service appointments cannot be deactivated until they are removed from the appointments. ## 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. [AssignedResourceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [AssignedResourceHistory](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.")(API version 61.0) History is available for tracked fields of the object. [AssignedResourceFeed](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. # AssignmentRule Represents an assignment rule associated with a Case or Lead. ## Supported Calls describeSObjects(), query(), retrieve(), search() ## Special Access Rules - This object is read only. Assignment rules are created, configured, and deleted in the user interface. - Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | Active | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this assignment rule is active (true) or not (false). | | Name | Type string Properties Filter, Group, Nillable, Sort Description Name of this assignment rule. | | SobjectType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of assignment rule—Case or Lead. | ## Usage Before creating or updating a new Case or Lead, a client application can query (by name) the AssignmentRule to obtain the ID of the assignment rule to use, and then assign that ID to the assignmentRuleId field of the AssignmentRuleHeader. The AssignmentRuleHeader can be set using either SOAP API or REST API. Assignment rules can also be specified when creating or upserting Case or Lead objects via the Bulk API or the Bulk 2.0 API. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # Associated Objects (Feed, History, OwnerSharingRule, Share, and ChangeEvent Objects) This section provides a list of objects associated to standard objects and their standard fields. Some fields may not be listed for some objects. To see the system fields for each object, see [System Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/system_fields.htm "System fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example, the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies a record."). To verify the complete list of fields for an object, use a describe call from the API or inspect with an appropriate tool. For example, inspect the WSDL or use a schema viewer. - **[StandardObjectName Feed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm)** _StandardObjectName_Feed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object. - **[StandardObjectName History](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm)** _StandardObjectName_History 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. - **[StandardObjectName OwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm)** _StandardObjectName_OwnerSharingRule 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. - **[StandardObjectName Share](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm)** _StandardObjectName_Share is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object. - **[StandardObjectName ChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm)** A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events. # AssociatedLocation Represents a link between an account and a location in Field Service. You can associate multiple accounts with one location. For example, a shopping center location may have multiple customer accounts. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | ActiveFrom | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time the associated location is active. | | ActiveTo | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time the associated location stops being active. | | AssociatedLocationNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated number identifying the associated location. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the associated location was last modified. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the associated location was last viewed. | | LocationId | Type reference Properties Create, Filter, Group, Sort, Update Description The location associated with the address. This is a relationship field. Relationship Name Location Relationship Type Lookup Refers To Location | | ParentRecordId | Type reference Properties Create, Filter, Group, Sort Description The account associated with the location. This is a relationship field. Relationship Name ParentRecord Relationship Type Lookup Refers To Account | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Picklist of address types. The values are: - Bill To - Ship To | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [AssociatedLocationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [AssociatedLocationHistory](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. # AsyncApexJob Represents an individual Apex sharing recalculation job, a batch Apex job, a method with the future annotation, or a job that implements Queueable or Schedulable. Use this object to query Apex batch jobs in your organization. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules If Apex isn’t running in system mode, users must have the View Setup and Configuration permission to access this object and to enqueue asynchronous Apex jobs. ## Fields | Field Name | Details | | --- | --- | | ApexClassId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Apex class executing the job. Label is Class ID. This is a relationship field. Relationship Name ApexClass Relationship Type Lookup Refers To ApexClass | | CompletedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the job was completed. | | CronTriggerId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the CronTrigger for the AsyncApexJob. This field only applies to ScheduledApex job type. This field is available in API version 53.0 and later. For scheduled jobs created before version 53.0, this field is populated on subsequent execution. This is a relationship field. Relationship Name CronTrigger Relationship Type Lookup Refers To CronTrigger | | ExtendedStatus | Type string Properties Filter, Group, Nillable, Sort Description If one or more errors occurred during the batch processing, this field contains a short description of the first error. A more detailed description of that error, along with any subsequent errors, is emailed to the last user who modified the batch class. This field is available in API version 19.0 and later. | | JobItemsProcessed | Type int Properties Filter, Group, Sort Description Number of job items processed. Label is Batches Processed. | | JobType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of job being processed. Valid values are: - ApexToken - [BatchApex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_batch_interface.htm) - BatchApexWorker - [Future](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_invoking_future_methods.htm) - [Queueable](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_queueing_jobs.htm) - [ScheduledApex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_scheduler.htm) - [SharingRecalculation](https://help.salesforce.com/s/articleView?id=platform.security_apex_sharing_recalc.htm&type=5&language=en_US) - TestRequest - TestWorker | | LastProcessed | Type string Properties Filter, Group, Nillable, Sort Description Last ID that was processed and committed. | | LastProcessedOffset | Type int Properties Filter, Group, Nillable, Sort Description Offset of the last ID that was processed and committed. | | MethodName | Type string Properties Filter, Group, Nillable, Sort Description The name of the Apex method being executed. Label is Apex Method. | | NumberOfErrors | Type int Properties Filter, Group, Nillable, Sort Description Total number of batches with a failure. A batch is considered transactional, so any unhandled exceptions constitute an entire failure of the batch. Label is Failures. | | ParentJobId | Type reference Properties Filter, Group, Nillable, Sort Description For batch Apex jobs that run using chunking implementation, multiple child jobs of type BatchApexWorker are created. Each of these child job records contains the job Id of the parent Apex job that started their execution. For batch Apex jobs that run using a non-chunking implementation, child jobs aren’t created. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the job. Valid values are: - Aborted - Completed - Failed - Holding1 - Preparing - Processing - Queued 1 This status applies to batch jobs in the Apex flex queue. | | TotalJobItems | Type int Properties Filter, Group, Nillable, Sort Description Total number of batches processed. Each batch contains a set of records. Label is Total Batches. | ## Usage Use this object to query Apex batch jobs in your organization. # Asynchronous Report Run Event Type Asynchronous Report Run events are created for reporting requests that are scheduled. This category includes dashboard refreshes, asynchronous reports, schedule reports, and analytics snapshots. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
AVERAGE_ROW_SIZE
Type
Number
Description
The average row size of all rows in the Asynchronous Report Run event, in bytes. A large average size, coupled with a high ROW_COUNT, can indicate that a user is downloading information for fraudulent purposes. For example, a salesperson who downloads all sales leads before departing for a competitor.
Example
700
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DASHBOARD_ID
Type
String
Description
The 15-character ID of the dashboard that was run.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request.
DISPLAY_TYPE
Type
String
Description
The report display type, indicating the run mode of the report.
Possible values are:
  • D—Dashboard
  • S—Show Details
  • H—Hide Details
ENTITY_NAME
Type
String
Description
The name of the object affected by the trigger.
EVENT_TYPE
Type
String
Description
The type of event. The value is always AsynchronousReportRun.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
NUMBER_BUCKETS
Type
Number
Description
The number of buckets that were used in the report.
NUMBER_COLUMNS
Type
Number
Description
The number of columns in the report.
NUMBER_EXCEPTION_FILTERS
Type
Number
Description
The number of exception filters that are used in the report.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
ORIGIN
Type
String
Description
The context in which the report executed, such as from a UI (Classic, Lightning, Mobile), through an API (synchronous, asynchronous, Apex), or through a dashboard.
Possible Values
  • ReportOpenedFromMobileDashboard: Report executed when a user clicked a dashboard component on a mobile device and drilled down to a report.
  • DashboardComponentUpdated: Report executed when a user refreshed a dashboard component.
  • DashboardComponentPreviewed: Report executed from a Lightning dashboard component preview.
  • ReportRunUsingSynchronousApi: Report executed from a synchronous API.
  • ReportRunUsingAsynchronousApi: Report executed from an asynchronous API.
  • ReportRunUsingApexSynchronousApi: Report executed from the synchronous Apex API.
  • ReportRunUsingApexAsynchronousApi: Report executed from the asynchronous Apex API.
  • ReportExported: Report executed from a printable view or report export that was not asynchronous nor an API export.
  • ReportRunFromClassic: Report executed from the Run Report option of Salesforce Classic.
  • ReportRunFromMobile: Report executed from the Run Report option of the mobile Salesforce app.
  • ReportRunFromLightning: Report executed from the Run option in Lightning Experience from a non-mobile browser.
  • ReportRunFromRestApi: Report executed from the REST API.
  • ReportPreviewed: Report executed when a user got preview results while using the report builder.
  • ReportScheduled: Report was scheduled.
  • ProbeQuery: Report executed from a probe query.
  • ReportRunFromReportingSnapshot: Report executed through Snapshot Analytics.
  • ReportExportedAsynchronously: Report was exported asynchronously.
  • ReportExportedUsingExcelConnector: Report was exported using the Excel connector.
  • ChartRenderedOnVisualforcePage: Report executed from a rendered chart on a VisualForce Page.
  • ChartRenderedInEmbeddedAnalyticsApp: Report executed from a rendered chart in an embedded Analytics app.
  • ReportRunAndNotificationSent: Report executed through the notifications API.
  • ChartRenderedOnHomePage: Report executed from a rendered chart on the home page.
  • ReportResultsAddedToWaveTrending: Report executed when a user trended a report in CRM Analytics.
  • ReportAddedToCampaign: Report was added from an Add to Campaign action.
  • ReportResultsAddedToEinsteinDiscovery: Report executed synchronously from Einstein Discovery.
  • Unknown: Report execution origin is unknown.
  • Test: Report execution resulted from a test.
RENDERING_TYPE
Type
String
Description
Describes the format of the report output in Salesforce Classic. If the report was exported in Lightning Experience, this field is blank.
Possible Values
  • W: Web (HTML)
  • E: Email
  • P: Printable
  • X: Excel
  • C: Comma-separated values (CSV)
  • J: JavaScript Object Notation (JSON)
  • D: Dummy data
REPORT_ID
Type
Id
Description
The 15-character ID of the report that was run.
REPORT_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the report that was run.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
ROW_COUNT
Type
Number
Description
The number of rows that were processed in the Asynchronous Report Run event. High row counts, coupled with a high AVERAGE_ROW_SIZE, can indicate that a user is downloading information for fraudulent purposes. For example, a salesperson who downloads all sales leads before departing for a competitor.
Example
150
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
SORT
Type
String
Description
The sort column and order that was used in the report.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # AsyncOperationLog Represents an async operations log containing progress and status information about external synchronizations to the Omnichannel Inventory service. This object is available in API version 51.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ## Special Access Rules This object is only available in Omnichannel Inventory orgs. ## Fields | Field | Details | | --- | --- | | AsyncOperationNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated number assigned to the operation. | | Description | Type string Properties Filter, Group, Nillable, Sort Description Description of the operation. | | Error | Type string Properties Filter, Group, Nillable, Sort Description The error message for the operation. Applies only if the operation has an error. | | ExternalReference | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique external reference ID per type. | | FinishedAt | Type dateTime Properties Filter, Nillable, Sort Description The date and time the operation finished. | | LastStatusUpdateAt | Type dateTime Properties Filter, Nillable, Sort Description The date and time the status of the operation was last updated. | | RelatedRecordId | Type reference Properties Filter, Group, Nillable, Sort Description The related record ID for the async request. This field is available in API version 60.0 and later. This field is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To Asset, OrderItemSummary | | Request | Type textarea Properties Nillable Description The request sent to the external service. | | Response | Type textarea Properties Nillable Description The full response from the external service. | | StartedAt | Type dateTime Properties Filter, Nillable, Sort Description The date and time the operation started. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the operation. Possible values are: - Completed - Error - In Progress - New | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of operation that is being tracked. Possible values are: - CancelAsset—This value is available in API version 60.0 and later. - CreateAsset—This value is available in API version 60.0 and later. - CancelOrderItemSummaries - ImportInventory - LocationManagement - OrderSummaryAdjustmentAggregate | # AsyncOperationTracker Represents the status of an asynchronous request initiated from the Quote, Order, and CreditMemo objects. This object is available in API version 61.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AsyncOperationNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A string that identifies the operation tracked in AsyncOperationTracker. | | CorrelationIdentifier | Type string Properties Filter, Group, Nillable, Sort Description A string that identifies an operation across services. | | ExpiresAt | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when this record will be deleted. | | FailedJobItems | Type int Properties Filter, Group, Nillable, Sort Description The number of items within the job that have failed. | | FinishedAt | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when the asynchronous process completed. | | JobType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of job. Possible values are: - ASMAdServerCheckAvailability. This field is available in API version 66.0 and later. - ASMAdServerIntegration. This field is available in API version 66.0 and later. - ASMAddRelatedEntityToAQL. This field is available in API version 66.0 and later. - ASMApplyMediaPlanTemplateJob. This field is available in API version 66.0 and later. - ASMApplyTargetingTemplateJob. This field is available in API version 66.0 and later. - ASMBulkEditLineItemDetail. This field is available in API version 67.0 and later. - ASMCalcLinearMediaSpotPrc. This field is available in API version 66.0 and later. - ASMCreateAmendQuoteJob. This field is available in API version 66.0 and later. - ASMFileProcessorJob. This field is available in API version 66.0 and later. - ASMLinearSpotGenerationJob. This field is available in API version 67.0 and later. - ASMMediaPlanAsTemplate. This field is available in API version 66.0 and later. - ASMMediaPlanClone. This field is available in API version 66.0 and later. - ASMMediaPlanCopyJob. This field is available in API version 66.0 and later. - AbandonedCart. This field is available in API version 67.0 and later. - AssetizationAsyncJob - AutomatedNegativeInvoiceLineConversion - AutomaticRefunds - CommerceVariationsUpsert - ContextPersistence - CreateCPQContractsJob - CreditMemoDraftToPosted. This field is available in API version 66.0 and later. - CreditMemoRecovery. This field is available in API version 66.0 and later. - DeltaCatalogSyndicationAsyncJob - energyAgreementSetup. This field is available in API version 66.0 and later. - FullCatalogSyndicationAsyncJob - InvoiceBatchRunEmailJob. This field is available in API version 66.0 and later. - InvoiceDocgenJob - InvoiceDocgenPostProcessJob - InvoiceDocgenRetryJob - InvoiceDraftToPosted - InvoiceEstimatedTaxCallout. This field is available in API version 66.0 and later. - LoadSalesRecipientData. This field is available in API version 66.0 and later. - MultisiteAutoQuote. This field is available in API version 66.0 and later. - PearAmendQtyAssets—Initiate Amend Quantity - PearCancelAssets—Initiate Cancellation - PearRenewAssets—Initiate Renewal - PersonalizationRecommender. This field is available in API version 67.0 and later. - PlaceOrder - PlaceOrderPersistSync - PlaceOrderPriceAsync - PlaceOrderTaxAsync - PlaceQuote - PlaceQuotePersistAndPriceSync - PlaceQuotePersistSync - PlaceQuotePriceAsync - PlaceQuoteTaxAsync - PostOrderCampaign. This field is available in API version 67.0 and later. - PreprocessOrder. This field is available in API version 66.0 and later. - PriceRuleDeployment - PriceSheetDeployJob - PSTBaseJob—Top-Level. This field is available in API version 66.0 and later. - PSTConfig—Configuration. This field is available in API version 66.0 and later. - PSTPersist—Save. This field is available in API version 66.0 and later. - PSTPrice. This field is available in API version 66.0 and later. - QuoteToOrderJob - RuleLibraryDeployment - SmsDltTemplateIngestion. This field is available in API version 66.0 and later. - StandaloneBillingSchedulesCreation. This field is available in API version 66.0 and later. - StatementOfAccountGeneration. This field is available in API version 66.0 and later. - StoreRetrieveSyncJob. This field is available in API version 66.0 and later. - TestSerialMessageStepJob. This field is available in API version 66.0 and later. - TransactionLineBom—Create Material Lines - VoidCreditMemo. This field is available in API version 66.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, the user only accessed this record or list view (LastReferencedDate) but not viewed it. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user or group that owns the job. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ParentOperationId | Type reference Properties Filter, Group, Nillable, Sort Description This field is a relationship field. Relationship Name ParentOperation Refers To AsyncOperationTracker | | ReferenceEntityId | Type reference Properties Filter, Group, Nillable, Sort Description Contains the ID of a record associated with the asynchronous request. For example, if the asynchronous request is associated with a credit memo, this field contains the ID of the credit memo. This field is a polymorphic relationship field. Relationship Name ReferenceEntity Refers To CreditMemo, InvoiceBatchRun, Order, Product2, Quote | | Request | Type textarea Properties Nillable Description The payload required to process the async request that’s populated by internal Salesforce services that use the async framework. This field is available in API version 66.0 and later. | | Response | Type textarea Properties Nillable Description Stores the response for each step in the async flow, used in the next steps of the flow until its completion. This field is available in API version 66.0 and later. | | SequenceNumber | Type int Properties Filter, Group, Nillable, Sort Description The sequence number associated with each step of a multiple step job, to define the execution order for the async job flow. This field is available in API version 66.0 and later. | | StartedAt | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when Salesforce started the asynchronous process. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the asynchronous request. Possible values are: - Completed - CompletedWithFailures - Failure - InProgress - Submitted | | StepName | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Possible values are: - ASMAdServerCheckAvailability. This field is available in API version 66.0 and later. - ASMAdServerIntegration. This field is available in API version 66.0 and later. - ASMAddRelatedEntityToAQL. This field is available in API version 66.0 and later. - ASMApplyMediaPlanTemplateJob. This field is available in API version 66.0 and later. - ASMApplyTargetingTemplateJob. This field is available in API version 66.0 and later. - ASMBulkEditLineItemDetail. This field is available in API version 67.0 and later. - ASMCalcLinearMediaSpotPrc. This field is available in API version 66.0 and later. - ASMCreateAmendQuoteJob. This field is available in API version 66.0 and later. - ASMFileProcessorJob - ASMLinearSpotGenerationJob. This field is available in API version 67.0 and later. - ASMMediaPlanAsTemplate. This field is available in API version 66.0 and later. - ASMMediaPlanClone. This field is available in API version 66.0 and later. - ASMMediaPlanCopyJob. This field is available in API version 66.0 and later. - AbandonedCart. This field is available in API version 67.0 and later. - AssetizationAsyncJob - AutomatedNegativeInvoiceLineConversion - AutomaticRefunds - CommerceVariationsUpsert - ContextPersistence - CreateCPQContractsJob - CreditMemoDraftToPosted. This field is available in API version 66.0 and later. - CreditMemoRecovery. This field is available in API version 66.0 and later. - DeltaCatalogSyndicationAsyncJob - energyAgreementSetup. This field is available in API version 66.0 and later. - FullCatalogSyndicationAsyncJob - InvoiceBatchRunEmailJob. This field is available in API version 66.0 and later. - InvoiceDocgenJob - InvoiceDocgenPostProcessJob - InvoiceDocgenRetryJob - InvoiceDraftToPosted - InvoiceEstimatedTaxCallout. This field is available in API version 66.0 and later. - LoadSalesRecipientData. This field is available in API version 66.0 and later. - MultisiteAutoQuote. This field is available in API version 66.0 and later. - PearAmendQtyAssets—Initiate Amend Quantity - PearCancelAssets—Initiate Cancellation - PearRenewAssets—Initiate Renewal - PersonalizationRecommender. This field is available in API version 67.0 and later. - PlaceOrder - PlaceOrderPersistSync - PlaceOrderPriceAsync - PlaceOrderTaxAsync - PlaceQuote - PlaceQuotePersistAndPriceSync - PlaceQuotePersistSync - PlaceQuotePriceAsync - PlaceQuoteTaxAsync - PostOrderCampaign. This field is available in API version 67.0 and later. - PreprocessOrder. This field is available in API version 66.0 and later. - PriceRuleDeployment - PriceSheetDeployJob - PSTBaseJob—Top-Level. This field is available in API version 66.0 and later. - PSTCommonSyncStep - PSTConfig. This field is available in API version 66.0 and later. - PSTConfigAndPersist. This field is available in API version 66.0 and later. - PSTOrderTaxAsync. This field is available in API version 66.0 and later. - PSTPersist—Save. This field is available in API version 66.0 and later. - PSTPrice. This field is available in API version 66.0 and later. - PSTPriceAndPersist. This field is available in API version 66.0 and later. - PSTQuoteTaxAsync. This field is available in API version 66.0 and later. - QuoteToOrderJob - RuleLibraryDeployment - SmsDltTemplateIngestion. This field is available in API version 66.0 and later. - StandaloneBillingSchedulesCreation. This field is available in API version 66.0 and later. - StatementOfAccountGeneration. This field is available in API version 66.0 and later. - StoreRetrieveSyncJob. This field is available in API version 66.0 and later. - TestSerialMessageStepJob. This field is available in API version 66.0 and later. - TransactionLineBom—Create Material Lines - VoidCreditMemo | | SubmittedAt | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when the asynchronous process was submitted by the REST request. | | SuccessfulJobItems | Type int Properties Filter, Group, Nillable, Sort Description The number of successful items in this job. | | TotalJobItems | Type int Properties Filter, Group, Nillable, Sort Description Total number of items in this job. | ## 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. [AsyncOperationTrackerOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [AsyncOperationTrackerShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # AsyncOpSyndicationFeedFile Represents the sync status of file-related information shared with external channels such as Facebook and Instagram. This object is available in API version 64.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AsyncOpSyndicationFeedFileNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID assigned to each syndication feed file record, and used for tracking and reference purposes. | | AsyncOperationTrackerId | Type reference Properties Filter, Group, Nillable, Sort Description ID assigned to the Async Operation Tracker record, which monitors and manages the lifecycle of the syndication process. This field is a relationship field. Relationship Name AsyncOperationTracker Refers To AsyncOperationTracker | | FeedContentBody | Type base64 Properties Nillable Description The content of the feed file that is syndicated to the external platform. | | FeedContentContentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the format of the feed file to ensure proper processing. For example, CSV, JSON, or XML files. | | FeedContentLength | Type int Properties Filter, Group, Nillable, Sort Description The size of the feed file in bytes, which is used for validation and processing requirements. | | FeedContentName | Type string Properties Filter, Group, Nillable, Sort Description The name of the feed file, which includes identifiers like timestamp or sequence number. | | FeedScope | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Defines the scope or category of the feed. For example, if the feed applies to main, country-specific, or language-specific catalog segments. Possible values are: - CountryFeed - LanguageFeed - MainFeed | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description For internal use only. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description For internal use only. | | PlatformConnections | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The external channel or destination for syndication. Possible values are: - Meta | | SyncMode | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies the type of sync being performed. Possible values are: - FullSync | # AsyncReportRunEventLog Async Report Run Event Log is used for reporting scheduled requests. This category includes dashboard refreshes, asynchronous reports, schedule reports, and analytics snapshots. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AverageRowSize | Type double Properties Filter, Nillable, Sort Description The average row size (in bytes) of all rows in the Asynchronous Report Run event. | | BucketCount | Type int Properties Filter, Group, Nillable, Sort Description The number of buckets used in the report. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | ColumnCount | Type int Properties Filter, Group, Nillable, Sort Description The number of columns in the report. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DashboardIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the dashboard that was run. | | DatabaseBlocks | Type double Properties Filter, Nillable, Sort Description How much activity is occurring in the database. | | DatabaseCpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time (in milliseconds) to complete the request. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description Total time spent in OracleJdbc calls, counting the Jdbc driver, Network, and Oracle time for execs, fetches, and get-connection. | | DisplayType | Type string Properties Filter, Group, Nillable, Sort Description Possible values are: - D—Dashboard - S—Show Details - H—Hide Details | | ExceptionFilterCount | Type int Properties Filter, Group, Nillable, Sort Description The number of exception filters used in the report. | | IsPreview | Type boolean Properties Defaulted on create, Filter, Group, Sort Description This field is reserved for future use. The default value is false. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | ObjectName | Type string Properties Filter, Group, Nillable, Sort Description The name of the object affected by the trigger. | | Origin | Type string Properties Filter, Group, Nillable, Sort Description Where the report is being executed, such as from a UI (Classic, Lightning, Mobile), through an API (synchronous, asynchronous, Apex), or through a dashboard. | | RenderingType | Type string Properties Filter, Group, Nillable, Sort Description Describes the format of the report output in Salesforce Classic. If the report was exported in Lightning Experience, this field is blank. | | ReportIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The report’s ID. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RowCount | Type int Properties Filter, Group, Nillable, Sort Description The number of rows that were processed in the Asynchronous Report Run event. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | SortOrder | Type string Properties Filter, Group, Nillable, Sort Description The sort column and order that was used in the report. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # AttachedContentDocument This read-only object contains all ContentDocument objects associated with an object. ## Supported Calls describeSObjects() ## Special Access Rules ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Beginning in Summer ’26, Chatter is default turned off in all new orgs. For any features in these orgs that require access to Chatter functionality or the Chatter APIs, turn on Chatter by going to **Setup** | **Chatter Settings** and selecting **Enable**. For details, see [Chatter Is Turned Off by Default in New Orgs Beginning in Summer ’26](https://help.salesforce.com/s/articleView?id=experience.collab_chatter_default_off.htm&type=5&language=en_US). ## Fields | Field Name | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the attached ContentDocument. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | ContentSize | Type int Properties Filter, Group, Nillable, Sort Description The size of the document in bytes for notes smaller than 2 GB. In API version 66.0 and later, we recommend that you use the ContentSizeLong field even for notes smaller than 2 GB. | | ContentSizeLong | Type long Properties Filter, Group, Nillable, Sort Description The size of the note in bytes up to 10 GB. This field is available in API version 66.0 and later. | | ContentUrl | Type url Properties Filter, Group, Nillable, Sort Description URL for links and Google Docs. This field is set only for links and Google Docs, and is one of the fields that determine the FileType. This field is available in API version 31.0 and later. | | ExternalDataSourceName | Type string Properties Filter, Group, Nillable, Sort Description Name of the external data source in which the document is stored. This field is set only for external documents that are connected to Salesforce. This field is available in API version 32.0 and later. | | ExternalDataSourceType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of external data source in which the document is stored. This field is set only for external documents that are connected to Salesforce. This field is available in APIAPI version 35.0 and later. | | FileExtension | Type string Properties Filter, Group, Nillable, Sort Description File extension of the attached ContentDocument. This field is available in API version 31.0 and later. | | FileType | Type string Properties Filter, Group, Nillable, Sort Description Type of document, determined by the file extension. | | LinkedEntityId | Type reference Properties Filter, Group, Sort Description ID of the record the ContentDocument is attached to. This is a relationship field. Relationship Name LinkedEntity Relationship Type Lookup Refers To Account, Accreditation, ActivationTarget, ActivationTrgtIntOrgAccess, ApiAnomalyEventStore, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CollaborationGroup, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContentWorkspace, Contract, ConversationEntry, CoverageBenefit, CoverageBenefitItem, CredentialStuffingEventStore, CreditMemo, CreditMemoLine, Dashboard, DashboardComponent, DataStream, DelegatedAccount, DocumentChecklistItem, EmailMessage, EmailTemplate, EngagementChannelType, EnhancedLetterhead, EnrollmentEligibilityCriteria, Event, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Identifier, Image, IndividualApplication, Invoice, InvoiceLine, Lead, ListEmail, Location, MarketSegment, MarketSegmentActivation, MemberPlan, MessagingSession, MktCalculatedInsight, OperatingHours, Opportunity, Order, OrderItem, Organization, OtherComponentTask, PartyConsent, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, Product2, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, ProviderSearchSyncLog, PurchaserPlan, PurchaserPlanAssn, ReceivedDocument, Report, ReportAnomalyEventStore, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SessionHijackingEventStore, Shift, Shipment, ShipmentItem, Site, SkillRequirement, SocialPost, Solution, Task, ThreatDetectionFeedback, User, Visit, VisitedParty, Visitor, VoiceCall, VolunteerProject, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup, WorkTypeGroupMember | | SharingOption | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Controls whether or not sharing is frozen for a file. Only administrators and file owners with Collaborator access to the file can modify this field. Default is Allowed, which means that new shares are allowed. When set to Restricted, new shares are prevented without affecting existing shares. This field is available in API versions 35.0 and later. | | Title | Type string Properties Filter, Group, idLookup, Sort Description Title of the attached ContentDocument. | ## Usage Use this object to list all ContentDocument objects attached to an object via a feed post. To retrieve ContentDocument objects, issue a describe call on an object, which returns a query result for each activity since the record was created. You can’t directly query this object. # AttachedContentNote This read-only object contains all ContentNote objects associated with an object.This object is available in API version 35.0 and later. ## Supported Calls describeSObjects() ## Special Access Rules - Notes must be enabled. - Chatter must be enabled. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Beginning in Summer ’26, Chatter is default turned off in all new orgs. For any features in these orgs that require access to Chatter functionality or the Chatter APIs, turn on Chatter by going to **Setup** | **Chatter Settings** and selecting **Enable**. For details, see [Chatter Is Turned Off by Default in New Orgs Beginning in Summer ’26](https://help.salesforce.com/s/articleView?id=experience.collab_chatter_default_off.htm&type=5&language=en_US). ## Fields | Field Name | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the attached ContentNote | | ContentSize | Type int Properties Filter, Group, Nillable, Sort Description Size of the note in bytes for notes smaller than 2 GB. In API version 66.0 and later, we recommend that you use the ContentSizeLong field even for notes smaller than 2 GB. | | ContentSizeLong | Type long Properties Filter, Group, Nillable, Sort Description The size of the note in bytes up to 10 GB. This field is available in API version 66.0 and later. | | FileExtension | Type string Properties Filter, Group, Nillable, Sort Description File extension of the attached ContentNote. | | FileType | Type string Properties Filter, Group, Nillable, Sort Description Type of file for the note. All notes have a file type of SNOTE. | | LinkedEntityId | Type reference Properties Filter, Group, Sort Description ID of the record the ContentNote is attached to. | | TextPreview | Type string Properties Filter, Group, Nillable, Sort Description A preview of the note, up to 255 characters. | | Title | Type string Properties Filter, Group, Sort Description Title of the note. | ## Usage Use this object to list all ContentNote objects attached to an object. To retrieve ContentNote objects, issue a describe call on an object, which returns a describe result for each note created or attached. You can’t directly query this object. # Attachment Represents a file that a User has uploaded and attached to a parent object. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Body | Type base64 Properties Create, Update Description Required. Encoded file data. | | BodyLength | Type int Properties Filter, Group, Nillable, Sort Description Size of the file (in bytes). | | ConnectionReceivedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce. | | ConnectionSentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections. | | ContentType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The content type of the attachment. If the Don't allow HTML uploads as attachments or document records security setting is enabled for your organization, you cannot upload files with the following file extensions: .htm, .html, .htt, .htx, .mhtm, .mhtml, .shtm, .shtml, .acgi, .svg. When you insert a document or attachment through the API, make sure that this field is set to the appropriate MIME type. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the attachment. Maximum size is 500 characters. This field is available in API version 18.0 and later. | | IsEncrypted | This information is about Shield Platform Encryption and not Classic Encryption. Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the attachment is encrypted using Shield Platform Encryption (true) or not (false). This field is available in API version 34.0 and later. | | IsPartnerShared | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this record is shared with a connection using Salesforce to Salesforce. Label is Is Shared With Partner. | | IsPrivate | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this record is viewable only by the owner and administrators (true) or viewable by all otherwise-allowed users (false). During a create or update call, it is possible to mark an Attachment record as private even if you are not the owner. This can result in a situation in which you can no longer access the record that you just inserted or updated. Label is **Private**. Attachments on tasks or events can't be marked private. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the attached file. Maximum size is 255 characters. Label is **File Name**. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who owns the attachment. This field isn’t required for API version 9.0 or later. The owner of an attachment on a task or event must be the same as the owner of the task or event. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Calendar, User | | ParentId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the parent object of the attachment. The following objects are supported as parents of attachments: - Account - Asset - Campaign - Case - Contact - Contract - Custom objects - EmailMessage - EmailTemplate - Event - Lead - Opportunity - Product2 - Solution - Task This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareMetricTarget, CareObservationComponent, CarePgmProvHealthcareProvider, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareTaxonomy, Case, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, Contact, Contract, CreditMemo, DelegatedAccount, EmailMessage, EmailTemplate, EngagementChannelType, EnrollmentEligibilityCriteria, Event, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, Lead, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PersonEducation, PersonLifeEvent, Product2, ProductRequest, ProductRequestLineItem, PurchaserPlan, ReceivedDocument, ServiceAppointment, ServiceResource, Shift, SocialPost, Solution, Task, Visit, VisitedParty, Visitor, VolunteerProject, WorkOrder, WorkOrderLineItem | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you are importing Attachment data and want to set the value for an audit field, such as CreatedDate, contact Salesforce. For example, for compliance reasons, you may prefer to set the CreatedDate to the date the record was originally created in your system, rather than the date it was imported into Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself. ## Usage The API sends and receives the binary file attachment data encoded as a base64Binary data type. Before creating a record, client applications must encode the binary attachment data as base64. Upon receiving a response, client applications must decode the base64 data to binary (this conversion is usually handled for you by the SOAP client). The create call restricts these files to a maximum size of 25 MB. For a file attached to a Solution, the limit is 1.5 MB. The maximum email attachment size is 3 MB. The API supports attachments on email in create, delete, or update calls. The query call does not return attachments parented by email, unless the user performing the query has the “Modify All Data” permission. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - Attachment records are not searched during text searches. - When issued by an administrator, the query results include Attachment records from the Recycle Bin. - When issued by a non-administrator, the queryAll() call results do not include Attachment records from the Recycle Bin. Access to fields depends on the method being used: - All of the fields are accessible using the describeSObjects() and query() calls. With the create() call, you can insert the Name, ParentId, Body, IsPrivate, and OwnerId fields. - To modify existing records, the update() call gives you access to change the Name, Body, IsPrivate, and OwnerId fields. - You can access all of the fields using a query() call. However, you can't receive the Body field for multiple records in a single query() call. If your query returns the Body field, your client application must ensure that only one row with one Attachment is returned; otherwise, an error occurs. A more effective approach is to return IDs (but not Attachment records in the Body field) from a query() call and then pass them into retrieve() calls that return the Body field. - For information about accessing the attachments of archived activities, see Archived Activities. #### See Also - [Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_note.htm "Represents a note, which is text associated with a custom object or a standard object, such as a Contact, Contract, or Opportunity.") # AttachmentEventLog Attachment event logs contain information about attachments. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AttachmentIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the attachment. | | ContentType | Type string Properties Filter, Group, Nillable, Sort Description The content type of the attachment. | | IsPrivateOn | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the attachment is flagged as private or not. The default value is false. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The operation type of the attachment. | | ParentIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the parent object of the attachment. For example, a07EE00001LgsUH | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # AttribModel Represents an attribution model used with Personalization, Attribution, and Campaign Influence, including model weights and touch type. This object is available in API version 62.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AttribModelStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates a model’s current status. The default value is Draft, and accepted values are - Active - Draft - Inactive | | AttributionModelType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the type of attribution model, which determines which touchpoints to evaluate. The default value is LastTouch, and accepted values are - First touch - LastTouch | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Three letter ISO currency codes for supported currencies. The default value is USD. This is an optional field. | | DataSpaceId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the data space where a model's resources originate. This is a required field. Relationship Name DataSpace Refers To DataSpace | | Description | Type String Properties Filter, Group, Nillable, Sort Description Text description of the attribution model. Optional. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description Auto-generated or user-generated API name for the attribution model. This is a required field. | | Error Code | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the issue that’s causing an error. The default value is None, and accepted values are - ConfigurationMissingError indicates that a required configuration setting is missing. - DpcJobError indicates a problem during processing. - InternalError indicates an internal error during processing. - ModelValidationError indicates that the model is invalid. - None | | GlobalAttributionWindowDays | Type int Properties Filter, Group, Nillable, Sort Description Defines a timeframe for tracking attribution-related engagement. This is a required field. | | IdentityResolutionMode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Defines which identity resolution method to use when tracking engagement activities. Default value is Individual, and acceptable values are - Individual - Unified | | IsZeroDayLoadRequired | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Defines whether to sync data before the attribution window begins. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the model was referenced by another resource. | | LastRefresh | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates the last time engagement data was refreshed and evaluated by the model. | | LastSuccessfulRefresh | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates the last time the model was successfully refreshed. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time a user viewed the model. | | LatestRefreshedStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Picklist value that indicates the status of last refresh process. The default value is None, and accepted values are - Canceled - Complete - Failure - None - Processing | | ModelContext | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the app or feature in which the attribution model is used. The default value is Personalization, and accepted values are - Attribution: indicates the use with Attribution in Salesforce Personalization. - CampaignInfluence: indicates the use with Campaign Influence in Unified Marketing Analytics. - Personalization: indicates the use with Personalization in Salesforce Personalization. | | ModelRevision | Type int Properties Filter, Group, Nillable, Sort Description A version number that indicates the latest save of the model. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Text label that identifies the attribution model. This is a required field. | | Partner | Type string Properties Filter, Group, Nillable, Sort Description Indicates who's using the model. This field is required if the value of ModelContext is Attribution. | | ProfileDataGraphId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to the profile data graph that’s used with the model. Relationship Name ProfileDataGraph Refers To DataGraph | | ScheduledFrequencyMins | Type int Properties Filter, Group, Nillable, Sort Description The scheduled frequency (in minutes) at which the attribution model is processed. | | SyncStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Indicates the current status of the attribution model while an action is being performed. The default value is Processing, and acceptable values are: - Active - CreateError - DeleteError - Deleting - EditError - Processing | | Tags | Type string Properties Filter, Nillable, Sort Description User-generated strings that can be used to organize attribution models. | ## Usage Use this object to get information about attribution models that are in use with personalization and influence features. For example, you can: - Retrieve status and error details. - Identify model settings such as type (first-touch, last-touch). - Find out when the model was last used, refreshed, or synced. ## Associated Objects This object has these 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. [AttribModelChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [AttribModelFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [AttribModelHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [AttribModelOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm) Sharing rules are available for the object. [AttribModelShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm) Sharing is available for the object. # AttribModelStage Represents a funnel stage that’s used in a predefined or custom attribution configuration. Available in API version 62.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AttribModelId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the attribution configuration that uses this stage. This is a required field. Relationship Name AttribModel **Relationship Type** Master-detail Refers To AttribModel (the master object) | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Three letter ISO currency codes for supported currencies. The default value is USD. This is an optional field. | | EngagementSignalEnum | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Picklist value that indicates the engagement signal that’s selected for an attribution stage. This value represents a step in a customer journey. The accepted values are the engagement signals that are configured in the selected data space. | | IsContentMatchRequired | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether to link item attribution from one funnel stage to the next. The default value is false, meaning not required. If you set this value to true, only engagement with the same item from the previous stage is linkable. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Text label that identifies the attribution model stage. This is a required field. | | Sequence | Type int Properties Filter, Group, Sort Description Indicates the position of a stage in its journey sequence, reflecting funnel engagement from start to finish. The funnel requires a minimum of two stages, with a maximum of four stages. Accepted values are 1, 2, 3, or 4. | | StageUnionGroupName | Type string Properties Filter, Group, Nillable, Sort Description Name of a certain group of stages. It can be used to reference individual, consecutive stages as a combined group with a common name. | ## Usage Use this object to create attribution funnel stages. The funnel mirrors key touchpoints of an individual’s personalization journey, which you define by selecting an engagement signal and any relevant metrics. The order that you create stages in describes funnel engagement from start to finish. For example, view a product, click the product, add it to cart, and submit the order. The funnel requires a minimum of two stages, with a maximum of four stages in a journey. ## Associated Objects This object has the these 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. [AttribModelStageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [AttribModelStageFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [AttribModelStageHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [AttribModelStageOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm) Sharing rules are available for the object. [AttribModelStageShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm) Sharing is available for the object. # AttribModelStageMetric Represents the engagement signal metrics that you select when you configure a funnel stage for an attribution configuration. Available in API version 63.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Alias | Type string Properties Filter, Group, Sort Description Indicates the name of the output data metric. This name appears as the column name for the metric on the attribution output table. | | AttribModelStageId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the attribution configuration stage that uses this metric. Relationship Name AttribModelStage Relationship Type Primary-detail Refers To AttribModelStage (the primary object) | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Three letter ISO currency codes for supported currencies. The default value is USD. This is an optional field. | | EngagementSignalMetricId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the engagement signal that defines this stage. **Relationship Name** EngagementSignalMetric Refers To EngagementSignalMetric | | Name | Type string Properties Filter, Group, idLookup, Sort Description The text label that identifies the attribution model stage metric. | ## Usage An engagement signal metric is an aggregation of an engagement signal data field. These metrics are reported in the attribution model dashboard. For example, sum of clicks on a link, number of products added to a cart, email sends, or distinct article downloads. ## Associated Objects This object has these 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. [AttribModelStageMetricChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [AttribModelStageMetricFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [AttribModelStageMetricHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [AttribModelStageMetricOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm) Sharing rules are available for the object. [AttribModelStageMetricShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm) Sharing is available for the object. # AttributeDefinition Represents a product, asset, or object attribute, for example, a hardward specification or software detail. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | DataType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The data type of the attribute definition. Possible values are: - Checkbox - Date - Datetime - Number - Picklist - Text | | DefaultValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The default value for this attribute. | | Description | Type textarea Properties Create, Nillable, Update Description Description of this attribute. | | DeveloperName | Type string Properties Create, Filter, Group, Sort Description The unique name of the attribute definition record. This name must begin with a letter and use only alphanumeric characters and underscores. It can't include spaces, end with an underscore, or have two consecutive underscores. The developer name is used for internal purpose and must be unique for all records (including deleted records). If the system doesn't find the name unique, it automatically overrides the user input and creates a unique name. For external use, the developer name need not be fixed. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the attribute definition is active. Active attributes definitions can be selected for assets. The default value is false. | | IsRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the attribute definition is required for an asset. The default value is false. | | Label | Type string Properties Create, Filter, Group, Sort, Update Description The label for the attribute. Displays a friendly name for the attribute, for example, [threshold monitor lightning component and recordset filter criteria rule](https://help.salesforce.com/s/articleView?id=service.fs_asset_attrib_manage_monit_filter.htm&type=5&language=en_US). | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the attribute definition was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the attribute definition was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the attribute. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the attribute definition. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PicklistId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the attribute picklist with the valid values for this attribute. This field is a relationship field. Relationship Name Picklist Relationship Type Lookup Refers To AttributePicklist | | SourceSystemIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier of the attribute definition in an external system. | | UnitOfMeasureId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the measurement unit for this attribute. This field is a relationship field. Relationship Name UnitOfMeasure Relationship Type Lookup Refers To UnitOfMeasure | ## Usage Add asset descriptors to the Asset object instead of creating multiple custom attributes on an asset. This helps scale to a high volume of various assets in the system. When you create the AttributeDefinition, you can provide a unique API name. If the API name is not unique, the system appends a number to the end of the API name. The value of this number depends on how many times the same name has been used. ## 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. [AttributeDefinitionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 62.0) Change events are available for the object. [AttributeDefinitionHistory](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. [AttributeDefinitionOwnerSharingRule](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. [AttributeDefinitionShare](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. #### See Also - [AssetAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetattribute.htm "Stores asset attributes to track and analyze asset conditions to improve their uptime. This object is available in API version 57.0 and later.") - [AttributePicklist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklist.htm "Represents a custom picklist for an asset attribute. This object is available in API version 57.0 and later.") - [AttributePicklistValue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklistvalue.htm "Represents the values of an asset attribute picklist. This object is available in API version 57.0 and later.") - [RecordsetFltrCritMonitor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordsetfltrcritmonitor.htm "Monitors whether the value of an asset attribute is within the threshold of a recordset filter criteria (RFC). You can monitor one or more RFCs for an Asset. This object is available in API version 57.0 and later.") # AttributePicklist Represents a custom picklist for an asset attribute. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | DataType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The data type of this picklist. Possible values are: - Boolean - Currency - Date - Datetime - Number - Percent - Text The default value is Boolean. | | Description | Type textarea Properties Create, Nillable, Update Description A description of the picklist. Maximum size is 32000 alphanumeric characters. Can include the following special characters: @! - < > \* ? + = % # ( ) / \\ & ‘ £ € $ ”. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the attribute picklist was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the attribute picklist was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the picklist. Names must be unique. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the attribute picklist record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the attribute picklist. Possible values are: - Active - Draft - Inactive The default value is Draft. | | UnitOfMeasureId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the unit of measure associated with the product. This field is a relationship field. This field is available when Revenue Cloud is enabled. This field is available in API version 63.0 and later. Relationship Name UnitOfMeasure Refers To UnitOfMeasure | ## Usage The AttributePicklist object is the parent object and the AttributePicklistValue object contains the picklist values. Let’s say you need an asset attribute to track the T-shirt size, which can be small, medium, or large. Create an AttributePicklist parent record as a Text type for the T-shirt size attribute. Then create AttributePicklistValue records, one for each picklist value small, medium, and large, and associate them with the parent record. ## 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. [AttributePicklistHistory](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. [AttributePicklistOwnerSharingRule](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. [AttributePicklistShare](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. #### See Also - [AssetAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetattribute.htm "Stores asset attributes to track and analyze asset conditions to improve their uptime. This object is available in API version 57.0 and later.") - [AttributeDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributedefinition.htm "Represents a product, asset, or object attribute, for example, a hardward specification or software detail. This object is available in API version 57.0 and later.") - [AttributePicklistValue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklistvalue.htm "Represents the values of an asset attribute picklist. This object is available in API version 57.0 and later.") - [RecordsetFltrCritMonitor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordsetfltrcritmonitor.htm "Monitors whether the value of an asset attribute is within the threshold of a recordset filter criteria (RFC). You can monitor one or more RFCs for an Asset. This object is available in API version 57.0 and later.") # AttributePicklistValue Represents the values of an asset attribute picklist. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | Abbreviation | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A short name of the picklist value that's displayed at run time. Use up to 255 alphanumeric characters. Can include the following special characters: @ ! - < > \* ? + = % # ( ) / \\ & ‘ £ € $ ”. | | Code | Type string Properties Create, Filter, Group, Sort, Update Description A picklist value code unique to the picklist. Maximum size is 80 alphanumeric characters. Can include the following special characters: @ ! - < > \* ? + = % # ( ) / \\ & ‘ £ € $ ”. | | DisplayValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The displayed picklist value if it’s different from the Name field. For example, the Name ‘5’ could have a DisplayValue ‘Five’. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the picklist value is the default for the associated picklist. Only one value can be the default for a picklist. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the attribute picklist value was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the attribute picklist value was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the attribute picklist value. | | PicklistId | Type reference Properties Create, Filter, Group, Sort Description The ID of the picklist that the value is associated with. This field is a relationship field. Relationship Name Picklist Relationship Type Lookup Refers To AttributePicklist | | Sequence | Type double Properties Create, Filter, Nillable, Sort, Update Description The order in which the picklist value appears in the picklist. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the attribute picklist value. Possible values are: - Active - Draft - Inactive The default value is Draft. | | Value | Type string Properties Create, Filter, Group, Sort, Update Description The text value for a picklist item if the picklist data type is text. This value must be unique within a picklist. Maximum size is 255 alphanumeric characters. Can include the following special characters: @ ! - < > \* ? + = % # ( ) / \\ & ‘ £ € $ ”. | ## Usage The AttributePicklistValue object is the child object and the AttributePicklist object contains the picklist. Let’s say you need an asset attribute to track the T-shirt size, which can be small, medium, or large. Create an AttributePicklist parent record as a Text type for the T-shirt size attribute. Then create AttributePicklistValue records, one for each picklist value small, medium, and large, and associate them with the parent record.. ## 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. [AttributePicklistValueHistory](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. #### See Also - [AssetAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetattribute.htm "Stores asset attributes to track and analyze asset conditions to improve their uptime. This object is available in API version 57.0 and later.") - [AttributeDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributedefinition.htm "Represents a product, asset, or object attribute, for example, a hardward specification or software detail. This object is available in API version 57.0 and later.") - [AttributePicklist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklist.htm "Represents a custom picklist for an asset attribute. This object is available in API version 57.0 and later.") - [RecordsetFltrCritMonitor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordsetfltrcritmonitor.htm "Monitors whether the value of an asset attribute is within the threshold of a recordset filter criteria (RFC). You can monitor one or more RFCs for an Asset. This object is available in API version 57.0 and later.") # Audience Represents an audience that is defined by criteria and can be assigned and used for targeting in an Experience Cloud site. This object is available in API version 44.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve(), update() ## Fields | Field | Details | | --- | --- | | AudienceName | Type string Properties Filter, Group, Sort, Update Description Name of the audience. | | ContainerId | Type reference Properties Filter, Group, Sort Description ID of the site or org that contains the audience. ContainerId is nillable in API versions 47.0 and earlier. | | Description | Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the audience. | | DeveloperName | Type string Properties Filter, Group, Sort, Update Description The unique name of the audience in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | FormulaFilterType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description Formula filter for the criteria used to define the audience. Valid values are: - AllCriteriaMatch—Matching all the conditions (AND). - AnyCriterionMatches—Matching at least one condition (OR). - CustomLogicMatches—Matching condition logic (AND and OR) and numbered criteria groups. This value is available in API version 45.0 and later. | | Language | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description Language of the audience. Valid values are: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. | | MasterLabel | Type string Properties Filter, Group, Sort, Update Description Master label for the audience. This internal name doesn’t get translated. | # Aura Request Event Type Aura Request events contain details of requests to Apex methods from Aura and Lightning web components. For example, you can benchmark request time or identify the URI of an unsuccessful request. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
ACTION_MESSAGE
Type
String
Description
The action (Apex method) names and times for all the actions in the request in the format:
action1Name=action1Time;action2Name=action2Time...
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EASY_SUITE_VALUE
Type
String
Description
The org’s Small Business Suite Edition, if applicable. This field populates only for Small Business Suite editions and Salesforce Foundations. Otherwise, it will be empty. Available in API version 66.0 and later.
For example:
  • Freemium—Salesforce Free Suite
  • Starter—Salesforce Starter Suite
  • Pro—Salesforce Pro Suite
  • C360SuiteEE—Salesforce Foundations
EVENT_TYPE
Type
String
Description
The type of event. The value is always AuraRequest.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
Example
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_METHOD
Type
String
Description
The HTTP method of the request, such as GET or POST.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the resource that’s receiving the request.
For example: /aura.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_AGENT
Type
String
Description
The numeric code for the type of client used to make the request (for example, the browser, application, or API).
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # AuraDefinition Represents an Aura component definition, such as component markup, a client-side controller, or an event. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | AuraDefinitionBundleId | Type reference Properties Create, Filter, Group, Sort Description The ID of the bundle containing the definition. A bundle contains a Lightning definition and all its related resources. This is a relationship field. Relationship Name AuraDefinitionBundle Relationship Type Lookup Refers To AuraDefinitionBundle | | DefType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The definition type. Valid values are: - APPLICATION — Lightning Aura Components app - CONTROLLER — client-side controller - COMPONENT — component markup - EVENT — event definition - HELPER — client-side helper - INTERFACE — interface definition - RENDERER — client-side renderer - STYLE — style (CSS) resource - PROVIDER — reserved for future use - MODEL — deprecated, do not use - TESTSUITE — reserved for future use - DOCUMENTATION — documentation markup - TOKENS — tokens collection - DESIGN — design definition - SVG — SVG graphic resource - MODULE — reserved for future use | | Format | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The format of the definition. Valid values are: - XML for component markup - JS for JavaScript code - CSS for styles - TEMPLATE\_CSS reserved for future use - SVG for an SVG graphic | | Source | Type textarea Properties Create, Update Description The contents of the definition. This is all the markup or code for the definition. | ## Usage For more information, see the [Lightning Aura Components Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.lightning.meta/lightning/ "HTML (New Window)"). # AuraDefinitionBundle Represents a Lightning Aura component definition bundle, such as a component or application bundle. A bundle contains a Lightning Aura component definition and all its related resources. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ApiVersion | Type double Properties Create, Filter, Sort, Update Description The API version for this bundle. Every bundle has an API version specified at creation. | | Description | Type textarea Properties Create, Filter, Group, Sort, Update Description The text description of the bundle. Maximum size of 255 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the MasterLabel. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Master label for the Lightning bundle. This internal label doesn’t get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | ## Usage For more information, see the [Lightning Aura Components Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.lightning.meta/lightning/ "HTML (New Window)"). # AuraDefinitionBundleInfo For internal use only. # AuraDefinitionInfo For internal use only. # AuraRequestEventLog Aura Request Event Log contains details of requests to Apex methods from Aura and Lightning web components. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ActionMessage | Type string Properties Filter, Group, Nillable, Sort Description The action (Apex method) names and times for all the actions in the request in the format. For example: action1Name=action1Time;action2Name=action2Time... | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DatabaseCpuTime. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestMethod | Type string Properties Filter, Group, Nillable, Sort Description The HTTP method of the request, such as GET or POST. | | RequestStatus | Type String Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserAgent | Type string Properties Filter, Group, Nillable, Sort Description The numeric code for the type of client used to make the request (for example, the browser, application, or API) as a string. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # AuthConfig Represents authentication options for My Domain and Experience Cloud site login pages. This object is available in API version 32.0 and later. The fields for this object control the options that display on the login page of an org. By default, you have a My Domain and corresponding login page. If you use Digital Experiences, you can also set up a login page for each of your Experience Cloud sites. - Logging in with a username and password - Using SAML for single sign-on - Authentication provider logins from a third-party service, such as Facebook or Twitter ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules You must have “View Setup and Configuration” permission to view the settings. ## Fields | Field Name | Details | | --- | --- | | AuthOptionsAuthProvider | Type boolean Properties Filter Description If true, at least one Auth. Provider is selected to show up on the login page, and this object has child AuthConfigProvider objects for each provider. | | AuthOptionsCertificate | Type boolean Properties Filter Description If true, certificate-based login displays on the My Domain login page. | | AuthOptionsSaml | Type boolean Properties Filter Description If true, at least one SAML configuration is selected to show up on the login page. If the organization has only one SAML configuration, this value indicates whether that configuration is selected to show up on the login page. If the organization has multiple SAML configurations, see the child AuthConfigProvider objects for each configuration. | | AuthOptionsUsernamePassword | Type boolean Properties Filter Description If true, the login option for a username and password appears on the login page. | | DeveloperName | Type string Properties Filter, Group, Sort Description The name of the domain created using My Domain or, for an Experience Cloud site, a concatenated string of site name\_site prefix. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether this configuration is in use. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language for the organization. | | MasterLabel | Type string Properties Filter, Group, Sort Description The text that’s used to identify the Visualforce page in Setup. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The organization type for this object. - Org (includes custom domains) - Community - Site - Portal | | Url | Type string Properties Filter, Group, idLookup, Sort Description The login URL of the organization for this AuthConfig object. Each URL has only one associated AuthConfig object. | # AuthConfigProviders Represents an authentication provider that’s configured in an organization. AuthConfigProviders is a child of the AuthConfig object. This object is available in API version 32.0 and later. This object links the authentication configuration for an organization to the Auth Provider through the AuthOptionsAuthProvider field of the [AuthConfig](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_authconfig.htm "HTML (New Window)") object. The login page of a My Domain or Experience Cloud site can allow multiple SAML configurations and multiple authentication providers. These configurations can be set to show up as buttons on the login page. Each configuration has an AuthConfigProvider object. For more information about how to display these configurations on the login page, see these resources in Salesforce Help. - My Domain: [Add Identity Providers to the My Domain Login Page](https://help.salesforce.com/s/articleView?id=products.domain_name_login_id_prov.htm&type=5&language=en_US "HTML (New Window)") - Experience Cloud: [Configure Your Login Page](https://help.salesforce.com/s/articleView?id=xcloud.external_identity_login_pages_configure.htm&type=5&language=en_US "HTML (New Window)") ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Special Access Rules You must have “View Setup and Configuration” permission to view the settings. ## Fields | Field Name | Details | | --- | --- | | AuthConfigId | Type reference Properties Create, Filter, Group, Sort Description The ID for this configuration. This is a relationship field. Relationship Name AuthConfig Relationship Type Lookup Refers To AuthConfig | | AuthProviderId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Auth. Provider or SAML configuration. This is a polymorphic relationship field. Relationship Name AuthProvider Relationship Type Lookup Refers To AuthProvider, SamlSsoConfig | # AuthorizationForm Represents the specific version and effective dates of a form that is associated with consent, such as a privacy policy or terms and conditions. This object is available in API version 46.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if Data Protection and Privacy is enabled. ## Fields | Field Name | Details | | --- | --- | | DefaultAuthFormTextId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The ID of the default authorization form text to use if text isn’t available for a specific language. This is a relationship field. Relationship Name DefaultAuthFormText Relationship Type Lookup Refers To AuthorizationFormText | | EffectiveFromDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the authorization form takes effect. | | EffectiveToDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the authorization form is no longer in effect. | | IsSignatureRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the authorization form requires a signature. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the authorization form. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RevisionNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The revision number of the authorization form. For example, "rev1.21." | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [AuthorizationFormChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. [AuthorizationFormHistory](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. [AuthorizationFormOwnerSharingRule](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. [AuthorizationFormShare](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. # AuthorizationFormConsent Represents the date and way in which a user consented to an authorization form. This object is available in API version 46.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if Data Protection and Privacy is enabled. ## Fields | Field Name | Details | | --- | --- | | AuthorizationFormTextId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The authorization form text that the Individual consented to. This is a relationship field. Relationship Name AuthorizationFormText Relationship Type Lookup Refers To AuthorizationFormText | | ConsentCapturedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Required. The date and time that consent was given. | | ConsentCapturedSource | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The source through which consent was captured. For example, user@example.com, www.example.com. | | ConsentCapturedSourceType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. The source type through which consent was captured. For example, phone, email, or website. Picklist Values - Email - InPerson - MailingAddress - Phone - Social - Video - Web | | ConsentGiverId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The ID of the person consenting to the authorization form. This is a polymorphic relationship field. Relationship Name ConsentGiver Relationship Type Lookup Refers To Account, Contact, Individual, Lead, User | | DocumentVersionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the document version for which consent is given. This is a relationship field. Relationship Name DocumentVersion Relationship Type Lookup Refers To ContentVersion | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the authorization form consent. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. The ID of the owner of the account associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RelatedRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of a record showing consent of an authorization form. This is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To Account | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the authorization form. Possible values are: - Rejected - Seen - Signed | | PartyId | Type reference Properties Create, Filter, Group, Sort Description This field was removed in API version 47.0. UseConsentGiverId instead. | ## 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. [AuthorizationFormConsentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 47.0) Change events are available for the object. [AuthorizationFormConsentHistory](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. [AuthorizationFormConsentOwnerSharingRule](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. [AuthorizationFormConsentShare](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. # AuthorizationFormDataUse Represents the data use consented to in an authorization form. This object is available in API version 46.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if Data Protection and Privacy is enabled. ## Fields | Field Name | Details | | --- | --- | | AuthorizationFormId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The ID of the associated authorization form record. This is a relationship field. Relationship Name AuthorizationForm Relationship Type Lookup Refers To AuthorizationForm | | DataUsePurposeId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. Identifies the data use purpose record associated with the authorization form. This is a relationship field. Relationship Name DataUsePurpose Relationship Type Lookup Refers To DataUsePurpose | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the authorization form data use. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [AuthorizationFormDataUseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [AuthorizationFormDataUseHistory](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. [AuthorizationFormDataUseOwnerSharingRule](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. [AuthorizationFormDataUseShare](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. # AuthorizationFormText Represents an authorization form’s text and language settings. This object is available in API version 46.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if Data Protection and Privacy is enabled. ## Fields | Field Name | Details | | --- | --- | | AuthorizationFormId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the associated authorization form record. This is a relationship field. Relationship Name AuthorizationForm Relationship Type Lookup Refers To AuthorizationForm | | ContentDocumentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the ContentDocument that provides the authorization form’s text. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | DetailAuthorizationFormText | Type textarea Properties Create, Nillable, Update Description A detailed version of the authorization form. | | FullAuthorizationFormUrl | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The URL where the full text of the authorization form is located. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Locale | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The combined language and locale ISO code that control the language of the authorization form text. Locale and LocaleSelection have the same function. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Locale can contain custom values not included in the picklist if added before version 47.0. | | LocaleSelection | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The combined language and locale ISO code that control the language of the authorization form text. Locale and LocaleSelection have the same function. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the authorization form text. | | SummaryAuthFormText | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A shortened version of the authorization form that is displayed to the user. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [AuthorizationFormTextChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. [AuthorizationFormTextHistory](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. # AuthProvider Represents an authentication provider (auth provider). An auth provider lets users log in to your Salesforce org from an external service provider, such as Facebook, Google, or GitHub. This object is available in API version 27.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Only users with Customize Application and Manage AuthProviders permissions can access this object. ## Fields | Field Name | Details | | --- | --- | | AppleTeam | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required when using Apple as a third-party authentication provider. A 10-character team ID, obtained from an Apple developer account. Available in API version 48.0 and later. | | AuthorizeUrl | Type url Properties Create, Filter, Nillable, Sort, Update Description Required when creating an OpenID Connect authentication provider. The OAuth authorization endpoint URL. Available in API version 29.0 and later. In API version 33.0 and later, for Salesforce-managed auth providers, leave the field blank to let Salesforce supply and manage the value. | | ConsumerKey | Type string Properties Create, Filter, Nillable, Sort, Update Description The app’s key that is registered at the third-party (external) authentication provider. In API version 33.0 and later, for Salesforce-managed auth providers, leave the field blank to let Salesforce supply and manage the value. | | ConsumerSecret | Type string Properties Create, Nillable Description The consumer secret of the authentication provider that is registered at the third-party SSO provider. It’s used by the consumer for identification to Salesforce. In API version 33.0 and later, for Salesforce-managed auth providers, leave the field blank to let Salesforce supply and manage the value. You can create your own consumer secret on create(). However, after you set it, you can’t change the value. | | CustomMetadataTypeRecord | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required when creating a custom authentication provider plug-in. The API name of the custom authentication provider. Available in API version 36.0 and later. | | DefaultScopes | Type string Properties Create, Filter, Nillable, Sort, Update Description For OpenID Connect authentication providers, the scopes to send with the authorization request, if not specified when a flow starts. Available in API version 29.0 and later. In API version 33.0 and later, for Salesforce-managed auth providers, leave the field blank to let Salesforce supply and manage the value. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. Used when referring to the authentication provider from a program. | | EcKey | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required when using Apple as a third-party authentication provider. Available in API version 48.0 and later. | | ErrorUrl | Type string Properties Create, Filter, Nillable, Sort, Update Description A custom error URL for the authentication provider to use to report errors. | | ExecutionUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required to specify a registration handler. The username of the Salesforce admin or system user who runs the Apex handler or flow. The execution user provides the context in which the registration handler runs. For example, if the handler creates a contact, the creation can be easily traced back to the registration process. In production, use a system user. The user must have the Manage Users permission. Available in API version 27.0 and later. | | FlowDefaultAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description For authentication providers that use a flow registration handler, the default account that new external users are assigned to. If you include this field, Salesforce automatically uses it for the defaultAccountId variable in the Authentication Provider User Registration standard flow. A default account is required to use a flow registration handler for external users. You can specify a default account here or in the flow itself. If you use both, the default account that's configured in the flow takes precedent. Available in API version 64.0 and later. | | FlowDefaultProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description For authentication providers that use a flow registration handler, the default profile that new users are assigned to. If you include this field, Salesforce automatically uses it for the defaultProfileId variable in the Authentication Provider User Registration standard flow. A default profile is required to use a flow registration handler. You can specify a default profile here or in the flow itself. If you use both, the default profile that's configured in the flow takes precedent. Available in API version 64.0 and later. | | FriendlyName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. A user-friendly name for the authentication provider. | | IconUrl | Type url Properties Create, Filter, Nillable, Sort, Update Description The path to an icon to use as a button on the login page. Users click the button to log in with the associated authentication provider, such as Twitter or Facebook. Available in API version 32.0 and later. | | IdTokenIssuer | Type string Properties Create, Filter, Nillable, Sort, Update Description The source of the authentication token in https: URI format. This field is available when configuring an OpenID Connect or Microsoft authentication provider. If provided, Salesforce validates the returned id\_token value. OpenID Connect requires returning an id\_token value with the access\_token value. Available in API version 30.0 and later. | | LinkKickoffUrl | Type url Properties Nillable Description The URL for linking existing Salesforce users to a third-party account. This field is read-only. Available in API version 43.0 and later. | | LogoutUrl | Type url Properties Create, Filter, Nillable, Sort, Update Description The destination for users after they log out if they authenticated using single sign-on. The URL must be fully qualified with an http or https prefix, such as https://acme.my.salesforce.com. Available in API version 33.0 and later. | | OauthKickoffUrl | Type url Properties Nillable Description The URL for obtaining OAuth access tokens for a third party. This field is read-only. Available in API version 43.0 and later. | | OptionsIncludeOrgIdInId | Type boolean Properties Create, Filter, Update Description Used to differentiate between users with the same user ID from two sources (such as two sandboxes). If enabled (true), Salesforce stores the org ID of the third-party identity in addition to the user ID. After you enable this setting, you can’t disable it. Applies only to a Salesforce-managed auth provider. Available in API version 32.0 and later. | | OptionsIsPkceEnabled | Type boolean Properties Create, Filter, Update Description If set to true, the authentication provider uses the OAuth 2.0 Proof Key for Code Exchange (PKCE) extension, which improves the security of the provider’s authorization flow. This field applies only to these providerType values: - Custom - Facebook - Google - Microsoft - OpenIdConnect - Salesforce. This field is available in API version 59.0 and later. | | OptionsRequireMfa | Type boolean Properties Filter Description Requires multi-factor authentication (MFA) for single sign-on with this auth provider based on the MFA status of each user. For this setting to trigger MFA, you must apply MFA directly to users via one of two methods. 1) Assign the user permission Multi-Factor Authentication for User Interface Logins. 2) Enable the org setting Require multi-factor authentication (MFA) for all direct UI logins to your Salesforce org. | | OptionsSendAccessTokenInHeader | Type boolean Properties Create, Filter, Update Description If enabled (true), the access token is sent to the UserInfoUrl in a header instead of a query string. Available in API version 30.0 and later. | | OptionsSendClientCredentialsInHeader | Type boolean Properties Create, Filter, Update Description Required when creating an OpenID Connect authentication provider. If enabled (true), the client credentials are sent in a header to the tokenUrl instead of a query string. The credentials are in the standard OpenID Connect Basic Credentials header format, which is Basic , where is the base64-encoded string "clientkey:clientsecret". Available in API version 30.0 and later. | | OptionsSendSecretInApis | Type boolean Properties Create, Filter, Update Description Determines whether the encrypted consumer secret appears in API responses. If enabled (default), the secret appears in the response. If disabled (false), responses don’t include the consumer secret. For security, you can disable the setting. However, keep in mind that: - By disabling this setting, the consumer secret is excluded from API responses in all API versions. - Change sets and other metadata deployments break because both the consumer key and secret are expected. To fix this problem, insert the consumer key manually during deployment. Available in API version 47.0 and later. | | PluginId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description An existing Apex class that extends the Auth.AuthProviderPluginClass abstract class. Available in API version 39.0 and later. | | ProviderType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The third-party authentication provider to use. Valid values include: - Apple. Available in API version 48.0 and later. - Bitbucket—Provides authentication for a Bitbucket provider. Enables you to connect to Bitbucket from a Lightning Platform application. When logged in to Bitbucket, the app can makes calls to Bitbucket APIs. The Bitbucket provider isn’t available as an SSO provider, so users can’t log in to a Salesforce org using their Bitbucket login credentials. Available in API version 61.0 and higher. - CommerceCloudAccountManager. Available in API version 67.0 and later. - Confluence3LO. Available in API version 67.0 and later. - Custom—A provider configured with a custom authentication provider plug-in. Available in API version 36.0 and later. - Facebook. - GitHub—Provides authentication for a GitHub provider. Used to log in users of your Lightning Platform app to GitHub using OAuth. When logged in to GitHub, your app can make calls to GitHub APIs. The GitHub provider isn’t available as an SSO provider, so users can’t log in to your Salesforce org using their GitHub login credentials. Available in API version 35.0 and later. - Google. - Janrain. - LinkedIn. Available in API version 32.0 and later. - Microsoft. Provides authentication for all services that can be accessed via Microsoft Azure Active Directory. Available in API version 55.0 and later. - MicrosoftACS—Microsoft Access Control Service provides authentication for a Microsoft Office 365 service, like SharePoint Online. The MicrosoftACS provider doesn't support SSO. Available in API version 31.0 and later. - MuleSoftAnypointPlatform. Available in API version 67.0 and later. - OpenIdConnect. Available in API version 29.0 and later. - Salesforce. - Slack. Available in API version 54.0 and later. - Twitter. Available in API version 32.0 and later. | | RegistrationHandlerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description An existing Apex class that implements the Auth.RegistrationHandler interface. | | SsoKickoffUrl | Type url Properties Nillable Description The URL for performing SSO into Salesforce from a third party by using its third-party credentials. This field is read-only. Available in API version 43.0 and later. | | TokenUrl | Type url Properties Create, Filter, Nillable, Sort, Update Description The OAuth token endpoint URL of an OpenID Connect authentication provider. Available in API version 29.0 and later. In API version 33.0 and later, for Salesforce-managed auth providers for sandbox use cases only, leave the field blank to let Salesforce supply and manage the value. | | UserInfoUrl | Type url Properties Create, Filter, Nillable, Sort, Update Description The OpenID Connect endpoint URL of the OpenID Connect authentication provider. Available in API version 29.0 and later. In API version 33.0 and later, for Salesforce-managed auth providers, leave the field blank to let Salesforce supply and manage the value. | # AuthProvParamFwdAllowlist Represents an allowlisted URL parameter that can be forwarded from authentication provider client configuration URLs to the authorization URL. Use this type to add custom functionality to authentication providers. For example, allowlist a ui\_locales parameter and use it to send a user's language preference from Salesforce to the third-party provider's login page. This object is available in API version 62..0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AuthProviderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the authentication provider associated with the allowlist. This field is a relationship field. Relationship Name AuthProvider Refers To AuthProvider | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A description for the allowlisted URL parameter. | | Param | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the parameter, such as ui\_locales or login\_hint. | # AuthSession The AuthSession object represents an individual user session in your organization. This object is available in versions 29.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules To access the AuthSession object, users must have the Manage Users permission. ## Fields | Field Name | Details | | --- | --- | | CreatedDate | Type dateTime Properties Defaulted on create, Filter, Sort Description The date and time this session was created. This field is a standard system field. | | Id | Type id Properties Defaulted on create, Filter, Group, ID Lookup, Sort Description The current session’s ID. | | IsAssociatedWithJwtAccessToken | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the session is associated with a JSON Web Token (JWT)-based access token. This field is available in API version 64.0 and later. | | IsCurrent | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the session is a member of the user’s current session family. This field is available in API version 37.0 and later. | | LastModifiedDate | Type dateTime Properties Defaulted on create, Filter, Sort Description The date and time this session was last updated. A session expires when the current date and time equals LastModifiedDate + NumSecondsValid. This field is a standard system field. | | LoginGeoId | Type reference Properties Filter, Group, Nillable, Sort Description The 18-character ID for the record of the geographic location of the user for a login event. Due to the nature of geolocation technology, the accuracy of geolocation fields (for example, country, city, postal code) can vary. This field is available in API version 34.0 and later. This is a relationship field. Relationship Name LoginGeo Relationship Type Lookup Refers To LoginGeo | | LoginHistoryId | Type reference Properties Filter, Group, Nillable, Sort Description The 18-character ID for a successful login event. When a session is reused, Salesforce updates the LoginHistoryId with the value from the most recent login. This field is available in API version 33.0 and later. This is a relationship field. Relationship Name LoginHistory Relationship Type Lookup Refers To LoginHistory | | LoginSubType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of login flow used. For a list of values, see the LoginSubType field on the [LoginHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_loginhistory.htm) object. This field is available in API version 67.0 and later. | | LoginType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of login used to access the session. For a list of values, see the LoginType field on the [LoginHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_loginhistory.htm) object. | | LogoutUrl | Type string Properties Filter, Nillable, Sort Description The page or view to display after users log out of an Experience Cloud site, or an org if they authenticated using SAML. This field is available in API version 32.0 and later. | | NumSecondsValid | Type int Properties Filter, Group, Sort Description The number of seconds before the session expires, starting from the last update time. | | ParentId | Type reference Properties Filter, Group, Nillable, Sort Description The 18-character ID for the parent session, if one exists (for example, if the current session is for a canvas app). If the current session doesn’t have a parent, this value is the current session’s own ID. | | SessionSecurityLevel | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Standard or High, depending upon the authentication method used. | | SessionType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of session. Common ones are UI, Content, API, and Visualforce. For more information, see [User Session Types](https://help.salesforce.com/s/articleView?id=xcloud.security_session_types.htm&type=5&language=en_US "HTML (New Window)") in the Object Reference Guide. | | SourceIp | Type string Properties Filter, Group, Sort Description IP address of the end user’s device from which the session started. This address can be an IPv4 or IPv6 address. The SourceIp field doesn't support the LIKE [comparison operator](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_comparisonoperators.htm). | | UserType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The kind of user for this session. Types include Standard, Partner, Customer Portal Manager, High Volume Portal, and CSN Only. | | UsersId | Type reference Properties Filter, Group, Nillable, Sort Description The user’s Salesforce user ID. This is a relationship field. Relationship Name Users Relationship Type Lookup Refers To User | ## Usage The AuthSession object exposes session data and enables read and delete operations on that data. For example, use this object to see who is signed in to your org. Or you can use this object to create a tool to delete a session, ending that user’s session. For a user, only their own sessions are available, while administrators can see all sessions. You can’t change user sessions with this object. You can only read and delete them. # AutomatedAction Represents the configuration of an automated action, such as a workflow rule. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ApiVersion | Type int Properties Filter, Group, Sort Description Required. API version to use for executing the automated action. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the automated action. | | ErrorDetail | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The source of the error encountered when executing the automated action. Possible values are: - invalidCondition - invalidConditionReference - invalidConditionValue - invalidInvocableAction - invalidInvocableActionParam - invalidReferenceEntity - unknownError | | ErrorMessage | Type textarea Properties Create, Nillable, Update Description A description of the error encountered when executing the automated action. | | EvalType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description When the automated action runs. Possible values are: - OnCreate - OnCreateAndUpdate | | ExecutionType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Whether the action runs automatically or generates a reminder. Possible values are: - Automatic - Reminder | | ExtraFilterExpression | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Additional condition logic for cross-object filters. | | ExtraFilterType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Additional criteria for cross-object filters. Possible values are: - Advanced - And - Or | | FilterExpression | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If FilterType is Advanced, this field contains the condition logic. | | FilterType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Criteria for filters. Possible values are: - Advanced - And - Or | | InvocationName | Type string Properties Create, Filter, Group, Sort, Update Description Invocable action to execute. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action record is locked or not. The default value is false. | | LastEditedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The timestamp when the automated action had a change that impacted rule evaluation. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record was likely referenced (LastReferencedDate) and not viewed. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action record can be edited or not. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the automated action. | | ReferenceEntity | Type string Properties Create, Filter, Group, Sort, Update Description Entity on which the automated action operates. | | RuleType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of workflow rule. Possible values are: - ManagerAssigned - ManagerSubscribed - Personal - SdrAgent | | State | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the alert. Possible values are: - Active - Error - Inactive | | SubscriptionState | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description For users who don’t have an override, the default value of the subscription. Possible values are: - Active - Inactive | | Summary | Type string Properties Filter, Nillable, Sort Description A human-readable explanation of the automated action, its conditions, and its parameters. | ## 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. [AutomatedActionOwnerSharingRule](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. [AutomatedActionShare](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. # AutomatedActionCondition Represents the logical operator details for evaluating conditions in an automated action. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AutomatedActionId | Type reference Properties Create, Filter, Group, Sort Description ID of the automated action. This field is a relationship field. Relationship Name AutomatedAction Relationship Type Lookup Refers To AutomatedAction | | ConditionNumber | Type int Properties Create, Filter, Group, Sort, Update Description Reference number of the condition containing advanced filter logic. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action condition record is locked or not. The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action condition record can be edited or not. The default value is false. | | Operator | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The logical operator for this condition. Possible values are: - Contains - EndsWith - Equal - GreaterThan - GreaterThanOrEqual - IsChanged - IsNull - LessThan - LessThanOrEqual - NotEqual - StartsWith | | ReferenceField | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The field to use for this condition. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of condition. Possible values are: - ExtraFilterCondition - PrimaryFilterCondition | | Value | Type textarea Properties Create, Nillable, Update Description The value to compare to the ReferenceField. | # AutomatedActionOverride Represents a modified attribute of a shared automated action. For example, the modified attribute can contain customizations for your business. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | FieldName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the field to override. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action override record is locked or not. The default value is false. | | IsRelatedRecordOverridable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the parent automated action record can be overridden. The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action override record can be edited or not. The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the automated action. | | RelatedRecordApiName | Type string Properties Filter, Group, Nillable, Sort Description The object name of the RelatedRecordId. This field is a calculated field. | | RelatedRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the automated action. This field is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To AutomatedAction, FtestUser | | Value | Type textarea Properties Create, Update Description The overridden value used for FieldName. | ## 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. [AutomatedActionOverrideOwnerSharingRule](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. [AutomatedActionOverrideShare](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. # AutomatedActionParameter Represents the values or field references evaluated by the automated action. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AutomatedActionId | Type reference Properties Create, Filter, Group, Sort Description ID of the automated action. This field is a relationship field. Relationship Name AutomatedAction Relationship Type Lookup Refers To AutomatedAction | | DataType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The data type of the value or field reference value. Possible values are: - Boolean - Double - Int - None - String - ValueList | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action parameter record is locked or not. The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action parameter record can be edited or not. The default value is false. | | ParameterName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the invocable action parameter the value maps to. | | ReferenceField | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reference to the field that’s resolved at runtime. For example, LeadID. If Value has a value, this field is null. | | Value | Type textarea Properties Create, Nillable, Update Description The value to be passed to the invocable action parameter at runtime. If ReferenceField has a value, this field is null. | # AutomatedActionReminder Represents a reminder to the end user to take an action in the future. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActionTakenDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Timestamp of when the user took the action suggested by the reminder. | | AutomatedActionId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the automated action. This field is a relationship field. Relationship Name AutomatedAction Relationship Type Lookup Refers To AutomatedAction | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action reminder record is locked or not. The default value is false. | | IsValidForUser | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action is active and accessible to the user who owns the record (true) or not (false). The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action reminder record can be edited or not. The default value is false. | | ReferenceRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The record that triggered the reminder. For example, when a rule is set to Case, the value of this field is CaseId. This field is a polymorphic relationship field. Relationship Name ReferenceRecord Relationship Type Lookup Refers To Account, Case, Contact, Invoice, Lead, Opportunity | | StartDateTime | Type dateTime Properties Create, Filter, Sort, Update Description The date and time this reminder is scheduled to be displayed to the user. | | State | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the reminder. Possible values are: - Active - Completed - Disabled - Dismissed - Expired | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of automated action reminder. Possible values are: - Reminder | ## 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. [AutomatedActionReminderOwnerSharingRule](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. [AutomatedActionReminderShare](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. # BackgroundOperation Represents a background operation in an asynchronous job queue. This object is available in API version 35.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), retrieve() ## Special Access Rules - BackgroundOperation doesn’t support search. ## Fields | Field Name | Details | | --- | --- | | Error | Type string Properties Filter, Group, Nillable, Sort Description The error message for the operation. Applies only if the operation has an error status. | | ExecutionGroup | Type string Properties Filter, Group, Nillable, Sort Description Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Identifies the execution group. | | ExpiresAt | Type dateTime Properties Filter, Nillable, Sort Description After this time, the operation is removed from the asynchronous job queue. Applies only if the operation has a status of complete, canceled, error, or merged. | | FinishedAt | Type dateTime Properties Filter, Nillable, Sort Description When the operation reached the status of completed or error. | | GroupLeaderId | Type reference Properties Filter, Group, Nillable, Sort Description Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Identifies the operation that’s selected as the leader of the execution group. This field is a relationship field. Relationship Name GroupLeader Relationship Type Lookup Refers To BackgroundOperation | | Name | Type string Properties Filter, Group, idLookup, Sort Description Identifies the background operation. | | NumFollowers | Type int Properties Filter, Group, Nillable, Sort Description Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Number of other operations that are in the execution group. | | ParentKey | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Tag that identifies related sets of operations, if any. | | ProcessAfter | Type dateTime Properties Filter, Nillable, Sort Description The operation is scheduled to be processed after this time. | | RetryBackoff | Type int Properties Filter, Group, Nillable, Sort Description Applies only if the operation has an error status. The first retry is attempted immediately. Each subsequent retry is increasingly delayed according to an exponential expression that’s multiplied by the RetryBackoff, in milliseconds. Specifically, the delay time is (2n\-1)×R, where n is the RetryCount, and R is the RetryBackoff. The default value for RetryBackoff depends on the type of operation. For example, the RetryBackoff default for write operations on external objects is 1,000 milliseconds. For write operations, retries are attempted immediately, after 3 seconds, after 7 seconds, after 15 seconds, and so on. | | RetryCount | Type int Properties Filter, Group, Nillable, Sort Description Number of attempted retries. Applies only if the operation has an error status. | | RetryLimit | Type int Properties Filter, Group, Nillable, Sort Description Maximum number of retries to attempt. Applies only if the operation has an error status. | | SequenceGroup | Type string Properties Filter, Group, Nillable, Sort Description Identifies the sequence group. Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Within an execution group, operations can be placed into a sequence group to be executed in a specific order. | | SequenceNumber | Type int Properties Filter, Group, Nillable, Sort Description Order position within the sequence group. Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Within an execution group, operations can be placed into a sequence group to be run in a specific order. | | StartedAt | Type dateTime Properties Filter, Nillable, Sort Description When the operation started running. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of the background operation. The options are: - New - Scheduled - Canceled - Merged - Waiting - Running - Error - Complete | | SubmittedAt | Type dateTime Properties Filter, Nillable, Sort Description When the operation was added to the job queue. | | Timeout | Type int Properties Filter, Group, Nillable, Sort Description Maximum time in milliseconds to wait for results after the operation started running. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of the background operation. The options are: - ApiCatalogPoller - BlockchainEventPoller - CdpMetadataDeploy - ExternalChangeDataCapture - ExternalConnectivityPoller - ExternalObject - ExternalObjectSync - ExternalServiceCallback - MetadataChangesetOperation - MfgBulkUpdate - PrivateConnectMigration - SingularityAutoSync - SingularityMDSSync - SingularitySchemaEvolutionTrigger - SiteTaskCreate - SiteTaskPublish - Sweeper - WebCart - XClean | | WorkerUri | Type string Properties Filter, Group, idLookup, Nillable, Sort Description URI of the worker that performed the operation. Example for a Salesforce Connect OData operation: services/data/v35.0/xds/upsert | ## Usage Use the BackgroundOperation object to: - Monitor the job status of asynchronous operations. - View errors that are related to the asynchronous operations. - Extract statistics for the asynchronous job queue. # BackgroundOperationResult Stores error messages generated when or importing data into big objects using Bulk API. This is a big object, available in API version 37.0 and later. Each instance of BackgroundOperationResult represents one error. The Message field stores the text of the error message. The ParentID field stores the: - Batch ID for the data import, in case of Bulk API Bulk API validates data at the time of import, and generates an error message for the first occurrence of invalid data in any row of the data file. The validation performed depends on the type of data being imported. - **Text**—The length of the input string must be less than or equal to the length of the corresponding text field in the target object. - **Number**—The input data must be a number, whose scale and precision are compatible with the corresponding number field in the target object. - **ID—**The input data must be a valid 15- or 18-character ID. - **DateTime**—The input data must be a valid dateTime value, in the approved format. - **Lookup**—The lookup value must be a valid 15- or 18-character ID. ## Supported Calls describeSObjects(), query() ## Fields | Field Name | Details | | --- | --- | | CreatedById | Type ID Properties Nillable Description The user ID of the user initiating the Bulk API request. | | CreatedDate | Type dateTime Properties Defaulted on create Description The date and time at which the Bulk API request was made. | | Data | Type string Properties Nillable Description The data that generated the error message. The total length is limited to 2,000 characters, and each column can occupy a maximum of 50 characters. Any data exceeding those limits is truncated. | | Id | Type ID Properties Defaulted on create, idLookup Description The ID of the error message. | | Message | Type string Properties Nillable Description The text of the error message. | | MessageType | Type picklist Properties Nillable, Restricted picklist Description The type of error message. The possible values are: ERROR, WARNING, or INFO. | | ParentId | Type reference Properties Filter, Sort Description The batch ID in Bulk API. | ## Usage You can check for errors by querying the BackgroundOperationResult object. For example, this query returns details of all errors in a data file imported using Bulk API, whose batch ID is 751xx000000006OAAQ. SELECT CreatedbyId, CreatedDate, Id, Message, MessageType, ParentId FROM BackgroundOperationResult WHERE ParentId = “751xx000000006OAAQ” ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can only view errors resulting from Bulk API requests that you initiated, unless you have the global permission to view all data. # BatchApexErrorEvent The documentation has moved to [BatchApexErrorEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_batchapexerrorevent.htm "HTML (New Window)") in the Platform Events Developer Guide. # Big Objects A big object stores and manages massive amounts of data on the Salesforce platform. See these topics in the Big Objects Implementation Guide: - [Big Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.big_object_impl_guide.meta/big_object_impl_guide/big_object.htm) A big object stores and manages massive amounts of data on the Salesforce platform. You can archive data from other objects or bring massive datasets from outside systems into a big object to get a full view of your customers. - [Define and Deploy Custom Big Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.big_object_impl_guide.meta/big_object_impl_guide/big_object_define.htm) You can define custom big objects with Metadata API or in Setup. After you define and deploy a big object, you can view it or add fields in Setup. # BillingBatchScheduler Represents a scheduled processing job that triggers recurring invoice batch runs and payment batch runs in Subscription Management. This object is available in API version 55.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_billingbatchscheduler.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | BillingSchedulerName | Type string Properties Filter, Group, idLookup, Sort Description Name of the scheduler. | | Comments | Type textarea Properties Filter, Nillable, Sort Description Optional field for comments about the scheduler. | | CronExpression | Type string Properties Filter, Group, Sort Description Determines how often the scheduler recurs. | | EndDate | Type date Properties Filter, Group, Nillable, Sort Description The date when the scheduler stops triggering batch processing jobs. | | FrequencyCadence | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates how often the scheduler triggers the invoice batch run or the payment batch run. Possible values are: - Daily—The scheduled job recurs every day. - Monthly—The scheduled job recurs every month. - Once—The scheduled job occurs one time and doesn’t recur. - Weekly—The scheduled job recurs every week. | | FrequencyOptions | Type textarea Properties Nillable Description Derived field that stores the scheduler configuration. | | JobType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates the type of batch processing job that the scheduler triggers. Possible values are: - Invoice—The scheduler starts a batch invoice run. - Payment—The scheduler starts a batch payment run. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | NextRunTime | Type dateTime Properties Filter, Nillable, Sort Description The date and timestamp of the next scheduled batch invoice run or batch payment run are shown in the user's time zone. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user who created the scheduler. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RecurringSubType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the frequency at which the batch processing job recurs when the FrequencyCadence is set to _Monthly_. Possible values are: - Every—The processing job recurs at every instance of the frequency of the value. For example, if the RecurringSubType is Every and the FrequencyCadence is Weekly, then the batch processing job recurs every week. - SpecificDate—The scheduler triggers the batch processing job on the selected date. For example, if the selected date is 5, and the FrequencyCadence is Monthly, then the job recurs on the fifth day of each month. | | RecurringType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the frequency at which the batch processing job is repeated when the FrequencyCadence is set to _Weekly_. Possible values are: - Every | | RecursOn | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the interval at which the scheduler triggers a batch processing job. If the FrequencyCadence is Monthly, you must select either the specific date or the interval when the schedule triggers the job. Possible values are: - First - Fourth - Last - Second - Third **Example:** To tell the scheduler to trigger the job on the first Monday of the month, set the following fields: - FrequencyCadence\=Monthly - RecursOn\=First - RecursOnDay\= Monday | | RecursOnDate | Type string Properties Filter, Group, Nillable, Sort Description Specifies the date on which the scheduler triggers a batch processing job. **Example:** To tell the scheduler to trigger the job on the fifth day of the month, set the following fields: - FrequencyCadence\=Monthly - RecursOnDate\=5 **Example:** To tell the scheduler to trigger the job on the second to last day of the month, set the following fields: - FrequencyCadence\=Monthly - RecursOnDate\=SecondToLast If you select Last, SecondToLast, or ThirdToLast, the date of the batch processing job varies depending on the number of days in the month. For example, suppose SecondToLast is selected. If the month has 30 days, such as June, then the batch processing job occurs on the 28th day. If the month has 31 days, such as July, then the batch processing job occurs on the 29th day. | | RecursOnDay | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the day on which the scheduler triggers a batch processing job. If the FrequencyCadence field is set to Weekly, then you must select the day when the scheduler runs. The scheduler recurs every week on the selected day; for example, weekly on Monday. Possible values are: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday | | RunCriteriaId | Type reference Properties Filter, Group, Sort Description The ID of the filter criteria that’s defined for the invoice batch run or the payment batch run. This field is a polymorphic relationship field. Relationship Name RunCriteria Relationship Type Lookup Refers To InvoiceBatchRunCriteria, PaymentBatchRunCriteria | | StartDate | Type date Properties Filter, Group, Sort Description The date when the scheduler triggers its first batch processing job. | | StartTime | Type time Properties Filter, Sort Description The time when the scheduler triggers the batch processing job. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the scheduler. Only Active schedulers can trigger batch processing jobs. Possible values are: - Active - Canceled - Draft - Inactive | | TimeZone | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The time zone is either the value selected when the run was configured, or it's the user's time zone. The time zone is shown in Greenwich Mean Time (GMT). | # BillingPeriodItem Represents one payment period for a subscription. The billing period item is used to pass billing information to an invoice line item in Subscription Management. This object is available in API version 55.0 and later. When a billing schedule is invoiced, Subscription Management creates a billing period item to store the billing and payment information that’s passed to an invoice line. Subscription Management next creates an invoice line for billing period items that match the invoice's target date. One billing period item is created for each billing period in the billing schedule. For example, a one-year subscription that's billed quarterly creates a billing schedule with four billing period items. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_billingperioditem.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Filter, Sort Description Price for the billing period item. Used to calculate the invoice line's Amount field. | | BillingPeriodEndDate | Type date Properties Filter, Group, Nillable, Sort Description Used to calculate the invoice line's end date. | | BillingPeriodItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-defined number that refers to the billing period item. | | BillingPeriodStartDate | Type date Properties Filter, Group, Nillable, Sort Description Used to calculate the invoice line's start date. | | BillingScheduleId | Type reference Properties Filter, Group, Sort Description Parent billing schedule of the billing period item. This field is a relationship field. Relationship Name BillingSchedule Relationship Type Lookup Refers To BillingSchedule | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Contains the ISO code for any currency allowed by the org. Available only for orgs with the multicurrency feature enabled. | | InvoiceBatchRunId | Type reference Properties Filter, Group, Nillable, Sort Description Parent invoice batch run of the billing period item. This field is a relationship field. Relationship Name InvoiceBatchRun Relationship Type Lookup Refers To InvoiceBatchRun | | InvoiceLineId | Type reference Properties Filter, Group, Nillable, Sort Description This field looks up to the invoice line that's generated from the billing period item. This field is populated only when a billing period item is generated via an invoice batch run. Otherwise, this field is empty. This field is a relationship field. Relationship Name InvoiceLine Relationship Type Lookup Refers To InvoiceLine | | InvoiceStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Status of the invoice that contains the invoice line created from the billing period item. Valid values are: - Canceled—The invoice for this billing period item was canceled. - Draft—The invoice has been created but hasn’t been posted. Available in API version 60.0 and later. - DraftInProgress—The invoice hasn’t been created yet. When the invoice is created, the InvoiceStatus field value is changed to Draft. If the invoice generation process fails, the InvoiceStatus field value shows DraftInProgress. Available in API version 60.0 and later. - Error—The invoice for this billing period item was generated in error. - Pending—The invoice for this billing period item is being generated. - Posted—An invoice line based on this billing period has been created and added successfully to the invoice. - PostingInProgress—An invoice line based on this billing period has been created and is in the process of being added to the invoice. Available in API version 60.0 and later. - Voided—An invoice line based on this billing period was voided. - VoidInProgress—An invoice line based on this billing period is in the process of being voided. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Status of the billing period item. Draft billing period items aren't evaluated for invoice line creation. Valid values are: - Canceled - Draft - Reviewed | # BillingPolicy Represents a group of billing treatments, which define the rules for how to invoice a customer for an order item. This object is available in API version 55.0 and later. Billing policies are related to products, which pass the policy on to the resulting order items. When an order is activated, Subscription Management assigns a billing treatment to each order item based on the values in the BillingTreatmentSelection field. Then Subscription Management uses the billing treatment to create billing schedules. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_billingpolicy.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | BillingTreatmentSelection | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines how Subscription Management assigns billing treatments to order items and to assets related to the billing policy. Possible values are: - Default—The value specified in the DefaultBillingTreatmentId field is automatically applied to order items and assets. - Manual—Users must specify the billing treatment that's applied to the order items and assets. | | DefaultBillingTreatmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description When BillingTreatmentSelection has a value of Default, Subscription Management uses the selected billing treatment for all order items and assets related to the billing policy. This field is a relationship field. Relationship Name DefaultBillingTreatment Relationship Type Lookup Refers To BillingTreatment | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Optional user-defined description that describes the billing policy. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Optional user-defined name for the billing policy. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The billing policy's status. Possible values are: - Active—Indicates that the billing policy is available for use on products. - Draft—Indicates that the billing policy isn't available for use on products. Use this status when creating billing policies that aren't ready to be activated. - Inactive—Indicates that the billing policy isn't available for use on products. | # BillingSchedule Stores the order item information used in the invoicing process. This object is available in API version 55.0 and later. When you activate an order, Subscription Management creates one billing schedule for each order item in an order. For example, if an order contains 15 order items, Subscription Management creates 15 billing schedules, one billing schedule for each item. The invoice scheduler uses the information in the billing schedule to determine when it's time to invoice an order item. Billing schedules for all order items that are generated from one asset are summarized in a billing schedule group. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_billingschedule.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | BillDayOfMonth | Type int Properties Filter, Group, Nillable, Sort Description An integer from 1 to 31 that indicates the day of the month. | | BilledAmount | Type currency Properties Filter, Nillable, Sort Description The total amount (excluding tax) that has been invoiced from the billing schedule. This field is a calculated field. | | BillingAccountId | Type reference Properties Filter, Group, Sort Description This field is a relationship field. Relationship Name BillingAccount Refers To Account | | BillingPeriodAmount | Type currency Properties Filter, Nillable, Sort Description The amount to be invoiced each billing period. For example, if the billing period is monthly, this field shows the monthly amount that appears on the invoice line. | | BillingScheduleEndDate | Type date Properties Filter, Group, Nillable, Sort Description The last date that the billing schedule is available for invoicing. Inherited from the EndDate field on the order item. | | BillingScheduleGroupId | Type reference Properties Filter, Group, Sort Description ID of the billing schedule group that contains the billing schedule. Billing schedules are grouped when they have the same source order item. The source order item is the original order item that a customer bought. Afterwards, if the customer amends, cancels, or renews the order item, a new billing schedule is created with the BillingScheduleGroupId for the original order item. This field is a relationship field. Relationship Name BillingScheduleGroup Relationship Type Lookup Refers To BillingScheduleGroup | | BillingScheduleNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Autogenerated reference number for the billing schedule. | | BillingScheduleStartDate | Type date Properties Filter, Group, Nillable, Sort Description The date that the billing schedule is available for invoicing. Inherited from the ServiceDate on the order item. | | BilledThroughPeriod | Type date Properties Filter, Group, Nillable, Sort Description The last billing period that includes this date. | | BillingTreatmentItemId | Type reference Properties Filter, Group, Sort Description The billing treatment item used to configure invoiceable amounts on the billing schedule. This field is a relationship field. Relationship Name BillingTreatmentItem Relationship Type Lookup Refers To BillingTreatmentItem | | CancellationDate | Type date Properties Filter, Group, Nillable, Sort Description The date on which the subscriber can no longer access the service. For example, if a service ends on August 31, then the cancellation date is September 1, because that’s the date when the subscriber can no longer use the service. Subscription Management doesn't invoice billing schedules past their cancellation date. | | Category | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The business action represented by the billing schedule. Possible values are: - AmendQuantity—A billing schedule for an order that changes the quantity. This object is available in API version 56.0 and later. - Cancellation—A billing schedule for an order that was canceled - Original—A billing schedule for the initial order - Renewal—A billing schedule for an order that was renewed | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the invoice. The default value is USD. | | InvoiceBatchRunId | Type reference Properties Filter, Group, Nillable, Sort Description The invoice batch run that evaluated this billing schedule and its billing period items to produce an invoice. This field is a relationship field. Relationship Name InvoiceBatchRun Relationship Type Lookup Refers To InvoiceBatchRun | | InvoiceRunBatch | Type picklist Properties Filter, Group, Nillable, Sort Description The batch value used by the invoice run that evaluated this billing schedule. During an invoice run, billing schedules with the same batch value (including null) are grouped to the same invoice run. For example, create one batch of invoices for Premium Customers and another batch for Regular Customers. Possible values are: - Premium Customers - Regular Customers | | NextBillingDate | Type date Properties Filter, Group, Nillable, Sort Description The date that the next billing period starts for the invoice. Used to calculate which invoice lines are included on an invoice. When an invoice scheduler or API evaluates an order for invoicing, billing schedules with a next billing date on or before the invoice's target date are included on the invoice. | | NextChargeFromDate | Type date Properties Filter, Group, Nillable, Sort Description The date that the billing schedule is invoiced in the upcoming billing period. For example, if you invoiced a customer for a billing period of 01/01/22 through 01/31/22, the billing schedule's NextChargeFromDate is 02/01/22. | | OriginalBillingScheduleId | Type reference Properties Filter, Group, Nillable, Sort Description If this billing schedule is an amended or canceled billing schedule, then this field shows the original billing schedule. Otherwise, this field is null. This field is a relationship field. Relationship Name OriginalBillingSchedule Relationship Type Lookup Refers To BillingSchedule | | PendingAmount | Type currency Properties Filter, Nillable, Sort Description The amount from the current billing term that hasn't been billed yet. For example, the unbilled amount for a month, quarter, or year, depending on this billing schedule's billing term. | | Quantity | Type double Properties Filter, Nillable, Sort Description The quantity of the order item that created the billing schedule. | | ReferenceEntityId | Type reference Properties Filter, Group, Nillable, Sort Description The parent order of the order item that created the billing schedule. This field is a polymorphic relationship field. Relationship Name ReferenceEntity Relationship Type Lookup Refers To Order | | ReferenceEntityItemId | Type reference Properties Filter, Group, Nillable, Sort Description The order item or asset that created the billing schedule. This field is a polymorphic relationship field. Relationship Name ReferenceEntityItem Relationship Type Lookup Refers To OrderItem, OrderItemAdjustementLineTime, or OrderItemSummary | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The state of the order item that the billing schedule represents. Possible values are: - CompletelyBilled - Error - Processing - ReadyForInvoicing | | TaxTreatmentId | Type reference Properties Filter, Group, Sort Description Shows the treatment used to calculate tax for the billing schedule. Defined based on the order item's tax policy. This field is a relationship field. Relationship Name TaxTreatment Relationship Type Lookup Refers To TaxTreatment | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description The total amount of the order item represented by the billing schedule. | | UnitPrice | Type currency Properties Filter, Nillable, Sort Description The price for an individual unit of the billing schedule's parent order item, including charges, adjustments, and discounts. Inherited from the order item's UnitPrice field. | # BillingScheduleGroup Represents a consolidated view of all billing schedules related to the order items generated from one asset, including new orders and amendment orders. This object is available in API version 55.0 and later. When an order is created, a billing schedule is generated for each order item. The billing schedule group summarizes fields from each billing schedule. For example, it summarizes financial fields such as Total Billed Amount and Total Pending Amount and billing fields such as Billing Day of Month and Billing Term. The billing schedule group includes schedules generated from a new order item and schedules generated from amendment order items. The billing schedule group shows users the summarized financial data that includes any changes, such as new orders or amendments, made to the asset. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Special Access Rules This object is available with Subscription Management, Commerce Subscriptions, and Billing (Revenue Cloud). If your org has both Subscription Management and Commerce Subscriptions, then Subscription Management takes precedence. For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_billingschedulegroup.htm "HTML (New Window)"). ## Fields
Field Details
BillDayOfMonth
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The Billing Day of Month for the billing schedules that comprise the billing schedule group.
Subscription Management uses the order item's billing day of month to calculate the order item’s next billing date, which the billing schedule then inherits. For example, an order item can be billed on the first day of the month.
BillToContactId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The contact related to the billing schedule group.
This field can’t be modified when related billing schedules are in processing.
This field is a relationship field.
Relationship Name
BillToContact
Relationship Type
Lookup
Refers To
Contact
BillingAccountId
Type
reference
Properties
Filter, Group, Sort
Description
The Salesforce account for the billing schedule group.
This field is a relationship field.
Relationship Name
BillingAccount
Relationship Type
Lookup
Refers To
Account
BillingAddress
Type
address
Properties
Filter, Nillable
Description
The compound form of the billing address. Read-only. See Address Compound Fields for details on compound address fields.
BillingCity
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address of this billing schedule group. Maximum size is 40 characters.
BillingCountry
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address of this billing schedule group. Maximum size is 80 characters.
BillingGeocodeAccuracy
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Accuracy level of the geocode for the billing address. See Compound Field Considerations and Limitations for details on geolocation compound fields.
BillingLatitude
Type
double
Properties
Filter, Nillable, Sort
Description
Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
BillingLongitude
Type
double
Properties
Filter, Nillable, Sort
Description
Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
BillingMethod
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Shows the type of billing used for the source item.
Possible values are:
  • Evergreen
  • OrderAmount
BillingPostalCode
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address of this billing schedule group. Maximum size is 20 characters.
BillingScheduleGroupNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
System-generated reference number for the billing schedule group.
BillingStartMonth
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Read-only field used with annual billing. The field shows the numbers from 1 to 12, which indicate the month when billing begins for an annual subscription. For example, if billing starts in January, the value is 1; if billing starts in June, the value is 6. This field is available in API version 58.0 and later.
BillingState
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the billing address of this billing schedule group. Maximum size is 80 characters.
BillingStreet
Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
Street address for the billing address of this billing schedule group.
BillingTerm
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Used with BillingTermUnit to define a billing cycle. For example, bill every 20 days or every two months. In this example, the BillingTerm is 20 and the BillingTermUnit is days
BillingTermUnit
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The frequency with which the billing schedule is invoiced.
Possible values are:
  • Day
  • Month
  • OneTime
  • Quarter
  • Semi-Annual
  • Year
Used with BillingTermUnit to define a billing cycle.
BillingType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Inherited from the shared value of each billing schedule in the billing schedule group. Defines when Subscription Management bills a product or service relative to when it’s provided to the customer. Advance billing invoices a product or service before you provide it, while arrears billing invoices a product or service after you provide it. Subscription Management evaluates the billing type when it calculates an order's next billing date.
Possible values are:
  • Advance – If the billing schedule is billed in advance, Subscription Management evaluates the order’s billing day of month to choose the nearest date on or before the order product’s start date. For example, if a monthly order product’s start date is January 1, and the order’s billing day of month is 15, the next billing date is December 15.
  • Arrears – If the billing schedule is billed in arrears, Subscription Management evaluates the order’s billing day of month to choose the nearest date after the order product’s start date. For example, if a monthly order product’s start date is January 1 and the order’s billing day of month is 15, the order product’s next billing date is January 15.
CancellationDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The date that a cancellation was made against the billing schedule. Subscription Management doesn't invoice billing schedules past their cancellation date.
Controller
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
During the invoicing process, this field determines which date is used when the billing schedule group and billing schedule have a related field with conflicting values.
For example, when Controller has a value of BillingScheduleGroup, if the billing schedule's billing day of month is 5 while the billing schedule group's billing day of month is 10, the invoice is sent on the 10th day of the month.
Possible values are:
  • BillingScheduleGroup—The date on the billing schedule group controls.
CurrentBillingPeriodAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
This field was removed in Subscription Management API version 55.0.
CurrentQuantity
Type
double
Properties
Filter, Nillable, Sort
Description
This field was removed in Subscription Management API version 55.0.
EffectiveNextBillingDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The earliest NextBillingDate from all billing schedules in the billing schedule group. This field is a reference field that isn't used for any features or calculations.
This field is a calculated field.
EndDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The latest end date from all billing schedules in the billing schedule group.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The 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
The 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.
OwnerId
Type
reference
Properties
Filter, Group, Sort, Update
Description
The Salesforce user who owns the billing schedule group.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PaymentTermId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The ID of the payment term used in this billing schedule group.
This field can’t be modified when related billing schedules are in processing.
This field is a relationship field.
Relationship Name
PaymentTerm
Relationship Type
Lookup
Refers To
PaymentTerm
PeriodBoundary
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Inherited from the order item's parent quote line item or sales transaction item. The period boundary helps determine the start and end date of the billing periods.
Possible values are:
  • AlignToCalendar—the period starts on the first day of the term unit; for example, the first day of the month.
  • Anniversary—The start date determines the boundary. For example, if a monthly subscription starts on September 13, the subscription starts on the 13th day of each month.
  • DayOfPeriod—the period starts on the day indicated by PeriodBoundaryDay.
  • EndOfPeriod—the period starts on the last day of the pricing term unit.
Product2Id
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the product for the order item represented by each billing schedule in the billing schedule group.
This field is a relationship field.
Relationship Name
Product2
Relationship Type
Lookup
Refers To
Product2
ProductName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product for the order item represented by each billing schedule in the billing schedule group.
ProrationPolicyId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Refers to the proration policy that applies to this billing schedule group. The proration policy defines how time periods are calculated for subscription orders. For example, whether partial periods are allowed.
Inherited from the shared proration policy for each billing schedule in the billing schedule group.
This field is a relationship field.
Relationship Name
ProrationPolicy
Relationship Type
Lookup
Refers To
ProrationPolicy
ReferenceEntityId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The asset used to create the billing schedules in the billing schedule group.
This field is a relationship field.
Relationship Name
ReferenceEntity
Relationship Type
Lookup
Refers To
Asset
ShippingAddress
Type
address
Properties
Filter, Nillable
Description
The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields.
ShippingCity
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the shipping address for this billing schedule group. City maximum size is 40 characters
ShippingCountry
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the shipping address for this billing schedule group. Country maximum size is 80 characters.
ShippingGeocodeAccuracy
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Accuracy level of the geocode for the shipping address. See Compound Field Considerations and Limitations for details on geolocation compound fields.
ShippingLatitude
Type
double
Properties
Filter, Nillable, Sort
Description
Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
ShippingLongitude
Type
double
Properties
Filter, Nillable, Sort
Description
Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
ShippingPostalCode
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the shipping address for this billing schedule group. Postal code maximum size is 20 characters.
ShippingState
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Details for the shipping address for this billing schedule group. State maximum size is 80 characters.
ShippingStreet
Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
The street address of the shipping address for this billing schedule group. Maximum of 255 characters.
StartDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The earliest start date from all billing schedules in the billing schedule group.
TotalBilledAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount that has been invoiced for all billing schedules within the billing schedule group.
This field is a calculated field.
TotalPendingAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount that hasn't yet been invoiced for all billing schedules within the billing schedule group.
This field is a calculated field.
# BillingTreatment Defines how Subscription Management bills an order item. The Exclude From Billing field controls whether the order item is invoiced. Child billing treatment items control how much of the order item's balance is invoiced for each invoice across the subscription's lifecycle. Billing treatments are assigned to order items based on the parent billing policy's Billing Treatment Selection field. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_billingtreatment.htm). ## Fields | Field | Details | | --- | --- | | BillingPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the billing policy for the billing treatment. This field is a relationship field. Relationship Name BillingPolicy Relationship Type Lookup Refers To BillingPolicy | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Optional user-defined description of the billing treatment. | | ExcludeFromBilling | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Excludes any order items assigned to the treatment from creating billing schedules. Possible values are: - No - Yes | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | LegalEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the legal entity used to assign the treatment to order items when the parent billing policy's BillingTreatmentSelection is LegalEntity. This field is a relationship field. Relationship Name LegalEntity Relationship Type Lookup Refers To LegalEntity | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Optional user-defined name for the billing treatment. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Draft or inactive billing treatments can't be assigned to order items. Possible values are: - Active - Draft - Inactive | ## 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. [BillingTreatmentHistory](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.") (API version 55.0) History is available for tracked fields of the object. # BillingTreatmentItem A billing treatment item defines how the order item's total amount is distributed into billing schedules over the course of the order item's lifecycle. In the Subscription Management pilot, billing treatments must have only one billing treatment item, so that the billing treatment item covers 100% of the order item's total value. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_billingtreatmentitem.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | BillingTreatmentId | Type reference Properties Create, Filter, Group, Sort Description The parent billing treatment for the billing treatment item. This field is a relationship field. Relationship Name BillingTreatment Relationship Type Lookup Refers To BillingTreatment | | BillingType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines when Subscription Management invoices a product or service relative to when it’s provided to the customer. Advance billing invoices a product or service before it's provided, while arrears billing invoices a product or service after it has provided Subscription Management evaluates billing type when calculating an order product’s next billing date. Possible values are: - Advance – If the order item is billed in advance, Subscription Management evaluates the order’s billing day of month to choose the nearest date on or before the order product’s start date. For example, if a monthly order product’s start date is January 1, and the order’s billing day of month is 15, the next billing date is December 15. - Arrears – If the order item is billed in arrears, Subscription Management evaluates the order’s billing day of month to choose the nearest date after the order product’s start date. For example, if a monthly order product’s start date is January 1 and the order’s billing day of month is 15, the order product’s next billing date is January 15. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Arrears billing isn't available in Subscription Management API Version 54.0. | | Controller | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description During the invoicing process, this field determines which value Subscription Management uses when the billing schedule group and billing schedule have a shared field with different values. For example, when Controller has a value of BillingScheduleGroup, if the billing schedule's billing day of month is 5 while the billing schedule group's billing day of month is 10, Subscription Management uses the value of 10. In the Subscription Management API version 54.0, only BillingScheduleGroup is supported. Possible values are: - BillingScheduleGroup— | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Three-letter ISO 4217 currency code associated with the billing treatment item. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Optional user-defined description for the billing treatment item. | | FlatAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The amount in terms of units of currency (such as $10 or $21.52) to invoice from the order item. Used only when Type has a value of FlatAmount. | | Handling0Amount | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Shows how Subscription Management invoices billing period items that have an amount of $0. Possible values are: - CreateInvoice—Create a $0 invoice line. - Null —No invoice line is created. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Default name of this record. | | Percentage | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage (such as 10% or 12.5%) to invoice from the order item. Used only when Type has a value of Percentage. | | ProcessingOrder | Type int Properties Create, Filter, Group, Sort, Update Description Defines the order in which Subscription Management creates billing schedules based on each billing treatment item. Lower numbers are evaluated first. For example, if your billing treatment has a billing treatment item that invoices at 25 Percentage and a ProcessingOrder of 1, and another item that invoices at 75 Percentage and a ProcessingOrder of 2, your first billing schedule will be for 25 percent of the order item's total amount, and your second billing schedule will be for 75% of the order item's total amount. | | Sequencing | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Allows users to define the number used to start invoice numbers on invoices generated from this billing treatment item. Subscription Management API Version 54.0 supports only manual sequencing. Possible values are: - Manual—Invoices created from this billing treatment item begin with an invoice number of 1. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Draft billing treatment items aren't evaluated for creating billing schedules. Possible values are: - Active - Draft | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines whether billing schedules created from this billing treatment item are based on a flat amount or a percentage of the order item's total amount. Possible values are: - FlatAmount—The billing schedule is for a flat currency amount of the order item's total amount (for example, $50 or $200.50.) - Percentage—The billing schedule is for a percentage of the order item's total amount (for example, 12.5% or 54%). | ## 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. [BillingTreatmentItemHistory](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.") (API version 55.0) History is available for tracked fields of the object. # Blocked Redirect Event Type Blocked redirect events capture information about blocked redirections from Salesforce to untrusted and malformed URLs. The Blocked Redirect event type is available in the EventLogFile object in API version 63.0 and later. This event is free for all customers with a 24-hour data retention period. The blocked redirects event is available in the API but not in the Event Monitoring Analytics app. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or the [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). Blocked redirect events capture these redirections when the target URL isn’t a [RedirectWhitelistUrl](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_redirectwhitelisturl.htm "Represents a trusted URL for external user redirections. Redirections to a different Salesforce org, including its publicly served pages and content, are allowed from your Salesforce org only when the URL is a RedirectWhitelistUrl. For non-Salesforce URLs, a session setting controls whether redirections from pages and components built in Salesforce Classic are restricted to RedirectWhitelistUrl objects. Except for cross-org redirections, you can’t restrict redirections that originate from pages and components built with Lightning Experience. This object is available in API version 48.0 and later.") or when the target URL fails a syntax check. - An anchor link within a page or component that includes a redirection. For example, linkText includes a redirection via the startURL parameter. - A parameter within a page that redirects the user. For example, this form action redirects the user through the saveURL parameter:
. Within pages and components, a direct anchor link to an external URL is always allowed, even if the target URL isn’t a [RedirectWhitelistUrl](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_redirectwhitelisturl.htm "Represents a trusted URL for external user redirections. Redirections to a different Salesforce org, including its publicly served pages and content, are allowed from your Salesforce org only when the URL is a RedirectWhitelistUrl. For non-Salesforce URLs, a session setting controls whether redirections from pages and components built in Salesforce Classic are restricted to RedirectWhitelistUrl objects. Except for cross-org redirections, you can’t restrict redirections that originate from pages and components built with Lightning Experience. This object is available in API version 48.0 and later."). For those direct anchor links, if the target URL fails a syntax check, the user receives an error but the redirection isn’t captured as a blocked redirect event. An example of a direct anchor link is linkText. For hyperlinks within URL and Long Text Area fields, blocked redirections to untrusted URLs are captured as blocked redirect events only when the user who clicked the hyperlink accessed Salesforce via Salesforce Classic. If those users see a warning message and can proceed to the untrusted URL, that event isn’t captured as a blocked redirect event. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To help preserve performance, Salesforce uses throttling, a technique that limits the number of generated blocked redirect events when the volume is exceptionally high. Therefore, if your org generates a high volume of blocked redirections over a short period of time, some of those redirections can fail to generate a blocked redirect event. ## Fields | Field | Details | | --- | --- | | BLOCKED\_URI | Type String Description The full string of the target for the redirection. Example https://www.example.com/shop.htm | | BLOCKED\_URI\_DOMAIN | Type String Description If BLOCKED\_URI is a URL, the domain for that URL. To allow future redirections to the BLOCKED\_URI, BLOCKED\_URI\_DOMAIN is the value to add to [RedirectWhitelistUrl](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_redirectwhitelisturl.htm?q=%22Trusted%20URL%22). Example www.example.com | | EVENT\_TYPE | Type String Description The type of event. The value is always BlockedRedirect. | | MALFORMED\_URL | Type Boolean Description Indicates whether this redirection was blocked because the target URL failed a syntax check (1) or not (0). Here are examples of malformed URLs. - https://www.example.com/$t61'3 - https://malformed^url.example.com | | ORIGIN | Type String Description The origin that caused the request to the BLOCKED\_URI. For example, if a form on an Experience Cloud Visualforce site page redirects a user to an untrusted URL via the saveURL parameter, ORIGIN contains the base URL of that site. | | REFERRER | Type String Description The absolute or partial address from which the request to the BLOCKED\_URI came. The Referrer-Policy HTTP Header of the request determines how much of the URL is shared. | | REMOTE\_ADDRESS | Type String Description Remote IP address of the client making the request. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 0000000062\_0000x8Lz- | | TIMESTAMP | Type DateTime Description The access time of Salesforce services in GMT. Example 20220715233322.670 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). The time zone is always GMT. Example 2022-07-27T11:32:59.555Z. | ## Usage Only one blocked redirect log file is available at a time. When the daily incremental event log file is generated during the daily background process, the new file replaces the existing file. If the log file doesn’t exist, either the log generation process hasn’t run yet or there’s no redirection data to report for that 24-hour window. The log file is generated only when at least one redirection occurred for the day. To collect blocked redirect logs for multiple days, schedule a daily query of the Blocked Redirect event type via REST API. For example, you can configure a cron job in Unix or a scheduled task in Windows to run the query. #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # BlockedRedirectEventLog Blocked Redirect events capture information about blocked redirections from Salesforce to untrusted and malformed URLs. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | BlockedUri | Type string Properties Filter, Group, Nillable, Sort Description The full string of the target for the redirection. | | BlockedUriDomain | Type string Properties Filter, Group, Nillable, Sort Description If BLOCKED\_URI is a URL, the domain for that URL. To allow future redirections to the BLOCKED\_URI, BLOCKED\_URI\_DOMAIN is the value to add to [RedirectWhitelistUrl](https://developer.salesforce.com/docs/atlas.en-us.256.0.object_reference.meta/object_reference/sforce_api_objects_redirectwhitelisturl.htm?q=%22Trusted%20URL%22). | | IsMalformedUrl | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this redirection was blocked because the target URL failed a syntax check or not. The default value is false. | | Origin | Type string Properties Filter, Group, Nillable, Sort Description The origin that caused the request to the BLOCKED\_URI. For example, if a form on an Experience Cloud Visualforce site page redirects a user to an untrusted URL via the saveURL parameter, ORIGIN contains the base URL of that site. | | Referrer | Type string Properties Filter, Group, Nillable, Sort Description The absolute or partial address from which the request to the BLOCKED\_URI came. The Referrer-Policy HTTP Header of the request determines how much of the URL is shared. | | RemoteAddress | Type string Properties Filter, Group, Nillable, Sort Description Remote IP address of the client making the request. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | # Bookmark Represents a link between opportunities that share common information. This object is available to organizations with the Similar Opportunities feature enabled. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ID | Type ID Properties Defaulted on create, Filter Description ID of the bookmark. Label is **Bookmark ID**. | | FromId | Type ID Properties Filter Description The originating opportunity. Label is **Bookmarked From ID** | | ToId | Type ID Properties Filter Description The opportunity to which the originating opportunity is linked. Label is **Bookmarked To ID**. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | ## Usage The Bookmark object works with the Opportunity object only. Use this read-only object to query the bookmarks between opportunities in your organization. In the online application, users can search for opportunities that share attributes with their opportunity. The user can then bookmark the appropriate opportunities for future reference. # BotDefinition Represents a top level object for Einstein Bots or Agentforce Agents. This object is available in API version 60.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object, Agents must be enabled in your org. ## Fields | Field | Details | | --- | --- | | AgentTemplate | Type string Properties Filter, Group, Nillable, Sort Description If this BotDefinition represents an agent, this field represents the name of the agent template or legacy agent template used to create it. | | AgentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The agent type. For example, Agentforce Service Agent (ASA) or Agentforce Employee Agent (AEA). | | BotUserId | Type reference Properties Filter, Group, Nillable, Sort Description The user ID associated with the bot definition. Relationship Name BotUser Refers To User | | Description | Type textarea Properties Filter, Nillable, Sort Description A description for the bot or agent. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name for this object. | | MasterLabel | Type string Properties Filter, Group, Sort Description The master label of the bot. | | Type | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description This field represents the configuration type of the bot. The default value is Bot. Possible values are: - Bot—Default Einstein Bot configuration. - ExternalCopilot— An external-facing agent. For example, Agenforce Service Agent. - InternalCopilot— An internal-facing agent. For example, Agentforce (Default). | # BotVersion Represents a version of a bot or agent defined by a BotDefinition record. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BotDefinitionId | Type reference Properties Create, Filter, Group, Sort Description Required. This field relates a bot version to its parent BotDefinition record. This field is a relationship field. Relationship Name BotDefinition Refers To BotDefinition | | CopilotPrimaryLanguage | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The primary language that the bot or agent communicates in. | | CopilotSecondaryLanguages | Type string Properties Create, Filter, Nillable, Sort, Update Description A comma-separated list of additional languages that the bot or agent supports. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name for this object. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. Indicates whether the bot version is active or inactive. Only one version for a related BotDefinition can be active at once. Possible values are: - Active - Inactive The default value is Inactive. | | ToneType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Defines the tone of the bot. Possible values are: - Casual— - Formal— - Neutral— The default value is Casual. | | VersionNumber | Type int Properties Create, Filter, Group, Sort, Update Description The number for this version of the bot or agent. | # BrandingSet Represents the definition of a set of branding properties for an Experience Builder site, as defined in the Theme panel in Experience Builder. This object is available in API version 40.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules The BrandingSet type is available when at least one of the following is enabled in your org: Digital Experiences, Surveys, or Lightning Experience. All users, including unauthenticated guest users, can access this type. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the set of branding properties. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. API name of the BrandingSet object. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language used in the branding set. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Required. The user-facing label of the set of branding properties. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix with a 15 character limit. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. NamespacePrefix is null if the publisher is Salesforce. | # BrandTemplate Letterhead for HTML EmailTemplate. ## 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 | | --- | --- | | Description | Type string Properties Create, Filter, Nillable, Sort, Update Description Description of the letterhead. Limited to 1000 characters. | | 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 org. 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 **Letterhead Unique Name**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the letterhead is available for use (true) or not (false). Label is **Active**. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the template as it appears in the user interface. Limited to 255 characters. Label is **Brand Template Name**. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Value | Type textarea Properties Create, Update Description The contents of the letterhead, in HTML, including any logos. | ## Usage Use this object to brand EmailTemplate records with your letterhead. You can also set a brand template to active or inactive. For example, if you have five different marketing brands, you can maintain each different brand in one template, and assign to the appropriate EmailTemplate. #### See Also - [EmailTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailtemplate.htm "Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only.") # Brief Represents a marketing brief. A brief contains information that’s used for positioning and grounding a marketing campaign. Agentforce can help you create a campaign that best fits the goals and requirements in your brief. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AdditionalNotes | Type textarea Properties Create, Nillable, Update Description Context related to the campaign that isn’t represented in the other fields. | | AgentGuardrails | Type textarea Properties Create, Nillable, Update Description Guardrails that the agent must follow when creating a campaign. Use these guardrails to prevent damage to your brand and to ensure safety and compliance. | | BrandId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique ID of your brand. This field is a relationship field. Relationship Name Brand Refers To ManagedContent | | Description | Type textarea Properties Create, Nillable, Update Description A description of the brief. | | IsConversational | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the campaign contains conversational elements. The default value is false. | | KeyMessage | Type textarea Properties Create, Nillable, Update Description The main theme or message that you want to deliver to your customers through the campaign that’s associated with the brief. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the brief was last referenced by a campaign. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the brief was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the brief. | | PlanName | Type textarea Properties Create, Nillable, Update Description An agent-generated name for the campaign. When you save a campaign preview, the resulting campaign has this name. | | PrimaryCtas | Type textarea Properties Create, Nillable, Update Description The main calls-to-action (CTAs) for the brief. The agent uses this information to understand the actions that it can use to meet the goals of the campaign. | | PrimaryGoal | Type textarea Properties Create, Nillable, Update Description The goal of the campaign that’s associated with the brief. The agent uses this field to understand the main objective of the campaign. | | PrimaryKpi | Type textarea Properties Create, Nillable, Update Description The main key performance indicator (KPI) for measuring progress toward the goal. The agent uses this field to prioritize actions that contribute to the goal of the campaign. | | Priority | Type textarea Properties Create, Nillable, Update Description The priority of the brief. The agent uses this field to prioritize actions that contribute to the goal of the campaign. | | TargetAudience | Type textarea Properties Create, Nillable, Update Description A description of the characteristics of the audience that you want to reach through the campaign that’s associated with this brief. | # BriefcaseAssignment Represents the assignment of a briefcase definition to selected users and user groups. This object is available in API version 50.0 and later. Use this object to assign selected records for users and groups to view offline. Briefcase objects are available in orgs that have Briefcase Builder and Field Service enabled. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | BriefcaseId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the briefcase definition. Label is **Briefcase Definition ID**. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the user or group requiring access to the briefcase. Label is **User or Group ID**. | ## 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. [BriefcaseAssignmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. # BriefcaseDefinition Represents a briefcase definition. A briefcase makes selected records available for users to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android. This object is available in API version 50.0 and later. ## Special Access Rules This object is read-only. Briefcase objects are available in orgs that have Briefcase Builder and Field Service enabled. ## Supported Calls describeSObjects(), query(), retrieve() ## Packaging Considerations An org can have up to 5 briefcases. Installed briefcases are counted against this limit. You can’t install a package that includes a briefcase if your org already has 5 briefcases. When a managed package includes a briefcase, the only changes allowed for the briefcase are activating or deactivating and assigning users or groups to the briefcase. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Filter, Nillable, Sort Description Description of the briefcase definition. Limited to 1024 characters. | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. 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. Limited to 80 characters. Label is **Name**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the briefcase is available for use (true) or not (false). Label is **Active**. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language for the briefcase. This field defaults to the user's language unless the org is multi-language enabled. Specifies the language of the labels returned. Possible values are: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. | | MasterLabel | Type string Properties Filter, Group, Sort Description The master label for the briefcase. This internal label doesn’t get translated. Limited to 80 characters. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | ## Usage Use this object to query a briefcase or a list of briefcases with selected records and user assignments. For example: SELECT Id, Description FROM BriefcaseDefinition WHERE Id in (SELECT BriefcaseId FROM BriefcaseRule WHERE TargetEntity='Account') AND Id in (SELECT BriefcaseId FROM BriefcaseAssignment where UserOrGroupId='00GR0000000VtwUMAS') ## 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. [BriefcaseDefinitionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. # BriefcaseRule Represents a rule that specifies records for a briefcase definition. This object is available in API version 50.0 and later. ## Special Access Rules This object is read-only. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | BriefcaseId | Type reference Properties Filter, Group, Sort Description Required. ID of the briefcase definition. Label is **Briefcase Definition ID**. This field is a relationship field. Relationship Name Briefcase Relationship Type Lookup Refers To BriefcaseDefinition | | FilterLogic | Type string Properties Filter, Group, Nillable, Sort Description The filter logic for record selection, for example, 1 AND 2 where 1 and 2 correspond to filter 1 and filter 2. Filter logic operators include AND and OR. Limited to 255 characters. Label is **Filter Logic**. | | IsAscendingOrder | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates whether the records should be sorted in ascending order. Label is **Ascending**. | | OptionsIsRelatedFilesRule | Type boolean Properties Filter Description Indicates whether the briefcase rule is part of a hierarchical set of rules that configure the offline priming of file attachments. Available only for the Offline App (Salesforce Mobile App Plus). | | OrderBy | Type picklist Properties Nillable, Restricted picklist Description The field to order the records by, which determines how the records can be sorted. For example, AccountName or CreatedBy. Label is **Order By**. | | ParentRuleId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the parent rule of this briefcase rule. This field is a relationship field. Relationship Name ParentRule Relationship Type Lookup Refers To BriefcaseRule | | QueryScope | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. A group of records to restrict the scope of this rule. Possible values are: - assignedToMe - everything - mine The default value is everything (All Records). The value assignedToMe is available only for the ServiceAppointment object. | | RecordLimit | Type int Properties Filter, Group, Nillable, Sort Description The record limit for the object. The recommended number for record limit is up to 500 records per object for optimal performance. The maximum number is 2000. Label is **Limit**. | | RelationshipField | Type picklist Properties Nillable, Restricted picklist Description The Salesforce object field that relates the briefcase rule to another briefcase rule. For example, an Account rule can be related to a Contact rule using the Account ID object field. In this example, the value for the briefcase rule's RelationshipField is AccountID. | | RelationshipType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The relationship of the briefcase rule to another briefcase rule. Possible values are: - ParentToChild - ChildToParent | | TargetEntity | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The standard object, custom object, or custom metadata type that the briefcase rule selects records from. The UI label is **Target Object**. | # BriefcaseRuleFilter Represents a filter criteria for a briefcase rule. This object is available in API version 50.0 and later. ## Special Access Rules This object is read-only. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | BriefcaseRuleId | Type reference Properties Filter, Group, Sort Description Required. ID of the briefcase rule. | | FilterOperator | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. The comparison operator for this rule filter. Possible values are: - d—Ends with - e— Equals - g—Greater than - h—Greater than or equal - i—Like - l—Less than - m—Less than or equal - s—Starts with | | FilterSeqNumber | Type int Properties Filter, Group, Sort Description Required. The filter number. When you apply multiple filters, the filters are numbered sequentially, 1, 2, 3, and so on. | | FilterValue | Type string Properties Filter, Group, Nillable, Sort Description The value for the field and criteria. For example, true or false for a boolean field whose criteria or filter operator is Equals. Capitalization matters with date filter operators. Be sure to specify date literals in uppercase. Some valid date literals include TODAY, YESTERDAY and TOMORROW. | | TargetEntityField | Type picklist Properties Restricted picklist Description Required. The field to filter by. Compound fields and encrypted fields aren’t supported. Label is **Field**. | # BroadcastCommAudience Represents the audience that the broadcast communication is sent to. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To access this object with Service Cloud, enable Incident Management in Setup and set up Broadcast Communications. ## Fields | Field | Details | | --- | --- | | AudienceId | Type reference Properties Create, Filter, Group, Sort Description ID of the broadcast communication audience. - If BroadcastType is Alert, this value is the ID of the Group record where the message is sent to. - If BroadcastType is Email, this value is the ID of the ListEmail record where the email is sent to. - If BroadcastType is ExperienceSiteBanner, this value is the ID of the Network record where the banner is displayed at. - If BroadcastType is Slack, this value is the ID of the CollaborationRoom record where the message is sent to. This field is a polymorphic relationship field. Relationship Name Audience Relationship Type Lookup Refers To CollaborationRoom, Group, ListEmail, Network | | BroadcastCommAudienceNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated number for the BroadcastCommAudience record. | | BroadcastCommunicationId | Type reference Properties Create, Filter, Group, Sort Description ID of the broadcast communication record. This field is a relationship field. Relationship Name BroadcastCommunication Relationship Type Lookup Refers To BroadcastCommunication | | BroadcastFailureReason | Type string Properties Filter, Group, Nillable, Sort Description The reason the broadcast communication failed to send. | | BroadcastType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Medium used to distribute the message. Possible values are: - Alert - Email - ExperienceSiteBanner - Slack | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | MessageTimeStamp | Type string Properties Create, Filter, Group, Nillable, Sort Description If BroacastType is Slack, this value is the timestamp when the broadcast Slack message was sent. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | SiteBannerText | Type textarea Properties Create, Nillable Description If BroadcastType is ExperienceSiteBanner, this field contains the banner text displayed on the associated site. | | SiteBannerVisibility | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description If BroadcastType is ExperienceSiteBanner, this field contains information about who can view the banner. Possible values are: - AuthenticatedUsers - GuestUsers | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the broadcast communication. Possible values are: - Active—The site banner is visible on the site. Only applies if BroadcastType is ExperienceSiteBanner. - Deleted—The message is successfully deleted and isn’t visible anymore. Only applies if BroadcastType is Slack. - DeleteFailed—The message failed to delete but is still visible. Only applies if BroadcastType is Slack. - Failed—The message failed to send. Applies to any BroadcastType. - Inactive—The site banner isn’t visible on the site. Only applies if BroadcastType is ExperienceSiteBanner. - Sent—The message is sent successfully. Only applies if the BroadcastType is Email or Slack. - Updated—The message is successfully edited. Only applies if the BroadcastType is Slack. - UpdateFailed—The message failed to edit and the update isn’t visible. Only applies if the BroadcastType is Slack. | ## 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. [BroadcastCommAudienceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [BroadcastCommAudienceFeed](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. [BroadcastCommAudienceHistory](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. [BroadcastCommAudienceOwnerSharingRule](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. [BroadcastCommAudienceShare](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. # BroadcastCommunication Represents a broadcast communication related to an incident. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ## Special Access Rules To access this object with Service Cloud, enable Incident Management in setup and set up Broadcast Communications. ## Fields | Field | Details | | --- | --- | | Body | Type textarea Properties Create, Nillable Description - If BroadcastType is Alert, this field contains the alert message. - If BroadcastType is Email, this field contains the email body text. - If BroadcastType is ExperienceSiteBanner, this field is empty. - If BroadcastType is Slack, this field contains the Slack message. | | BroadcastCommunicationNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated number for every BroadcastCommunication record. | | BroadcastType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Medium used to distribute the message. Possible values are: - Alert - Email - ExperienceSiteBanner - Slack | | CustomNotificationTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the custom notification template used to frame the Slack message. Only applies if BroadcastType is Slack. Available in API version 58.0 and later. This field is a relationship field. Relationship Name CustomNotificationType Relationship Type Lookup Refers To CustomNotificationType | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort Description ID of the owner of this object. 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 Description ID of the incident associated with the broadcast communication. This field is a relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To Incident | | Subject | Type textarea Properties Create, Nillable Description - If BroadcastType is Alert, this field is the alert message in the format “Incident Alert | | .” - If BroadcastType is Email, this field is the subject of the email sent. - If BroadcastType is ExperienceSiteBanner, this field is empty. - If BroadcastType is Slack, this field is in the format “Incident Alert | ." | ## 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. [BroadcastCommunicationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [BroadcastCommunicationFeed](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. [BroadcastCommunicationHistory](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. [BroadcastCommunicationOwnerSharingRule](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. [BroadcastCommunicationShare](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. # BroadcastTopic Represents a definition of a broadcast topic. A broadcast topic is associated with a list of Experience Cloud network sites for Service Cloud and collaboration rooms for Sales Cloud. The topic is created for a specific user role. Collaboration rooms are linked to Slack channels. 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 with Sales Cloud, enable Slack Terms of Service and Sales Cloud for Slack App. To access this object with Service Cloud, enable Incident Management in Setup and Broadcast Site Banner in the Incident Management setup. ## Fields | Field | Details | | --- | --- | | BroadcastReason | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Reason for the broadcast topic. This field differentiates between Service Cloud and Sales Cloud use cases. Possible values are: - FeedChannels—Used in Sales Cloud and associates the topic with collaboration rooms. - IncidentCommunication—Used in Service Cloud for Customer Service Incident Management and associates the topic with networks. The default value is FeedChannels. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the broadcast topic. | | IsFeatured | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the broadcast topic is featured (true) or not (false). This field is applicable only when BroadcastReason is FeedChannels. A featured topic displays the associated collaboration rooms to new users. 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the broadcast topic. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Owner of the broadcast topic. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | TopicType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Category for the broadcast topic. Possible values are: - DealsWon—Feed of won deals to see your team's successes. This value appears when the Sales Cloud special access rules are enabled. - DealsToWatch—Feed of deals that have an amount above a specified value and are likely to close. This value appears when the Sales Cloud special access rules are enabled. - Incident Communication—This value appears when the Service Cloud special access rules are enabled. | # BroadcastTopicGroup Represents a junction object that relates a group to an alert type broadcast topic. The broadcast sends the alert to this group. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Enable Customer Service Incident Management and Broadcast Alert. To create a BroadcastTopicGroup record, set the BroadcastReason field of the associated BroadcastTopic to Incident Communication. ## Fields | Field | Details | | --- | --- | | BroadcastTopicId | Type reference Properties Create, Filter, Group, Sort Description ID of the broadcast topic. This field is a relationship field. Relationship Name BroadcastTopic Relationship Type Lookup Refers To BroadcastTopic | | GroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the group where the alert of the associated BroadcastTopic record with an Alert BroadcastType is sent to. This field is a relationship field. Relationship Name Group Relationship Type Lookup Refers To Group | | Name | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Name of the broadcast topic group. This field is optional. | ## 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. [BroadcastTopicGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. Available in API version 58.0 # BroadcastTopicNetwork Represents a link between a broadcast topic and the Experience Cloud network site for Service Cloud. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object with Service Cloud, enable Incident Management in Setup and Broadcast Site Banner in the Incident Management setup. ## Fields | Field | Details | | --- | --- | | BroadcastTopicId | Type reference Properties Create, Filter, Group, Sort Description The BroadcastTopic ID that's linked to the Network. This field is a relationship field. Relationship Name BroadcastTopic Relationship Type Lookup Refers To BroadcastTopic | | Name | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The name of the broadcast topic that's assigned to the network. | | NetworkId | Type reference Properties Create, Filter, Group, Sort Description The Network ID that's linked to the BroadcastTopic.. This field is a relationship field. Relationship Name Network Relationship Type Lookup Refers To Network | ## 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. [BroadcastTopicNetworkChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # BrowserPolicyViolation Represents a violation that occurred within the last seven days related to the Trusted URLs and Trusted URLs for External Redirects allowlists. These violations include blocked resource requests based on your content security policy (CSP) and blocked redirections. This object is available in API version 61.0 and later. We recommend that you manage this object through the Trusted URL and Browser Policy Violations list in Setup. See [Manage Trusted URL and Browser Policy Violations](https://help.salesforce.com/s/articleView?id=xcloud.security_trusted_urls_csp_violations.htm&type=5&language=en_US) in Salesforce Help. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To help preserve performance, Salesforce uses throttling, a technique that limits the number of generated violations when the volume is exceptionally high. Therefore, if your org generates a high volume of violations over a short period of time, some of those violations can fail to generate a BrowserPolicyViolation. To see detailed information about the captured CSP violations for your org, use the [CSP Violation Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_cspviolation.htm "CSP violation events capture details about blocked resource requests from Lightning Experience pages based on your content security policy (CSP). The CSP Violation event type is available in the EventLogFile object in API version 63.0 and later."). To understand when Salesforce captures blocked redirections, see [External Redirection Restrictions in Salesforce](https://help.salesforce.com/s/articleView?id=xcloud.security_trusted_urls_external_redirections_understand.htm&language=en_US) in Salesforce Help. For detailed information about each blocked redirection, use the [Blocked Redirect Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_blockedredirect.htm "Blocked redirect events capture information about blocked redirections from Salesforce to untrusted and malformed URLs. The Blocked Redirect event type is available in the EventLogFile object in API version 63.0 and later."). When you delete a BrowserPolicyViolation, only the logged event is removed. If your allowlists still block those requests, a new BrowserPolicyViolation is generated the next time a matching request occurs. To help you manage the list, a daily process deletes violations that haven’t occurred within the last seven days. To track browser policy violations over time, schedule daily queries of the Blocked Redirect and CSP Violations event types. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Only users with the Customize Application and Modify All Data permissions can access this object. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort Description The developer name of the violation. Only users with View DeveloperName or View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The language for the blocked request. | | MasterLabel | Type string Properties Create, Filter, Group, Sort Description Master label for this violation. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Namespace prefix for this violation. | | UntrustedUrl | Type string Properties Create, Filter, Group, Nillable, Sort Description The URL associated with the blocked request, without the path. For example, if a blocked requested resource is an image with the URL https://www.example.com/images/image1.png, the UntrustedUrl is https://www.example.com. | | ViolationContext | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description If the ViolationType is img-src (image), font-src (fonts), or frame-src (iframe content), the content security policy (CSP) context for the request. The CSP context controls which pages can load content from a CspTrustedSite. Possible values are: - Lightning—The blocked request is related to a Lightning Experience page. - Not Applicable—ViolationContext isn’t applicable to this violation. For example, violations with a ViolationType of Redirection. | | ViolationImpact | Type String Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The impact of this violation. Possible values are: - Blocked–The policy was enforced and prevented the resource from loading. The impact of blocked redirections and malformed URLs is always Blocked. - Reported–This violation is blocked only after stricter CSP settings are configured. For example, some resource requests associated with the frame-src, font-src, and img-src ViolationType are blocked only when the Adopt updated CSP directives setting is enabled in Session Settings. | | ViolationType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The violation type. Possible values are: - img-src–At least one request to load an image file from the URL was blocked because the UntrustedUrl isn’t a [CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_csptrustedsite.htm) object with this CSP directive. - font-src–At least one request to load a font from the URL was blocked because the UntrustedUrl isn’t a [CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_csptrustedsite.htm) object with this CSP directive. - frame-src–At least one request to load content in an iframe that originated from the URL was blocked because the UntrustedUrl isn’t a [CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_csptrustedsite.htm) object with this CSP directive. - MalformedUrl–At least one redirection to this URL failed because the UntrustedUrl is malformed. - Redirect–At least one redirection to this URL was blocked because the UntrustedUrl isn’t a [RedirectWhitelistUrl](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_redirectwhitelisturl.htm) object. | # Bulk API 2.0 Event Type BulkApi2 events contain details about Bulk API 2.0 requests. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This event type does not include Bulk API requests. For information about the BulkApi event type, see [Bulk API Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_bulkapi.htm "Bulk API events contain details about Bulk API requests."). You can monitor the following Bulk API 2.0 parameters: - The type of data processed via Bulk API 2.0 operations, and how much of that data was processed. - Bulk API 2.0 limits. - For jobs, track how long it takes to complete, database, and CPU usage. - Understand users and the operations they performed. - Detailed errors and failures. BulkApi2 events represent the steps in the Bulk API 2.0 workflow and changes in job state. For a Bulk API 2.0 **Ingest** job, an event is emitted when a job is marked: - created - Note: For multi-part requests, there is no “created” event emitted, only an uploadComplete event. - uploadComplete - inProgress - with a processing update - complete - aborted - deleted For a Bulk API 2.0 **Query** job, an event is emitted when a job is marked: - created - uploadComplete - inProgress - with a processing update - complete - aborted - deleted For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
ENTITY_TYPE
Type
String
Description
The type of entity that Bulk API 2.0 used.
For example, Account or Contact.
EVENT_TYPE
Type
String
Description
The type of event. The value is always BulkApi2.
JOB_ID
Type
String
Description
The 15-character ID of the Bulk API 2.0 job.
JOB_STATUS
Type
String
Description
The job’s current status.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
OPERATION_TYPE
Type
String
Description
The type of Bulk API 2.0 operation that was performed.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
RECORDS_FAILED
Type
Number
Description
The total number of records that failed.
For example: 150.
RECORDS_PROCESSED
Type
Number
Description
Number of records processed for this event.
For example: 980.
Note

Note

The number of records processed is reported differently for ingest and query jobs.

For ingest jobs:
  • Events with a status of InProgress report (if applicable) the number of records processed.
For query jobs:
  • Events with a status of JobComplete or InProgress report (if applicable) the number of records processed.

RESULT_SIZE_MB
Type
Number
Description
Number of megabytes returned in query. Empty for ingest jobs.
For example: 670.
Note

Note

RESULT_SIZE_MB currently does not emit events, but is shown here as a placeholder for future enhancement.

REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case-safe ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case-safe ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
# Bulk API Event Type Bulk API events contain details about Bulk API requests. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This event type does not include Bulk API 2.0 requests. For information about the BulkApi2 event type, see [Bulk API 2.0 Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_bulkapi2.htm "BulkApi2 events contain details about Bulk API 2.0 requests."). For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
BATCH_ID
Type
String
Description
The 15-character ID of the Bulk API batch.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
ENTITY_TYPE
Type
String
Description
The type of entity that the Bulk API used.
EVENT_TYPE
Type
String
Description
The type of event. The value is always BulkApi.
JOB_ID
Type
String
Description
The 15-character ID of the Bulk API job.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
MESSAGE
Type
EscapedString
Description
Any success or error message that’s associated with the request.
NUMBER_FAILURES
Type
Number
Description
The number of failures that were returned with the request.
OPERATION_TYPE
Type
String
Description
The type of Bulk API operation that was performed.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
ROWS_PROCESSED
Type
Number
Description
The number of rows that were processed in the request.
For example: 150.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
SUCCESS
Type
Boolean
Description
Whether the batch was successful.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Bulk API Request Event Type The Bulk API request event captures when Bulk API requests are received to create a job, update a job, create a batch, update a batch, and when a job completes. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This event type doesn’t include Bulk API 2.0 requests. For information about the BulkApi2 event types, see [Bulk API 2.0 Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_bulkapi2.htm "BulkApi2 events contain details about Bulk API 2.0 requests."). For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
API_VERSION
Type
Number
Description
The API version.
BATCH_ID
Type
String
Description
The 15-character ID of the Bulk API batch.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CLIENT_NAME
Type
EscapedString
Description
The name of the client making the request.
CONCURRENCY_MODE
Type
String
Description
The concurrency mode selected by the user.
CONNECTED_APP_ID
Type
String
Description
The ID of the connected app making a request.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
ERROR_MESSAGE
Type
EscapedString
Description
The type of entity that the Bulk API used.
EVENT_TYPE
Type
String
Description
The type of event. The value is always BulkApiRequest.
JOB_ID
Type
String
Description
The 15-character ID of the Bulk API job.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
OPERATION_TYPE
Type
String
Description
The type of Bulk API operation.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_PATH
Type
String
Description
The path of the request.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
STATUS_CODE
Type
Number
Description
The HTTP Status code indicating whether the batch was successful.
SUCCESS
Type
Boolean
Description
Whether the batch was successful.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. The timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The ID of the user making the request.
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
# BulkApi2EventLog Bulk API 2 event logs contain details about Bulk API 2.0 requests. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | ErrorMessage | Type string Properties Filter, Nillable, Sort Description The error message returned on failure. | | FailedRecordCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of records that failed. For example: 150. | | JobIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the Bulk API 2.0 job. | | JobStatus | Type string Properties Filter, Group, Nillable, Sort Description The job’s current status. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | ObjectType | Type string Properties Filter, Group, Nillable, Sort Description The type of event. The value is always BulkApi2. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The type of Bulk API 2.0 operation that was performed. | | ProcessedRecordCount | Type double Properties Filter, Group, Nillable, Sort Description Number of records processed for this event. For example: 980.The number of records processed is reported differently for ingest and query jobs. For _ingest_ jobs: - Events with a status of InProgress report (if applicable) the number of records processed. For _query_ jobs: - Events with a status of JobComplete or InProgress report (if applicable) the number of records processed. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestId. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | ResultSize | Type double Properties Filter, Nillable, Sort Description Number of megabytes returned in query. Empty for ingest jobs. For example: 670. ResultSizeMb currently does not emit events, but is shown here as a placeholder for future enhancement. | | RunTime | Type double Properties Filter, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestId. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # BulkApiEventLog Bulk API event logs contain details about Bulk API requests. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | BatchIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the Bulk API batch. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | FailureCount | Type int Properties Filter, Group, Nillable, Sort Description The number of failures that were returned with the request. | | IsSuccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the callout request was successful. | | JobIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the Bulk API job. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | Message | Type string Properties Filter, Nillable, Sort Description Any success or error message that’s associated with the request. | | ObjectType | Type string Properties Filter, Group, Nillable, Sort Description The type of entity that the Bulk API used. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The type of Bulk API operation that was performed. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestId. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # BulkApiRequestEventLog The Bulk API request event captures when Bulk API requests are received to create a job, update a job, create a batch, update a batch, and when a job completes. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ApiVersion | Type int Properties Filter, Group, Nillable, Sort Description The API version. | | BatchIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the Bulk API batch. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. | | ClientName | Type string Properties Filter, Group, Nillable, Sort Description The name of the client making the request. | | ConcurrencyMode | Type string Properties Filter, Group, Nillable, Sort Description The concurrency mode selected by the user. | | ConnectedAppIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the connected app making a request. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | ErrorMessage | Type string Properties Filter, Group, Nillable, Sort Description The type of entity that the Bulk API used. | | IsSuccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the batch was successful. | | JobIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the Bulk API job | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The hash of the login id to allow click tracking across multiple transactions from login to action. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The type of Bulk API operation. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | RequestPath | Type string Properties Filter, Group, Nillable, Sort Description The path of the request. | | RunTime | Type double Properties Filter, Nillable, Sort Description Amount of time the request took, as measured by SFDC code. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The hash of the sid to allow click tracking across multiple transactions after login to action. | | StatusCode | Type int Properties Filter, Group, Nillable, Sort Description The HTTP Status code indicating whether the batch was successful. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description Timestamp at which the log event was generated. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description URI of the page receiving the request. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # Business Process Represents a business process. Business Processes track separate sales, lead, support, and solution lifecycles by displaying different picklist values according to each user’s profile. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of this business process. Limit: 255 characters. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this business process can be presented to users in the Salesforce user interface (true) or not (false) when creating a new record type or changing the business process of an existing record type. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of this business process. Limit: 80 characters. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | TableEnumOrId | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Required. One of the following values: Case, Opportunity, or Solution. Label is **Entity Enumeration Or ID**. | ## Usage Use the BusinessProcess object to offer different subsets of picklist values to different users for the LeadStatus, CaseStatus, and OpportunityStage fields. Similar to a RecordType, a BusinessProcess identifies the type of a row in a Case, Lead, or Opportunity and implies a subset of picklist values for these three fields. The values for the remaining picklist fields are driven by RecordType. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # BusinessAlert Represents information about insight notifications that Einstein Relationship Insights explores, such as news mentions, job updates, and relationships. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The BusinessAlert object is available only if the ERI Growth User or ERI Starter User license is enabled. ## Fields | Field | Details | | --- | --- | | AlertData | Type textarea Properties Create, Nillable, Update Description Data associated with each alert. | | AlertRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The record that's referenced by the insight alert. This field is a polymorphic relationship field. Relationship Name AlertRecord Relationship Type Lookup Refers To Account, Asset, AuthorizationForm, AuthorizationFormConsent, AuthorizationFormDataUse, AuthorizationFormText, BusinessBrand, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, Contact, ContactPointAddress, ContactPointConsent, ContactPointEmail, ContactPointPhone, ContactPointTypeConsent, ContentVersion, Customer, DataUseLegalBasis, DataUsePurpose, EmailMessage, EngagementChannelType, Idea, Image, Individual, Lead, Location, Opportunity, PartyConsent, Pricebook2, Product2, ProfileSkill, QuickText, Recommendation, Scorecard, ScorecardMetric, Seller, SocialPersona, SocialPost, Solution, VideoCall, WorkBadgeDefinition In addition to the listed standard object fields, this field can refer to custom objects as well, | | AlertType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the type of insight alert. Possible values are: - JOB\_CHANGE - NEWS - RELATIONSHIP The default value is NEWS. | | CurrentDesignation | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The current designation that's related to the job alert. | | CurrentEmployer | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the current employer that's related to the job alert. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed a record related to this alert record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this alert. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the alert record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PreviousDesignation | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The previous designation that's related to the job alert. | | PreviousEmployer | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the previous employer that's related to the job alert. | # BusinessAlertStatus Represents information about the read status of an insight alert. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The BusinessAlertStatus object is available only if the ERI Growth User or ERI Starter User license is enabled. ## Fields | Field | Details | | --- | --- | | BusinessAlertId | Type reference Properties Create, Filter, Group, Sort Description The insight alert related to the status. This field is a relationship field. Relationship Name BusinessAlert Relationship Type Lookup Refers To BusinessAlert | | IsAlertRead | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the insight alert is read by the user (true) or not (false). The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Specifies the activation status of the insight alert. | | UserId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user who is associated with the alert. This field is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | # BusinessBrand Represents a unique brand for a business that belongs to a parent entity. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of this business brand. | | OrgId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Salesforce ID of the business brand. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account owner associated with this business brand. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent entity that this business brand is a child of. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To BusinessBrand | ## 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. [BusinessBrandChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # BusinessHours Specifies the business hours of your support organization. Escalation rules are run only during these hours. Limit a list view to a maximum of 10,000 business hours. If business hours are associated with any Holiday records, then business hours and escalation rules associated with business hours are suspended during the dates and times specified as holidays. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules All users, even those without the “View Setup and Configuration” user permission, can view business hours via the API. ## Fields | Field | Details | | --- | --- | | BusinessHoursId | Type reference Properties Filter, Group, Nillable,Sort Description ID of the BusinessHours associated with the SlaProcess. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the business hours is active (true) or not active (false). | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the business hours. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the business hours are set as the default business hours (true) or not (false). | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the business hours were last viewed. | | FridayEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business closes. | | FridayStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business opens. | | MondayEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business closes. | | MondayStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business opens. | | SaturdayEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business closes. | | SaturdayStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business opens. | | SundayEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business closes. | | SundayStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business opens. | | ThursdayEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business closes. | | ThursdayStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business opens. | | TimeZoneSidKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The time zone of the business hours. | | TuesdayEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business closes. | | TuesdayStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business opens. | | WednesdayEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business closes. | | WednesdayStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description Time that business opens. | ## Usage Use this object to specify the business hours at which your support team operates. Escalation rules only run during the business hours with which they are associated. To set business hours to 24-hours a day, set the times from midnight to midnight (00:00:00 ~ 00:00:00) on each day. By default, business hours are set from 12:00 AM to 12:00 AM in the default time zone specified in your organization's profile. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # BusinessProcessDefinition Setup object that stores information about stages in a customer lifecycle map. The stages are associated with surveys and questions created using Salesforce Surveys. This object is reserved for internal use, and is available in API version 49.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | BusinessProcessGroupId | Type reference Properties Filter, Group, Sort Description Unique identifier of the customer lifecycle map associated with the stage. | | DeveloperName | Type string Properties Filter, Group, Sort Description Developer name of the stage. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the MasterLabel. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, Sort Description Label of the stage. | | ProcessDescription | Type textarea Properties Nillable Description Description of the stage. | | SequenceNumber | Type int Properties Filter, Group, Sort Description The position of the stage in the associated customer lifecycle map. | # BusinessProcessFeedback Setup object that stores information about the survey and the question associated with each stage in a customer lifecycle map. Customer lifecycle maps are used to track the scores provided by customers across their lifecycle using Salesforce Surveys. This object is reserved for internal use, and is available in API version 49.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ActionName | Type string Properties Filter, Group, Sort Description Name of the survey used to gather feedback. | | ActionParam | Type string Properties Filter, Group, Sort Description Name of the question used to gather feedback. | | ActionType | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Method of collecting feedback. Possible value is: - PHONE\_CALL - SURVEY | | BusinessProcessDefinitionId | Type reference Properties Filter, Group, Sort Description Unique identifier of the stage associated with the survey and question. | # BusinessProcessGroup Setup object that stores information about customer lifecycle maps. Customer lifecycle maps are used to track the scores provided by customers across their lifecycle using Salesforce Surveys. This object is reserved for internal use, and is available in API version 49.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CustomerSatisfactionMetric | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Represents the question type that measures the customers' Net Promote Score or satisfaction score across their lifecycle. Possible values are: - NPS - Rating | | Description | Type textarea Properties Nillable Description Description of the customer lifecycle map. | | DeveloperName | Type string Properties Filter, Group, Sort Description Developer name the customer lifecycle map. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the MasterLabel. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, Sort Description Label of the customer lifecycle map. | # BuyerAccount Represents an account that is enabled as a buyer for Lightning B2B Commerce. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The BuyerAccount object is available only if the B2B Commerce license is enabled. ## Fields
Field Details
AvailableCredit
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount of credit available to a buyer account.
This is a calculated field.
BuyerId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the buyer account.
This is a relationship field.
Relationship Name
Buyer
Relationship Type
Lookup
Refers To
Account
Note

Note

This field is unique within your organization.
BuyerStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Status of the buyer account.
Possible values are:
  • Active
  • Inactive
  • On Hold
  • Pending
The default value is 'Pending'.
CommerceType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The type of commerce that the buyer account is conducting, using the Commerce app.
Possible values are:
  • Buyer
  • Reseller
  • Seller
The default value is 'Buyer'.
CreditLimit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The limit of credit available to the buyer account.
CreditStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The type or status of the buyer account's credit ranking.
Possible values are:
  • Bad Credit
  • Delinquent
  • Good Credit
  • On Hold
The default value is 'Good Credit'.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Three-letter ISO currency code associated with the buyer account record.
Possible values are:
  • USD—U.S. Dollar
The default value is 'USD'.
CurrentBalance
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The balance carried by the buyer account.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the buyer account is active (true) or not (false).
The default value is 'false'.
MaximumOrderLimit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The maximum number of orders that can be placed by the buyer account.
MinimumOrderLimit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum number of orders that can be placed by the buyer account.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the buyer account.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the buyer account owner.
This is a relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
User
PayerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the buyer account payer.
This is a relationship field.
Relationship Name
Payer
Relationship Type
Lookup
Refers To
Account
SendToId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of account that an order is sent to.
This is a relationship field.
Relationship Name
SendTo
Relationship Type
Lookup
Refers To
Account
## 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. [BuyerAccountFeed](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. [BuyerAccountHistory](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. [BuyerAccountShare](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. # BuyerCriteria Represents the buyer context qualifier of locale for any buyer groups of type Market This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CriteriaKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The label displayed to list supported markets with associated languages and currencies. Possible values are: - Locale - DataCloudSegment | | CriteriaKeyType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Defines the type of key. Possible values are: - SessionAttributes Session Attributes - DataCloudObjects | | CriteriaValue | Type string Properties Create, Filter, Group, Sort, Update, Nillable Description Required. The value of a Locale. For example, fr-FR. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Optional. Three letter ISO currency codes associated with the buyer account record or a locale. Auto populated if MultiCurrency is enabled in org. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The supported criteria in this record. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the buyer group the criteria apply to. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the member group or Admin/Merchandiser . This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Usage BuyerCriteria is related to objects that enable a localized buyer experience. Together, these objects provide buyers with dynamic access to the qualifiers (entitlements, price books, and promotions) associated with their buyer group when they browse and shop in webstores with localized languages and currencies. The related objects are as follows: - BuyerGroup - stores keys that link member entitlements, price books, promotions, and shipping methods to either a single currency and language or to multiple currencies and languages. - BuyerCriteria - represents locales (languages and currencies) that are enabled for BuyerGroup members when they shop in webstores with localized currencies and languages. - BuyerGroupBuyerCriteria - associates a buyer group that is enabled for webstores with multiple languages and currencies with BuyerCriteria that define those languages and currencies. - BuyerGroupRelatedObject - allows BuyerGroup qualifiers (entitlements, price books, and promotions) to be available in multiple languages and currencies without duplicating the qualifiers for each language and currency. ## 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. [BuyerCriteriaFeed](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. [BuyerCriteriaHistory](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. [BuyerCriteriaOwnerSharingRule](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. [BuyerCriteriaShare](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. # BuyerGroup Associates group qualifiers (entitlements, price books, promotions, and shipping methods) with buyer members based on buyer account ID or on the localized language and currency of the market browsed in a webstore. This object is available in API version 57.0; amended to support Market in version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Buyer group details. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the buyer group. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the creator of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RecordTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the record type of the version This field is a relationship field. Relationship Name RecordType Relationship Type Lookup Refers To RecordType | | Role | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines a fixed or dynamic relationship to the language and currency that products, promotions, and entitlements are displayed in. Possible values are: - AccountBased - Market - DataCloudSegments The default value is AccountBased. When set to Market, and when the org has multiple locales, the currency and language for qualifiers (price books, promotions, entitlements) dynamically change as the buyer views different locale-based markets. | ## Usage BuyerGroup is related to objects that enable a localized buyer experience. Together, these objects provide buyers with dynamic access to the qualifiers (entitlements, price books, and promotions) associated with their buyer group when they browse and shop in webstores with localized languages and currencies. The related objects are as follows: - BuyerGroup - stores keys that link member entitlements, price books, promotions, and shipping methods to either a single currency and language or to multiple currencies and languages. - BuyerCriteria - represents locales (languages and currencies) that are enabled for BuyerGroup members when they shop in webstores with localized currencies and languages. - BuyerGroupBuyerCriteria - associates a buyer group that is enabled for webstores with multiple languages and currencies with BuyerCriteria that define those languages and currencies. - BuyerGroupRelatedObject - allows BuyerGroup qualifiers (entitlements, price books, and promotions) to be available in multiple languages and currencies without duplicating the qualifiers for each language and currency. ## 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. [BuyerGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [BuyerGroupFeed](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. [BuyerGroupHistory](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. [BuyerGroupOwnerSharingRule](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. [BuyerGroupShare](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. # BuyerGroupBuyerCriteria Associates a buyer group that is enabled for webstores supporting multiple languages and currencies with BuyerCriteria that define those languages and currencies. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BuyerCriteriaId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the buyer criteria this record is associated with. This field is a relationship field. Relationship Name BuyerCriteria Relationship Type Lookup Refers To BuyerCriteria | | BuyerGroupId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the buyer group this record is associated with. This field is a relationship field. Relationship Name BuyerGroup Relationship Type Lookup Refers To BuyerGroup | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Optional. Three letter ISO currency codes associated with the buyer account record or a locale. Auto populated if MultiCurrency is enabled in org. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of this record. | ## Usage BuyerGroupBuyerCriteria is related to objects that enable a localized buyer experience. Together, these objects provide buyers with dynamic access to the qualifiers (entitlements, price books, and promotions) associated with their buyer group when they browse and shop in webstores with localized languages and currencies. The related objects are as follows: - BuyerGroup - stores keys that link member entitlements, price books, promotions, and shipping methods to either a single currency and language or to multiple currencies and languages. - BuyerCriteria - represents locales (languages and currencies) that are enabled for BuyerGroup members when they shop in webstores with localized currencies and languages. - BuyerGroupBuyerCriteria - associates a buyer group that is enabled for webstores with multiple languages and currencies with BuyerCriteria that define those languages and currencies. - BuyerGroupRelatedObject - allows BuyerGroup qualifiers (entitlements, price books, and promotions) to be available in multiple languages and currencies without duplicating the qualifiers for each language and currency. # BuyerGroupMember Represents a member of a buyer group. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout, describeSObjects(), getDeleted(), getUpdated(), query, retrieve(), undelete(), update(), upsert() ## Special Access Rules The BuyerGroupMember object is available only if the Commerce Buyer and Entitlements Integrator permission is granted. ## Fields | Field | Details | | --- | --- | | BuyerGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID of the buyer group to which the member belongs. BuyerGroupId is a relationship field. Relationship Name BuyerGroup Relationship Type Lookup Refers To BuyerGroup | | BuyerId | Type reference Properties Create, Filter, Group, Sort Description The ID of the account or guest buyer profile. BuyerId is a polymorphic relationship field. Relationship Name Buyer Relationship Type Lookup Refers To Account, GuestBuyerProfile | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the buyer group member. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, idLookup, Sort Description The ID of the member group or user. OwnerId is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | # BuyerGroupPricebook Represents a buyer group price book used in Lightning B2B Commerce. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The BuyerGroupPricebook object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | BuyerGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID of the buyer group that the price book record is assigned to. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the BuyerGroupPricebook is active (true) or not (false). Default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the Buyer Group Price Book record. | | Pricebook2Id | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the price book assigned to the buyer group. | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The sequential priority used to determine the price of a product. This field is only available for web stores that use the **Priority** pricing strategy. | ## Usage Use the BuyerGroupPricebook object to assign a price book to a set of buyer users. Assigning a price book to a buyer group allows buyers within that buyer group to retrieve product prices from the price book. When a buyer has multiple price book assignments, including multiple prices for the same product, the store Pricing Strategy determines the price. # BuyerGroupRelatedObject Used to associate currencies and supported ship-to countries with a buyer group and its price books, promotions, and entitlements. Supports buyer experience when buyer group members shop in stores enabled for multiple locales. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules BuyerGroupRelatedObject is availble only if the org is Market Enabled (Commerce.orgHasCommerceMarketEnabled). ## Fields | Field | Details | | --- | --- | | BuyerGroupId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the buyer group this record is associated with. This field is a relationship field. Relationship Name BuyerGroup Relationship Type Lookup Refers To BuyerGroup | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of this record. | | ObjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The names displayed in the picklist showing the ObjectValues - currency and ship-to countries. Possible values are: - DefaultCurrency - Default Currency - SupportedShipToCountries - Supported Ship-to Countries | | ObjectValues | Type textarea Properties Create, Nillable, Update Description Optional. Values for ObjectType. The actual currency and supported ship-to countries. Possible values are: - Three-letter ISO currency code associated with the buyer account or a supported locale. - ISO country code for supported ship-to countries. | ## Usage BuyerGroupRelatedObject is related to objects that enable a localized buyer experience. Together, these objects provide buyers with dynamic access to the qualifiers (entitlements, price books, and promotions) associated with their buyer group when they browse and shop in webstores with localized languages and currencies. The related objects are as follows: - BuyerGroup - stores keys that link member entitlements, price books, promotions, and shipping methods to either a single currency and language or to multiple currencies and languages. - BuyerCriteria - represents locales (languages and currencies) that are enabled for BuyerGroup members when they shop in webstores with localized currencies and languages. - BuyerGroupBuyerCriteria - associates a buyer group that is enabled for webstores with multiple languages and currencies with BuyerCriteria that define those languages and currencies. - BuyerGroupRelatedObject - allows BuyerGroup qualifiers (entitlements, price books, and promotions) to be available in multiple languages and currencies without duplicating the qualifiers for each language and currency. ## 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. [BuyerGroupRelatedObjectChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [BuyerGroupRelatedObjectFeed](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. [BuyerGroupRelatedObjectHistory](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. # CalcProcStepRelationship Defines a parent-child relationship between two Expression Set Steps in an Expression Set Version. The label for this object is Expression Set Step Relationship. This object is available in API version 53.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object has been deprecated as of API version 55.0. In API version 55.0 and later, use the new Expression Set objects in Business Rules Engine instead. Parent-child step relationships collectively determine the step order. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Access to Expression Sets requires OmniStudio licenses. ## Fields | Field | Details | | --- | --- | | CalcProcStepId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the child Expression Set Step. This is a relationship field. Relationship Name CalcProcStep Relationship Type Lookup Refers To CalculationProcedureStep | | CalcProcVersionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related Expression Set Version. This is a relationship field. Relationship Name CalcProcVersion Relationship Type Lookup Refers To CalculationProcedureVersion | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The Expression Set Step Relationship name. | | ParentCalcProcStepId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent Expression Set Step. This is a relationship field. Relationship Name ParentCalcProcStep Relationship Type Lookup Refers To CalculationProcedureStep | | RelationshipType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of relationship between the parent and child steps. Possible values are: - Bypass—The parent is a condition step. If the condition is false, the child is the next step. - ParentChild—The child is the next step after the parent. | ## 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. [CalcProcStepRelationshipFeed](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. [CalcProcStepRelationshipHistory](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. # CalculatedInsightRangeBound Stores the information required to calculate a range-bound data insight. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available only if a B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | InsightName | Type string Properties Create, Filter, Group, Sort Description Name of the calculated insight. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | LowerBoundRange | Type double Properties Create, Filter, Sort, Update Description The lower limit of the calculated insight. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The autogenerated name of the insight. | | Operator | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Operation used to calculate the insight based on the upper bound range and lower bound range. Possible values are: - EQUAL\_TO - GREATER\_THAN - GREATER\_THAN\_EQUAL\_TO - LESS\_THAN - LESS\_THAN\_EQUAL\_TO | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the contact who owns the insight. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | SalesStoreId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the webstore associated with the insight benchmarks. This field is a relationship field. Relationship Name SalesStore Relationship Type Lookup Refers To WebStore | | UpperBoundRange | Type double Properties Create, Filter, Nillable, Sort, Update Description The upper limit of the calculated insight. | ## 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. [CalculatedInsightRangeBoundOwnerSharingRule](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. [CalculatedInsightRangeBoundShare](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. # CalculationProcedure Performs a series of calculations using matrix lookups and user-defined variables and constants. The label for this object is Expression Set. This object is available in API version 53.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object has been deprecated as of API version 55.0. In API version 55.0 and later, use the new Expression Set objects in Business Rules Engine instead. Expression Sets accept input variables and return output variables, both in JSON format. Expression Sets are especially useful for determining prices, rates, and quotes. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Access to Expression Sets requires OmniStudio licenses. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A text description of the Expression Set. | | InputVariablesMetadata | Type textarea Properties Create, Nillable, Update Description Metadata for the Expression Set's input variables. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user only accessed this record or list view (LastReferencedDate) but didn't view it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The Expression Set name. | | OutputVariablesMetadata | Type textarea Properties Create, Nillable, Update Description Metadata for the Expression Set's output variables. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this Expression Set. Default value is the user logged in to the API to perform the create action. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Usage OmniScripts and Integration Procedures can call Expression Sets. Expression Sets can call Decision Matrices. # CalculationProcedureStep Defines a step in an Expression Set. The label for this object is Expression Set Step. This object is available in API version 53.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object has been deprecated as of API version 55.0. In API version 55.0 and later, use the new Expression Set objects in Business Rules Engine instead. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Access to Expression Sets requires OmniStudio licenses. ## Fields | Field | Details | | --- | --- | | CalculationMatrixId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Decision Matrix this step calls. Applicable only if the StepType is MatrixLookupor GroupMatrixLookup. This is a relationship field. Relationship Name CalculationMatrix Relationship Type Lookup Refers To CalculationMatrix | | CalculationMatrixType | Type string Properties Filter, Group, Nillable, Sort Description The type of the Decision Matrix this step calls. Applicable only if this step calls a Decision Matrix. If the StepType is MatrixLookup, the value of this field is Standard. If the StepType is GroupMatrixLookup, the value of this field is Grouped. | | CalculationProcedure | Type string Properties Filter, Group, Nillable, Sort Description The ID of the Expression Set to which this step belongs. | | CalculationProcedureVersionId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Expression Set Version to which this step belongs. This is a relationship field. Relationship Name CalculationProcedureVersion Relationship Type Lookup Refers To CalculationProcedureVersion | | ConditionsConvertedText | Type textarea Properties Create, Nillable, Update Description The condition expression converted to postfix notation. Applicable only if the StepType is Condition. | | ConditionsExpressionText | Type textarea Properties Create, Nillable, Update Description The condition expression as the user entered it. Applicable only if the StepType is Condition. | | ConditionsUiFormattedText | Type textarea Properties Create, Nillable, Update Description The condition expression converted to JSON format for UI display. Applicable only if the StepType is Condition. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A text description of the Expression Set Step. | | FormulaConvertedText | Type textarea Properties Create, Nillable, Update Description The formula expression converted to postfix notation. Applicable only if the StepType is Calculation. | | FormulaExpressionText | Type textarea Properties Create, Nillable, Update Description The formula expression as the user entered it. Applicable only if the StepType is Calculation. | | FormulaUiFormattedText | Type textarea Properties Create, Nillable, Update Description The formula expression converted to JSON format for UI display. Applicable only if the StepType is Calculation. | | InputVariablesFormatText | Type textarea Properties Create, Nillable, Update Description A list of the input matrix columns or procedure variables applicable to the step. | | IsConditionalStep | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies that this step is conditional. The default value is false. | | IsResultIncluded | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies that the result of this step is included in the Expression Set output. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The step name. | | OutputVariablesFormatText | Type textarea Properties Create, Nillable, Update Description A list of the output matrix columns or procedure variables applicable to the step. Applicable only if the StepType is MatrixLookup, GroupMatrixLookup, or ReferenceProcedure. | | OutputVariablesMappingText | Type textarea Properties Create, Nillable, Update Description Maps Decision Matrix output variables to Expression Set variables. Applicable only if the StepType is MatrixLookupor GroupMatrixLookup. | | ReferenceProcedureId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the child Expression Set this step calls. Applicable only if the StepType is ReferenceProcedure. This is a relationship field. Relationship Name ReferenceProcedure Relationship Type Lookup Refers To CalculationProcedure | | ReturnMessageValueSet | Type textarea Properties Create, Nillable, Update Description A set of messages to return based on the result of a step with a StepType of Condition. | | Stage | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The stage of Expression Set invocation. The Aggregation stage applies only to steps with a StepType of Aggregation. Possible values are: - Aggregation - Calculation | | StageStepSequence | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Sequence order of the step within the Expression Set. Used only for Expression Sets migrated from a Salesforce Industries package. New Expression Sets use Expression Set Step Relationship objects to order their steps. | | StepType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of action this step performs. Possible values are: - Aggregation—Returns an average, maximum, minimum, or sum of a list of values. - Calculation—Performs a mathematical operation, which can include variables and constants. - Condition—Defines a condition that determines whether other steps are invoked. - GroupMatrixLookup—Calls a Grouped Decision Matrix. - MatrixLookup—Calls a Standard Decision Matrix. - ReferenceProcedure—Calls a child Expression Set. | # CalculationProcedureVariable Defines a variable in an Expression Set. The label for this object is Expression Set Variable. This object is available in API version 53.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object has been deprecated as of API version 55.0. In API version 55.0 and later, use the new Expression Set objects in Business Rules Engine instead. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Access to Expression Sets requires OmniStudio licenses. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of this variable. | | CalculationMatrixName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the Decision Matrix to which this variable belongs. Applicable only if this variable references a Decision Matrix column. | | CalculationProcedureVersionId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Expression Set Version to which this variable belongs. This is a relationship field. Relationship Name CalculationProcedureVersion Relationship Type Lookup Refers To CalculationProcedureVersion | | DataType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The data type of this variable. Possible values are: - Boolean - Currency - Date - Number - Percent - Text | | DefaultValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The default value of this variable. | | DisplayName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user-readable name of this variable. | | IsEditable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, specifies that a variable is NOT auto-imported from a step that calls a Decision Matrix or a child Expression Set. The default value is false. | | IsUserDefined | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether a variable is defined by the user. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this variable. | | Precision | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of decimal places. Applicable if the DataType is Currency, Number, or Percent. | | UiDisplayOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The display order of the variable in the UI. | # CalculationProcedureVersion Defines a version of an Expression Set. The label for this object is Expression Set Version. This object is available in API version 53.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object has been deprecated as of API version 55.0. In API version 55.0 and later, use the new Expression Set objects in Business Rules Engine instead. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Access to Expression Sets requires OmniStudio licenses. ## Fields | Field | Details | | --- | --- | | CalculationProcedureId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Expression Set to which this version belongs. This is a relationship field. Relationship Name CalculationProcedure Relationship Type Lookup Refers To CalculationProcedure | | Constants | Type textarea Properties Create, Nillable, Update Description A serialized JSON object containing information about each constant. This information includes the name, data type, alias, and precision. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A text description of the Expression Set Version. | | EndDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last date on which this Expression Set Version is active. | | IsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether this Expression Set Version is active. The default value is false. | | IsLoopingEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether looping is enabled in this Expression Set Version. The default value is false. | | LastSimulatedVariablesInput | Type textarea Properties Create, Nillable, Update Description The input variables and results of the most recent simulation. | | LoopEnd | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the end variable for looping. | | LoopIncrement | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the interval variable for looping. | | LoopStart | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the start variable for looping. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The version name. | | Rank | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description When more than one enabled version matches an Expression Set call, and the StartDateTime to EndDateTime spans overlap, the version with the highest Rank is chosen. | | StartDateTime | Type dateTime Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The first date on which this Expression Set Version is active. | | VersionNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The version number. | # Calendar Represents a calendar. This can be a default user calendar, public calendar, resource calendar, or holiday calendar. This object is available in API version 45.0 and later. Newly created users are assigned a default calendar automatically. Similarly, holiday calendars are created automatically for each organization. ## Supported Calls describeSObjects(), query(), retrieve(), search() ## Special Access Rules Users with "View Setup and Configuration" user permissions can create, edit, and delete public and resource calendars in the user interface. All users, even those without the “View Setup and Configuration” user permission, can view calendars via the API. ## Fields All fields are readable only. | Field | Details | | --- | --- | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description This field indicates whether a user can save events to the calendar. | | Name | Type string Properties Filter, Group, idLookup, Sort Description A user provided name that identifies the calendar. It is text-indexed for searchability. Note that this is not an enumerated field; it can be any string to a maximum length of 80 characters. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of the calendar. Possible values are: - Holiday (Holiday Calendar) - Public (Public Calendar) - Resource (Resource Calendar) - User (User Calendar) | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user that owns that calendar record. If Type=User, there’s a UserID associated (foreign key reference to the user). Otherwise, the user field is null. | # CalendarView These calendars can be created and assigned to users other than the creator. Available calendars include object, shared, public, resource, and user list calendars. Object calendars represent a calendar based on a Salesforce object, either standard or custom. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules All fields and entities referenced by field values must be accessible by the CalendarView creator even if the creator isn’t the CalendarView owner. ## Fields
Field Details
Color
Type
string
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Represents the color used in the background for records displayed in a user’s calendar view within the user interface.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
DateHandlingType
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Determined by the data type of the StartField. Valid values include:
  • Date
  • Datetime
DisplayField
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Represents the SobjectType field used as the subject for records displayed in a user’s calendar view within the user interface.
EndField
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
An optional field that represents the sObjectType field used as the end time for records displayed in a user’s calendar view within the user interface. Must be a date or dateTime field that matches the type in StartField.
FillPattern
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Represents the pattern displayed as the background for records displayed in a user’s calendar view within the user interface. Valid values include:
  • verticalStripes
  • ascDiagonalStripes
  • descDiagonalStripes
IsDisplayed
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Defines whether users can see a calendar’s records in their calendar view in the user interface. When true, records are visible in the user’s calendar view. When false, records are hidden from the user’s calendar view. The default is true. IsDisplayed can be true for up to 50 calendars.
ListViewFilterId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References the ListView used to filter records represented by the CalendarView. ListView must have the same sObjectType. If no ListViewFilterId is defined, the calendar displays only records with the same owner as the CalendarView.
This is a relationship field.
Relationship Name
ListViewFilter
Relationship Type
Lookup
Refers To
ListView
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
A user-provided name that identifies the calendar. This isn’t an enumerated field; it can be any string to a maximum length of 80 characters.
OwnerId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Represents the owner of the CalendarView.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PublisherId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Represents the user, user list, public, or resource calendar from where event data is populated.
This is a polymorphic relationship field.
Relationship Name
Publisher
Relationship Type
Lookup
Refers To
Calendar, ListView, User
SobjectType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The type of standard or custom Salesforce object that is used to create records for the CalendarView. Use the API name of the desired SobjectType.
StartField
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Represents the SobjectType field used as the start time for records displayed in a user’s calendar view within the user interface. Must be a date or dateTime field type.
## Usage To distribute a CalendarView to multiple users, IDs can be pulled from a group, user list, or profile. For this example, a CalendarView based on opportunity close dates is being distributed to a sales team in a public group, Sales Group: Group userGroup = \[SELECT Id FROM Group WHERE Name = 'Sales Group' LIMIT 1\]; List groupId = new List(); groupId.add(userGroup.id); List groupMembers = \[SELECT UserOrGroupId FROM GroupMember WHERE GroupId IN: groupId\]; List calendarViews = new List(); for (GroupMember groupMember : groupMembers) { CalendarView calendarView = new CalendarView(name = 'Opportunity Close Dates’, SobjectType = 'Opportunity', StartField = 'CloseDate', DisplayField = 'Name', OwnerId = groupMember.UserOrGroupId); calendarViews.add(calendarView); } insert calendarViews; ## 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. [CalendarViewChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # CallCenter Represents a call center, which is a logical representation of a single computer-telephony integration (CTI) system instance in an organization. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | AdapterUrl | Type string Properties Create, Filter, Group, Nillable, Sort Description An optional field that specifies the location of where the CTI adapter is hosted. For example, http://localhost:11000. This field is available in API version 23.0 or later. | | CustomSettings | Type string Properties Create, Filter, Nillable, Sort Description Specifies settings in the call center definition file, such as whether the call center uses the Open CTI, and SoftPhone properties, such as height in pixels. This field is available for Open CTI and in API version 25.0 or later. | | Id | Type ID Properties Defaulted on create, Filter Description System field that uniquely identifies this call center. Label is **Call Center ID**. This ID is created automatically when the call center is created. | | InternalName | Type string Properties Create, Filter, Group, Sort Description The internal name of the call center. Limit is 80 characters. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort Description The name of the call center. Limit is 80 characters. | | Version | Type double Properties Create, Filter, Nillable, Sort Description The version of the CTI Toolkit used to create the call center (for versions 2.0 and later). This field is available in API version 18.0 and later. | ## Usage Create a call center or query an existing call center. # CallCenterRoutingMap Stores a mapping between a user or queue in a Salesforce org to a user or queue in an external system’s call center. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Access to standard objects requires Salesforce admin privileges or the Customize Application permission. Access to call center routing map records requires Salesforce Voice Contact Center Admin, Salesforce Voice Contact Center Admin (Partner Telephony), Salesforce Voice Contact Center Supervisor, or Manage Call Centers permission. ## Fields | Field | Details | | --- | --- | | CallCenterId | Type reference Properties Create, Filter, Group, Sort, Update Description Reference to a call center. This is a relationship field. Relationship Name CallCenter Relationship Type Lookup Refers To CallCenter | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer name is a combination of the Salesforce user ID or queue name, and the call center ID, with an underscore between these two values. - \[SALESFORCE\_USER\_ID\]\_\[CALL\_CENTER\_ID\] - \[SALESFORCE\_QUEUE\_NAME\]\_\[CALL\_CENTER\_ID\] | | ExternalId | Type string Properties Create, Filter, Group, Sort, Update Description Unique identifier for the external system’s user or queue. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the MasterLabel. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The master label of the CallCenterRoutingMap. | | QuickConnect | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Amazon Connect QuickConnectId ARN used to determine agent availability for Omni-Channel call transfers. Available in API version 56.0 and later. This is a polymorphic relationship field. | | ReferenceRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description Lookup field to a Salesforce user or queue. This is a polymorphic relationship field. Relationship Name ReferenceRecord Relationship Type Lookup Refers To Group, User | # CallCoachingMediaProvider Represents the media provider for call recordings. This object is available in API version 49.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the connection with the provider is active or not. | | ProviderDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the media provider. | | ProviderName | Type string Properties Create, Filter, Group, idLookup, Sort Description The name of the media provider. | # CallCtrAgentFavTrfrDest Represents a transfer destination that has been marked (starred) as a favorite in the Omni-Channel softphone by a contact center agent for voice call transfers. This object is available in API version 55.0 and later. To see a list of transfer destinations that have been marked as favorites in the Omni-Channel softphone, add a participant to the call, click the Phone tab, and select **Favorite** from the Filter dropdown menu. Examples of transfer destination types include agents, contacts, directories, flows, and queues. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AgentId | Type reference Properties Create, Filter, Group, Sort, Update Description The unique ID of the contact center agent who marked the transfer destination as a favorite. This field is a relationship field. Relationship Name Agent Relationship Type Lookup Refers To User | | CallCenterId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique ID of the contact center from where the agent starred the transfer destination as a favorite. This field is a relationship field. Relationship Name CallCenter Relationship Type Lookup Refers To CallCenter | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the transfer destination record that’s marked as a favorite. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The unique ID of the user who owns this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | TransferDestination | Type string Properties Create, Filter, Group, Sort, Update Description The unique ID of the transfer destination that’s marked as a favorite. This is an external ID. | # CallCtrAgentFavTrfrDestShare Represents a sharing entry on a favorite transfer destination in the Omni-Channel softphone for voice call transfers. This object is available in API version 55.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The level of access the User or Group has to the transfer destination that’s marked as a favorite. Possible values are: - All — Owner - Edit — Read/Write - Read — Read Only | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The unique ID of the parent object. This field is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To CallCtrAgentFavTrfrDest | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Possible values are: - CompliantDataSharing — Compliant Data Sharing - GuestParentImplicit — Associated guest user sharing - GuestPersonImplicit — Associated Guest User Sharing - GuestRule — Guest User Sharing Rule - ImplicitChild — Account Sharing - ImplicitParent — Associated record owner or sharing - ImplicitPerson — Person Contact - LearningAssignment — Learning Assignment Share - LearningAssignmentImplicit — Learning Assignment Implicit Share - LearningItemAssignment — Learning Item Assignment Share - Manual — Manual Sharing - MfgTargetShare — Manufacturing Target Sharing Rule - Owner - Rule — Sharing Rule - SharingRecordCollection — Record Collection - SurveyShare — Survey Sharing Rule - Team — Sales Team - Territory — Territory Assignment Rule - Territory2AssociationManual — Territory Manual - Territory2Forecast — Territory assignment for forecasting and reporting - TerritoryManual — Territory Manual - TerritoryRule — Territory Sharing Rule | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The unique ID of the User or Group that has been given access to the favorite transfer destination. This field is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | # CallDisposition Represents a call result value that sales reps select when logging a call. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field | Details | | --- | --- | | Disposition | Type string Properties Filter, Group, idLookup, Sort Description The result of a phone call, such as whether a call was connected or the rep left a voicemail. | | DispositionCategoryId | Type reference Properties Filter, Group, Sort Description The related call outcome that is used in reports and branching criteria for cadences. | # CallDispositionCategory Represents the call outcome of a phone call that is used in reports and branching criteria for cadences. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field | Details | | --- | --- | | Category | Type string Properties Filter, Group, idLookup, Sort Description The name of the call outcome. | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the call category. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, Sort Description The static name of the call outcome. | # CallTemplate Represents a call script for users to read when making calls. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Filter, Group, Nillable, Sort Description The description of the call script. | | HtmlBody | Type textarea Properties Nillable Description The body content of the call script. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this CallTemplate. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this CallTemplate. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the call script. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user who owns the call script. | | TemplateType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of call template. Possible values are: - Text | | TotalCalls | Type int Properties Filter, Group, Nillable, Sort Description The total number of calls that use the CallTemplate. | | TotalCallsCallBackLater | Type int Properties Filter, Group, Nillable, Sort Description The total Call Back Later call results that use the CallTemplate. | | TotalCallsLeftVoicemail | Type int Properties Filter, Group, Nillable, Sort Description The total Left Voicemail call results that use the CallTemplate. | | TotalCallsMeaningfulConnect | Type int Properties Filter, Group, Nillable, Sort Description The total Meaningful Connect call results that use the CallTemplate. | | TotalCallsNotInterested | Type int Properties Filter, Group, Nillable, Sort Description The total Not Interested call results that use the CallTemplate. | | TotalCallsUncategorized | Type int Properties Filter, Group, Nillable, Sort Description The total uncategorized call results that use the CallTemplate. | | TotalCallsUnqualified | Type int Properties Filter, Group, Nillable, Sort Description The total Unqualified call results that use the CallTemplate. | ## 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. [CallTemplateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. # Campaign Represents and tracks a marketing campaign, such as a direct mail promotion, webinar, or trade show. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | ActualCost | Type currency Properties Filter, Nillable, Sort Description The amount of money spent to run the campaign. Label is Actual Cost in Campaign. | | AmountAllOpportunities | Type currency Properties Filter, Sort Description Amount of money in all opportunities associated with the campaign, including closed/won opportunities. Label is Value Opportunities in Campaign. | | AmountWonOpportunities | Type currency Properties Filter, Sort Description Amount of money in closed or won opportunities associated with the campaign. Label is Value Won Opportunities in Campaign. | | BriefId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the brief that's associated with the campaign. A brief contains additional context about the goals and audience for the campaign. The label is Brief. Relationship Name Brief Relationship Type Lookup Refers To Record | | BudgetedCost | Type currency Properties Filter, Nillable, Sort Description Amount of money budgeted for the campaign. Label is Budgeted Cost in Campaign. | | CampaignImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the campaign image. Available in API version 42.0 and later. Only available to orgs with Partner Community licenses and Digital Experience enabled or orgs that have installed the Direct Marketing Managed package. | | CampaignMemberRecordTypeId | Type reference Properties Filter, Group, Nillable, Sort Description The record type ID for CampaignMember records associated with the campaign. This is a relationship field. Relationship Name CampaignMemberRecordType Relationship Type Lookup Refers To RecordType | | CampaignStage | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description This field is available with Marketing Cloud Growth and Advanced editions. The lifecycle stage of the campaign based on the status of all of its related flows. Possible values are: - In Planning - In Progress - Completed - Error - Canceled - Paused | | CreatedByID | Type reference Properties Filter, Group, Sort Description ID of the user who created the campaign. This is a relationship field. Relationship Name Creator Relationship Type Lookup Refers To User | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Description | Type textarea Properties Nillable Description Description of the campaign. Limit: 32 KB. Only the first 255 characters display in reports. | | EndDate | Type date Properties Filter, Group, Nillable, Sort Description Ending date for the campaign. Responses received after this date are still counted. | | ExpectedResponse | Type percent Properties Filter, Nillable, Sort Description Percentage of responses you expect to receive for the campaign. | | ExpectedRevenue | Type currency Properties Filter, Nillable, Sort Description Amount of money you expect to generate from the campaign. | | HierarchyActualCost | Type currency Properties Filter, Nillable, Sort Description Calculated field for the total amount of money spent to run the campaigns in a campaign hierarchy. Label is Total Actual Cost in Hierarchy. | | HierarchyAmountAllOpportunities | Type currency Properties Filter, Sort Description Amount of money in all opportunities associated with the campaign in a campaign hierarchy, including closed/won opportunities. Label is Value Opportunities in Hierarchy. | | HierarchyAmountWonOpportunities | Type currency Properties Filter, Sort Description The amount of money in closed or won opportunities associated with the campaign in a campaign hierarchy. Label is Value Won Opportunities in Hierarchy. | | HierarchyBudgetedCost | Type currency Properties Filter, Nillable, Sort Description Calculated field for the total amount of money budgeted for the campaigns in a campaign hierarchy. Label isTotal Budgeted Cost in Hierarchy. | | HierarchyExpectedRevenue | Type currency Properties Filter, Nillable, Sort Description Calculated field for the total amount of money you expect to generate from the campaign in a campaign hierarchy. Label is Total Expected Revenue in Hierarchy. | | HierarchyNumberOfContacts | Type int Properties Filter Description Calculated field for the number of contacts associated with the campaign hierarchy. Label is Total Contacts in Hierarchy. | | HierarchyNumberOfConvertedLeads | Type currency Properties Filter, Nillable, Sort Description Calculated field for the number of converted leads from the campaign in a campaign hierarchy. Label is Converted Leads in Hierarchy. | | HierarchyNumberOfLeads | Type currency Properties Filter, Nillable, Sort Description Calculated field for the number of leads from the campaign in a campaign hierarchy. Label is Leads in Hierarchy. | | HierarchyNumberOfOpportunities | Type currency Properties Filter, Nillable, Sort Description Calculated field for the number of opportunities related to the campaign in a campaign hierarchy. Label is Opportunities in Hierarchy. | | HierarchyNumberOfResponses | Type currency Properties Filter, Nillable, Sort Description Number of contacts and unconverted leads with a Member Status equivalent to “Responded” for the campaign in a campaign hierarchy. Label is **Responses in Hierarchy**. | | HierarchyNumberOfWonOpportunities | Type int Properties Filter, Group, Sort Description The number of closed or won opportunities associated with the campaign. Label is Won Opportunities in Hierarchy. | | HierarchyNumberSent | Type double Properties Filter, Nillable, Sort Description Calculated field for the total number of individuals targeted by the campaign in a campaign hierarchy. For example, the number of email messages sent. The label is Num Sent in Hierarchy. | | HierarchyTotalEmailsDelivered | Type int Properties Filter Description Calculated field for emails delivered related to the campaign in a campaign hierarchy. Label is Total Emails Delivered in Hierarchy. This field is available with Marketing Cloud Account Engagement. | | HierarchyTotalFormSubmissions | Type int Properties Filter Description Calculated field for form submissions related to the campaign in a campaign hierarchy. Label is Total Form Submissions in Hierarchy. This field is available with Marketing Cloud Account Engagement. | | HierarchyTotalFormViews | Type int Properties Filter Description Calculated field for form views related to the campaign in a campaign hierarchy. Label is Total Form Views in Hierarchy. This field is available with Marketing Cloud Account Engagement. | | HierarchyTotalLandingPageFormSubmissions | Type int Properties Filter Description Calculated field for form submissions from a landing page related to the campaign in a campaign hierarchy. Label is Total Landing Page Form Submissions in Hierarchy. This field is available with Marketing Cloud Account Engagement. | | HierarchyTotalLandingPageViews | Type int Properties Filter Description Calculated field for landing page views related to the campaign in a campaign hierarchy. Label is Total Landing Page Views in Hierarchy. This field is available with Marketing Cloud Account Engagement. | | HierarchyUniqueEmailOpens | Type int Properties Filter Description Calculated field for email opens related to the campaign in a campaign hierarchy. Excludes repeat opens. Label is Unique Email Opens in Hierarchy. This field is available with Marketing Cloud Account Engagement. | | HierarchyUniqueEmailTrackedLinkClicks | Type int Properties Filter Description Calculated field for unique email link clicks related to the campaign in a campaign hierarchy. Excludes repeat clicks. Label is Unique Email Clicks in Hierarchy. This field is available with Marketing Cloud Account Engagement. | | HierarchyUniqueMarketingLinkClicks | Type int Properties Filter Description Calculated field for unique marketing link clicks related to the campaign in a campaign hierarchy. Excludes repeat clicks. Label is Unique Marketing Link Clicks in Hierarchy. This field is available with Marketing Cloud Account Engagement. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this campaign is active (true) or not (false). The default value is false. The label is **Active**. | | LastActivityDate | Type date Properties Filter, Group, Nillable, Sort Description Value is one of the following, whichever is the most recent: - The due date of the most recent event logged against the record. - The due date of the most recently closed task associated with the record. | | LastModifiedById | Type reference Properties Filter, Group, Sort Description ID of the user who last updated the campaign. This is a relationship field. Relationship Name Last Modified Relationship Type Lookup Refers To User | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort, Description The 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 The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. Name of the campaign. Limit: is 80 characters. | | NumberOfContacts | Type int Properties Filter, Group, Sort Description Number of contacts associated with the campaign. Label is Total Contacts. | | NumberOfConvertedLeads | Type int Properties Filter, Group, Sort Description Number of leads that were converted to an account and contact due to the marketing efforts in the campaign. Label is Converted Leads. | | NumberOfLeads | Type int Properties Filter, Group, Sort Description The number of leads associated with the campaign. Label is Leads in Campaign. | | NumberOfOpportunities | Type int Properties Filter, Group, Sort Description The number of opportunities associated with the campaign. Label is Opportunities in Campaign. | | NumberOfResponses | Type int Properties Filter, Group, Sort Description The number of contacts and unconverted leads with a Member Status equivalent to “Responded” for the campaign. Label is Responses in Campaign. | | NumberOfWonOpportunities | Type int Properties Filter, Group, Sort Description The number of closed or won opportunities associated with the campaign. Label is Won Opportunities in Campaign. | | NumberSent | Type double Properties Filter, Nillable, Sort Description The number of individuals targeted by the campaign. For example, the number of emails sent. Label is Num Sent. | | OwnerId | Type reference Properties Filter, Group, Sort Description ID of the user who owns this campaign. Default value is the user logging in to the API to perform the create. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | ParentCampaign | Type reference Properties Create, Filter, Nillable, Update Description The campaign above the selected campaign in the campaign hierarchy. | | ParentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the parent Campaign record, if any. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Campaign | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to this object. | | StartDate | Type date Properties Filter, Group, Nillable, Sort Description Starting date for the campaign. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description Status of the campaign, for example, Planned, In Progress. Limit: 40 characters. | | TenantId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated Marketing Cloud Account Engagement business unit. Read-only. Available with Marketing Cloud Account Engagement in API version 51.0 and later. This is a relationship field. Relationship Name Business Unit Relationship Type Lookup Refers To PardotTenant | | TotalAmountAllOpportunities | Type currency Properties Filter Description Calculated field for total amount of all opportunities associated with the campaign hierarchy, including closed/won opportunities. Label is Total Value Opportunities in Hierarchy. | | TotalAmountAllWonOpportunities | Type currency Properties Filter Description Calculated field for amount of all closed/won opportunities associated with the campaign hierarchy. Label is Total Value Won Opportunities in Hierarchy. | | TotalEmailsDelivered | Type int Properties Filter Description Calculated field for emails delivered related to the campaign. Label is Total Emails Delivered in Campaign. This field is available with Marketing Cloud Account Engagement. | | TotalFormSubmissions | Type int Properties Filter Description Calculated field for form submissions related to the campaign. Label is Total Form Submissions in Campaign. This field is available with Marketing Cloud Account Engagement. | | TotalFormViews | Type int Properties Filter Description Calculated field for form views related to the campaign. Label is Total Form Views in Campaign. This field is available with Marketing Cloud Account Engagement. | | TotalLandingPageFormSubmissions | Type int Properties Filter Description Calculated field for form submissions from a landing page related to the campaign. Label is Total Landing Page Form Submissions in Campaign. This field is available with Marketing Cloud Account Engagement. | | TotalLandingPageViews | Type int Properties Filter Description Calculated field for landing page views related to the campaign. Label is Total Landing Page Views in Campaign. This field is available with Marketing Cloud Account Engagement. | | TotalNumberofLeads | Type int Properties Filter Description Calculated field for total number of leads associated with the campaign hierarchy. This number also includes converted leads. Label is Total Leads in Hierarchy. | | TotalNumberofOpportunities | Type int Properties Filter Description Calculated field for the total number of opportunities associated with the campaign hierarchy. Label is Total Opportunities in Hierarchy. | | TotalNumberofResponses | Type int Properties Filter Description Calculated field for number of contacts and unconverted leads that have a Member Status equivalent to “Responded” for the campaign hierarchy. Label is Total Responses in Hierarchy. | | TotalNumberofWonOpportunities | Type int Properties Filter Description Calculated field for the total number of won opportunities associated with the campaign hierarchy. Label is Total Won Opportunities in Hierarchy. | | Type | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description Type of campaign, for example, Direct Mail or Referral Program. Limit: 40 characters. | | UniqueEmailOpens | Type int Properties Filter Description Calculated field for email opens related to the campaign. Excludes repeat opens. Label is Unique Email Opens in Campaign. This field is available with Marketing Cloud Account Engagement. | | UniqueEmailTrackedLinkClicks | Type int Properties Filter Description Calculated field for unique email link clicks related to the campaign. Excludes repeat clicks. Label is Unique Email Clicks in Campaign. This field is available with Marketing Cloud Account Engagement. | | UniqueMarketingLinkClicks | Type int Properties Filter Description Calculated field for unique marketing link clicks related to the campaign. Excludes repeat clicks. Label is Unique Marketing Link Clicks in Campaign. This field is available with Marketing Cloud Account Engagement. | ## Usage Client applications can create, update, delete, and query Attachment records associated with a campaign via the API. The Campaign object is defined only for those organizations that have the marketing feature enabled and valid marketing licenses. In addition, it is accessible only to those users that are enabled as marketing users. If the organization does not have the marketing feature or valid marketing licenses, this object does not appear in the describeGlobal() call, and you can’t use describeSObjects() or query() with the Campaign object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The main constituent of a campaign is a CampaignMember. You will commonly need to update campaigns with CampaignMember. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CampaignChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [CampaignFeed](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.") (API version 18.0) Feed tracking is available for the object. [CampaignHistory](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.") (API version 40.0) History is available for tracked fields of the object. [CampaignOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaignownersharingrule.htm "Represents the rules for sharing a campaign with User records other than the owner or anyone above the owner in the role hierarchy.") Sharing rules are available for the object. [CampaignShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaignshare.htm "Represents a sharing entry on a Campaign.") Sharing is available for the object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # CampaignExt Represents a campaign's extended configuration, capturing its association with a marketing program and its governance and review status. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Marketing Planning and Operations must be available to access this object. See [Availability of Marketing Planning and Operations](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | ApprovalStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the current approval state of the campaign. Possible values are: - APPROVED—Approved - DRAFT—Draft - PENDING—Pending - REJECTED—Rejected | | CampaignId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the campaign associated with this extension. This field is a relationship field. Relationship Name Campaign Refers To Campaign | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate is not null, the user accessed this record or list view indirectly. | | MarketingProgramId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the marketing program associated with the campaign. This field is a relationship field. Relationship Name MarketingProgram Refers To MarketingProgram | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the campaign extension. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the campaign extension record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ReviewExecutionStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the status of the review execution. Possible values are: - COMPLIANT—Compliant - NON\_COMPLIANT—Non-Compliant - PENDING—Pending | ## 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. [CampaignExtOwnerSharingRule](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. [CampaignExtShare](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. # CampaignInfluence Represents the association between a campaign and an opportunity in Customizable Campaign Influence. This object is available in API version 37.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This information applies only to Customizable Campaign Influence and not to [Campaign Influence 1.0](https://help.salesforce.com/s/articleView?id=sf.campaigns_influence_original.htm&language=en_US) . To ingest this object in Data Cloud, set up the Data Cloud Salesforce Connector permission set. See [Enable Object and Field Permissions for CRM Connections.](https://help.salesforce.com/s/articleView?id=data.c360_a_crm_enable_object_and_field_permissions.htm&type=5&language=en_US "HTML (New Window)") ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, Customizable Campaign Influence must be enabled. Customer Portal users can’t access this object. ## Fields | Field Name | Details | | --- | --- | | CampaignId | Type reference Properties Create, Filter, Group, Sort Description The ID of the campaign that’s related to the opportunity. | | CampaignMemberId | Type reference Properties Create, Filter, Group, Sort Description The ID of the campaign member related to the opportunity. Not available in the UI. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the contact on the associated opportunity. | | Influence | Type percent Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The percentage of the Amount field for the related opportunity that’s attributed to the campaign. | | ModelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the campaign influence model that’s related to the record. | | OpportunityContactRoleId | Type reference Properties Create, Filter, Group, Sort Description The opportunity contact role ID of the related opportunity. Not available in the UI. | | OpportunityId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related opportunity. | | RevenueShare | Type currency Properties Filter, Nillable, Sort Description The amount of revenue from the related opportunity attributed to the campaign. | ## Usage Use this object to create campaign influence records for your custom campaign influence models. Don’t create campaign influence records for the Primary Campaign Source model. Records added to the Primary Campaign Source model via the API are deleted when the model is recalculated. # CampaignInfluenceModel This read-only object represents a campaign influence model in Customizable Campaign Influence. Use campaign influence models to group CampaignInfluence records created by a specific set of triggers and workflows that you define. The Primary Campaign Source influence model is the default model. This object is available in API version 37.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This information applies only to [Customizable Campaign Influence](https://help.salesforce.com/s/articleView?id=sales.campaigns_influence_customizable.htm&type=5&language=en_US "HTML (New Window)") and not to [Campaign Influence 1.0](https://help.salesforce.com/s/articleView?id=sales.campaigns_influence_original.htm&type=5&language=en_US "HTML (New Window)"). ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object, Customizable Campaign Influence must be enabled. Customer Portal users can’t access this object. ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The API name of the influence model. This name can contain only underscores and alphanumeric characters, and must be unique in your org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the model is active. Active models can generate campaign influence records. Deactivating a model deletes its campaign influence records. Custom models are always active and this field is ignored. | | IsDefaultModel | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the model is the default model (true) or not (false). CampaignInfluence records associated with the default model appear in 3 locations. - The Campaign Influence related list on opportunities - The Influenced Opportunities related list on campaigns - The Campaign Statistics section on campaigns The value of IsDefaultModel can only be true for 1 model at a time. | | IsModelLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the model is locked (true) or not (false). Records for locked models can only be added, updated, or deleted via the API. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the influence model. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label for the influence model. | | ModelDescription | Type string Properties Filter, Group, Nillable, Sort Description The description of the influence model. | | ModelType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the model is the Primary Campaign Source influence model, or a custom model. These values are the allowed. - 1: Primary Campaign Source Model - 2: Custom Model - 3: First Touch Model - 4: Last Touch Model - 5: Even Distribution Model - 6: Data-Driven Model | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | RecordPreference | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The value of this field determines when to create campaign influence records. - AllRecords: Creates records regardless of the revenue attribution percentage. - RecordsWithAttribution: Creates records only when the revenue attribution is greater than 0%. | # CampaignMember The CampaignMember object represents the relationship between a campaign and either a lead or a contact. If the Accounts as Campaign Members setting is enabled in an org, CampaignMember can also represent the relationship between a campaign and an account. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Sort Description ID of the account related to the campaign. This field is available only if the Accounts as Campaign Members setting is enabled in the org. This field is a relationship field. Relationship Name Related Record ID Relationship Type Lookup Refers To Account | | CampaignId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the campaign related to the lead or contact. This field is a relationship field. Relationship Name Campaign Relationship Type Lookup Refers To Campaign | | City | Type string Properties Filter, Group, Nillable, Sort Description The city for the address of the lead or contact. In orgs with the Accounts as Campaign Members setting enabled, this field can be the city for the account. | | CompanyOrAccount | Type string Properties Filter, Group, Nillable, Sort Description The company or account of the lead or contact. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Required. The ID of a contact that's related to the campaign. This field is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. This field contains the ISO code for any currency allowed by the organization. | | Country | Type string Properties Filter, Group, Nillable, Sort Description The country for the address of the lead or contact. In orgs with the Accounts as Campaign Members setting enabled, this field can be the country for the account. | | Description | Type textarea Properties Nillable Description The description of the associated lead or contact. In orgs with the Accounts as Campaign Members setting enabled, this field can be the description of the account. | | DoNotCall | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the lead or contact doesn’t want to be called. In orgs with the Accounts as Campaign Members setting enabled, this field can indicate the account doesn’t want to be called. | | Email | Type email Properties Filter, Group, Nillable, Sort Description Email address for the lead or contact. In orgs with the Accounts as Campaign Members setting enabled, this field can be the email address for the account. | | Fax | Type phone Properties Filter, Group, Nillable, Sort Description Fax number for the lead or contact. In orgs with the Accounts as Campaign Members setting enabled, this field can be the fax number for the account. | | FirstName | Type string Properties Filter, Group, Nillable, Sort Description The first name of the lead or contact. | | FirstRespondedDate | Type date Properties Filter, Group, Nillable, Sort Description This field indicates the date that the campaign member received a status of Responded. | | HasOptedOutOfEmail | Type boolean Properties Defaulted on create, Filter, Group, Sort Description This field indicates the email opt-out preference for the lead or contact. A value of false indicates that the lead or contact is opted in to emails. A value of true indicates that they’re opted out. In orgs with the Accounts as Campaign Members setting enabled, this field can be the opt-out preference for the account email address. | | HasOptedOutOfFax | Type boolean Properties Defaulted on create, Filter, Group, Sort Description This field indicates the fax opt-out preferences for the lead or contact. A value of false indicates that the lead or contact is opted in to receiving faxes. A value of true indicates that they’re opted out. In orgs with the Accounts as Campaign Members setting enabled, this field can indicate the account has opted out of faxes. | | HasResponded | Type boolean Properties Defaulted on create, Filter, Group, Sort Description This field indicates whether the campaign member has responded to the campaign (true) or not (false). Label is **Responded**. | | LastName | Type string Properties Filter, Group, Nillable, Sort Description The last name of the lead or contact. The limit is 80 characters. | | LeadId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Required. The ID of a lead that's related to the campaign. This field is a relationship field. Relationship Name Lead Relationship Type Lookup Refers To Lead | | LeadOrContactId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of a lead or contact that's related to the campaign. In orgs with the Accounts as Campaign Members setting enabled, this field also accepts an account ID. | | LeadOrContactOwnerId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the owner of the associated lead or contact owner. In orgs with the Accounts as Campaign Members setting enabled, this field can be the owner of the account. This field is a polymorphic relationship field. Relationship Name LeadOrContactOwner Relationship Type Lookup Refers To Group, User | | LeadSource | Type picklist Properties Filter, Group, Nillable, Sort Description The source where the lead was obtained. | | MobilePhone | Type phone Properties Filter, Group, Nillable, Sort Description The mobile phone number of the lead or contact. In orgs with the Accounts as Campaign Members setting enabled, this field can be the mobile phone number for the account. | | Name | Type string Properties Filter, Group, Nillable, Sort Description The first and last name of the lead or contact that's related to the campaign member. | | Phone | Type phone Properties Filter, Group, Nillable, Sort Description The phone number of the lead or contact. In orgs with the Accounts as Campaign Members setting enabled, this field can be the phone number for the account. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort Description The postal code for the lead or contact. In orgs with the Accounts as Campaign Members setting enabled, this field can be the postal code for the account. | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to this object. To change the record type, modify the CampaignMemberRecordTypeId field on the associated Campaign. | | Salutation | Type picklist Properties Filter, Group, Nillable, Sort Description Salutation for the lead or contact. | | State | Type string Properties Filter, Group, Nillable, Sort Description The state for the address of the lead or contact. The limit is 80 characters. In orgs with the Accounts as Campaign Members setting enabled, this field can be the state of the account address. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Controls the HasResponded flag on this object. You can't directly set the HasResponded flag, as it’s read-only. You can set it indirectly by setting this field in a create or update call. Each predefined value implies a HasResponded flag value. Each time you update this field, you implicitly update the HasResponded flag. In the Salesforce user interface, Marketing users can define valid status values for the Status picklist. They can choose one status as the default status. For each Status field value, they can also select which values to count as “Responded,” meaning that the HasResponded flag is set to true for those values. The limit is 40 characters. When you create or update campaign members, use the text value for Status instead of the ID from the CampaignMemberStatus object. | | Street | Type string Properties Filter, Group, Nillable, Sort Description The street for the address of the lead or contact. In orgs with the Accounts as Campaign Members setting enabled, this field can be the street of the account address. | | Title | Type string Properties Filter, Group, Nillable, Sort Description Title for the lead or contact. | | Type | Type string Properties Filter, Group, Nillable, Sort Description Indicates if the campaign member is a lead or a contact. In orgs with the Accounts as Campaign Members setting enabled, this field can indicate an account. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you’re importing CampaignMember data into Salesforce and want to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself. ## Usage Each record has a unique ID, and must contain either a ContactId or a LeadId, but can't contain both. Any attempt to create a single record with both results in a successful insert but only the ContactId is inserted. However, you can create two separate records on a Campaign—one for the Lead and one for the Contact. In orgs with the Accounts as Campaign Members setting enabled, the unique ID can be an AccountID. Standard fields from a lead or contact are associated with the CampaignMember object, but you can’t query them directly. To include a Phone in your query, for example, query the field from the Lead object. SELECT Id, (SELECT Phone FROM Lead) FROM CampaignMember This object is defined only for orgs that have the marketing feature and valid marketing licenses. If your org doesn’t have the marketing feature or valid marketing licenses, this object doesn’t appear in the describeGlobal() call, and you can't use describeSObjects() or query() with this object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you want to track lead-based campaign members you convert to contacts, provide both a ContactId and a LeadId. Otherwise, only use one ID type. To issue create() requests to the API, your account only requires read access to campaigns. If the record doesn’t exist for the specified ContactId or LeadId, then a new record is created. If the record exists, an error is returned and no update is made. To update an existing record, specify the ID of the CampaignMember record to update. To delete a record, specify the ID of the CampaignMember record. When creating or updating records, the Status field value specified in the call is verified as a valid status for the given Campaign: - If the specified Status value is a valid status, the value is updated, and the HasResponded field is updated to either true or false, depending on the Status value association with HasResponded. - If the specified Status value isn’t a valid status, the API assigns the default status to the Status field and updates the HasResponded field with the associated value. However, if the given Campaign doesn’t have a default status, the API assigns the value specified in the call to the Status field, and the HasResponded field is set to false. ## 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. [CampaignMemberChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 46.0) Change events are available for the object. #### See Also - [Campaign](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaign.htm "Represents and tracks a marketing campaign, such as a direct mail promotion, webinar, or trade show.") - [CampaignMemberStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaignmemberstatus.htm "One or more member status values defined for a campaign.") # CampaignMemberStatus One or more member status values defined for a campaign. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Customer Portal users can't access this object. You can't delete a CampaignMemberStatus if that status is designated as the default status or if the status is currently used in a Campaign. ## Fields | Field | Details | | --- | --- | | CampaignId | Type reference Properties Filter, Group, Sort Description ID of the campaign associated with this member status. | | HasResponded | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this status is equivalent to “Responded” (true) or not (false). Beginning with API version 39.0, at least one CampaignMemberStatus on each campaign must have a hasResponded value of true. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this status is the default status (true) or not (false). Beginning with API version 39.0, there must be a default CampaignMemberStatus defined for every campaign. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | Label | Type string Properties Filter, Sort Description Label for the status in the picklist. Limited to 765 characters. | | SortOrder | Type int Properties Filter, Group, Sort, Update Description Unique number order where this campaign member status appears in the picklist. | ## Usage Use this object to create picklist items for the member status in a campaign. This object is defined only for those organizations that have the marketing feature and valid marketing licenses. In addition, the object is accessible only to those users that are enabled as marketing users. If the organization does not have the marketing feature or valid marketing licenses, this object does not appear in a describeGlobal() call, and you can't use describeSObjects() or query() with the CampaignMember object. ## 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. [CampaignMemberStatusChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 46.0) Change events are available for the object. #### See Also - [Campaign](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaign.htm "Represents and tracks a marketing campaign, such as a direct mail promotion, webinar, or trade show.") - [CampaignMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaignmember.htm "The CampaignMember object represents the relationship between a campaign and either a lead or a contact. If the Accounts as Campaign Members setting is enabled in an org, CampaignMember can also represent the relationship between a campaign and an account.") # CampaignOwnerSharingRule Represents the rules for sharing a campaign with User records other than the owner or anyone above the owner in the role hierarchy. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CampaignAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group, or UserRole. The possible values are: - Read - Edit - All | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. This field is available in API version 24.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. A Campaign owned by a User in the source Group triggers the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access. | ## Usage Use this object to manage the sharing rules for campaigns. #### See Also - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") # CampaignShare Represents a sharing entry on a Campaign. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only users with access to the Campaign object can access this object. ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field | Details | | --- | --- | | CampaignId | Type reference Properties Create, Filter, Group, Sort Description ID of the Campaign associated with this sharing entry. This field can't be updated. This is a relationship field. Relationship Name Campaign Relationship Type Lookup Refers To Campaign | | CampaignAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the Campaign. The possible values are: - Read - Edit - All (This value is not valid for creating or updating records.) This field must be set to an access level that is higher than the organization’s default access level for Campaign. | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values: - Rule—The User or Group has access via a Campaign sharing rule. - GuestRule—The User or Group has access via a Campaign guest user sharing rule. - Manual—The User or Group has access because a User with “All” access manually shared the Campaign with them. - Owner—The User is the owner of the Campaign. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. - ARImplicit—The User, who belongs to a partner or customer account, has access to the Campaign via an account relationship data sharing rule. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the Campaign. This field can't be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object allows you to determine which users and groups can view or edit Campaign records owned by other users. # CampaignTag Associates a word or short phrase with a Campaign. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage CampaignTag stores the relationship between its parent TagDefinition and the Campaign being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. # CardPaymentMethod Represents a credit card or debit card payment method, which implements the PaymentMethod object. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Customer account for the payment method. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | AuditEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the card owner where audit information about payments gets sent. This field is available in API v49.0 and later. It doesn’t appear in the UI by default for orgs that upgraded from v48.0. Users must add it to the CardPaymentMethod page layout on their own. | | AutoCardType | Type string Properties Create, Filter, Group, Nillable, Sort Description Card network type, derived from the card number. | | CardBin | Type int Properties Create, Filter, Group, Nillable, Sort Description First six digits of the card number. | | CardCategory | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Defines whether the card is a credit card or debit card. Possible values are: - CreditCard - DebitCard | | CardHolderFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description First name of the cardholder. | | CardHolderLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Last name of the cardholder. | | CardHolderName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Full name of the cardholder. | | CardLastFour | Type int Properties Create, Filter, Group, Nillable, Sort Description Last four digits of the credit card or debit card. | | CardPaymentMethodNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-defined unique ID for the card payment method. | | CardType | Type picklist Properties Create, Filter, Group, Nillable, Sort Description Identifies the credit card type. Possible values are: - American Express - Diners Club - JCB - Maestro - Master Card - Visa | | CardTypeCategory | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Further identifies the credit card. Used for internal reference. Possible values are: - AmericanExpress - DinersClub - Discover - Jcb - Maestro - MasterCard - UnionPay - Visa | | Comments | Type textarea Properties Create, Nillable, Update Description Payment admin can add comments to provide additional details about a record. Maximum of 1000 characters. | | CompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Company of the cardholder. | | DisplayCardNumber | Type string Properties Filter, Group, Nillable, Sort Description Masked digits for the full credit card number except the last four digits. | | Email | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the payer. | | ExpiryMonth | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The card’s expiration month. | | ExpiryYear | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The card’s expiration year. | | GatewayDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date that the payment gateway logs a card activity. | | GatewayResultCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The result of the card payment method’s interaction with the payment gateway during a transaction request. | | GatewayResultCodeDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Additional information about the gateway result code. Descriptions vary between payment gateway providers. | | GatewayToken | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unencrypted unique token ID generated by the payment gateway to represent the card payment method during transactions. GatewayToken is for use with APIs earlier than version 52.0. For version 53.0 and latter, use the GatewayTokenEncrypted field. To secure the token, use the GatewayTokenEncrypted field. An error message appears if you try to record a GatewayToken for a card payment method that already has a GatewayToken or GatewayTokenEncrypted value. | | GatewayTokenDetails | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Additional information about the gateway token. | | GatewayTokenEncrypted | Type encryptedstring Properties Create, Nillable, Update Description Encrypted unique token ID generated by the payment gateway to represent the card payment method during transactions. Encrypted using Salesforce Classic Encryption. Available in API version 52.0 and later. | | InputCardNumber | Type string Properties Create, Filter, Group, Nillable, Sort Description Used by a payer to enter a credit card number when storing an external-type card payment method. After entry, the credit card number isn’t saved, so the InputCardNumber value always appears blank. The credit card number appears as a masked value in DisplayCardNumber, which shows only the last four digits. | | IpAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description IP address of the card payment method holder. This field is available in API version 49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from version 48.0. Users must add it to the CardPaymentMethod page layout on their own. | | IsAutoPayEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the payment method can be used for recurring payments (True) or not (False). The default value is False. This field is available in API version 55.0 and later. For orgs that upgraded from version 54.0, you must add this field to the Card Payment Method page layout in the UI. It isn't automatically added. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record or list view related to this record, but didn’t access it directly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it's possible the user referenced this record but didn’t view it directly. | | MacAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description MAC address of the card payment method holder. This field is available in API version 49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from version 48.0. Users must add it to the CardPaymentMethod page layout on their own. | | NickName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Payer-defined nickname for the card payment method. | | PaymentGatewayId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The payment gateway used to create a gateway token. For transactions with a saved payment method in Salesforce, this field stores the payment gateway ID used in the transaction. This field is a relationship field. Relationship Name PaymentGateway Relationship Type Lookup Refers To PaymentGateway | | PaymentMethodAddress | Type address Properties Filter, Nillable Description Full address associated with the card payment method. | | PaymentMethodCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City of the address for the payment method. | | PaymentMethodCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country of the address for the payment method. | | PaymentMethodDetails | Type string Properties Create, Filter, Group, Nillable, Sort Description Optional information about the payment method type. This field is available in API version 57.0 and later. | | PaymentMethodGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the payment method address. An accuracy level contains information about the location of a latitude and longitude. For more information about geolocation fields, see [Geolocation Compound Field](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_geolocation.htm "Geolocation fields are accessible in the SOAP and REST APIs as a Location—a structured compound data type—or as individual latitude and longitude elements."). Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | PaymentMethodLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Latitude of the payment method address. Used with the PaymentMethodLongitude to specify the precise geolocation of the address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | PaymentMethodLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Latitude of the payment method address. Used with the PaymentMethodLatitude to specify the precise geolocation of the address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | PaymentMethodPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal Code of the address for the payment method. | | PaymentMethodState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State of the address for the payment method. | | PaymentMethodStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street of the address for the payment method. | | PaymentMethodSubType | Type string Properties Create, Filter, Group, Nillable, Sort Description A payment method that exists as a subtype of a payment method type. For example, Visa, Mastercard, and American Express exist as subtypes of payment method types such as Apple Pay and Google Pay. This field is available in API version 57.0 and later. | | PaymentMethodType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Payment method used for the transaction. This field is available in API version 57.0 and later. Possible values are: - AfterpayClearpay - AmericanExpress - ApplePay - BanContact - DinersClub - Discover - EPS - GooglePay - Jcb - Klarna - Maestro - MasterCard - Other - PayPal - SepaDebit - UnionPay - Venmo - Visa - iDeal | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the payer. This field is available in API version 49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from version 48.0. Users must add it to the CardPaymentMethod page layout on their own. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Defines whether the card payment method is used for transactions made by Salesforce Payments or by an external third-party payment provider. Possible values are: - External—Transactions happened outside of the Salesforce payments platform. - Salesforce—Salesforce made and recorded an external call to the payment platform. This field is available in API version 49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from version 48.0. Users must add it to the CardPaymentMethod page layout on their own. You must enter a value for this field. | | SavedPaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the saved payment method record. This field is available in API version 60.0 and later. Relationship Name SavedPaymentMethod Relationship Type Lookup Refers To SavedPaymentMethod | | SfResultCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The results of the card payment method’s interaction with the payment gateway. Possible values are: - Decline - Indeterminate - PermanentFail - RequiresReview - Success - SystemError - ValidationError | | StartMonth | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The month is activated. | | StartYear | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The year the card is activated. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the payment method. Possible values are: - Active - Canceled - InActive | ## Usage The following fields drop zeroes that appear at the beginning of the field value, and introduce commas for values with four or more digits: - CardLastFour - CardBin - ExpiryYear For example, a CardLastFour entered value of 0004112233445566 would appear as 4,112,233,445,566 on the record. As a workaround, create a String-type custom formula field with the same label as the field that you want to replace, then hide the original field. Here are some examples for replacing CardLastFour, CardBin, and ExpiryYear. CardLastFour IF(ISBLANK(CardLastFour), NULL,RIGHT("0000" & TEXT(CardLastFour) , 4)) CardBin IF(ISBLANK(CardBin), NULL,RIGHT("000000" & TEXT(CardBin) , 6)) ExpiryYear IF(ISBLANK(ExpiryYear), NULL,TEXT(ExpiryYear))) # CartCheckoutSession Represents a checkout session used in Lightning B2B Commerce checkout. This object is available in API version 48.0 and later. A checkout session is tied to a single web cart, but there can be multiple checkout sessions for a single cart. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | BackgroundOperationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the in progress background operation. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency used for the checkout session. Default value is USD. Possible values are: - USD—U.S. Dollar | | IsArchived | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether checkout processing is archived (true) or not (false). After a session is archived, it can’t be unarchived. Default value is false. | | IsError | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the session is in error state (true) or not (false). Default value is false. | | IsProcessing | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether checkout processing is in progress (true) or not (false). Default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the checkout session. | | NextState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The next state of the checkout session. | | OrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of a created order after the checkout session has gone from cart to order. | | OrderReferenceNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique reference number the shopper can use to refer to the order. In API version 63.0 and later, LWR stores don't populate this field upon checkout. Instead, the InitialOrderReferenceNumber field on the WebCart object is populated. | | State | Type string Properties Create, Filter, Group, Sort, Update Description The current state of the checkout session. | | WebCartId | Type reference Properties Create, Filter, Group, Sort Description The ID of the cart that is used to create the checkout session. | # CartDeliveryGroup Represents shipping information for the delivery of items in an order against a store built with B2B Commerce or D2C Commerce. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The CartDeliveryGroup object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | CartId | Type reference Properties Create, Filter, Group, Sort Description The ID the [WebCart](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcart.htm "Represents an online shopping cart for a store built with B2B Commerce or D2C Commerce, with total amounts for products, shipping and handling, and taxes. This object is available in API version 49.0 and later.") that’s associated with this delivery group. This field is a relationship field. Relationship Name Cart Relationship Type Lookup Refers To WebCart | | CompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Company name associated with a delivery. This field is available in API version 59.0 and later. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Possible values are: - USD—U.S. Dollar | | DeliverToAddress | Type address Properties Filter, Nillable Description The address to which a buyer order is delivered. | | DeliverToCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city to which a buyer order is delivered. | | DeliverToCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country to which a buyer order is delivered. | | DeliverToFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first name of the person set to receive an order. This field is available in API version 57.0 and later. | | DeliverToGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The geocode location to which a buyer order is delivered. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | DeliverToLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last name of the person to whom a buyer order is delivered. This field is available in API version 57.0 and later. | | DeliverToLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude of a buyer delivery location. | | DeliverToLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude of a buyer delivery location. | | DeliverToName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the person to deliver a buyer order to. This field is set based on the Name field of the ContactPointAddress associated with this delivery group. ContactPointAddress.Name is generated by the system using the first and last names entered by a buyer during checkout. | | DeliverToPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code to which to deliver a buyer order. | | DeliverToState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state to which to deliver a buyer order. | | DeliverToStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street to which to deliver a buyer order. | | DeliveryMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID for the delivery method to use to deliver a buyer order. Populated if the selected CartDeliveryGroupMethod only has the ShippingFee populated, but it has reference to an existing DeliveryMethodId which contains the fields Carrier, ClassOfService, and ReferenceNumber. If not, the SelectedDeliveryMethod field is used. This field is a relationship field. This field is deprecated in API version 64.0 and will be removed in API version 66.0. Instead, use the DeliveryMethodId field on the CartDeliveryGroupMethod object. Relationship Name DeliveryMethod Relationship Type Lookup Refers To OrderDeliveryMethod | | DesiredDeliveryDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date that a buyer requests to have an order delivered. | | GiftMessage | Type textarea Properties Create, Nillable, Update Description Personalized gift message for the order. This field is available in API version 64.0 and later. | | GiftToName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the recipient for a gift order. This field is available in API version 64.0 and later. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description Sum of all cart items’ TotalAmount, or CartDeliveryGroup TotalAmount plus CartDeliveryGroup TotalTaxAmount. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the delivery group is the default. This field is available in API version 59.0 and later. The default value is false. B2B and D2C stores create a default delivery group, along with a WebCart, when a customer adds an item to cart and doesn't have an existing cart. The default cart delivery group is needed to complete the checkout flow, and can't be replaced by a non-default cart delivery group. If you customize the standard checkout flow, make sure that you don't delete the default cart delivery group. | | IsGift | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the delivery group is a gift. This field is available in API version 64.0 and later. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this CartDeliveryGroup record. Name can be up to 255 characters. In API version 62.0 and later, if IsDefault is true, the Name is Shipment1, a localized string. In prior API versions, the Name for a default delivery group was Cart Delivery Group. Due to this change, any queries intended to identify default delivery groups should use the IsDefault rather than Name field. | | SelectedDeliveryMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the selected cart delivery group method. Populated if the selected CartDeliveryGroupMethod has the fields Carrier, ClassOfService, ReferenceNumber, and ShippingFee, but the DeliveryMethodId is null. If not, the DeliveryMethodId field is used. This field is available in API version 59.0 or later. This field is a relationship field. Relationship Name SelectedDeliveryMethod Relationship Type Lookup Refers To CartDeliveryGroupMethod | | ShipToPhoneNumber | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number associated with a delivery. This field is available in API version 59.0 and later. | | ShippingInstructions | Type textarea Properties Create, Nillable, Update Description Instructions for delivering an order. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description The total amount of all promotional adjustments on the cart delivery group. This field is available in API version 54.0 and later. For product bundles, this includes the aggregate adjustments of all child components. | | TotalAdjustmentTaxAmount | Type currency Properties Filter, Nillable, Sort Description The total tax amount for all promotional adjustments on the cart delivery group. This field is available in API version 54.0 and later. For product bundles, this includes the aggregate of the tax amounts for all child components’ adjustments. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all cart items TotalPrice, or TotalProductAmount plus TotalChargeAmount. For product bundles, this includes the aggregate of all child component prices. | | TotalCartItemCount | Type int Properties Filter, Group, Nillable, Sort Description The number of cart items, including their quantities, of the type PRODUCT in the delivery group. For product bundles, this count includes only the parent component. If the total quantity of cart items of type PRODUCT in the delivery group exceeds the system-defined maximum (INT\_MAX), this field is set to INT\_MAX. | | TotalChargeAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all the cart items TotalPrice for all cart items of type CHARGE. Cart items can be of type Product or Charge. For product bundles, if a child component includes a cart item of type CHARGE, its amount is aggregated with the parent’s cart item's total charge amount. | | TotalChargeTaxAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all the cart items TotalTaxAmount for all cart items of type CHARGE. Cart items can be of type Product or Charge. For product bundles, this includes the aggregate of all tax amounts associated with bundle-level charges, including the taxes of individual child products. | | TotalProductAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all the cart items TotalPrice for all cart items of type PRODUCT. Cart items can be of type Product or Charge. For product bundles, this includes the aggregate of all child component prices. | | TotalProductTaxAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all the cart items TotalTaxAmount for all cart items of type PRODUCT. Cart items can be of type Product or Charge. For product bundles, this includes the aggregate of all child component taxes based on their individual prices. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all cart items TotalTaxAmount, or the combined value of TotalProductTaxAmount plus TotalChargeTaxAmount. For product bundles, this includes the aggregate of all child component taxes based on their individual prices. | ## Associated Objects [CartDeliveryGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. # CartDeliveryGroupMethod Represents the selected delivery method for a cart delivery group used in Lightning B2B Commerce checkout. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The CartDeliveryGroupMethod object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustedShippingFee | Type currency Properties Filter, Nillable, Sort Description Shipping fee, including TotalAdjustmentAmount, for the delivery method. | | Carrier | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The carrier that the buyer chose for their delivery method. Values are defined based on the user’s shipping service. This field is available in API version 59.0 or later. | | CartCheckoutSessionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique ID used to identify your cart checkout session. | | CartDeliveryGroupId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the cart delivery group associated with the checkout session. | | ClassOfService | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The carrier class of service that the buyer chose for their delivery method. Values are defined based on the user’s shipping service. This field is available in API version 59.0 or later. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency used for your shipping fee. Default value is USD. Possible values are: - USD—U.S. Dollar | | DeliveryMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the selected order delivery method. | | ExternalProvider | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the external shipping method provider. Optional field. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Assign new delivery groups to active delivery methods. The default value is False. This field is available in API version 59.0 or later. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the delivery method. | | ProcessTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Merchant-specified process time for the delivery method. Process time includes the time between when an order is placed and when the shipment is given to the shipping carrier. | | ProcessTimeUnit | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Unit of time used to define ProcessTime. Possible values are: - Days - Hours - Weeks | | ProductId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. This product represents a delivery charge order product for a delivery using this delivery method. For example, you could create a product that represents an overnight express charge and assign it to an overnight express delivery method. If your store uses [Salesforce Native Shipping](https://help.salesforce.com/s/articleView?id=commerce.comm_set_up_native_shipping.htm&type=5&language=en_US), the ProductId is selected from a non-variation product with Shipping in its name. The term Shipping in a product name isn’t localized. If no matching product is found, a random non-variation product is used. This field is available in API version 59.0 or later. | | ReferenceNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reference number for an external delivery method. This field is available in API version 59.0 or later. | | ShippingFee | Type currency Properties Create, Filter, Sort, Update Description Shipping fee associated with the delivery method. Required field. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description The adjustment amount of a promotion applicable to the delivery method. | | TransitTimeMax | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Maximum estimate of transit time for the delivery method. Transit time includes the time between when a shipping carrier receives a shipment and when the shipment arrives at the delivery address. | | TransitTimeMin | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Minimum estimate of transit time for the delivery method. Transit time includes the time between when a shipping carrier receives a shipment and when the shipment arrives at the delivery address. | | TransitTimeUnit | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Unit of time used to define TransitTimeMax and TransitTimeMin. Possible values are: - Days - Hours - Weeks | | WebCartId | Type reference Properties Create, Filter, Group, Sort Description The ID of the WebCart associated with the cart delivery group method. Required field. | ## Usage Use the CartDeliveryGroupMethod object to give commerce buyers the ability to choose a delivery method for a cart delivery group. Shipping integrations populate the delivery options that are available for a cart delivery group. # CartDeliveryGroupMethodAdj Represents the shipping promotion discount for a shipping method. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The CartDeliveryGroupMethodAdj object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentAmount | Type currency Properties Create, Filter, Sort, Update Description Amount subtracted from the price by the shipping promotion discount. | | AdjustmentBasisReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the adjustment basis reference. This is the coupon that causes the adjustment. This field is a relationship field. This field is available in API version 62.0 and later. Relationship Name AdjustmentBasisReference Refers To Coupon | | AdjustmentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of shipping promotion discount. Possible values are: - AdjustmentAmount - AdjustmentPercentage - OverrideAmount | | AdjustmentValue | Type double Properties Create, Filter, Sort, Update Description Number representing the value of the price adjustment. For example, if the AdjustmentType is AdjustmentPercentage, a -10 AdjustmentValue means 10 percent off. If the AdjustmentType is AdjustmentAmount, a -10 AdjustmentValue means 10 dollars off. | | CartDeliveryGroupMethodId | Type reference Properties Create, Filter, Group, Sort Description ID of the cart delivery group method. This field is a relationship field. Relationship Name CartDeliveryGroupMethod Relationship Type Lookup Refers To CartDeliveryGroupMethod | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Currency ISO code of the cart. Possible values are: - USD—U.S. Dollar The default value is USD. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the cart delivery group method adjustment. | | PriceAdjustmentCauseId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the price adjustment cause. This field is a relationship field. Relationship Name PriceAdjustmentCause Relationship Type Lookup Refers To Promotion | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description If there are multiple promotional adjustments, the order in which the shipping promotion is applied. | # CartItem Represents an item in a WebCart that’s active in a store built with B2B. Cart item can be of type Product or Charge. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The CartItem object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Non-itemized adjustments for this cart item. | | AdjustmentTax​Amount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The tax that’s calculated on the AdjustmentAmount. | | AssociatedItem​Pricing | Type picklist Properties Create, Filter, Nillable, Sort, Update Description Specifies how a child cart item is priced relative to its parent cart item within a product bundle. This field is null for standalone products that aren't part of a bundle. Available in API version 65.0 and later. Possible values are: - IncludedInBundlePrice—Indicates that the parent product’s price includes the aggregated prices of its child components. - NotIncludedInBundlePrice—Indicates that the parent product’s price doesn’t include the aggregated prices of its child components. | | BillingFrequency | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies how often a subscription is billed. Available in API version 59.0 and later. Possible values are: - Annual - MilestonePlan - Monthly - Quarterly - Semi-Annual | | CartDelivery​GroupId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the CartDeliveryGroup that’s associated with a cart item. This field is a relationship field. Relationship Name CartDeliveryGroup Relationship Type Lookup Refers To CartDeliveryGroup | | CartId | Type reference Properties Create, Filter, Group, Sort Description The ID of the WebCart that’s associated with a cart item. This field is a relationship field. Relationship Name Cart Relationship Type Lookup Refers To WebCart | | ChildProduct​Count | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The total number of child products associated with this cart item. If a child product is a bundle, its own ChildProductCount is included in this total. For simple products that don’t have any child products, the ChildProductCount value is zero. | | Configure​DuringSale | Type picklist Properties Create, Filter, Nillable, Sort, Update Description Specify whether a product bundle is configurable. Available in API version 65.0 and later. Possible values are: - Allowed - NotAllowed | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Possible values are: - AED—UAE Dirham - AUD—Australian Dollar - BRL—Brazilian Real - CAD—Canadian Dollar - EUR—Euro - GBP—British Pound - INR—Indian Rupee - JPY—Japanese Yen - SEK—Swedish Krona - USD—U.S. Dollar | | DistributedAdjustment​Amount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description A calculated field that determines the amount of a cart-wide promotional adjustment when distributed across all items in the cart. This field is for display purposes only and is valid only during checkout. This field is available in API version 52.0 and later. You receive $10 off, and there are 5 items in the cart. The distributed adjustment is (-$2). | | DistributedAdjustment​TaxAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description A calculated field that determines the amount of a cart-wide tax adjustment due to promotions when distributed across all items in the cart. This field is available in API version 52.0 and later. EXAMPLE: Your discount causes a cart-wide tax reduction of (-$10), and there are 5 items in the cart. The distributed tax adjustment is (-$2). | | EndQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description Indicates the final asset quantity when the subscription is modified or when it ends. | | FirstPymtPriceAferAdjustments | Type currency Properties Create, Filter, Nillable, Sort, Update Description The first term price for term-based subscription products, after price adjustments are applied. The total amount for a non-subscription product or a non-term based subscription product, after price adjustments are applied. This is available in API version 60.0 and later. | | FirstPymtTax | Type currency Properties Create, Filter, Nillable, Sort, Update Description The tax for the first term price for term-based subscription products. The tax amount for a non-subscription product or a non-term subscription product. This field is available in API version 60.0 and later. | | GrossAdjustment​Amount | Type currency Properties Filter, Nillable, Sort Description The gross amount of the price adjustment on the cart item (tax inclusive). This is available in API version 55.0 and later. | | GrossUnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The gross amount of the unit price for a cart item (tax inclusive). This is available in API version 55.0 and later. | | IsShippingChargeNot​Applicable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether shipping charges are applicable (true) or not (false) to the cart item. The default value is false. This field is available in API version 64.0 and later. | | ItemizedAdjustment​Amount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description A calculated field that determines the total amount of promotional adjustments that are specific to an item. This field is available in API version 52.0 and later. EXAMPLE: One cart item has one discount code for $10 off. Your itemized adjustment amount is (-$10) for that item. | | ItemizedAdjustment​TaxAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description A calculated field that determines the total amount of promotion-related tax adjustments that are specific to an item. This field is available in API version 52.0 and later. EXAMPLE: One cart item has one discount code for $10 off. This reduces the tax on that item by (-$2). Your itemized adjustment tax amount is (-$2) for that item. | | ListPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The original price of the cart item. Typically shown with a line through it. List price is shown only when it’s higher than the negotiated price. If the list price is the same or lower, it isn’t shown to the buyer. This field is available in API version 52.0 and later. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this CartItem record. Name can be up to 255 characters. | | NetAdjustment​Amount | Type currency Properties Filter, Nillable, Sort Description The net amount of the price adjustment made on the cart item (tax exclusive). This is available in API version 55.0 and later. | | NetUnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The net amount of the unit price for the cart item (tax exclusive). This is available in API version 55.0 and later. | | NetUnitPriceAfterAdjustments | Type currency Properties Create, Filter, Nillable, Sort, Update Description The net unit price for a cart item, after all tier and promotional price adjustments are applied. This field is available in API version 60.0 and later. | | ParentCart​ItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the cart item's parent CartItem. The value is empty if the item is a top-level cart item. This field is a relationship field. Relationship Name CartItem Relationship Type Lookup Refers To CartItem | | PerUnitWeight | Type double Properties Create, Filter, Nillable, Sort, Update Description Weight per unit of this cart item, in the unit specified by WeightUnit. This field is available in API version 62.0 and later. | | PeriodBoundary | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The. Default value is . Possible values are: - AlignToCalendar - Anniversary - DayOfPeriod - LastDayOfPeriod | | PeriodBoundaryDay | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The . | | PeriodBoundaryStartMonth | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The. Default value is . Possible values are: - 1—January - 10—October - 11—November - 12—December - 2—February - 3—March - 4—April - 5—May - 6—June - 7—July - 8—August - 9—September | | PriceBookEntryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the price book entry for the product. This field is available in API version 60.0 and later. This field is a relationship field. Relationship Name PricebookEntry Relationship Type Lookup Refers To PricebookEntry | | PricingTermCount | Type double Properties Create, Filter, Nillable, Sort, Update Description A calculated field that indicates the number of pricing terms in the subscription. This field is available in API version 59.0 and later. | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of a product type cart item. Cart items can be of type PRODUCT or CHARGE. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductClass | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The product class of the cart item. Default value is Simple. Possible values are: - Bundle - Set - Simple - Variation - VariationParent | | ProductRelated​ComponentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the cart item's ProductRelatedComponent. The ProductRelatedComponent represents a product that is included in a product bundle, a set, or a product and an add-on. The ProductRelatedComponent is empty if the item is a top-level cart item. This field is a relationship field. Relationship Name ProductRelatedComponent Relationship Type Lookup Refers To ProductRelatedComponent | | ProductSellingModelId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the model used to sell a product. This field is available in API version 59.0 or later. This field is a relationship field. Relationship Name ProductSellingModel Relationship Type Lookup Refers To ProductSellingModel | | ProductValidation​Key | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The product validation key of the cart item. | | ProductRelationshipTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the product relationship type that defines the relationship between a product bundle and its child product. Available in API version 65.0 and later. This field is a relationship field. Relationship Name ProductRelationshipType Relationship Type Lookup Refers To [https://developer.salesforce.com/docs/atlas.en-us.object\_reference.meta/object\_reference/sforce\_api\_objects\_productrelationshiptype.htm](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productrelationshiptype.htm "HTML (New Window)")ProductRelationshipType | | ProrationPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the proration policy, which defines how prices are calculated for each time period within a subscription term. This field is available in API version 60.0 and later. This field is a relationship field. Relationship Name ProrationPolicy Relationship Type Lookup Refers To Proration Policy | | StartQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description Indicates the initial asset quantity when the subscription starts. | | Quantity | Type double Properties Create, Filter, Nillable, Sort, Update Description The number of a given cart item in a cart. | | QuoteLineItemId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the associated quote line item. Applicable only if the cart is created from a quote. | | QuantityScaleMethod | Type picklist Properties Create, Filter, Nillable, Sort, Update Description Determines how a child product's quantity scales when added to a cart or configured within a product bundle. Available in API version 65.0 and later. Possible values are: - Constant—Represents a value that remains fixed relative to the parent bundle. - Proportional—Represents a value that varies in proportion to the parent bundle’s price or quantity. | | SalesPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The discounted price of a cart item. | | SellingModelType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the product selling model associated with a term-based subscription product. This field is available in API version 60.0 and later. Possible values are: - Evergreen - OneTime - TermDefined The default value is OneTime. | | Sku | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Shelf-Keeping Unit ID of a cart item. | | StockCheck​Method | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines how inventory is assessed for a cart item that’s part of a bundle or set. Possible values are: - ChildProducts—Inventory is assessed based on the child product or products. - ParentProduct—Inventory is assessed based on the parent product. | | SubType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the subtype of the product. Possible values are: - Bonus—Bonus product. - GiftWrap—Gift wrapped product. This field is available in API version 64.0 and later. | | SubscriptionTerm | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of terms (years or months, for example) in the subscription. This field is available in API version 59.0 and later. | | TaxTreatment​Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related tax treatment for the cart item. This field is available in API version 63.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name TaxTreatment Relationship Type Lookup Refers To TaxTreatment | | TotalAdjustment​Amount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The total amount of all promotional adjustments on the item, both distributed and itemized. This field is available in API version 52.0 and later. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description The total cost of this cart item, including taxes and adjustments. | | TotalFirstPymtAdjAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The total adjustment amount for the first payment of a term-based susbcription product. The TotalAdjustmentAmount for non-subscription products and non-term based subscription products. This field is available in API version 63.0 and later. | | TotalFirstPymtListPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The first-payment amount for a term-based subscription product, based on the product's ListPrice. This is the same value as TotalListPrice for non-subscription products or non-term based subscription products. This price is only for comparison, and not the price at which the buyer purchases a product. This field is available in API version 63.0 and later. | | TotalFirstPymtPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The first term price for term-based subscription products. The price of a line item for non-subscription products and non-term based subscription products. This price includes price adjustments and excludes taxes. This field is available in API version 63.0 and later. | | TotalLine​Amount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Total amount for this cart item, based on sales price and quantity. | | TotalLineFirstPymtAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The first term price for term-based subscripiton products, calculated based on the sales price and quantity, before any price adjustments are made. This is the same value as TotalLineAmount for non-subscription products and non-term based subscription products. This field is available in API version 63.0 and later. | | TotalLineFirstPymtTaxAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description The tax on the first payment amount, after price adjustments, for term-based subscription products. The tax on the price of the product for non-subscription products and non-term based subscription products. Taxes are also calculated on the delivery charge items. This field is a calculated field. This field is available in API version 63.0 and later. | | TotalLineGross​Amount | Type currency Properties Filter, Nillable, Sort Description The total gross amount of the line item (tax inclusive). This is available in API version 55.0 and later. | | TotalLineNet​Amount | Type currency Properties Filter, Nillable, Sort Description The total net amount of the line item (tax exclusive). This is available in API version 55.0 and later. | | TotalLineTax​Amount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description Total tax amount for TotalLineAmount. | | TotalListPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description Total amount for this cart item, based on ListPrice. We provide this value for comparison. It's not the price that the buyer is paying. | | TotalPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description Total amount for this cart item, including adjustments but excluding taxes. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Although this field is Nillable, if you want to use [Commerce Webstore Cart Promotions](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_cart_promotions.htm), this field is required. | | TotalPriceAfterAll​Adjustments | Type currency Properties Create, Filter, Nillable, Sort, Update Description Total price after all price adjustments are applied. This field is available in API version 52.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Although this field is Nillable, if you want to use [Commerce Webstore Cart Promotions](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_cart_promotions.htm), this field is required. | | TotalPrice​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Total tax amount for a cart item before promotional adjustments, including quantity-based adjustments. This field is available in API version 56.0 and later. | | TotalPromo​AdjustmentAmount | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Total itemized and distributed adjustment amount in cart (only for promotions). This field is available in API version 52.0 and later. | | TotalPromoAdjustment​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Total itemized and distributed adjustment tax amount in cart (only for promotions). This field is available in API version 52.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Total tax amount for this cart item. This value includes taxes for both TotalLineAmount and AdjustmentAmount. | | TotalWeight | Type double Properties Filter, Nillable, Sort Description Total weight of this cart item, in the unit specified by WeightUnit. This field is available in API version 62.0 and later. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The CartItem type. Possible values are: - Product - Charge | | UnitAdjusted​Price | Type currency Properties Create, Filter, Nillable, Sort, Update Description Price per quantity unit after a tier discount or surcharge is applied. This field is available in API version 50.0 and later. | | UnitAdjustedPrice​WithItemAdj | Type currency Properties Create, Filter, Nillable, Sort, Update Description Unit price, including both tier and item level discounts, for the item. | | UnitAdjustment​Amount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Tier discount or surcharge to apply to a quantity unit. This amount is added to the SalesPrice to get the UnitAdjustedPrice. This field is available in API version 50.0 and later. | | UnitItemAdjustment​Amount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Item level adjustments made to the unit price for the item. | | UnitPriceAfterAdjustments | Type currency Properties Create, Filter, Nillable, Sort, Update Description The unit price for a cart item, after tier and promotional price adjustments are applied. This field is available in API version 60.0 and later. | | WeightUnit | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Unit of measurement for the weight of the cart item. This field is available in API version 62.0 and later. Possible values are: - Grams - Kilograms - Ounces - Pounds | ## Associated Objects This object has the following associated objects. Unless it’s noted, associated objects are available in the same API version as this object. [CartItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. #### See Also - [Commerce Webstore Cart Promotions](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_cart_promotions.htm "Commerce Webstore Cart Promotions - html (New Window)") - [Commerce Webstore Promotions, Associate Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_promotions_actions_associate.htm "Commerce Webstore Promotions, Associate Action - html (New Window)") - [Commerce Webstore Promotions, Execute Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_promotions_actions_execute.htm "Commerce Webstore Promotions, Execute Action - html (New Window)") - [CartDeliveryGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartdeliverygroup.htm "Represents shipping information for the delivery of items in an order against a store built with B2B Commerce or D2C Commerce. This object is available in API version 49.0 and later.") - [WebCart](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcart.htm "Represents an online shopping cart for a store built with B2B Commerce or D2C Commerce, with total amounts for products, shipping and handling, and taxes. This object is available in API version 49.0 and later.") # CartItemAttribute Represents the attributes associated with a cart item, stored as key-value pairs. These attributes are derived from the product and carried forward to the order during checkout. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules The CartItemAttribute object is available:only if the B2B Commerce license, the Salesforce CPQ feature, and Commerce Dynamic Bundles are enabled in your Salesforce org. ## Fields | Field | Details | | --- | --- | | AttributeDefinitionId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the attribute definition associated with the cart item attribute. This field is a relationship field. Relationship Name AttributeDefinition Relationship Type Lookup Refers To [AttributeDefinition](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_attributedefinition.htm "HTML (New Window)") | | AttributeName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the cart item attribute. | | AttributePicklistValueId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the picklist value associated with the cart item attribute. This field is a relationship field. Relationship Name AttributePicklistValue Relationship Type Lookup Refers To [AttributePicklistValue](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_attributepicklistvalue.htm "HTML (New Window)") | | AttributeValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the cart item attribute, such as Blue or Large. | | CartItemId | Type reference Properties Create, Filter, Group, Sort Description The ID of the cart item to which this attribute is assigned. This field is a relationship field. Relationship Name CartItem Relationship Type Master-detail Refers To [CartItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_cartitem.htm "HTML (New Window)") (the master object) | | ExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An auto-generated ID for the attribute record that's stored in an external system, such as the HBase database. | | IsPriceImpacting | Type boolean Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates whether the attribute affects cart pricing (true) or not (false). This field determines whether the Commerce Pricing API calls must be triggered to update the price. | | UnitOfMeasure | Type reference Properties Create, Filter, Group, Sort Description The ID of the unit of measure associated with the cart item attribute. This field is available only if the AttributeUomPilot Org perm is enabled. Contact Salesforce support for assistance. This field is a relationship field. Relationship Name UnitOfMeasure Relationship Type Lookup Refers To [UnitOfMeasure](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_unitofmeasure.htm "HTML (New Window)") | ## 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. [CartItemAttributeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [CartItemAttributeFeed](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. [CartItemAttributeHistory](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. [CartItemAttributeOwnerSharingRule](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. [CartItemAttributeShare](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. # CartItemPriceAdjustment Price adjustment for a cart item. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The CartItemPriceAdjustment object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentAmountScope | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Scope of the adjustment amount for a promotion. Possible values are: - Total—The amount off the total price. This field is available in API version 54.0 and later. | | AdjustmentBasisReferenceId | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Coupon code of the coupon associated with a promotion. This field is available in API version 54.0 and later. This is a relationship field. Relationship Name AdjustmentBasisReference Relationship Type Lookup Refers To Coupon | | AdjustmentSource | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Price adjustment type. Possible values are: - Discretionary - Promotion - System | | AdjustmentTargetType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Target for the price adjustment (the cart itself or individual items). Possible values are: - Cart - Item | | AdjustmentType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates if the price adjustment is applied as percentage or an absolute amount. Possible values are: - AdjustmentAmount - AdjustmentPercentage | | AdjustmentValue | Type double Properties Create, Filter, Sort, Update Description Numeric value of the adjustment (for example, 10 if the price adjustment is either 10% off or $10 off). | | CartId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the WebCart that’s associated with a cart item. This field is available in API version 55.0 and later. This is a relationship field. Relationship Name Cart Relationship Type Lookup Refers To WebCart | | CartItemId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent cart item to which this adjustment belongs. This is a relationship field. Relationship Name CartItem Relationship Type Lookup Refers To CartItem | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Possible values are: - EUR—Euro - USD—U.S. Dollar | | Description | Type textarea Properties Create, Nillable, Update Description Description of the price adjustment. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the price adjustment. | | PriceAdjustmentCauseId | Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description ID of entity that caused this adjustment (for example, a promotion ID). If unspecified, then Description populates the display name. This is a relationship field. Relationship Name PriceAdjustmentCause Relationship Type Lookup Refers To Promotion | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description If there are multiple price adjustments, sequence in which the price adjustments are applied. | | TotalAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Total price after applying price adjustments. | | TotalGrossAmount | Type currency Properties Filter, Nillable, Sort Description The total gross amount (tax inclusive) after applying price adjustments. This field is available in API version 55.0 and later. | | TotalNetAmount | Type currency Properties Filter, Nillable, Sort Description The total net amount (tax exclusive) after applying price adjustments. This field is available in API version 55.0 and later. | | TotalTax | Type currency Properties Filter, Nillable, Sort Description Tax on the total adjusted price. | | WebCartAdjustmentGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the cart’s adjustment group. This is a relationship field. Relationship Name WebCartAdjustmentGroup Relationship Type Lookup Refers To WebCartAdjustmentGroup | ## Associated Objects This object has the following associated objects. Unless it’s noted, associated objects are available in the same API version as this object. [CartItemPriceAdjustmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. # CartTax Represents taxes for a line item in a WebCart that’s active in a store built with B2B Commerce or D2C Commerce. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The CartTax object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentTargetType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Target for the price adjustment (the cart itself or individual items). This field is available in API version 52.0 and later. Possible values are: - Cart - Item | | Amount | Type currency Properties Create, Filter, Sort, Update Description Calculated tax amount. | | CartId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the WebCart being taxed. | | CartItemId | Type reference Properties Create, Filter, Group, Sort Description The ID of a cart item being taxed. | | CartItemPriceAdjustmentId | Type reference Properties Create, Filter, Group, Sort Description The ID of a price adjustment for a cart item being taxed. (This field is available in API version 52.0 and later.) Refers To CartItemPriceAdjustment | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Valid values include: - USD—U.S. Dollar | | Description | Type textarea Properties Create, Nillable, Update Description A description of the tax. Enter up to 2000 characters. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this CartTax record. Name can be up to 255 characters. | | TaxCalculationDate | Type date Properties Create, Filter, Group, Sort, Update Description The date this tax was calculated. | | TaxRate | Type percent Properties Create, Filter, Nillable, Sort, Update Description The applied tax rate for this line of tax. | | TaxType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of tax for this line of tax. Possible values are: - Actual - Estimated | ## Associated Objects This object has the following associated objects. Unless it’s noted, associated objects are available in the same API version as this object. [CartTaxChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. #### See Also - [WebCart](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcart.htm "Represents an online shopping cart for a store built with B2B Commerce or D2C Commerce, with total amounts for products, shipping and handling, and taxes. This object is available in API version 49.0 and later.") # CartValidationOutput Associate errors to cart entities, such as cart line items, delivery groups, and the like, in a store built with B2B Commerce or D2C Commerce. An example error is “Out of stock.” Available in API version 49.0 and later. ## Supported Calls create(), delete(),describeLayout() describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The CartValidationOutput object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | BackgroundOperationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the background operation that ran the validation. | | CartId | Type reference Properties Create, Filter, Group, Sort Description ID of the related WebCart. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD.Possible values are: - EUR—Euro - USD—U.S. Dollar | | IsDismissed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the validation process is finished. Default value is false. | | Level | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Describes the type of output resulting from the validation process. Possible values are: - 0 (Info) - 1 (Error) - 2 (Warning) | | Message | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Defines the message to show in the log when validation is complete. Message can be up to 255 characters. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this CartValidationOutput record. Name can be up to 255 characters. | | RelatedEntityId | Type reference Properties Create, Filter, Group, Sort, Update Description Foreign key to WebCart, CartItem, and CartDeliveryGroup. | | RelatedEntityPrefix | Type string Properties Filter, Group, Nillable, Sort Description Three-character prefix for the related entity. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The CartValidationOutput type. Possible values are: - CartSave — Available in API version 64.0 and later. - Entitlement - Inventory - Other - Pricing - Promotions - Shipping - ShippingPromotions - SystemError - Taxes | ## Associated Objects This object has the following associated objects. Unless it’s noted, associated objects are available in the same API version as this object. [CartValidationOutputChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. #### See Also - [WebCart](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcart.htm "Represents an online shopping cart for a store built with B2B Commerce or D2C Commerce, with total amounts for products, shipping and handling, and taxes. This object is available in API version 49.0 and later.") - [CartItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartitem.htm "Represents an item in a WebCart that’s active in a store built with B2B. Cart item can be of type Product or Charge. This object is available in API version 49.0 and later.") - [CartDeliveryGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartdeliverygroup.htm "Represents shipping information for the delivery of items in an order against a store built with B2B Commerce or D2C Commerce. This object is available in API version 49.0 and later.") # Case Represents a case, which is a customer issue or problem. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the account associated with this case. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | AssetWarrantyID | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Asset associated with the warranty. Must be a valid asset warranty ID. | | BusinessHoursId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the business hours associated with this case. | | Comments | Type textarea Properties Create, Delete, Layout, Nillable, Query, Retrieve, Search, Sort, Undelete, Update Description Used to insert a new CaseComment. Email textarea has a length of 4000 chars. | | CaseNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Assigned automatically when each case is inserted. It can't be set directly, and it can't be modified after the case is created. | | ClosedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the case was closed. | | CommunityId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the zone associated with this case. This field is available in API version 24.0 and later. | | ConnectionReceivedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce. | | ConnectionSentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections. | | ContactEmail | Type email Properties Filter, Group, Nillable, Sort Description Email address for the contact. The Case.ContactEmail field displays the [Email field on the contact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm#contact.email) that is referenced by Case.ContactId. Label is Contact Email. This field is available in API version 38.0 and later. | | ContactFax | Type phone Properties Filter, Group, Nillable, Sort Description Fax number for the contact. Label is Contact Fax. This field is available in API version 38.0 and later. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the associated contact. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | ContactMobile | Type phone Properties Filter, Group, Nillable, Sort Description Mobile telephone number for the contact. Label is Contact Mobile. This field is available in API version 38.0 and later. | | ContactPhone | Type phone Properties Filter, Group, Nillable, Sort Description Telephone number for the contact. Label is Contact Phone. This field is available in API version 38.0 and later. | | CreatorFullPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | CreatorName | Type string Properties Filter, Group, Nillable, Sort Description Name of the user who posted the question or reply. Only the first name of internal users (agents) appears to portal users in the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | CreatorSmallPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description A text description of the case. Limit: 32 KB. | | FeedItemId | Type reference Properties Create, Group, Nillable, Sort Description ID of the question in Chatter associated with the case. This field is available in API version 33.0 and later, and is only accessible in organizations where Question-to-Case is enabled. | | HasCommentsUnreadByOwner | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a case contains comments that the case owner hasn’t read (true) or not (false). | | HasSelfServiceComments | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a case has comments added by a Self-Service user (true) or not (false). Only visible when Customer Portal is enabled. | | IsClosed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the case is closed (true) or open (false). This field is controlled by the Status field; it can't be set directly. Label is Closed. | | IsClosedOnCreate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the case was closed at the same time that it was created (true) or not (false). This flag is read-only and is automatically set when a record is created. It can't be set to true unless the IsClosed flag is also true. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. | | IsEscalated | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the case has been escalated (true) or not. A case's escalated state does not affect how you can use a case, or whether you can query, delete, or update it. You can set this flag via the API. Label is Escalated. | | IsSelfServiceClosed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the case is closed for Self-Service users (true) or not (false). | | IsStopped | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether an entitlement process on a case is stopped (true) or not (false). | | IsVisibleInSelfService | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the case can be viewed in the Customer Service Portal, Partner Service Portal, and Self-Service Portal (true) or not (false). This field is applied for case visibility in the Partner Relationship Management, Customer Service Portal, and the earlier version of Self Service Portal. The field does not alter sharing and will not prevent usage of a direct URL to a case if a portal user has read or write access. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the case. The Language field is available when you enable Einstein Case Classification in Enterprise, Performance, and Unlimited edition orgs with Service Cloud. By default, only Einstein classification apps use this field. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The 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 The 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. | | MasterRecordId | Type reference Properties Filter, Group, Nillable, Sort Description If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null. This is a relationship field. Relationship Name MasterRecord Relationship Type Lookup Refers To Case | | Origin | Type picklist Properties Create, Filter, Group, Nillable,Sort, Update Description The source of the case, such as Email, Phone, or Web. Label is Case Origin. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the contact who owns the case. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent case in the hierarchy. The label is Parent Case. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Case | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The importance or urgency of the case, such as High, Medium, or Low. | | QuestionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The question in the answers zone that is associated with the case. This field does not appear if you don't have an answers zone enabled. | | Reason | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The reason why the case was created, such as Instructions not clear, or User didn’t attend training. | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to this object. | | ServiceContractId | Type reference Properties Create, Filter, Nillable, Update Description Required. ID of the ServiceContract associated with the entitlement. Must be a valid ID. | | SlaStartDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Shows the time that the case entered an entitlement process. If you have the Edit permission on cases, you can update or reset the time. This field is available in API version 18.0 and later. | | SourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the social post source. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the case, such as New, Closed, or Escalated. This field directly controls the IsClosed flag. Each predefined Status value implies an IsClosed flag value. For more information, see CaseStatus. | | StopStartDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time an entitlement process was stopped on the case. This field is available in API version 18.0 and later. | | Subject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The subject of the case. Limit: 255 characters. | | SuppliedCompany | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The company name that was entered when the case was created. Label is Company. | | SuppliedEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address that was entered when the case was created. Label is Email. If your organization has an active auto-response rule, SuppliedEmail is required when creating a case via the API. Auto-response rules use the email in the contact specified by ContactId. If no email address is in the contact record, the email specified here is used. | | SuppliedName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name that was entered when the case was created. Label is Name. | | SuppliedPhone | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number that was entered when the case was created. Label is Phone. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of case, such as Feature Request or Question. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you are importing Case data and need to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself. ## Usage Use the Case object to manage cases for your organization. Client applications can query, update, and delete Attachment records associated with a case via the API. ## Assignment Rules When you query or update a case, your client application can have the case automatically assigned to one or more User records based on assignment rules that have been configured in the user interface. To use this feature, your client application must set either of the following options (but not both) in the AssignmentRuleHeader used in the create or update: | Field | Field Type | Details | | --- | --- | --- | | assignmentRuleId | reference | ID of the assignment rule to use. Can be an inactive assignment rule. If unspecified and useDefaultRule is true, then the default assignment rule is used. To find the ID for a given assignment rule, query the AssignmentRule object (specifying RuleType="caseAssignment"), iterate through the returned AssignmentRule objects, find the one you want to use, retrieve its ID, and then specify its ID in this field in the AssignmentRuleHeader. | | useDefaultRule | boolean | Specifies whether to use the default rule for rule-based assignment (true) or not (false). The default rule is assigned by users in the Salesforce user interface. | For a code example that shows setting the AssignmentRuleHeader for a Lead (which is similar to setting the AssignmentRuleHeader for a Case), see Lead. ## Separating Accounts from Contacts in Cases In releases before 8.0, the AccountId could not be specified, it was derived from the contact’s account. This behavior will continue to be supported in future releases, but you can also now specify an AccountId. If you do not specify the AccountId during the creation of a case, the value will default to the contact’s AccountId. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When a record is updated, if the ContactId has not changed, then the AccountId is not regenerated. This prevents the API from overwriting a value previously changed in the Salesforce user interface. However, if an API call changes the ContactId and the AccountId field is empty, then the AccountId is generated using the contact’s account. ## Using \_case with Java Depending on the development tool you use, you might need to write your application using \_case instead of Case, because case is a reserved word in Java. ## 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. [CaseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [CaseFeed](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.") (API version 18.0) Feed tracking is available for the object. [CaseHistory](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. [CaseOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseownersharingrule.htm "Represents the rules for sharing a case with users other than the owner.") Sharing rules are available for the object. [CaseShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseshare.htm "Represents a sharing entry on a Case.") Sharing is available for the object. #### See Also - [Account](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm "Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners).") - [CaseMilestone](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casemilestone.htm "Represents a milestone (required step in a customer support process) on a Case. This object is available in API version 18.0 and later.") # CaseArticle Represents the association between a Case and a KnowledgeArticle. This object is available in API version 20.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Access to this object is controlled by the parent Case and KnowledgeArticle. However, when querying, access is only controlled by the parent Case. Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | ArticleLanguage | Type picklist Properties Filter, Restricted picklist Description The language of the article associated with the case. | | ArticleVersionNumber | Type int Properties Create, Group, Nillable Description The number assigned to a version of an article. This field is available in API version 24.0 and later. | | CaseId | Type reference Properties Create, Filter, Group, Sort Description ID of the Case associated with the KnowledgeArticle. | | IsSharedByEmail | Type int Properties Create, Group, Nillable Description Indicates that the article has been shared with the customer through an email. | | KnowledgeArticleId | Type reference Properties Create, Filter, Group, Sort Description ID of the KnowledgeArticle associated with the Case. | ## Usage This object represents the association of a knowledge article with a Case. An article is associated with a case when it’s relevant to a specific issue, when it helps an agent solve the case, or when the agent sends the article to a customer. You can use this object to include case-article associations in Apex and Visualforce. You can't update this object via the API. If you attempt to create a record that matches an existing record, the create request simply returns the existing record. #### See Also - [Case](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm "Represents a case, which is a customer issue or problem.") - [KnowledgeArticle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticle.htm "Provides read-only access to an article and the ability to delete the primary article. This object is available in API version 19.0 and later.") # CaseComment Represents a comment that provides additional information about the associated Case. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CommentBody | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Text of the CaseComment. The maximum size of the comment body is 4,000 bytes. Label is **Body**. | | ConnectionReceivedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce. | | ConnectionSentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections. | | CreatorFullPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | CreatorName | Type string Properties Filter, Group, Nillable, Sort Description Name of the user who posted the question or reply. Only the first name of internal users (agents) appears to portal users in the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | CreatorSmallPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsNotificationSelected | Type boolean Properties Create, Defaulted on create, Update Description Indicates whether an email notification is sent to the case contact when a CaseComment is created or updated. When this field is queried, it always returns null. This field is available only when the Enable Case Comment Notification to Contacts setting is enabled on the Support Settings page in Setup. To send email notifications for CaseComment, you must use the EmailHeader triggerUserEmail. Available in API version 43.0 and later. | | IsPublished | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the CaseComment is visible to customers in the Self-Service portal (true) or not (false). Label is **Published**. This is the only CaseComment field that can be updated via the API. | | ParentId | Type reference Properties Create, Filter, Group, Sort, Description Required. ID of the parent Case of the CaseComment. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Case | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you're importing CaseComment data and must set the value for an audit field, such as CreatedDate, contact Salesforce. Record id's can't delete CaseComments entities when calling the Database.delete() Apex method or its analogous SOAP API. Audit fields are automatically updated during API operations unless you request to set these fields yourself. ## Usage In the Salesforce user interface, comments are entered by a User working on a Case. All users have access to create and view CaseComment in the Salesforce user interface and when using the API. In the API, CaseComment records can't be modified after insertion unless the user has the “Modify All Records” object-level permission for Cases or the “Modify All Data” permission. If not, users can only update the IsPublished field, and can't delete CaseComment. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # CaseContactRole Represents the role that a given Contact plays on a Case. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CasesId | Type reference Properties Create, Filter, Group, Sort Description ID of the cases associated with this contact. This is a relationship field. Relationship Name Cases Relationship Type Lookup Refers To Case | | ContactId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the contact. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | Role | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the role played by the contact on this case, such as Technical Contact, Business Contact, Decision Maker, and so on. Must be unique—there can't be multiple records in which the CaseId, ContactId , and Role values are identical. Different contacts can play the same role on the same case. A contact can play different roles on the same case. | ## Usage Use this object to define the role that a given Case plays on a given Contact. For example, you can use this object to be able to see all contacts who are associated to a case, or, given a contact, be able to query all cases that they are associated with, even if they are not the primary contact on the case. # CaseHistory Represents historical information about changes that have been made to the associated Case. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules This object is always read-only. ## Fields | Field | Details | | --- | --- | | CaseId | Type reference Properties Filter, Group, Sort Description ID of the Case associated with this record. This is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name of the case field that was modified, or a special value to indicate some other modification to the case. The possible values, in addition to the case field names, are: - **ownerAssignment**—The owner of the case was changed. - **ownerAccepted**—A user took ownership of a case from a queue. - **ownerEscalated**—The owner of the case was changed due to case escalation. - **external**—A user made the case visible to customers in the Customer Self-Service Portal. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | NewValue | Type anyType Properties Nillable, Sort Description New value of the modified case field. Maximum of 255 characters. | | OldValue | Type anyType Properties Nillable, Sort Description Previous value of the modified case field. Maximum of 255 characters. | ## Usage Case history entries are indirectly created each time a case is modified. Two rows are added to this record when foreign key fields change. One row contains the foreign key object names that display in the online application. For example, Jane Doe is recorded as the name of a Contact. The other row contains the actual foreign key ID that is only returned to and visible from the API. This object respects field level security on the parent object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # CaseHistory2 Represents historical information about owner and status changes that have been made to the associated Case. This object is available in API version 59.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules This object is always read-only. ## Fields | Field | Details | | --- | --- | | CaseId | Type reference Properties Filter, Group, Sort Description The ID of the Case associated with this record. This is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the contact who owns the case. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PreviousUpdate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the case was last updated. | | Status | Type string Properties Filter, Group, Nillable, Sort Description The status of the case, such as New, Closed, or Escalated. | ## Usage CaseHistory2 entries are intended for case history reports. ## 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. [CaseHistory2ChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object in API version 60.0 or later. # CaseMilestone Represents a milestone (required step in a customer support process) on a Case. This object is available in API version 18.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve(), update() ## Fields | Field | Details | | --- | --- | | BusinessHoursId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the BusinessHours associated with the CaseMilestone. | | CaseId | Type reference Properties Filter Description ID of the case. | | CompletionDate | Type dateTime Properties Filter, Nillable, Update Description The date and time the milestone was completed. | | ElapsedTimeInDays | Type double Properties Filter, Nillable Description The time required to complete a milestone in days. | | ElapsedTimeInHrs | Type double Properties Filter, Nillable Description The time required to complete a milestone in hours. | | ElapsedTimeInMins | Type int Properties Filter, Nillable Description The time required to complete a milestone in minutes. | | IsCompleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the milestone is completed (true) or not (false). | | IsViolated | Type boolean Properties Defaulted on create, Filter Description Indicates whether the milestone is violated (true) or not (false). | | MilestoneTypeId | Type reference Properties Filter, Nillable Description The ID of the milestone on the case. | | StartDate | Type dateTime Properties Filter, Nillable, Update Description The date and time the milestone started on the case. | | TargetDate | Type dateTime Properties Filter Description The date and time the milestone must be completed. | | TargetResponseInDays | Type double Properties Filter, Nillable, Sort Description The time to complete the milestone in days. | | TargetResponseInHrs | Type double Properties Filter, Nillable, Sort Description The time to complete the milestone in hours. | | TargetResponseInMins | Type int Properties Filter, Group, Nillable, Sort Description The time to complete the milestone in minutes. | | TimeRemainingInDays | Type double Properties Group, Nillable, Sort Description Time remaining to reach the milestone target, measured in days. | | TimeRemainingInHrs | Type text Properties Nillable Description Time remaining to reach the milestone target, measured in hours. | | TimeRemainingInMins | Type text Properties Group, Nillable, Sort Description Time remaining to reach the milestone target. The format is minutes and seconds. | | TimeSinceTargetInDays | Type double Properties Nillable, Sort Description The time elapsed since the milestone target, measured in days. | | TimeSinceTargetInHrs | Type string Properties Group, Nillable, Sort Description The time elapsed since the milestone target, measured in hours. | | TimeSinceTargetInMins | Type string Properties Group, Nillable, Sort Description The time elapsed since the milestone target. The format is minutes and seconds. | ## Usage This object lets you view a milestone on a case. It also lets you view if the milestone was completed and when it must be completed. #### See Also - [Case](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm "Represents a case, which is a customer issue or problem.") - [MilestoneType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_milestonetype.htm "Represents a milestone (required step in a customer support process). This object is available in API version 18.0 and later.") - [SlaProcess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_slaprocess.htm "Represents an entitlement process associated with an Entitlement. This object is available in API version 19.0 and later.") # CaseOwnerSharingRule Represents the rules for sharing a case with users other than the owner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## 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 | | --- | --- | | CaseAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. The possible values are: - Read - Edit | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. This field is available in API version 24.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. Cases owned by users in the source group trigger the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the target user or group. Target users or groups are given access. | ## Usage Use this object to manage the sharing rules for cases. General sharing and territory management-related sharing use this object. #### See Also - [Case](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm "Represents a case, which is a customer issue or problem.") - [CaseShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseshare.htm "Represents a sharing entry on a Case.") - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") # CaseParticipant Represents a junction between a case, and an account or a contact. This object stores the details of the participant associated with a case. This participant could be the applicant, co-applicant, a household, or even a business account. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Fields and values added in API version 58.0 are available if the add-on license for Financial Services Cloud is enabled. ## Fields | Field | Details | | --- | --- | | AuthorizationProof | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description How the participant communicated their consent. This field is available in API version 58.0 and later. Possible values are: - Email Consent - Joint Ownership - Power of Attorney - Verbal Consent | | CaseId | Type reference Properties Create, Filter, Group, Sort, Update Description The case associated with the case participant record. This field is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, possibly the user only accessed this record or list view (LastReferencedDate) but didn't view it. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the case participant record. | | ParticipantId | Type reference Properties Create, Filter, Group, Sort, Update Description The participant associated with the case participant record. This field is a polymorphic relationship field. Relationship Name Participant Relationship Type Lookup Refers To Account, Contact | | PreferredCallTimeFrom | Type time Properties Create, Filter, Nillable, Sort, Update Description The start of the preferred time window for contacting the participant. This field is available in API version 58.0 and later. | | PreferredCallTimeTo | Type time Properties Create, Filter, Nillable, Sort, Update Description The end of the preferred time window for contacting the participant. This field is available in API version 58.0 and later. | | PreferredCommunicationMode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description How the participant prefers to receive messages. This field is available in API version 58.0 and later. Possible values are: - Email - Phone - SMS | | Role | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The role of the case participant. Possible values are: - Applicant - Complainant Representative (Available in API version 58.0 and later.) - Inspection Officer - Lawyer - Observer - Perpetrator - Primary Caretaker - Victim The default value is Applicant. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the case participant. Possible values are: - Active - Inactive - In Review (Available in API version 58.0 and later.) - Pending (Available in API version 58.0 and later.) - Submitted (Available in API version 58.0 and later.) | ## 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. [CaseParticipantFeed](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. [CaseParticipantHistory](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. # CaseRelatedIssue This object acts as a junction between a customer issue (Case) and the Incident or Problem that represents an associated service failure. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CaseId | Type reference Properties Create, Filter, Group, Sort Description A relationship field that represents the case you're linking a Problem or Incident to. Relationship Name Case Relationship Type Lookup Refers To Case | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A brief description of the related case. | | RelatedEntityType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Shows what type of object the related entity is. Possible values are: - Incident - Problem | | RelatedIssueId | Type reference Properties Create, Filter, Group, Sort Description A polymorphic relationship field that represents a related Problem or Incident. Relationship Name RelatedIssue Relationship Type Lookup Refers To Incident, Problem | | RelationshipType | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Shows how two records relate to each other. Possible values are: - Root Cause - Similar The default value is 'Root Cause'. | | UniqueKeyIndex | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description This field is unique within your organization. | ## 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. [CaseRelatedIssueChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CaseRelatedIssueFeed](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. [CaseRelatedIssueHistory](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. # CaseShare Represents a sharing entry on a Case. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls describeSObjects(), create(), delete(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only users with access to the Case object can access this object. ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field | Details | | --- | --- | | CaseAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the Case. The possible values are: - Read - Edit - All This value isn’t valid for creating or deleting records. This field must be set to an access level that is higher than the organization’s default access level for cases. | | CaseId | Type reference Properties Create, Filter, Group, Sort Description ID of the Case associated with this sharing entry. This field can't be updated. This is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Manual—The User or Group has access because a user with “All” access manually shared the Case with them. - Owner—The User is the owner of the [Case](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm "Represents a case, which is a customer issue or problem."). - ImplicitChild—The User or Group has access to the Case on the Account associated with this Case. After faster account sharing recalculation is enabled for your org, sharing entries with this value aren’t returned in queries. Instead of storing implicit child shares, record access is determined dynamically. - RelatedPortalUser—The portal user is the contact on the Case. - Rule—The User or Group has access via a Case sharing rule. - GuestRule—The User or Group has access via a Case guest user sharing rule. - Team—The User or Group has team access. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. - ARImplicit—The User, who belongs to a partner or customer account, has access to the Case via an account relationship data sharing rule. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the Case. This field can't be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object allows you to determine which users and groups can view and edit Case records owned by other users. If you attempt to create a record that matches an existing record, request updates any modified fields and returns the existing record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note After faster account sharing recalculation is enabled for your org, we no longer store implicit share records between accounts and their child case records. Sharing entries that have a value of ImplicitChild in the RowCause field aren’t returned when you query this object. Instead, the system dynamically determines whether users can access child case records when they try to access them. This change speeds up ownership and sharing recalculation for accounts. For more information, see the [Faster Account Sharing Recalculation](https://help.salesforce.com/s/articleView?id=000394638&type=1&language=en_US) knowledge article. #### See Also - [AccountShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm "Represents a sharing entry on an account.") - [LeadShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadshare.htm "Represents a sharing entry on a Lead.") - [OpportunityShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityshare.htm "Represents a sharing entry on an Opportunity.") # CaseSolution Represents the association between a Case and a Solution. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CaseId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Case associated with the Solution. This is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | SolutionId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Solution associated with the case. This is a relationship field. Relationship Name Solution Relationship Type Lookup Refers To Solution | ## Usage You can't update this object via the API. If you attempt to create a record that matches an existing record, the request simply returns the existing record. #### See Also - [CaseShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseshare.htm "Represents a sharing entry on a Case.") - [SolutionStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_solutionstatus.htm "Represents the status of a Solution, such as Draft, Reviewed, and so on.") # CaseStatus Represents the status of a Case, such as New, On Hold, or In Process. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an id or primary label. | | IsClosed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this case status value represents a closed Case (true) or not (false). Multiple case status values can represent a closed Case. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default case status value (true) or not (false) in the picklist. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Label for this case status value. This display value is the internal label that does not get translated. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the case status picklist. These numbers are not guaranteed to be sequential, as some previous case status values might have been deleted. | ## Usage This object represents a value in the case status picklist. The case status picklist provides additional information about the status of a Case, such as whether a given Status value represents an open or closed case. Query the CaseStatus object to retrieve the set of values in the case status picklist, and then use that information while processing Case records to determine more information about a given case. For example, the application could test whether a given case is open or closed based on its Status value and the value of the IsClosed property in the associated CaseStatus object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # CaseSubjectParticle Represents the Social Business Rules custom format for the **Case Subject** field on cases created from inbound social posts. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name for the CaseSubjectParticle object. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Index | Type int Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The order in which the custom **Case Subject** is generated, meaning if the social network is 0 and the social message is 1, then the subject generates as Twitter | Tweet. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the case subject field. Possible values are: - ar—Arabic - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - iw—Hebrew - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for the case subject field. | | TextField | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies inbound social content added to **Case Subject** in case records. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Specifies the custom **Case Subject** format from which inbound social content appears in case records. Possible values are: - ColonSeparator - Content—Message - HyphenSeparator - MessageType - PipeSeparator - ProvidedString - RealName - Sentiment - SocialHandle - SocialNetwork - Source | ## Usage In the Salesforce UI, case subjects are brief descriptions of cases. They are what agents see on cases first. Social Business Rules specify the brief descriptions of cases created from social posts. Using CaseSubjectParticle objects you can build your own case subject format, where each object represents a social post's component. For example, combining CaseSubjectParticle objects with components for types MessageType, RealName, and SocialNetwork results in "Tweet Customer123 Twitter". # CaseTag Associates a word or short phrase with a Case ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage CaseTag stores the relationship between its parent TagDefinition and the Case being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. # CaseTeamMember Represents a case team member, who works with a team of other users to help resolve a case. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only users with read access to the Case object can access this object. Queries return CaseTeamMember records only for Cases the user can access. Fields on the parent Case are available through the Parent relationship only for those Cases. When accessing from Apex code, use the WITH USER\_MODE clause to enable field-level and object-level security permissions checking for SOQL SELECT queries, including subqueries and cross-object relationships. See [Enforce User Mode for Database Operations](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_classes_enforce_usermode.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | MemberId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user or contact who is a member on a case team. This is a polymorphic relationship field. Relationship Name Member Relationship Type Lookup Refers To Contact, User | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the case with which the case team member is associated. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Case | | TeamRoleId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the case team role with which the case team member is associated. This is a relationship field. Relationship Name TeamRole Relationship Type Lookup Refers To CaseTeamRole | | TeamTemplateId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the predefined team with which the case team member is associated. This is a relationship field. Relationship Name TeamTemplate Relationship Type Lookup Refers To CaseTeamTemplate | | TeamTemplateMemberId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the team member included in a predefined case team. This is a relationship field. Relationship Name TeamTemplateMember Relationship Type Lookup Refers To CaseTeamTemplateMember | # CaseTeamRole Represents a case team role. Every case team member has a role on a case, such as “Customer Contact” or “Case Manager.” ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only users with read access to the Case object can access this object. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group for cases. The possible values are: - None - Read - Edit | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the case team role. | | PreferencesVisibleInCSP | Type boolean Properties Create, Filter, Update Description Indicates whether or not the case team role is visible to Customer Portal users. | # CaseTeamTemplate Represents a predefined case team, which is a group of users that helps resolve a case. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only users with read access to the Case object can access this object. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A text description of the predefined case team. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the predefined case team. | # CaseTeamTemplateMember Represents a member on a predefined case team, which is a group of users that helps resolve cases. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only users with read access to the Case object can access this object. ## Fields | Field | Details | | --- | --- | | MemberId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user or contact who is a team member on a predefined case team. | | TeamRoleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the predefined case team member's case team role. | | TeamTemplateId | Type reference Properties Create, Filter, Group, Sort Description The ID of the predefined case team's template. | # CaseTeamTemplateRecord The CaseTeamTemplateRecord object is a linking object between the Case and CaseTeamTemplate objects. To assign a predefined case team to a case (customer inquiry), create a CaseTeamTemplateRecord record and point the ParentId to the case and the TeamTemplateId to the predefined case team. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only users with read access to the Case object can access this object. ## Fields | Field | Details | | --- | --- | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the case with which the case team template record is associated. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Case | | TeamTemplateId | Type reference Properties Create, Filter, Group, Sort Description The ID of the predefined case team with which the case team template record is associated. This is a relationship field. Relationship Name TeamTemplate Relationship Type Lookup Refers To CaseTeamTemplate | # CategoryData Represents a logical grouping of Solution records. ## 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 | | --- | --- | | CategoryNodeId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the CategoryNode associated with the solution. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | RelatedSobjectId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the solution related to the category. | ## Usage This object allows you to assign one or more categories to a Solution. It is an intermediate data table with two foreign keys that defines the relationship between a CategoryNode and a Solution record. CategoryData has two foreign keys: - The first foreign key, CategoryNodeId, refers to the ID of a CategoryNode. - The other foreign key, RelatedSobjectId, refers to a Solution ID. This is a many-to-many relationship, so there can be multiple rows returned with a CategoryNodeId. A Solution can be associated with multiple categories. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # CategoryNode Represents a tree of Solution categories. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - Customer Portal users can't access this object. - Attempting to delete a CategoryNode that has children (referred by CategoryNode.Parent), or is referred to elsewhere, causes a failure. ## Fields | Field | Details | | --- | --- | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for the category node. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the parent of this node, if any. | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the sort order of child CategoryNode objects. | | SortStyle | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the sort order is alphabetical or custom. | ## Usage A CategoryNode defines a category of solutions. In the user interface, you can edit category definitions from Setup by entering Solution Categories in the Quick Find box, then selecting **Solution Categories**. #### See Also - [CategoryData](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_categorydata.htm "Represents a logical grouping of Solution records.") - [Solution](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_solution.htm "Represents a detailed description of a customer issue and the resolution of that issue.") # CategoryNodeLocalization When the Translation Workbench is enabled for your organization, the CategoryNodeLocalization object provides the translation of the label of a solution category. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - Your organization must be using Professional, Enterprise, Developer, Unlimited, or Performance Edition and be enabled for the Translation Workbench. - To view this object, you must have the “View Setup and Configuration” permission. ## Fields | Field | Details | | --- | --- | | CategoryNodeId | Type reference Properties Create, Filter, Nillable Description The ID of the solution CategoryNode that is being translated. | | LanguageLocaleKey | Type picklist Properties Create, Filter, Nillable, Restricted picklist Description This field is available in API version 16.0 and earlier. It is the same as the Language field. | | Language | Type picklist Properties Create, Filter, Nillable, Restricted picklist Description This field is available in API version 17.0 and later. The combined language and locale ISO code, which controls the language for labels displayed in an application. This picklist contains the following fully-supported languages: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. The following end-user only languages are available. - Arabic: ar - Bulgarian: bg - Croatian: hr - Czech: cs - English (UK): en\_GB - Greek: el - Hebrew: iw - Hungarian: hu - Indonesian: in - Polish: pl - Portuguese (European): pt\_PT - Romanian: ro - Slovak: sk - Slovenian: sl - Turkish: tr - Ukrainian: uk - Vietnamese: vi The following platform languages are available for organizations that use Salesforce exclusively as a platform. - Albanian: sq - Afrikaans: af - Amharic: am - Arabic (Algeria): ar\_DZ - Arabic (Bahrain): ar\_BH - Arabic (Egypt): ar\_EG - Arabic (Iraq): ar\_IQ - Arabic (Jordan): ar\_JO - Arabic (Kuwait): ar\_KW - Arabic (Lebanon): ar\_LB - Arabic (Libya): ar\_LY - Arabic (Morocco): ar\_MA - Arabic (Oman): ar\_OM - Arabic (Qatar): ar\_QA - Arabic (Saudi Arabia): ar\_SA - Arabic (Sudan): ar\_SD - Arabic (Syria): ar\_SY - Arabic (Tunisia): ar\_TN - Arabic (United Arab Emirates): ar\_AE - Arabic (Yemen): ar\_YE - Armenian: hy - Basque: eu - Bosnian: bs - Bengali: bn - Burmese: my - Catalan: ca - Chinese (Hong Kong): zh\_HK - Chinese (Singapore): zh\_SG - Chinese (Malaysia): zh\_MY - Dutch (Belgium): nl\_BE - English (Australia): en\_AU - English (Belgium): en\_BE - English (Canada): en\_CA - English (Cyprus): en\_CY - English (Germany): en\_DE - English (Hong Kong): en\_HK - English (India): en\_IN - English (Ireland): en\_IE - English (Israel): en\_IL - English (Malaysia): en\_MY - English (Malta): en\_MT - English (Netherlands): en\_NL - English (New Zealand): en\_NZ - English (Philippines): en\_PH - English (Singapore): en\_SG - English (South Africa): en\_ZA - English (United Arab Emirates): en\_AE - Estonian: et - Farsi: fa - French (Belgium): fr\_BE - French (Canada): fr\_CA - French (Luxembourg): fr\_LU - French (Morocco): fr\_MA - French (Switzerland): fr\_CH - Georgian: ka - German (Austria): de\_AT - German (Belgium): de\_BE - German (Luxembourg): de\_LU - German (Switzerland): de\_CH - Greek (Cyprus): el\_CY - Greenlandic: kl - Gujarati: gu - Hawaiian: haw - Haitian Creole: ht - Hindi: hi - Hmong: hmn - Icelandic: is - Irish: ga - Italian (Switzerland): it\_CH - Kannada: kn - Kazakh: kk - Khmer: km - Latvian: lv - Lithuanian: lt - Luxembourgish: lb - Macedonian: mk - Malay: ms - Malayalam: ml - Maltese: mt - Marathi: mr - Montenegrin: sh\_ME - Punjabi: pa - Romanian (Moldova): ro\_MD - Romansh: rm - Russian (Armenia): ru\_AM - Russian (Belarus): ru\_BY - Russian (Kazakhstan): ru\_KZ - Russian (Kyrgyzstan): ru\_KG - Russian (Lithuania): ru\_LT - Russian (Moldova): ru\_MD - Russian (Poland): ru\_PL - Russian (Ukraine): ru\_UA - Samoan: sm - Serbian (Cyrillic): sr - Serbian (Latin): sh - Spanish (Argentina): es\_AR - Spanish (Bolivia): es\_BO - Spanish (Chile): es\_CL - Spanish (Colombia): es\_CO - Spanish (Costa Rica): es\_CR - Spanish (Dominican Republic): es\_DO - Spanish (Ecuador): es\_EC - Spanish (El Salvador): es\_SV - Spanish (Guatemala): es\_GT - Spanish (Honduras): es\_HN - Spanish (Nicaragua): es\_NI - Spanish (Panama): es\_PA - Spanish (Paraguay): es\_PY - Spanish (Peru): es\_PE - Spanish (Puerto Rico): es\_PR - Spanish (United States): es\_US - Spanish (Uruguay): es\_UY - Spanish (Venezuela): es\_VE - Swahili: sw - Tagalog: tl - Tamil: ta - Te reo: mi - Telugu: te - Urdu: ur - Welsh: cy - Xhosa: xh - Yiddish: ji - Zulu: zu The values in this field are not related to the default locale selection. | | NamespacePrefix | Type string Properties Filter, Nillable Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Value | Type string Properties Create, Filter, Nillable, Update Description The actual translated label for the solution category. Label is **Translation**. | ## Usage Use this object to translate the labels of your solution categories into a supported language. Users with the Translation Workbench enabled can view category node translations, but either the “Customize Application,” “Manage Translation,” or “Manage Categories” permission is required to create or update category node translations. #### See Also - [ScontrolLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scontrollocalization.htm "The translated value of the field label for an s-control.") - [WebLinkLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_weblinklocalization.htm "Represents the translated value of the field label for a custom link to a URL or s-control when the Translation Workbench is enabled for your organization.") # Change Set Operation Event Type Change Set Operation events contain information from change set migrations. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CHANGE_SET_NAME
Type
String
Description
The name of the change set.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ChangeSetOperation.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
OPERATION
Type
String
Description
The operation that’s being performed.
Possible Values
  • DELETE
  • DEPLOY
  • UPLOAD
  • VALIDATE
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TARGET_ORG_ID
Type
Id
Description
The 15-character ID of the organization that’s receiving the change set.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # ChangeRequest Represents a decision to implement a formal request for a change (RFC). This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BusinessJustification | Type textarea Properties Create, Nillable, Update Description A description of the business reason to implement the change. This field can store up to 32 KB of data, but only the first 255 characters display in reports. | | BusinessReason | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The core reason for creating the change request. Possible values are: - t2 | | Category | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of change request. Administrators set field values. | | ChangeRequestNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique, system-generated change request number. | | ChangeType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of change request. Administrators set field values. Possible values are: - Emergency - Major - Normal - Standard | | Description | Type textarea Properties Create, Nillable, Update Description A description of the change request. This field can store up to 32 KB of data, but only the first 255 characters display in reports. | | EstimatedEndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time (in UTC) when the change request is estimated to be implemented. | | EstimatedStartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The estimated date and time (in UTC) when the change request is implemented. | | FinalReviewDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time (in UTC) when the change request was reviewed. | | FinalReviewNotes | Type textarea Properties Create, Nillable, Update Description Notes left by the change request reviewer. This field can store up to 32 KB of data, but only the first 255 characters display in reports. | | Impact | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Shows the impact of a requested change. Possible values are: - High - Low - Medium The default value is 'High'. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description A polymorphic relationship field that represents the user or group assigned as the change reviewer. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The impact and urgency of a requested change. Possible values are: - Critical - High - Low - Moderate The default value is 'Critical'. | | RemediationPlan | Type textarea Properties Create, Nillable, Update Description A description of the steps required to resolve the incident. This field can store up to 32 KB of data, but only the first 255 characters display in reports. | | ReviewerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who reviewed the change request. This is a relationship field. Relationship Name Reviewer Relationship Type Lookup Refers To User | | RiskImpactAnalysis | Type textarea Properties Create, Nillable, Update Description An assessment of the risk involved with the implementation of the change request. Administrators set field values, and each value can have up to 20 characters. | | RiskLevel | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The risk level associated with adopting the requested change. Possible values are: - High - Low - Medium The default value is 'High'. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents any custom or granular stages a customer may want to track. This will be a dependent picklist. Possible values are: - Approved - Canceled - Closed - Implementing - New - Open - Planning - Rejected - Reviewed - Scheduled The default value is 'New'. | | StatusCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status of the change. Possible values are: - Approved - Canceled - Closed - Implementing - New - Open - Planning - Rejected - Reviewed - Scheduled The default value is 'New'. | | Subject | Type string Properties Create, Filter, Group, Sort, Update Description A brief description of the requested change. | ## 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. [ChangeRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [ChangeRequestFeed](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. [ChangeRequestHistory](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. [ChangeRequestOwnerSharingRule](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. [ChangeRequestShare](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. # ChangeRequestRelatedIssue Represents a junction object that relates a ChangeRequest to an Incident or Problem due to a service failure. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ChangeRequestId | Type reference Properties Create, Filter, Group, Sort Description The ChangeRequest ID that's linked to the Problem or Incident. Relationship Name ChangeRequest Relationship Type Lookup Refers To ChangeRequest | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A description of the change request as it relates to the problem or incident. | | RelatedEntityType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the related object type. Possible values are: - Incident - Problem | | RelatedIssueId | Type reference Properties Create, Filter, Group, Sort Description A polymorphic relationship field that represents the related Problem or Incident. Relationship Name RelatedIssue Relationship Type Lookup Refers To Incident, Problem | | RelationshipType | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Shows how the ChangeRequest and Incident or Problem records relate to each other. Possible values are: - Caused By - Fixed By The default value is 'Caused By'. | ## 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. [ChangeRequestRelatedIssueChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ChangeRequestRelatedIssueFeed](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. [ChangeRequestRelatedIssueHistory](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. # ChangeRequestRelatedItem Represents a junction object that relates a ChangeRequest to an Asset. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Sort Description The Asset ID that’s linked to the ChangeRequest. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | ChangeRequestId | Type reference Properties Create, Filter, Group, Sort Description The ChangeRequest ID that’s linked to the Asset. This field is a relationship field. Relationship Name ChangeRequest Relationship Type Lookup Refers To ChangeRequest | | Comment | Type textarea Properties Create, Nillable, Update Description A description of the change request as it relates to the item. | | ImpactLevel | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The related item's impact on the change request. Possible values are: - High - Low - Medium The default value is High. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated ID of the item that's related to the change request. | | RelationshipType | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Shows how the ChangeRequest and Asset records relate to each other. Possible values are: - Broke Item - Fixed Item The default value is Broke Item. | ## 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. [ChangeRequestRelatedItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ChangeRequestRelatedItemFeed](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. [ChangeRequestRelatedItemHistory](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. # ChangeSetOperationEventLog Change Set Operation events contain information from change set migrations. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ChangeSetName | Type string Properties Filter, Group, Nillable, Sort Description The name of the change set. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The operation that’s being performed. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. | | TargetOrganizationIdentifier | Type string Properties Filter, Group, Nillable, Sort Description ID of the organization that’s receiving the change set. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description Timestamp at which the log event was generated. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description URI of the page receiving the request. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # ChannelObjectLinkingRule Represents a rule for linking a channel interaction with an object (such as Lead or Contact). This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActionForNoRecordFound | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Action to take when no matching records are found. Possible values are: - CreateNewRecordAndLink—Create Record and Link (Recommended) - PromptAgent—Prompt Agent | | ActionForSingleRecordFound | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Action to take when one matching record is found. Possible values are: - AutoLink—Auto-Link Record (Recommended) - PromptAgent—Prompt Agent | | ChannelType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of channel used for this rule. Possible values are: - FacebookMessenger - Phone - Text - WeChat - WhatsApp | | Description | Type textarea Properties Create, Nillable, Update Description The description for this linking rule. | | DeveloperName | Type string Properties 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsLinkedRecordOpenedAsSubTab | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to open the linked record as a subtab when the link is established. | | IsRuleActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the rule is active. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language for this linking rule. Possible values are: - ar—Arabic - bg—Bulgarian - cs—Czech - da—Danish - de—German - el—Greek - en\_GB—English (UK) - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - hr—Croatian - hu—Hungarian - in—Indonesian - it—Italian - iw—Hebrew - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pl—Polish - pt\_BR—Portuguese (Brazil) - pt\_PT—Portuguese (European) - ro—Romanian - ru—Russian - sk—Slovak - sl—Slovene - sv—Swedish - th—Thai - tr—Turkish - uk—Ukrainian - vi—Vietnamese - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The unique label name for this rule. | | ObjectToLink | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of object to link to the channel interaction. Possible values are: - Contact | | RuleName | Type string Properties Create, Filter, Group, Sort, Update Description Name of the rule as it appears in the UI. Maximum length is 80 characters. | # ChannelProgram Represents a channel program that vendors use to market and sell their products through channel partners. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Category | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Category of the channel program. Categories group channel programs by type. For example, a reseller category would include all the different regional reseller channel programs. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the channel program. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the channel program is active. New channel programs are inactive by default. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Name of the channel program. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the channel program. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ChannelProgramFeed](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. [ChannelProgramHistory](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. [ChannelProgramOwnerSharingRule](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. [ChannelProgramShare](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. # ChannelProgramLevel Represents a level, based on member experience, in a channel program. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | BenefitsInformation | Type textarea Properties Create, Nillable, Update Description Stores information about the benefits associated with this channel program level. This field is available in API version 64.0 and later. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the channel program level. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the channel program level. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. ID of the user who is the owner of the record. | | ProgramId | Type reference Properties Create, Filter, Group, Sort Description ID of the channel program. | | Rank | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description An integer associated with the level. For example, 1 represents the lowest level, 2 the next level up, etc. | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to this object. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ChannelProgramLevelFeed](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. [ChannelProgramLevelHistory](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. [ChannelProgramLevelOwnerSharingRule](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. [ChannelProgramLevelShare](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.") (API version 43.0) Sharing is available for the object. # ChannelProgramMember Represents a partner who is a member of a channel program. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Most recent date referenced. This field is available in API version 45.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Most recent date viewed. This field is available in API version 45.0 and later. | | LevelId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the channel program level. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the channel program member. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. ID of the user who is the owner of the record. | | PartnerId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the partner. | | ProgramId | Type reference Properties Create, Filter, Group, Sort Description ID of the channel program. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ChannelProgramMemberFeed](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.") (API version 46.0) Feed tracking is available for the object. [ChannelProgramMemberHistory](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.") (API version 46.0) History is available for tracked fields of the object. [ChannelProgramMemberOwnerSharingRule](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. [ChannelProgramMemberShare](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.") (API version 43.0) Sharing is available for the object. # ChatterActivity ChatterActivity represents the number of posts and comments made by a user and the number of comments and likes on posts and comments received by the same user. This object is available in API version 23.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | CommentCount | Type int Properties Filter, Group, Sort Description The number of FeedComments made by the ParentId. | | CommentReceivedCount | Type int Properties Filter, Group, Sort Description The number of FeedComments received by the ParentId. | | InfluenceRawRank | Type int Properties Filter, Group, Sort Description Number indicating the ParentId’s Chatter influence rank, which is calculated based on the ParentId’s ChatterActivity statistics, relative to the other users in the organization. This field is available in API version 26.0 and later. | | LikeReceivedCount | Type int Properties Filter, Group, Sort Description The number of FeedLikes received by the ParentId. | | NetworkId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Experience Cloud site to which the ChatterActivity belongs. This field is available only if digital experiences is enabled in your org. This field is available in API version 26.0 and later. | | ParentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the object type to which the ChatterActivity is related. In API version 68.0, the ParentId must be a UserId or SelfServiceUser ID. | | PostCount | Type int Properties Filter, Group, Sort Description The number of FeedItems made by the ParentId. | ## Usage - Use this object to reference the Chatter activity statistics, which include the number of posts and comments made by a user and the number of comments and likes on posts and comments received by the same user. - You can directly query for ChatterActivity. SELECT Id, PostCount, LikeReceivedCount FROM ChatterActivity WHERE ParentId = UserId ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To query ChatterActivity, you must provide the ParentId. In API version 68.0, the ParentId must be a UserId or SelfServiceUser ID. - A ChatterActivity record is created for users the first time they post or comment. Users who have never posted or commented don’t have ChatterActivity records. If users make only one post and then delete it, they do have ChatterActivity records. In both cases, the user interface displays zeros for their Chatter activity. - Use the InfluenceRawRank field to reference a user’s Chatter influence rank. This field is available in API version 26.0 and later. #### See Also - [FeedItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feeditem.htm "FeedItem represents an entry in the feed, such as changes in a record feed, including text posts, link posts, and content posts. This object is available in API version 21.0 and later. This object replaces FeedPost.") - [FeedComment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedcomment.htm "Represents a comment added to a feed by a user. This object is available in API version 18.0 and later.") - [FeedLike](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedlike.htm "Indicates that a user has liked a feed item. This object is available in API version 21.0 and later.") # ChatterAnswersActivity Represents the reputation of a User in Chatter Answers zones.This object is available in API version 25.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | BestAnswerReceivedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of best answers the User has received from other users. | | BestAnswerSelectedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of best answers the User has selected. | | QuestionsCount | Type int Properties Filter, Group, Nillable, Sort Description The number of Question records posted by the User. | | QuestionSubscrCount | Type int Properties Filter, Group, Nillable, Sort Description The number of Question records the User has selected to follow. | | QuestionSubscrReceivedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of users following Question records posted by the User. | | QuestionUpVotesCount | Type int Properties Filter, Group, Nillable, Sort Description The number of up votes the User has marked on Question records posted by other users. | | QuestionUpVotesReceivedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of up votes the User has received from other users on the Question records he or she has posted. | | RepliesCount | Type int Properties Filter, Group, Nillable, Sort Description The number of Reply records posted by the User. | | ReplyDownVotesCount | Type int Properties Filter, Group, Nillable, Sort Description The number of down votes the User has marked on Reply records posted by other users. | | ReplyDownVotesReceivedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of down votes the User has received from other users on the Reply records he or she has posted. | | ReplyUpVotesCount | Type int Properties Filter, Group, Nillable, Sort Description The number of up votes the User has marked on the Reply records posted by other users. | | ReplyUpVotesReceivedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of up votes the User has received from other users on the Reply records he or she has posted. | | ReportAbuseOnQuestionsCount | Type int Properties Filter, Group, Nillable, Sort Description The number of abuses that the User has reported on Question records posted by other users. | | ReportAbuseOnRepliesCount | Type int Properties Filter, Group, Nillable, Sort Description The number of abuses that the User has reported on Reply records posted by other users. | | ReportAbuseReceivedOnQnCount | Type int Properties Filter, Group, Nillable, Sort Description The number of abuses reported by other users on the Question records posted by the User. | | ReportAbuseReceivedOnReCount | Type int Properties Filter, Group, Nillable, Sort Description the number of abuses reported by other users on the Reply records posted by the User. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description The User ID associated with this reputation. | | CommunityId | Type reference Properties Filter, Group, Nillable, Sort Description The ID for the zone associated with this reputation. | ## Usage Use this object to view metrics on User activity in Chatter Answers. For example, you can use the ChatterAnswersActivity object to view the number of Question records a user is following in Chatter Answers zones. #### See Also - [Question](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_question.htm "Represents a question in a zone that users can view and reply to.") - [Reply](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reply.htm "Represents a reply that a user has submitted to a question in an answers zone.") - [User](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_user.htm "Represents a user in your organization.") # ChatterAnswersReputationLevel Represents a reputation level within a Chatter Answers zone. This object is available in API version 26.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see [End of Support for Chatter Answers in Spring ’18](https://help.salesforce.com/apex/HTViewSolution?urlname=Chatter-Answers-to-Retire-in-Spring-18 "HTML (New Window)"). ## Supported Calls create(), delete(), query(), retrieve(), update() ## Fields | Field | Details | | --- | --- | | CommunityID | Type reference Properties Create, Filter, Group, Sort Description ID of the zone for which you’re creating the reputation level. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Name of the reputation level. | | Value | Type int Properties Create, Filter, Group, Sort, Update Description Minimum number of points for this level. | ## Usage Use to create or edit reputation levels for the zone. # ChatterConversation Represents a private conversation in Chatter, consisting of messages that conversation members have sent or received. This object is available in API version 23.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | Id | Type ID Properties Defaulted on create, Filter, Group, Sort Description ID of the conversation. | ## Usage Use this object to identify private conversations in Chatter. Users can access this object if they have the Manage Chatter Messages and Direct Messages permission. This object is read-only via the API and is provided only to allow administrators to view users' Chatter messages; for example, for compliance purposes. #### See Also - [ChatterConversationMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatterconversationmember.htm "Represents a member of a private conversation in Chatter. A member has either sent messages to or received messages from other conversation participants. This object is available in API version 23.0 and later.") - [ChatterMessage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chattermessage.htm "Represents a message sent as part of a private conversation in Chatter. This object is available in API version 23.0 and later.") # ChatterConversationMember Represents a member of a private conversation in Chatter. A member has either sent messages to or received messages from other conversation participants. This object is available in API version 23.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ConversationId | Type reference Properties Filter, Group, Sort Description ID of the associated ChatterConversation. | | MemberId | Type reference Properties Filter, Group, Sort Description ID of the conversation member. | ## Usage Use this object to view members of private conversations in Chatter. Users can access this object if they have the Manage Chatter Messages and Direct Messages permission. This object is read-only via the API and is provided only to allow administrators to view users' Chatter messages; for example, for compliance purposes. #### See Also - [ChatterConversation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatterconversation.htm "Represents a private conversation in Chatter, consisting of messages that conversation members have sent or received. This object is available in API version 23.0 and later.") - [ChatterMessage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chattermessage.htm "Represents a message sent as part of a private conversation in Chatter. This object is available in API version 23.0 and later.") # ChatterExtension Represents a Rich Publisher App that’s integrated with the Chatter publisher. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CompositionComponentEnumOrId | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ID of the composition component for the Rich Publisher App. This field requires a value. | | Description | Type string Properties Create, Filter, Group, Sort, Update Description The description of your custom Rich Publisher App. This field requires a value. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the developer who is responsible for the app. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | ExtensionName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of your extension. This field requires a value. | | HeaderText | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The text to show in the header of your app composer. Header text is required for Lightning type extensions. | | HoverText | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The text to show when a user mouses over your extension’s icon. Mouse-over text is required for Lightning type extensions. | | IconId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The icon to show in the Chatter publisher. Use an existing file asset ID from your org. This field requires a value. This is a relationship field. Relationship Name Icon Relationship Type Lookup Refers To ContentAsset | | IsProtected | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description An auto-generated value. It currently has no impact. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language used for this instance of the ChatterExtension. This field requires a value. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The master label for the ChatterExtension object. This field requires a value. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The prefix to use for the extension’s namespace. | | RenderComponentEnumOrId | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The rendering component of the Rich Publisher App that you provide. It’s comprised of the lightning:availableForChatterExtensionRenderer interface. This field requires a value. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Describes the type of the extension. Currently, the only value supported is Lightning. Included to allow for other possible types in the future. | # ChatterExtensionConfig Configuration for the Chatter extension for Experience Cloud sites. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CanCreate | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the ChatterExtension can create an instance that appears by rendering. | | CanRead | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the ChatterExtension can be viewed. | | ChatterExtensionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the ChatterExtension. This is a relationship field. Relationship Name ChatterExtension Relationship Type Lookup Refers To ChatterExtension | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Experience Cloud site where the ChatterExtension is deployed. | | Position | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The position of the ChatterExtension icon in the Chatter publisher. | # ChatterMessage Represents a message sent as part of a private conversation in Chatter. This object is available in API version 23.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve(), update() ## Fields | Field Name | Details | | --- | --- | | Body | Type textarea Properties Update Description Text of the message. | | ConversationId | Type reference Properties Filter, Group, Sort Description ID of the conversation that the message is associated with. | | SenderId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the sender. | | SenderNetworkId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Experience Cloud site from which the message was sent. This field is available only if digital experiences is enabled in your org. This field is available in API version 32.0 and later. | | SentDate | Type dateTime Properties Filter, Sort Description Date the message was sent. | ## Usage Use this object to view and delete messages sent or received via private conversations in Chatter. Users can access this object if they have the Manage Chatter Messages and Direct Messages permission. Users with the Moderate Experiences Chatter Messages permission can access this object in Experience Cloud sites they’re a member of, only if the message has been flagged as inappropriate. This object is provided to allow administrators to view and delete users’ Chatter messages, for example, for compliance purposes. Messages are hard deleted. That is, they’re removed completely without a trip to the Recycle Bin. Deleting a message that resulted from sharing a file with someone doesn’t also delete the file. #### See Also - [ChatterConversation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatterconversation.htm "Represents a private conversation in Chatter, consisting of messages that conversation members have sent or received. This object is available in API version 23.0 and later.") - [ChatterConversationMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatterconversationmember.htm "Represents a member of a private conversation in Chatter. A member has either sent messages to or received messages from other conversation participants. This object is available in API version 23.0 and later.") # ClientBrowser Represents a cookie added to the browser upon login, and also includes information about the browser application where the cookie was inserted. This object is available in version 28.0 and later. ## Supported Calls describeSObjects(), delete(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | FullUserAgent | Type string Properties Filter, Nillable, Sort Description Detailed information about the client (browser). For example, Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.1) Gecko/2008070208 Firefox/3.0.1 | | LastUpdate | Type dateTime Properties Filter, Nillable, Sort Description Represents the last time the cookie was changed. | | ProxyInfo | Type string Properties Filter, Nillable, Sort Description The browser’s current proxy information. | | UsersId | Type reference Properties Filter, Group, Sort Description The ID of the user associated with this item. This is a relationship field. Relationship Name Users Relationship Type Lookup Refers To User | ## Usage At every login, the device the login request is from is checked against the known devices using ClientBrowser. A match means a cookie was found on the browser that matches an entry in the ClientBrowser table, so the device is known. No match means that no matching cookie was found, so the device is unknown, and the user is asked to confirm their identity. # CollabDocumentMetric Represents the engagement metrics for a Quip thread (document or spreadsheet) that’s linked to a Salesforce record. This object is available in API version 50.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Document | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The Quip thread ID. | | Site | Type string Properties Filter, Group, Nillable, Sort Description The ID of the Quip site in which the thread is located. | | SourceTemplate | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the template (if any) on which a Quip thread is based. | | DocumentTitle | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The title of the thread. | | MetricDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the metric was gathered in your local time zone. | | MetricDateOnly | Type date Properties Filter, Nillable, Sort Description The date that the metric was gathered in UTC. Available in API version 55.0 and later. | | LastUpdatedDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the thread was created, last edited, or last shared in your local time zone. | | LastUpdatedDateOnly | Type date Properties Filter, Nillable, Sort Description The date that the thread was created, last edited, or last shared in UTC. Available in API version 55.0 and later. | | ViewerCount | Type int Properties Filter, Nillable, Sort Description The number of thread views by user for the specified MetricDate. | | UpdateCount | Type int Properties Filter, Group, Nillable, Sort Description The number of edits made on the thread on a given day. | | EditorCount | Type int Properties Filter, Group, Nillable, Sort Description For the specified MetricDate, the number of users who edited the Quip thread. | | CommenterCount | Type int Properties Filter, Group, Nillable, Sort Description For the specified MetricDate, the number of users who commented on the Quip thread. | # CollabDocumentMetricRecord Represents an association between a CollabDocumentMetric and a Salesforce record.It tracks which Salesforce record, such as an Account or Contact, is linked to a Quip thread for which metrics were gathered using CollabDocumentMetric. CollabDocumentMetricRecord is available in API version 50.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ParentRecord | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Salesforce record. | | QuipDocumentMetric | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the CollabDocumentMetric record. | | MetricDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the metric was gathered in your local time zone. | | MetricDateOnly | Type date Properties Filter, Nillable, Sort Description The date that the metric was gathered in UTC. Available in API version 55.0 and later. | | EntityType | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The object type of the Salesforce record, such as Account or Contact. | # CollaborationGroup Represents a Chatter group. This object is available in API version 19.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules The visibility of information in groups depends on the type of group and the user’s permissions. - **Members**: Any user with the Create and Own New Chatter Groups permission can create public, private, and unlisted groups, including in any Experience Cloud sites they belong to. - **Owners and managers**: Users can modify group details for any group they own or manage. Owners can also delete groups they own. - **Nonmembers**: These user permissions allow group access regardless of group membership. - View All Data—Allows users to view all public and private groups across their org and its Experience Cloud sites. Users with this permission can’t view unlisted group information, unless they have the Modify Unlisted Groups permission as well. - Modify All Data—Allows users to view, modify, and delete all public and private groups across their org and its Experience Cloud sites. Users with this permission can’t view or modify unlisted group information, unless they have the Manage Unlisted Groups permission as well. - Create and Set Up Experiences—Allows users to view, modify, and delete all public and private groups in Experience Cloud sites. - Manage Unlisted Groups—Allows users to search for, access, and modify any unlisted group in an org and its Experience Cloud sites. - Data Export—Allows users to export any data from Salesforce, including private and unlisted group data from an org and its Experience Cloud sites. - **Apex and Visualforce**: Apex code runs in system mode, which means that the permissions of the current user aren’t taken into account. - Visualforce pages that display groups might expose unlisted or private group data to users who aren’t members. - Because system mode disregards the user’s permissions, all users who are accessing a Visualforce page that’s showing a group can act as an owner of that group. - AppExchange apps that are written in Apex and that access all groups will expose unlisted groups to users who aren’t members. To limit and manage access to the unlisted and private groups in your org: - Explicitly filter out unlisted and private group information from SOQL queries in all Apex code. - Use permission sets, profile-level permissions, and sharing checks in your code to further limit group access. - Use Apex triggers on the CollaborationGroup object to monitor and manage the creation of groups. In Setup, enter Group Triggers in the Quick Find box, then select **Group Triggers** to add triggers. ## Fields | Field | Details | | --- | --- | | AnnouncementId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Contains the ID of the Announcement last associated with the group. This field is available in API version 30.0 and later. This is a relationship field. Relationship Name Announcement Relationship Type Lookup Refers To Announcement | | BannerPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for the group's banner photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo has been uploaded, the URL returned for an older photo is not guaranteed to return a photo. Query this field for the URL of the most recent photo. This field is available in API version 36.0 and later. | | CanHaveGuests | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If set to true, indicates that a group allows customers. Chatter customers are people outside your company's email domains. Customers can see only the groups they're invited to. They can interact only with members of those groups. Customers can’t see any Salesforce information. This field is available starting in API version 23.0, but groups that allow customers are accessible from earlier API versions. However, when accessed from earlier API versions, groups that allow customers aren't distinguishable from private groups. We strongly recommend that you upgrade to the latest API version. If you must use an earlier version, name groups that allow customers to indicate that they include customers. | | CollaborationType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of Chatter group. Available values are: - Public—Anyone can see and post updates. Anyone can join a public group. - Private—Only members can see the group feed and post updates. Non-members can only see the group name and a few other details in list views, search, and on the group page. The group's owner or managers must add members who request to join the group. - Unlisted—Only members and users with the Manage Unlisted Groups permission can see the group and post updates. Other users can’t access the group or see it in lists, search, and feeds. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the group. | | FullPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for the group's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo has been uploaded, the URL returned for an older photo is not guaranteed to return a photo. Query this field for the URL of the most recent photo. This field is available in API version 20.0 and later. | | GroupEmail | Type email Properties Nillable, Sort Description The email address for posting to the group. For private groups, only visible to members and users with Modify All Data or View All Data permissions. This field is available in API version 29.0 and later. | | HasPrivateFieldsAccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If set to true, indicates that a user can see the InformationBody and InformationTitle fields in a private group. This field is set to true for members of a private group and users with Modify All Data or View All Data permissions. | | InformationBody | Type textarea Properties Create, Nillable, Update Description The text of the Information section. For private groups, only visible to members and users with Modify All Data or View All Data permissions. | | InformationTitle | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The title of the Information section. For private groups, only visible to members and users with Modify All Data or View All Data permissions. | | IsArchived | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the group is archived (true) or not (false). This field is available in API version 28.0 and later. | | IsAutoArchiveDisabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether automatic archiving is disabled for the group (true) or not (false). This field is available in API version 29.0 and later. | | IsBroadcast | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the group is a broadcast group (true) or not (false). This field is available in API version 36.0 and later. | | LastFeedModifiedDate | Type dateTime Properties Filter, Sort Description The date of the last post or comment on the group. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | MediumPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for the larger, cropped photo size. | | MemberCount | Type int Properties Filter, Group, Nillable, Sort Description The number of members in the group. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the group. Group names must be unique across public and private groups. Unlisted groups don’t require unique names. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Experience Cloud site that this group is part of. This field is available only if digital experiences is enabled in your org. You can only add a NetworkId when creating a group. You can’t change or add a NetworkId for an existing group. This field is available in API version 26.0 and later. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the group. Only the current group owner or people with the Modify All Data permission can update the OwnerId. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | SmallPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for a thumbnail of the group's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo has been uploaded, the URL returned for an older photo is not guaranteed to return a photo. Query this field for the URL of the most recent photo. This field is available in API version 20.0 and later. | ## Usage Use this object to create, edit, or delete groups in an org or Experience Cloud site. Deleting a group permanently deletes all posts and comments to the group. It also deletes all files and links posted to the group and removes the files from other locations where they were shared. As a Chatter group member, you can post to the group using the CollaborationGroupFeed object. As a Chatter group owner or manager, you can add or remove group members using the CollaborationGroupMember object, post announcements to the group using the Announcement object, and accept or decline requests to join private groups using the CollaborationGroupMemberRequest object. Additionally, the group owner, manager, or your Salesforce system administrator can invite people to join the group using the [CollaborationInvitation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationinvitation.htm "Represents an invitation to join Chatter, either directly or through a group. This object is available in API version 21.0 and later.") object. The Salesforce system administrator doesn’t need to be a member of the group in order to send invitations using the API. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CollaborationGroupFeed](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. #### See Also - [CollaborationGroupMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgroupmember.htm "Represents a member of a Chatter group. This object is available in API version 19.0 and later.") - [CollaborationGroupMemberRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgroupmemberrequest.htm "Represents a request to join a private Chatter group. This object is available in API version 21.0 and later.") # CollaborationGroupMember Represents a member of a Chatter group. This object is available in API version 19.0 and later. ## Supported Calls create(), delete(), describeSObjects(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CollaborationGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the associated CollaborationGroup. This is a relationship field. Relationship Name CollaborationGroup Relationship Type Lookup Refers To CollaborationGroup | | CollaborationRole | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The role of a group member. Group owners and managers can change roles for members of their groups. The valid values are: - Standard—Indicates that a user is a group member. Members can post and comment in the group. - Admin—Indicates that a user is a group manager. Managers can post and comment, change member roles, edit group settings, add and remove members, delete posts and comments, and edit the group information field. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To change the group owner, use the OwnerId field on the CollaborationGroup object. | | LastFeedAccessDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when a group member last accessed the group’s feed. The value is only updated when a member explicitly consumes the group’s feed, not when the member sees group posts in other feeds, like the profile feed. | | MemberId | Type reference Properties Create, Filter, Group, Sort Description ID of the group member. This is a relationship field. Relationship Name Member Relationship Type Lookup Refers To User | | NotificationFrequency | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. The frequency at which Salesforce sends Chatter group email digests to this member. Can only be set by the member or users with the “Modify All Data” permission. The valid values are: - D—Daily - W—Weekly - N—Never - P—On every post The default value is specified by the member in their Chatter email settings. In communities, the Email on every post option is disabled once more than 10,000 members choose this setting for the group. All members who had this option selected are automatically switched to Daily digests. | ## Usage Use this object to view, create, and delete Chatter group members. You must be a group owner or manager to create members for private Chatter groups. #### See Also - [CollaborationGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgroup.htm "Represents a Chatter group. This object is available in API version 19.0 and later.") - [CollaborationGroupMemberRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgroupmemberrequest.htm "Represents a request to join a private Chatter group. This object is available in API version 21.0 and later.") # CollaborationGroupMemberRequest Represents a request to join a private Chatter group. This object is available in API version 21.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CollaborationGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the private Chatter group. This is a relationship field. Relationship Name CollaborationGroup Relationship Type Lookup Refers To CollaborationGroup | | RequesterId | Type reference Properties Create, Filter, Group, Sort Description ID of the user requesting to join the group; must be the ID of the context user. This is a relationship field. Relationship Name Requester Relationship Type Lookup Refers To User | | ResponseMessage | Type string Properties Filter, Group, Nillable, Sort, Update Description Optional message to be included in the notification email when Status is Declined. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The status of the request. Available values are: - Accepted - Declined - Pending | ## Usage This object represents a request to join a private Chatter group, and can be used to accept or decline requests to join private groups you own or manage. On create, an email is sent to the owner and managers of the private group to be accepted or declined. When the Status is Accepted or Declined, an email is sent to notify the requester. When the Status is Declined, a ResponseMessage is optionally included to provide additional details. Note the following when working with requests: - Users with the “Modify All Data” or “View All Data” permission can view records for all groups, regardless of membership. - A user can be a member of 300 groups. Requests to join groups count against this limit. - Status can't be specified on create. - You can only update a request when the Status is Pending. - You can't delete or update a request with a Status of Accepted or Declined. #### See Also - [CollaborationGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgroup.htm "Represents a Chatter group. This object is available in API version 19.0 and later.") - [CollaborationGroupMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgroupmember.htm "Represents a member of a Chatter group. This object is available in API version 19.0 and later.") # CollaborationGroupRecord Represents the records associated with Chatter groups. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CollaborationGroupId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Chatter group. This is a relationship field. Relationship Name CollaborationGroup Relationship Type Lookup Refers To CollaborationGroup | | NetworkId | Type reference Properties Filter, Group, Nillable, Sort Description Optional. The ID of the Experience Cloud site that the group belongs to. Available from API version 34.0. | | RecordId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the record associated with the Chatter group. This is a polymorphic relationship field. Relationship Name Record Relationship Type Lookup Refers To Account, Campaign, Case, Contact, Contract, Lead, Opportunity | ## 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. [CollaborationGroupRecordChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # CollaborationInvitation Represents an invitation to join Chatter, either directly or through a group. This object is available in API version 21.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Invitations are available if “Allow Invitations” is enabled for your organization. Invitations are limited to your allowed domain(s) unless the invite is sent from a private group that allows customers. Allowed domains are set by the administrator. Invitations to customers are available if “Allow Customer Invitations” is enabled for your organization. Users must have the “Invite Customers to Chatter” permission to send invitations to people outside their Chatter domain. ## Fields | Field | Details | | --- | --- | | InvitedUserEmail | Type string Properties Create, Filter, Group, Sort Description The email address for the user invited to join Chatter. Label is Invited Email. | | InvitedUserEmailNormalized | Type email Properties Filter, Group, Sort Description A normalized version of the InvitedUserEmail entered. Label is Invited Email (Normalized). | | InviterId | Type reference Properties Filter, Group, Sort Description The person that initiated the invitation. | | OptionalMessage | Type string Properties Create, Filter, Group, Nillable, Sort Description An optional message from the person sending the invitation to the person receiving it. | | ParentId | Type reference Properties Filter, Group, Nillable, Sort Description Used when the email address on the invitation is different than the one entered when the invitee accepts the invitation. | | SharedEntityId | Type reference Properties Create, Filter, Group, Sort Description ID of the user or group associated with this invitation. - If the invitation is to join Chatter, the SharedEntityId is the ID of the User that created the invitation. The invitee will auto-follow the inviter. - If the invitation is to join a group within Chatter, the SharedEntityId is the ID of the Chatter CollaborationGroup. - To invite a customer, set SharedEntityId to the ID of the private CollaborationGroup with Allow Customers turned on. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the invitation. Possible values are: - Sent - Accepted - Canceled | ## Usage Use this object to create or delete (cancel) invitations to join Chatter. You can either invite a user to join Chatter directly or as part of a CollaborationGroup. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To invite someone to join a CollaborationGroup, you must be either the owner or a manager of the group or a Salesforce system administrator. The Salesforce system administrator doesn’t need to be a member of the group in order to send invitations using the API. When the person accepts your CollaborationGroup invitation, they join the CollaborationGroup and Chatter as well. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can't send invitations to users of the organization the invite was sent from. Invited users can view profiles, post on their feed, and join groups, but they can't see your Salesforce data or records. If your organization allows groups with customers, owners and managers of private groups with the “Allow Customers” setting, as well as system administrators, can use this object to invite customers. ## Java Samples The following example shows how to send an invitation to join Chatter: public void invitePeople(String inviterUserId, String invitedEmail) throws Exception { CollaborationInvitation invitation = new CollaborationInvitation(); invitation.setSharedEntityId(inviterUserId);//pass the userId of the inviter invitation.setInvitedUserEmail(invitedEmail);//email of the invited user insert(invitation); } The following example shows how to send an invitation to a customer user from a group that allows customers: public void inviteToGroup(String GroupName, String invitedEmail) throws Exception { QueryResult qr = query("select id from collaborationgroup where name = '" + GroupName); //pass the group name String groupId = qr.getRecords()\[0\].getId(); CollaborationInvitation invitation = new CollaborationInvitation(); invitation.setSharedEntityId(groupId);//pass the groupId invitation.setInvitedUserEmail(invitedEmail);//email of the invited user insert(invitation); } ## Apex Samples String emailAddress = 'bob@external.com'; CollaborationGroup chatterGroup = \[SELECT Id FROM CollaborationGroup WHERE Name='All acme.com' LIMIT 1\]; CollaborationInvitation inv = New CollaborationInvitation(); inv.SharedEntityId = chatterGroup.id; inv.InvitedUserEmail = emailAddress; try { Insert inv; } catch(DMLException e){ System.debug('There was an error with the invite: '+e); } # CollaborationRoom Represents a collaboration room, which links Salesforce to a Slack channel used by applications with specific use cases, such as swarming or reporting. This object is available in API version 55.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules To access this object, enable the Slack Terms of Service and one of: - Sales Cloud for Slack App - Service Cloud for Slack App - CRM Analytics for Slack App - Industries Cloud for Slack App - Health Cloud for Slack App ## Fields | Field | Details | | --- | --- | | IsArchived | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the collaboration room is archived (true) or not (false). The default value is false. | | IsAutoJoin | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether new users automatically join the collaboration room. Used for Sales Cloud for Slack App. The default value is false. | | IsExternal | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether external users are members of the Slack channel (true) or not (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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of collaboration room. | | PlatformKey | Type string Properties Create, Filter, Group, Nillable, Sort Description ID of the Slack channel. | | TeamKey | Type string Properties Create, Filter, Group, Nillable, Sort Description ID of the Slack workspace. | # CollabTemplateMetric Represents the engagement metrics for a Quip template.This object is available in API version 50.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Template | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the template. | | TemplateTitle | Type string Properties Filter, Group, Nillable, Sort Description The title of the template. | | Site | Type string Properties Filter, Group, Nillable, Sort Description The ID of the Quip site on which the template is available. | | MetricDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the metric was gathered in your local time zone. | | MetricDateOnly | Type date Properties Filter, Nillable, Sort Description The date that the metric was gathered in UTC. Available in API version 55.0 and later. | | LastUpdatedDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the thread was created, last edited, or last shared in your local time zone. | | LastUpdatedDateOnly | Type date Properties Filter, Nillable, Sort Description The date that the thread was created, last edited, or last shared in UTC. Available in API version 55.0 and later. | | TotalDocumentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of documents created based on the template. | ## 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. [CollabTemplateMetricChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # CollabTemplateMetricRecord Represents an association between a CollabTemplateMetric and a Salesforce record.It tracks which Salesforce record, such as an Account or Contact, is linked to a Quip template for which metrics were gathered using CollabTemplateMetric. CollabTemplateMetricRecord is available in API version 50.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ParentRecord | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Salesforce record. | | QuipDocumentMetric | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the CollabTemplateMetric record. | | MetricDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the metric was gathered in your local time zone. | | MetricDateOnly | Type date Properties Filter, Nillable, Sort Description The date that the metric was gathered in UTC. Available in API version 55.0 and later. | | EntityType | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The object type of the Salesforce record, such as Account or Contact. | # CollabUserEngagementMetric Represents the user engagement metrics for a Quip thread in a Quip template or document. This object is available in API version 50.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CommentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of comments by the user for the specified MetricDate. | | EditCount | Type int Properties Filter, Group, Nillable, Sort Description The number of edits by the user for the specified MetricDate. | | MetricDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the metric was gathered in your local time zone. | | MetricDateOnly | Type date Properties Filter, Nillable, Sort Description The date that the metric was gathered in UTC. Available in API version 55.0 and later. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name of the CollabUserEngagementMetric object. | | QuipThread | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The Quip thread ID. | | QuipThreadTitle | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The title of the Quip document, sheet, slide, and so forth. | | QuipThreadType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of Quip thread. The possible values are: - CHAT - DOCUMENT - SHEET - SLIDE - TEMPLATE | | QuipUser | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the Quip user. | | SalesforceUserId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Salesforce user. | | Site | Type string Properties Filter, Group, Nillable, Sort Description The ID of the Quip site. | | SourceTemplate | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the source template. | | ViewCount | Type int Properties Filter, Group, Nillable, Sort Description The number of views by the user for the specified MetricDate. | # CollabUserEngmtRecordLink Represents an association between a CollabUserEngagementMetric and a Salesforce record. It tracks which Salesforce record, such as an Account or Contact, is associated with the user engagement metric. This object is available in API version 50.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The CollabUserEngmtRecordLink object is now deprecated. You can still access user engagement metrics for metric dates before August 12, 2021. To obtain user engagement metric for dates starting from August 12, 2021, follow the instructions in the [Quip Engagement Metrics documentation](https://help.salesforce.com/articleView?id=xcloud.quip_template_metrics.htm&type=5&language=en_US). ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | MetricDate | Type dateTime Properties Filter, Nillable, Sort Description The date of the gathered metric. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name of the CollabUserEngmtRecordLink object. | | ObjectType | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The object type of the Salesforce record, such as Account or Contact. | | ParentRecordId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Salesforce record. | | UserEngagementMetricId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the [CollabUserEngagementMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collabuserengagementmetric.htm "Represents the user engagement metrics for a Quip thread in a Quip template or document. This object is available in API version 50.0 and later.") record. | # ColorDefinition Represents the color-related metadata for a custom tab. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field Name | Details | | --- | --- | | Color | Type string Properties Filter, Group, Nillable, Sort Description The color described in web color RGB format—for example, “00FF00”. | | Context | Type string Properties Filter, Group, Nillable, Sort Description The color context, which determines whether the color is the main color (or primary) for the tab. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description A unique virtual Salesforce ID for the color. | | TabDefinitionId | Type string Properties Filter, Nillable, Sort Description The TabDefinition ID. This is a relationship field. Relationship Name TabDefinition Relationship Type Lookup Refers To TabDefinition | | Theme | Type string Properties Filter, Group, Nillable, Sort Description The icon’s theme. | # CombinedAttachment This read-only object contains all notes, attachments, Google Docs, documents uploaded to libraries in Salesforce CRM content, and files added to Chatter that are associated with a record. ## Supported Calls describeSObjects() ## Fields | Field Name | Details | | --- | --- | | ContentSize | Type int Properties Filter, Group, Nillable, Sort Description The size of the document in bytes for documents smaller than 2 GB. In API version 66.0 and later, we recommend that you use the ContentSizeLong field even for documents smaller than 2 GB. | | ContentSizeLong | Type long Properties Filter, Group, Nillable, Sort Description The size of the document in bytes up to 10 GB. This field is available in API version 66.0 and later. | | ContentUrl | Type url Properties Filter, Group, Nillable, Sort Description URL for links and Google Docs. This field is set only for links and Google Docs, and is one of the fields that determine the FileType. This field is available in API version 31.0 and later. | | ExternalDataSourceName | Type string Properties Filter, Group, Nillable, Sort Description The name of the external data source in which the document is stored. This field is set only for external documents that are connected to Salesforce. This field is available in API version 32.0 and later. | | ExternalDataSourceType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of external data source in which the document is stored. This field is set only for external documents that are connected to Salesforce. This field is available in API version 35.0 and later. | | FileExtension | Type string Properties Filter, Group, Nillable, Sort Description File extension of the document. This field is available in API version 31.0 and later. | | FileType | Type string Properties Filter, Group, Nillable, Sort Description Type of document, which is determined by the file extension. | | ParentId | Type reference Properties Filter, Group, Sort Description The ID of the parent object. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account, Accreditation, ActivationTarget, ActivationTrgtIntOrgAccess, ApiAnomalyEventStore, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CollaborationGroup, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContentWorkspace, Contract, ConversationEntry, CoverageBenefit, CoverageBenefitItem, CredentialStuffingEventStore, CreditMemo, CreditMemoLine, Dashboard, DashboardComponent, DataStream, DelegatedAccount, DocumentChecklistItem, EmailMessage, EmailTemplate, EngagementChannelType, EnhancedLetterhead, EnrollmentEligibilityCriteria, Event, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Identifier, IdentityDocument, Image, IndividualApplication, Invoice, InvoiceLine, Lead, ListEmail, Location, MarketSegment, MarketSegmentActivation, MemberPlan, MessagingSession, MktCalculatedInsight, OperatingHours, Opportunity, Order, OrderItem, Organization, OtherComponentTask, PartyConsent, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, Product2, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, ProviderSearchSyncLog, PurchaserPlan, PurchaserPlanAssn, ReceivedDocument, Report, ReportAnomalyEventStore, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SessionHijackingEventStore, Shift, Shipment, ShipmentItem, Site, SkillRequirement, SocialPost, Solution, Task, ThreatDetectionFeedback, User, Visit, VisitedParty, Visitor, VoiceCall, VolunteerProject, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup, WorkTypeGroupMember | | RecordType | Type string Properties Filter, Group, Nillable, Sort Description The parent object type. | | SharingOption | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Controls whether sharing is frozen for a file. Only Salesforce admins and file owners with Collaborator access to the file can modify this field. The default is Allowed, which means that new shares are allowed. When set to Restricted, new shares are prevented without affecting existing shares. This field is available in API versions 35.0 and later. | | Title | Type string Properties Filter, Group, Nillable, Sort Description Title of the attached file. | ## Usage Use this object to list all notes, attachments, documents uploaded to libraries in Salesforce CRM content, and files added to Chatter for a record, such as a related list on a detail page. To determine if an object supports the CombinedAttachment object, call describeSObject() on the object. For example, describeSObject('Account') returns all the child relationships of the Account object, including CombinedAttachment. You can then query the CombinedAttachment child relationship. SELECT Name, (SELECT Title FROM CombinedAttachments) FROM Account You can’t directly query CombinedAttachment. # CommerceEntitlementBuyerGroup Represents the entitlement policy for a buyer group. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules The CommerceEntitlementBuyerGroup object is available when you meet these requirements. The B2B Commerce license is enabled. The Commerce Buyer and Entitlements Integrator permission is granted. ## Fields | Field | Details | | --- | --- | | BuyerGroupId | Type reference Properties Create, Filter, Group, Sort Description The unique ID for the buyer group. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The standard code for the currency. Possible values are: - GBP—British Pound - USD—U.S. Dollar | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the entitlement buyer group. | | PolicyId | Type reference Properties Create, Filter, Group, Sort Description The unique ID for the entitlement policy. | ## 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. [CommerceEntitlementBuyerGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # CommerceEntitlementPolicy Represents an entitlement policy, which determines what products and prices a user can see. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The CommerceEntitlementPolicy object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | CanViewPrice | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether a user can view the price of a product (true) or not (false). Default value is false. | | CanViewProduct | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether a user can view the product (true) or not (false). Default value is false. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The standard code for the currency. Possible values are: - GBP—British Pound - USD—U.S. Dollar | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The entitlement policy description. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines if the entitlement policy is active (true) or inactive (false). Default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it can mean that the record was only referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the entitlement policy. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The unique ID for the entitlement policy owner. | ## Associated Objects This object has the following associated objects. Except where noted, these objects are available in the same API version as CommerceEntitlementPolicy. [CommerceEntitlementPolicyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [CommerceEntitlementPolicyOwnerFeed](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. [CommerceEntitlementPolicyHistory](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. [CommerceEntitlementPolicyOwnerSharingRule](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 this object. # CommerceEntitlementPolicyShare Represents the entitlement rule for sharing products and prices with users other than the owner. This object is available in API version 49.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules The CommerceEntitlementPolicyShare object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Possible values are: - All—Owner - Edit—Read/Write - Read—Read Only | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The unique ID of the parent entitlement policy. | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Possible values are: - CompliantCollaboration—Compliant Data Sharing - GuestParentImplicit—Associated guest user sharing - GuestPersonImplicit—Associated Guest User Sharing - GuestRule—Guest User Sharing Rule - ImplicitChild—Account Sharing - ImplicitParent—Associated record owner or sharing - ImplicitPerson—Person Contact - Manual—Manual Sharing - Owner - Rule—Sharing Rule - SurveyShare—Survey Sharing Rule - Team—Sales Team - Territory—Territory Assignment Rule - Territory2AssociationManual—Territory Manual - Territory2Forecast—Territory assignment for forecasting and reporting - TerritoryManual—Territory Manual - TerritoryRule—Territory Sharing Rule | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The unique ID of the associated user or buyer group. | # CommerceEntitlementProduct Represents the entitlement policy for a product. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules The CommerceEntitlementProduct object is available when you meet these requirements. The B2B Commerce license is enabled. The Commerce Buyer and Entitlements Integrator permission is granted. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The standard code for the currency. Possible values are: - GBP—British Pound - USD—U.S. Dollar | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The product entitlement policy name. | | PolicyId | Type reference Properties Create, Filter, Group, Sort Description The unique ID for the product entitlement policy. | | ProductId | Type reference Properties Create, Filter, Group, Sort Description The unique ID for the product referenced in the entitlement policy. | ## 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. [CommerceEntitlementProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # CommissionSchedule Represents a commission calculation and rate definition. Calculates commission values for a commissionable event. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ApplicableObject | Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description The object for which this Commission Schedule calculates commissions. Possible values are: - Contract - InsurancePolicy - Producer - Quote | | CalcProcessInputMapping | Type textarea Properties Create, Nillable, Update Description The input mappings from the object fields to the variables used in the commission calculation. | | CalcProcessOutput | Type textarea Properties Create, Nillable, Update Description The formula applied to this Commission Schedule’s process output that calculates the final commission amount. | | CalcProcessOutputConvNotation | Type textarea Properties Create, Nillable, Update Description An optimized version of the CalcProcessOutput formula that calculates the commission. Not user-editable. | | CalculationProcessName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the Integration Procedure, Calculation Matrix, or Calculation Procedure this Commission Schedule uses for calculations. | | CalculationType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of calculation or process used when this Commission Schedule is used. Possible values are: - Amount - CalculationMatrix - CalculationProcedure - IntegrationProcedure - Rate | | CommissionAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The commission amount for the Commission Schedule when the process type is Amount. | | CommissionRate | Type percent Properties Create, Filter, Nillable, Sort, Update Description The commission percentage for the Commission Schedule when the process type is Rate. | | CommissionStructureType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the commission calculation is Flat or Tiered when the process type is Matrix. Possible values are: - Flat - Tiered The default value is Flat. | | EffectiveEndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The effective end date of the Commission Schedule. | | EffectiveStartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The effective start date of the Commission Schedule. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Commission Schedule is active. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Commission Schedule. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the record owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | TierDefinition | Type textarea Properties Create, Nillable, Update Description Internal-only. Applies when the CalculationType is CalculationMatrix. | ## 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. [CommissionScheduleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object in API version 62.0 and later. [CommissionScheduleFeed](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. [CommissionScheduleHistory](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. [CommissionScheduleOwnerSharingRule](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. [CommissionScheduleShare](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. # CommissionScheduleAssignment Represents the commission calculation applicable to a specific product or producer for one or multiple commissionable events. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CommissionableEventType | Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description The event that results in the commission calculation. Possible values are: - Contracting - Endorsement - Issue Policy - Policy Issuance | | CommissionScheduleId | Type reference Properties Create, Filter, Group, Sort Description The ID of the associated Commission Schedule, which is the commission calculation tied to the product or producer. This is a relationship field. Relationship Name CommissionSchedule Relationship Type Lookup Refers To CommissionSchedule | | EffectiveEndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The last date when the Commission Schedule is in effect for the product or producer. | | EffectiveStartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The first date when the Commission Schedule is in effect for the product or producer. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | MaxCommissionAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The maximum commission calculated for the product or producer for a commissionable event. Constrains the output from the Commission Schedule. | | MaxCommissionRate | Type percent Properties Create, Filter, Nillable, Sort, Update Description The maximum commission rate that a producer receives for a commissionable event. | | MinCommissionAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The minimum commission calculated for the product or producer for a commissionable event. Constrains the output from the Commission Schedule. | | MinCommissionRate | Type percent Properties Create, Filter, Nillable, Sort, Update Description The minimum commission rate that a producer receives for a commissionable event. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the Commission Schedule Assignment. | | ProducerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The producer, broker, brokerage, or other user who receives the commission. This is a relationship field. Relationship Name Producer Relationship Type Lookup Refers To Producer | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product for which commissions are calculated. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | ## 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. [CommissionScheduleAssignmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object in API version 62.0 and later. [CommissionScheduleAssignmentFeed](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. [CommissionScheduleAssignmentHistory](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. [CommissionScheduleAssignmentOwnerSharingRule](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. [CommissionScheduleAssignmentShare](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. # CommSubscription Represents the subscription options for a specific communication. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DataUsePurposeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the data use purpose record associated with the communication subscription. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if this communication subscription is the default (true) or not (false). This field has a default value of false. Only one communication subscription record can be the default. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the communication subscription record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account owner associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CommSubscriptionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. [CommSubscriptionFeed](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. [CommSubscriptionHistory](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. [CommSubscriptionOwnerSharingRule](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. [CommSubscriptionShare](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. # CommSubscriptionChannelType Represents the engagement channel through which you can reach a customer for a communication subscription. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CommunicationSubscriptionId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the associated communication subscription record. This is a relationship field. Relationship Name CommunicationSubscription Relationship Type Lookup Refers To CommSubscription | | EngagementChannelTypeId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the associated engagement channel type record. This is a relationship field. Relationship Name EngagementChannelType Relationship Type Lookup Refers To EngagementChannelType | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | MessagingChannelUsageId | Type reference Properties Filter, Group, Sort Description The ID of the associated Messaging channel usage record, which is in turn associated with a messaging channel. This is a relationship field. Relationship Name MessagingChannelUsage Relationship Type Lookup Refers To MessagingChannelUsage | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the communication subscription channel type record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID account owner associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CommSubscriptionChannelTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. [CommSubscriptionChannelTypeFeed](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. [CommSubscriptionChannelTypeHistory](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. [CommSubscriptionChannelTypeOwnerSharingRule](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. [CommSubscriptionChannelTypeShare](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. # CommSubscriptionConsent Represents a customer’s consent to a communication subscription. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields With certain page layout and field-level security settings, some fields aren't visible or editable. | Field | Details | | --- | --- | | BusinessBrandId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Business Brand that the individual has given consent to for a communication subscription. This is a relationship field. This field is available in API version 53.0 and later. Relationship Name BusinessBrand Relationship Type Lookup Refers To BusinessBrand | | CommSubscriptionChannelTypeId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the associated communication subscription channel type record. This is a relationship field. Relationship Name CommSubscriptionChannelType Relationship Type Lookup Refers To CommSubscriptionChannelType | | ConsentCapturedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Required. Date when the customer’s consent was captured. | | ConsentCapturedSource | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. Source through which consent was captured. For example, user@example.com or www.example.com. | | ConsentGiverId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the person who gave consent to the communication subscription on behalf of the contact point. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If the contact point gave consent, don't use ConsentGiverId. This is a polymorphic relationship field. Relationship Name ConsentGiver Relationship Type Lookup Refers To Account, Contact, Individual, User | | ContactPointId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the contact point, such as an Individual or person account, associated with the communication subscription consent. This is a polymorphic relationship field. Relationship Name ContactPoint Relationship Type Lookup Refers To ContactPointAddress, ContactPointEmail, ContactPointPhone | | ContactPointValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the contact point. | | DataUsePurposeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the record for data use purpose that you want to associate this consent with. This field is available in API version 57.0 and later. This is a relationship field. Relationship Name DataUsePurpose Relationship Type Lookup Refers To DataUsePurpose | | EffectiveFromDate | Type date Properties Create, Filter, Group, Sort, Update Description Required. Date when consent starts. | | EffectiveToDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when consent ends. This field is restricted by field-level security. | | EngagementChannelTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the contact method you want to apply consent to. This field is available in API version 57.0 and later. This is a relationship field. Relationship Name EngagementChannelType Relationship Type Lookup Refers To EngagementChannelType | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the communication subscription consent record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account owner associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PartyId | Type reference Properties Filter, Group, Nillable, Sort Description Represents the record based on the Individual object that you want to associate consent with. This field is available in API version 57.0 and later. This is a relationship field. Relationship Name Party Relationship Type Lookup Refers To Individual | | PartyRoleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Party Role for the individual you want to associate consent with. This is a polymorphic relationship field. This field is available in API version 53.0 and later. Relationship Name PartyRole Relationship Type Lookup Refers To Customer, Seller | | PrivacyConsentStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Identifies whether the individual or person account associated with this record agrees to this form of contact. Possible values are: - NotSeen - OptIn - OptInPending—Available in API version 58.0 and later. - OptOut - OptOutPending—Available in API version 58.0 and later. - Seen The default value is NotSeen. This field is available in API version 57.0 and later. | ## 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. [CommSubscriptionConsentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 49.0) Change events are available for the object. [CommSubscriptionConsentFeed](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. [CommSubscriptionConsentHistory](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. [CommSubscriptionConsentOwnerSharingRule](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. [CommSubscriptionConsentShare](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. # CommSubscriptionTiming Represents a customer's timing preferences for receiving a communication subscription. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CommSubscriptionConsentId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated communication subscription consent record. This is a relationship field. Relationship Name CommSubscriptionConsent Relationship Type Lookup Refers To CommSubscriptionConsent | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Required. Name of the communication subscription timing record. | | Unit | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The unit of time for the communication timing Possible values are: - Day - DayOfWeek - Hour - Month - Week | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CommSubscriptionTimingChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [CommSubscriptionTimingFeed](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. [CommSubscriptionTimingHistory](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. # Community (Zone) Represents a zone that contains Idea or Question objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Starting with the Summer ’13 release, Chatter Answers and Ideas communities were renamed to zones. In API version 28, the API object label has changed to Zone, but the API type is still Community. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CanCreateCase | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether users can ask private questions in the zone using Chatter Answers. | | DataCategoryName | Type string Properties Filter, Nillable, Group, Sort Description The data category associated with the zone. | | Description | Type textarea Properties Filter, Nillable, Sort Description Text description of the zone. | | HasChatterService | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether Chatter Answers is available in the zone. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the zone is active or inactive. An idea or question can only be posted to an active zone. | | IsPublished | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the zone is available in portals. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the zone. | | NetworkId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Experience Cloud site that this zone is associated with. This field is available only if digital experiences is enabled in your org. This field is available in API version 66.0 and later. | ## Usage Use this object to create a zone in Ideas, Chatter Answers, or Answers. Zones help organize ideas and questions into logical groups and are shared by the Ideas, Answers, and Chatter Answers. # ComplaintCase Represents the association between an HR complaint and a case. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CaseId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the Case record associated with this complaint for tracking investigation and resolution activities. This field is a relationship field. Relationship Name Case Refers To Case | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the complaint case record was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the complaint case record was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated unique identifier for the complaint case record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the User or Group who owns this complaint case record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | PublicComplaintId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the PublicComplaint record linked to this case. This field is a relationship field. Relationship Name PublicComplaint Refers To PublicComplaint | ## 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. [ComplaintCaseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ComplaintCaseFeed](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. [ComplaintCaseHistory](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. [ComplaintCaseOwnerSharingRule](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. [ComplaintCaseShare](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. # ComplaintParticipant Represents a participant in an HR complaint case, linking individuals or groups to complaint records with their role and status. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the complaint participant record was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the complaint participant record was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated unique identifier for the complaint participant record. | | ParticipantId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the individual or group participating in the complaint. References an Account, Contact, Group, or User record. This field is a polymorphic relationship field. Relationship Name Participant Refers To Account, Contact, Group, User | | PublicComplaintId | Type reference Properties Create, Filter, Group, Sort Description The ID of the PublicComplaint record to which this participant is linked. This is a master-detail relationship. This field is a relationship field. Relationship Name PublicComplaint Relationship Type Master-detail Refers To PublicComplaint (the master object) | | Role | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The role of the participant in the complaint, such as complainant, respondent, or witness. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The current status of the participant's involvement in the complaint case. | ## 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. [ComplaintParticipantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ComplaintParticipantFeed](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. [ComplaintParticipantHistory](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. [ComplaintParticipantOwnerSharingRule](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. [ComplaintParticipantShare](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. # ComplianceControlScope Represents a mandatory compliance control and the type of business record it applies to, such as a campaign, marketing program, or tactic. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Marketing Planning and Operations must be available to access this object. See [Availability of Marketing Planning and Operations](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | ComplianceControlId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the compliance control that the scope is for. This field is a relationship field. Relationship Name ComplianceControl Refers To ComplianceControl | | DefaultReviewerId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user or user group that's set as the default reviewer of the reviews created for this compliance control scope. This field is a polymorphic relationship field. Relationship Name DefaultReviewer Refers To Group, User | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the compliance control scope is active (true) or not (false). The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate is not null, the user accessed this record or list view indirectly. | | MarketingHierGroupDefId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the marketing hierarchy group definition associated with the compliance control scope. This field is a relationship field. Relationship Name MarketingHierGroupDef Refers To MarketingHierarchyGroupDef | | MarketingHierGrpNdDefId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the marketing hierarchy group node definition associated with the compliance control scope. This field is a relationship field. Relationship Name MarketingHierGrpNdDef Refers To MarketingHierarchyGroupNodeDef | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the compliance control scope. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the compliance control scope record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ScopeTargetReference | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the type of business record that this compliance control scope applies to. Possible values are: - Campaign - MarketingProgram—Marketing Program - Tactic The default value is MarketingProgram. | | TargetRecordTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the record type that represents the business record selected as the scope target reference. This field is a relationship field. Relationship Name TargetRecordType Refers To RecordType | # Composite API Event Type Composite API events contain details about composite API requests. One composite API event is generated for each composite API and composite graph API call. This event type is available in API version 64.0 and later. ## Fields | Field | Details | | --- | --- | | ALL\_OR\_NONE | Type boolean Description Indicates whether the entire request is rolled back when the update of any object fails (true), or if the call should continue with the independent update of other objects in the request (false). The default is false. If true, it overrides the ALL\_OR\_NONE setting in subrequests. | | CLIENT\_IP | Type String Description The IP address of the client that’s using the API. | | CPU\_TIME | Type Number Description The CPU time in milliseconds to complete the request. | | EVENT\_TYPE | Type String Description The type of the event. The value is always CompositeApi. | | FAILURE\_REASON | Type String Description An error code giving the reason for a failed request. | | IS\_REQUEST\_COLLATION\_ON | Type boolean Description The setting for subrequest collation. | | LOGIN\_KEY | Type String Description Identifies all related events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I | | NUM\_GRAPH\_DEPTH | Type Number Description The depth of the graph. When multiple graphs are present, this number is the depth of the deepest graph. | | NUM\_RETRIES | Type Number Description Number of attempted retries while processing the graph. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization that made the request. For example: 00D000000000123 | | REQUEST\_ID | Type String Description A unique ID identifying the composite API request. | | RUN\_TIME | Type Number Description The amount of time in milliseconds to complete the request. | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. For example: 20130715233322.670 | | TIMESTAMP | Type String Description The date and time that the event was generated. | | TIMESTAMP\_DERIVED | Type DateTime Description The date and time, in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ), that the event was generated. The timezone is GMT. For example: 2015-07-27T11:32:59.555Z | | URI | Type String Description The resource URI. | | URI\_ID\_DERIVED | Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. | | USER\_ID | Type Id Description The 15-character ID of the user that’s using the API. For example: 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case insensitive ID of the user that’s using the API. For example: 00590000000I1SNIA0 | #### See Also - [_REST API Developer Guide_: Composite](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/resources_composite_composite.htm) - [_REST API Developer Guide_: Composite Graph](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/resources_composite_graph.htm) - [_REST API Developer Guide_: Using Composite Resources](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_composite_resources.htm) # Composite API Subrequest Event Type Composite API subrequest events contain details about composite API subrequests. One composite API subrequest event is generated for each subrequest or collated set of subrequests. For example, if a composite API request contains five subrequests and four of the subrequests are collated, then two composite API subrequest events are generated. This example also applies to composite graph API. This event type is available in API version 64.0 and later. ## Fields | Field | Details | | --- | --- | | CANCELLED\_REASON | Type String Description If the subrequest was canceled, shows the reason. | | CLIENT\_IP | Type String Description The IP address of the client that’s using the API. | | CPU\_TIME | Type Number Description The CPU time in milliseconds to complete the request. | | DB\_TOTAL\_TIME | Type Number Description Time (in nanoseconds) spent waiting for database processing in aggregate for all operations in the subrequest or set of collated subrequests. Compare this field to CPU\_TIME to determine whether performance issues are occurring in the database layer or in your own code. | | EVENT\_TYPE | Type String Description The type of the event. The value is always CompositeApiSubrequest. | | INITIAL\_REFERENCE\_IDS | Type String Description The original reference IDs of subrequests that were collated into the current subrequest. | | IS\_CANCELLED | Type boolean Description True if the subrequest call was canceled. | | LOGIN\_KEY | Type String Description Identifies all related events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I | | METHOD | Type String Description The HTTP method of the request. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization that made the request. For example: 00D000000000123 | | REQUEST\_ID | Type String Description A unique ID identifying the composite API request. | | REQUEST\_STATUS | Type String Description The status of the subrequest or collated set of subrequests. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RUN\_TIME | Type Number Description The amount of time in milliseconds to complete the request. | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. For example: 20130715233322.670 | | STATUS\_CODE | Type Number Description The HTTP status code for the response. | | SUCCESS | Type boolean Description True if the subrequest call succeeded. | | TIMESTAMP | Type String Description The date and time that the event was generated. | | TIMESTAMP\_DERIVED | Type DateTime Description The date and time, in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ), that the event was generated. The timezone is GMT. For example: 2015-07-27T11:32:59.555Z | | URI | Type String Description The resource URI. | | URI\_ID\_DERIVED | Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. | | USER\_ID | Type Id Description The 15-character ID of the user that’s using the API. For example: 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case insensitive ID of the user that’s using the API. For example: 00590000000I1SNIA0 | | USER\_TYPE | Type String Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and they access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and they access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and they access the application through a customer portal. Users with this license type can view and edit data that they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and they typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and they access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses and admins for this org. | #### See Also - [_REST API Developer Guide_: Composite](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/resources_composite_composite.htm) - [_REST API Developer Guide_: Composite Graph](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/resources_composite_graph.htm) - [_REST API Developer Guide_: Using Composite Resources](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_composite_resources.htm) # Compound Field Considerations and Limitations Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps. ## For Address and Geolocation Compound Fields Both address and geolocation compound fields have the following limitations. - Compound fields are read-only. To update field values, modify the individual field components. - Compound fields are accessible only through SOAP API, REST API, and Apex. The compound versions of fields aren’t accessible anywhere in the Salesforce user interface. - Although compound fields can be queried with the Location and Address Apex classes, they’re editable only as components of the actual field. Read and set geolocation field components by appending “\_\_latitude\_\_s” or “\_\_longitude\_\_s” to the field name, instead of the usual “\_\_c.” For example: Double theLatitude = myObject\_\_c.aLocation\_\_latitude\_\_s; myObject\_\_c.aLocation\_\_longitude\_\_s = theLongitude; You can’t access or set the compound value. - You can’t use compound fields in Visualforce—for example, in an . To access or update field values, use the individual field components. - If you select compound fields for export in the Data Loader, they cause error messages. To export values, use individual field components. - Custom geolocation and location fields on standard addresses aren’t supported with email templates. - You can’t use compound fields in lookup filters, except to filter distances that are within or not within given ranges. You can use distance lookup filters only in the Metadata API. - The only formula functions that you can use with compound fields are ISBLANK, ISCHANGED, and ISNULL. You can’t use BLANKVALUE, CASE, NULLVALUE, PRIORVALUE, or the equality and comparison operators with compound fields. The equality and comparison operators include \= and \== (equal), <> and != (not equal), < (less than), \> (greater than), <= (less than or equal), \>= (greater than or equal), && (AND), and || (OR). ## For Address Compound Fields Address compound fields have the following limitations. - Compound address fields are available only for address fields that exist as part of the standard objects included in Salesforce. - To add custom address fields on standard and custom objects, enable Custom Address Fields. For more information see the [Custom Address Fields Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.caf_dev_guide.meta/caf_dev_guide/caf_dev_guide.htm). - In Developer, Professional, Enterprise, Unlimited, and Performance editions, Salesforce can automatically add or update geolocation fields for Account, Contact, Lead, and WorkOrder records. To use this feature, your administrator must enable the geo data integration rule for each object. For all other objects and editions, set values for latitude and longitude by using [Salesforce CLI](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_intro.htm "HTML (New Window)"), SOAP or REST API, or a geocoding service. You can then use address fields as locatable values. To find geocoding services, search AppExchange. - The accuracy subfield of address fields is populated only when an address is geocoded. Typically, geocoding service providers provide accuracy data for an address’s latitude and longitude coordinates. - Address fields can’t be used in WHERE statements in SOQL. Address fields aren’t filterable, but the isFilterable() method of the DescribeFieldResult Apex class erroneously returns true for address fields. ## For Geolocation Compound Fields Geolocation compound fields have the following limitations. - Geolocation fields aren’t supported in custom settings. - Geolocation fields aren’t available in dashboards or Schema Builder. - Geolocation fields are available in Visual Workflow and in formula-based workflow and approvals, but they can’t be used in filter-based workflow updates and approvals. - DISTANCE formulas are supported in: - Entry criteria for workflow rules and approval processes - Field update actions in workflow rules and approval processes - Custom validation rules - Lookup filters (in the Metadata API only) - Geolocation fields and latitude and longitude on standard addresses aren’t supported in Salesforce to Salesforce. - In Developer, Professional, Enterprise, Unlimited, and Performance editions, Salesforce can automatically add or update geolocation fields for Account, Contact, Lead, and WorkOrder records. To use this feature, your administrator must enable the geo data integration rule for each object. For all other objects and editions, set values for latitude and longitude by using SOQL, SOAP or REST API, or a geocoding service. You can then use address fields as locatable values. To find geocoding services, search AppExchange. - Geolocation fields are supported in SOQL with the following limitations. - DISTANCE and GEOLOCATION are supported in WHERE and ORDER BY clauses in SOQL, but not in GROUP BY. DISTANCE is supported in SELECT clauses. - DISTANCE supports only the logical operators > and <, returning values within (<) or beyond (>) a specified radius. - When using the GEOLOCATION function in SOQL queries, the geolocation field must precede the latitude and longitude coordinates. For example, DISTANCE(warehouse\_location\_\_c, GEOLOCATION(37.775,-122.418), 'km') works but DISTANCE(GEOLOCATION(37.775,-122.418), warehouse\_location\_\_c, 'km') doesn’t work. - Apex bind variables aren’t supported for the units parameter in the DISTANCE function. This query doesn’t work. String units = 'mi'; List accountList = \[SELECT ID, Name, BillingLatitude, BillingLongitude FROM Account WHERE DISTANCE(My\_Location\_Field\_\_c, GEOLOCATION(10,10), :units) < 10\]; For more information and examples, see the [SOQL and SOSL Reference](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/ "HTML (New Window)"). # Compound Fields Compound fields group together multiple elements of primitive data types, such as numbers or strings, to represent complex data types, such as a location or an address. Compound fields are an abstraction that can simplify application code that handles the values, leading to more concise, understandable code. Address compound fields are available in the SOAP and REST APIs in API version 30.0 and later. Geolocation fields are available in the SOAP and REST APIs in API version 26.0 and later, with some limitations on SOAP for API versions below 30.0. Compound fields are accessible as a single, structured field, or as individual component fields. The values contained within the compound field and the values in individual fields both map to the same underlying data stored in Salesforce; they always have identical values. Code that references individual component fields is unaffected by the new compound fields. Compound fields are read-only. Changes are performed by writing to the individual component fields. This maintains a single, consistent method for performing updates, and avoids the possibility of conflicts. For example, if both the BillingAddress compound field and BillingCity individual component field were updated in the same API call, it would be unclear which value should be saved. Compound fields are available only through the SOAP and REST APIs. Compound fields are described in both the Enterprise and Partner WSDLs. Update your WSDL to at least API 30.0 to access the new compound data types. - **[Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm)** Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior. - **[Geolocation Compound Field](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_geolocation.htm)** Geolocation fields are accessible in the SOAP and REST APIs as a Location—a structured compound data type—or as individual latitude and longitude elements. - **[Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm)** Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps. # ConcurApexLimitEventLog Concurrent Apex Limit event logs contain information about long-running concurrent Apex requests in your org that Salesforce terminated after reaching your org’s concurrency limit. Requests with an established Apex context that execute for 5 seconds are counted towards your org’s limit of concurrent long-running requests. (Asynchronous requests don’t count towards the limit.) When the long-running requests exceed the org default limit, additional long-running requests are denied. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | RequestCount | Type int Properties Filter, Group, Nillable, Sort Description Count of requests with an established Apex context executing for longer than 5 seconds in your org. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestLimit | Type double Properties Filter, Nillable, Sort Description Maximum count of requests with an established Apex context that can execute for longer than 5 seconds. When RequestCount reaches this limit, then additional long-running Apex requests are terminated. (Asynchronous requests don’t count towards the limit.) See _Apex Developer Guide_: [Lightning Platform Apex Limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_gov_limits.htm#in_topic_non_transactional_gov_limits_section). For example: 10. | | RequestUri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the long-running Apex request that Salesforce terminated. For example: /apex/ApexClassName. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | # Concurrent Long-Running Apex Limit Event Type Concurrent Long-Running Apex Limit events contain information about long-running concurrent Apex requests in your org that Salesforce terminated after reaching your org’s concurrency limit. Requests with an established Apex context that execute for 5 seconds are counted towards your org’s limit of concurrent long-running requests. (Asynchronous requests don’t count towards the limit.) When the long-running requests exceed the org default limit, all new Apex invocation requests are denied. This event type is available in the EventLogFile object in API version 45.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | EVENT\_TYPE | Type String Description The type of event. The value is always ConcurrentLongRunningApexLimit. | | NUMBER\_REQUESTS | Type Number Description Count of requests with an established Apex context executing for longer than 5 seconds in your org. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. For example: 00D000000000123. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | REQUEST\_URI | Type String Description URI of the long-running Apex request that Salesforce terminated. Example /apex/ApexClassName | | REQUESTS\_LIMIT | Type Number Description Maximum count of requests with an established Apex context that can execute for longer than 5 seconds. When NUMBER\_REQUESTS reaches this limit, then additional long-running Apex requests are terminated. (Asynchronous requests don’t count towards the limit.) See _Apex Developer Guide_: [Lightning Platform Apex Limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_gov_limits.htm#in_topic_non_transactional_gov_limits_section). Example 10 | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | USER\_ID | Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | ## Usage For example, you can monitor Concurrent Long-Running Apex Limit log counts to get a benchmark or plot a count by hour. To identify where the limit was exceeded, see the REQUEST\_URI field. Then, cross-reference this data with [Apex Execution event](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apexexecution.htm "Apex Execution events contain details about Apex classes that are used.") data where the average RUN\_TIME exceeds 5 seconds. To identify synchronous requests only, cross-reference event data with the QUIDDITY field in Apex Execution event data. For example, QUIDDITY NOT IN (A,BA,F,Q,S) and CALLOUT\_TIME (>5000). #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") - [_Salesforce Developers Blog_: Designing Force.com Applications That Avoid Hitting Concurrent Request Limits](https://developer.salesforce.com/blogs/engineering/2013/05/force-com-concurrent-request-limits.html " Salesforce Developers Blog: Designing Force.com Applications That Avoid Hitting Concurrent Request Limits - HTML (New Window)") # ConferenceNumber Holds the telephone number for an external event shown in the Salesforce Today feature in the Salesforce mobile app. This object is available in API version 35.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The Salesforce Today app is available in Salesforce for Android and Salesforce for iOS. It’s not available in the Salesforce desktop site. Access to Today is available only if you grant Calendar permission to the Salesforce mobile app. ## Fields | Field | Details | | --- | --- | | AccessCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the access code to enter in order to validate identity and join the call. | | ExternalEventId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the external event associated with the conference number. This field is a relationship field. Relationship Name ExternalEvent Refers To ExternalEvent | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Returns true if the conference number is locked, or false if it’s not. The default value is false. | | Label | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the conference number. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Indicates whether the conference number can be edited (true) or not (false). The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the conference call’s organizer. | | Number | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number used to connect to the conference call. | | Vendor | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The vendor or company associated with the conference number. | ## 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. [ConferenceNumberChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") # ConnectedApplication Represents a connected app and its details; all fields are read-only. Connected apps link client applications, third-party services, other Salesforce organizations, apps, and resources to your organization. The connected app configuration specifies authorization and security settings for these resources. This object exposes the settings for a specified connected app. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | MobileSessionTimeout | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Length of time after which the system logs out inactive mobile users. | | MobileStartUrl | Type url Properties Filter, Nillable, Sort Description Users are directed to this URL after they’ve authenticated when the app is accessed from a mobile device. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The unique name for this object. | | NamedUserUvidTimeout | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The timeout value for a JSON Web Token (JWT)-based access token that's issued to a named user. This field defines the timeout only if the app is configured to have an app-specific timeout. If the app uses the user's session timeout, the timeout value is defined based on the user's profile or the org session settings. For more information about defining JWT-based access token timeout, see [Configure a Connected App to Issue JWT-Based Access Tokens](https://help.salesforce.com/s/articleView?id=xcloud.jwt_connectedapp_enable.htm&language=en_US). These values are available in API version 59.0 and later. - 1—1 Minute - 5—5 Minutes - 10—10 Minutes - 15—15 Minutes - 30—30 Minutes These values are available in API version 65.0 and later. - 60—1 Hour - 90—90 Minutes - 120—2 Hours - 240—4 Hours - 480—8 Hours - 720—12 Hours This field is available in API version 59.0 and later. | | OptionsAllowAdminApprovedUsersOnly | Type boolean Properties Filter Description Indicates whether access is limited to users granted approval to use the connected app by an administrator. Manage profiles for the app by editing each profile’s Access list. | | OptionsCodeCredentialGuestEnabled | Reserved for future use. | | OptionsFullContentPushNotifications | For internal use only. | | OptionsHasSessionLevelPolicy | Type boolean Properties Filter Description Specifies whether the connected app requires a High Assurance level session. | | OptionsIsInternal | For internal use only. | | OptionsRefreshTokenValidityMetric | Type boolean Properties Filter Description Specifies whether the refresh token validity is based on duration or inactivity. If true, the token validity is measured based on the last use of the token; otherwise, it’s based on the token duration. | | OptionsTokenExchangeManageBitEnabled | Type boolean Properties Filter Description If true, the OAuth 2.0 token exchange flow is enabled. | | PinLength | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description For mobile apps, this field is the PIN length requirement for users of the connected app. Valid values are 4, 5, 6, 7, or 8. | | RefreshTokenValidityPeriod | Type int Properties Filter, Group, Nillable, Sort Description The duration of an authorization token until it expires in hours, months, or days as set in the connected app management page. | | StartUrl | Type url Properties Filter, Nillable, Sort Description If the app isn’t accessed from a mobile device, users are directed to this URL after they’ve authenticated. | | UvidTimeout | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The timeout value for a JWT-based access token that's issued to an unknown user as a result of the guest user variation of the Authorization Code and Credentials Flow. JWT-based access tokens issued during this flow variation always contain a UVID. This field defines the timeout only if the app is configured to have an app-specific timeout. If the app uses the user's session timeout, the timeout value is defined based on the user's profile or the org session settings. For more information about defining JWT-based access token timeout, see [Configure a Connected App to Issue JWT-Based Access Tokens](https://help.salesforce.com/s/articleView?id=xcloud.jwt_connectedapp_enable.htm&language=en_US). These values are available in API version 59.0 and later. - 1—1 Minute - 5—5 Minutes - 10—10 Minutes - 15—15 Minutes - 30—30 Minutes These values are available in API version 65.0 and later. - 60—1 Hour - 90—90 Minutes - 120—2 Hours - 240—4 Hours - 480—8 Hours - 720—12 Hours This field is available in API version 59.0 and later. | # Console Event Type Console events contain information about the performance and use of Salesforce Consoles. The Console events are logged whenever a Console tab is opened with a sidebar component. Outside of that, when Console tabs are opened, a regular view record detail event is served just like in Salesforce Classic. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
COMPONENT_ID
Type
Id
Description
The 15-character ID of the component.
COMPONENT_ID_DERIVED
Type
Id
Description
The 18-character, case-insensitive ID of the component.
CONSOLE_ID
Type
Id
Description
The 15-character ID of the console.
CONSOLE_ID_DERIVED
Type
Id
Description
The 18-character, case-insensitive ID of the console.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
String
Description
The type of event. The value is always Console.
LICENSE_CONTEXT
Type
String
Description
The license context in which a user is using a console.
Example
service, salesandservice, sales
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
RECORD_ID
Type
Id
Description
The 15-character ID of the record that’s associated with the console.
RECORD_ID_DERIVED
Type
Id
Description
The 18-character, case-insensitive ID of the record that’s associated with the console.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Consumption Rate Consumption rates describe the billing rate for a range of usage within a consumption schedule. All consumption schedules require at least one consumption rate in order to rate usage on a usage product. This object is available in API version 45.0 and later. The consumption rate sets a quantity-based boundary for usage and defines how much your product costs when its usage falls within that boundary. Consumption rates price usage at a per-unit fee or a flat fee across the entire range of usage. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ConsumptionScheduleId | Type reference Properties Create, Filter, Group, Sort Description The consumption schedule that contains the consumption rate. This is a relationship field. Relationship Name ConsumptionSchedule Relationship Type Lookup Refers To ConsumptionSchedule | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Possible values are: - AUD—Australian Dollar - CAD—Canadian Dollar - GBP—British Pound - JPY—Japanese Yen - USD—U.S. Dollar | | Description | Type textarea Properties Create, Nillable, Update Description Description of the consumption rate. | | LowerBound | Type int Properties Create, Filter, Group, Sort, Update Description The lowest quantity of usage for the consumption rate. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Required. Default name of this record. Label is **Product Name**. | | Price | Type currency Properties Create, Filter, Sort, Update Description The price for usage that falls within the consumption rate’s bounds. | | PricingMethod | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description How Salesforce applies the consumption rate’s price to the total quantity of usage within a usage summary. Possible values are: - FlatFee—Salesforce applies the rate’s price to the entire quantity of usage. - PerUnit—Salesforce applies the rate’s price to each individual quantity of usage within the usage summary. | | ProcessingOrder | Type int Properties Create, Filter, Group, Sort, Update Description The order for processing the usage rate across multiple rates. Consumption rates are evaluated beginning with the lowest processing order. | | UpperBound | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The highest quantity of usage for the consumption rate. | # Consumption Schedule A consumption schedule organizes a set of consumption rates by which usage-based products are quoted and billed. This object is available in API version 45.0 and later. Salesforce uses consumption schedules to group consumption rates. Your consumption schedule defines the unit of measurement and rating method for the schedule's rates. It also defines the billing frequency that Salesforce Billing uses to invoice a usage product. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BillingTerm | Type int Properties Create, Filter, Group, Sort, Update Description The number used with the billing term unit to determine billing frequency. | | BillingTermUnit | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The unit used with the billing term to determine billing frequency Possible values are: - Month— - Quarter— - Year— | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Possible values are: - AUD—Australian Dollar - CAD—Canadian Dollar - GBP—British Pound - JPY—Japanese Yen - USD—U.S. Dollar | | Description | Type textarea Properties Create, Nillable, Update Description Description of the consumption schedule. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this record is active (true) or not (false). Label is **Active**. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | MatchingAttribute | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce Billing matches usage with a consumption schedule if the records share Matching Attribute value. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Default name of this record. Label is **Product Name**. | | NumberOfRates | Type int Properties Filter, Group, Nillable, Sort Description The number of consumption rates in this consumption schedule. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who owns a consumption schedule record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RatingMethod | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A specific use case to rate usage against the schedule. This field is the controlling picklist for the Type field. Possible values are: - Tier | | SBQQ\_\_Category\_\_c | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description This field is available only with Salesforce CPQ. You can define custom categories to organize consumption schedules in separate tabs on sales rep UI. If you do this, make sure to create a field set for each category. Possible values are: - Rates | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines how rate tiers are calculated. Possible values are: - Range—The schedule prices only using the tier that applies to the usage quantity. - Slab—Usage within a given bound receives pricing equal to its tier’s value. | | UnitOfMeasure | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description A unit of measure defines how you quantify instances of usage for your usage products. For example, if your usage product is a cloud storage subscription, you could provide a value of GB for your unit of measure. | | blng\_\_BillingRule\_\_c | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description This field is available only with Salesforce Billing. Salesforce Billing invoices usage summaries based off their related consumption schedule's billing rule. | | blng\_\_RevenueRecognitionRule\_\_c | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description This field is available only with Salesforce Billing. Salesforce Billing recognizes usage summary revenue based off the summary's related revenue recognition rule. | | blng\_\_TaxRule\_\_c | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description This field is available only with Salesforce Billing. Salesforce Billing taxes usage summary invoice lines based off the summary's related tax rule. | # Contact Represents a contact, which is a person associated with an account. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), merge(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Customer Portal users can access only portal-enabled contacts. ## Fields
Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the account that’s the parent of this contact.

We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours.

This is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
ActionCadenceAssigneeId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the sales rep designated to work the lead through their assigned cadence. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.
ActionCadenceId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the lead’s assigned cadence. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.
ActionCadenceState
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The state of the current action cadence tracker. This field is available in API version 50.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.
Possible values are:
  • Complete
  • Error
  • Initializing
  • Paused
  • Processing
  • Running
ActiveTrackerCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of cadences that are actively running on this contact. This field is available in API version 57.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.
ActivityMetricId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric.
This field is a relationship field.
This field is available in API version 41.0 and later.
Relationship Name
ActivityMetric
Refers To
ActivityMetric
ActivityMetricRollupId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup.
This field is a relationship field.
This field is available in API version 41.0 and later.
Relationship Name
ActivityMetricRollup
Refers To
ActivityMetricRollup
AssistantName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The assistant’s name.
AssistantPhone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The assistant’s phone number. Label is Asst. Phone.
Birthdate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact’s birthdate.
Filter criteria for report filters, list view filters, and SOQL queries ignore the year portion of the Birthdate field. For example, this SOQL query returns contacts with birthdays later in the year than today:
SELECT Name, Birthdate
FROM Contact
WHERE Birthdate > TODAY
BuyerAttributes
Type
multipicklist
Properties
Create, Filter, Nillable, Restricted picklist, Update
Description
If Automatic Contact Enhancements or Buyer Relationship Map is enabled, this field contains the role of the contact in the opportunity or account. Possible values are:
  • BusinessUser—For example, an end user. Key value.
  • Buyer—Key value
  • Champion—Key value
  • DecisionMaker—Shown in green on a contact in the buyer relationship map UI. Key value.
  • Detractor—Shown in red on a contact in the buyer relationship map UI. Key value.
  • Evaluator
  • ExecutiveSponsor—Key value
  • TechnicalExpert
Key values represent key contacts on an opportunity or account. If a buyer relationship map doesn’t have contacts with key values, then Salesforce prompts you to add them. Having all key values represented on the map provides a full view of the deal or account, increasing sales success.
Warning

Warning

To ensure that the buyer relationship map feature works as expected, don't modify field values. For example, if you change Detractor to Detract, the value isn’t shown in red in a buyer relationship map.

This field is available with all profiles except custom and minimum-access. To provide access, use field-level security in Object Manager.
CanAllowPortalSelfReg
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this contact can self-register for your Customer Portal (true) or not (false).
CleanStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates the record’s clean status as compared with Data.com. Values include: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped.

Several values for CleanStatus appear with different labels on the contact record.

  • Matched appears as In Sync
  • Acknowledged appears as Reviewed
  • Pending appears as Not Compared
CommerceCustomerReference
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The external Commerce ID of the individual. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later.
CommerceGroupReference
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The external name of the Commerce customer group. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later.
CommerceOrganizationReference
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The external organization ID of the Commerce instance. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later.
ConnectionReceivedId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce.
ConnectionSentId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.
ContactSource
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
If Automatic Contact Creation is enabled, this field indicates whether the contact was created automatically and identifies the source. Possible values are:
  • Auto Create
  • Email Message
  • Meeting Digest
  • Seller Home
Department
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact’s department.
DepartmentGroup
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
If Automatic Contact Enhancements or Buyer Relationship Map is enabled, this field contains the business unit, function, or department that the contact belongs to in the organization. Possible values are:
  • chiefExecutive—Key value
  • customerSuccess—For example, wealth management, consumer banking, subject matter experts, or healthcare research experts.
  • finance—Includes pricing and procurement. Key value.
  • humanResources
  • legal—Key value
  • marketing
  • other
  • sales
  • support—For example, tech support or customer support.
  • tech—For example, IT or engineering. Key value.
Key values represent key contacts on an opportunity or account. If a buyer relationship map doesn’t have contacts with key values, then Salesforce prompts you to add them. Having all key values represented on the map provides a full view of the deal or account, increasing sales success. This field is available with all profiles except custom and minimum-access. To provide access, use field-level security in Object Manager.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
A description of the contact. Label is Contact Description up to 32 KB.
DoNotCall
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates that the contact doesn’t want to receive calls.
Email
Type
email
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The contact’s email address.
EmailBouncedDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
If bounce management is activated and an email sent to the contact results in a hard bounce, the date and time of the bounce.
Note

Note

Email bounce functionality isn't triggered by record updates, including updates to this field.

EmailBouncedReason
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
If bounce management is activated and an email sent to the contact results in a hard bounce, the reason for the bounce.
Note

Note

Email bounce functionality isn't triggered by record updates, including updates to this field.

Fax
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact’s fax number. Label is Business Fax.
FirstCallDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time of the first call placed to the contact. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.
FirstEmailDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time of the first email sent to the contact. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.
FirstName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact’s first name up to 40 characters.
GenderIdentity
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The contact’s internal experience of their gender, which may or may not correspond to their designated sex at birth.
HasOptedOutOfEmail
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the contact doesn’t want to receive email from Salesforce (true) or does (false). Label is Email Opt Out.
HasOptedOutOfFax
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the contact prohibits receiving faxes.
HomePhone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact’s home phone number. Label is Home Phone.
IndividualId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the data privacy record associated with this contact. This field is available if Data Protection and Privacy is enabled.
This is a relationship field.
Relationship Name
Individual
Relationship Type
Lookup
Refers To
Individual
IsDeleted
Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
IsEmailBounced
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If bounce management is activated and an email is sent to a contact, indicates whether the email results in a soft or hard bounce (true) or not (false).
IsPersonAccount
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Read only. Indicates whether this account has a record type of Person Account (true) or not (false). Label is Is Person Account.
IsPriorityRecord
Type
boolean
Properties
Defaulted on create, Group
Description
Shows whether the user has marked the contact as important (True) or not (False). The default value is false. Available in API version 59.0 and later.
Jigsaw
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References the company’s ID in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account wasn’t imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key.
Important

Important

The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify this value.
JigsawContactId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The ID of the contact in reference to Jigsaw.
Important

Important

The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Don’t modify the value in the Jigsaw field.

LastActivityDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
Value is the most recent of either:
  • Due date of the most recent event logged against the record.
  • Due date of the most recently closed task associated with the record.
LastName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Last name of the contact up to 80 characters.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The 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
The 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.
LeadSource
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The source of the lead that was converted to this contact.
MailingAddress
Type
address
Properties
Filter, Nillable
Description
The compound form of the mailing address. Read-only. For details on compound address fields, see Address Compound Fields.
MailingCity
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Mailing address details.
MailingCountry
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Mailing address details.
MailingCountryCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO codes for the mailing address’s state and country.
MailingGeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update, Query, Restricted picklist, Nillable
Description
Accuracy level of the geocode for the mailing address. For details on geolocation compound field, see Compound Field Considerations and Limitations.
MailingLatitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with MailingLongitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
MailingLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with MailingLatitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
MailingPostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Mailing address details.
MailingState
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Mailing address details.
MailingStateCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO codes for the mailing address’s state and country.
MailingStreet
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Street address for mailing address.
MasterRecordId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
If this record was deleted as the result of a merge, this field contains the ID of the record that remains. If this record was deleted for any other reason, or hasn’t been deleted, the value is null.
This is a relationship field.
Relationship Name
MasterRecord
Relationship Type
Lookup
Refers To
Contact
MiddleName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact’s middle name. Maximum size is 40 characters.
MobilePhone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Contact’s mobile phone number. Label is Mobile Phone.
Name
Type
string
Properties
Filter, Group, Sort
Description
Concatenation of FirstName, MiddleName, LastName, and Suffix up to 203 characters, including whitespaces.
OtherAddress
Type
address
Properties
Filter, Nillable
Description
The compound form of the other address. Read-only. For details on compound address fields, see Address Compound Fields.
OtherCity
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Alternate address details.
OtherCountry
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Alternate address details.
OtherCountryCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO codes for the alternate address’s state and country.
OtherGeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Accuracy level of the geocode for the other address. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
OtherLatitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with OtherLongitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
OtherLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with OtherLatitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
OtherPhone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Phone for alternate address.
OtherPostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Alternate address details.
OtherState
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Alternate address details.
OtherStateCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO codes for the alternate address’s state and country.
OtherStreet
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Street for alternate address.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of the account associated with this contact.
This is a relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
User
Phone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Phone number for the contact. Label is Business Phone.
PhotoUrl
Type
url
Properties
Filter, Group, Nillable, Sort
Description

Path to be combined with the URL of a Salesforce instance (Example: https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the contact. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the contact.

Empty if Social Accounts and Contacts isn't enabled or if Social Accounts and Contacts is disabled for the requesting user.
Pronouns
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The contact’s personal pronouns, reflecting their gender identity. Others can use these pronouns to refer to the contact in the third person. The entry is selected from a picklist of available values, which the administrator sets. Maximum 40 characters.
Possible values are:
  • He/Him
  • He/They
  • Not Listed
  • She/Her
  • She/They
  • They/Them
RecordTypeId
Type
reference
Properties
Create, Filter, Nillable, Update
Description
ID of the record type assigned to this object.
ReportsToId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the contact that this contact reports to.
This is a relationship field.
Relationship Name
ReportsTo
Relationship Type
Lookup
Refers To
Contact
Salutation
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs.
ScheduledResumeDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the action cadence tracker is going to resume after it’s paused or on a wait step. This field is available in API version 54.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.
Suffix
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name suffix of the contact. Maximum size is 40 characters.
Title
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Title of the contact, such as CEO or Vice President.
TitleType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
If Automatic Contact Enhancements or Buyer Relationship Map is enabled, this field contains the hierarchical position that the contact holds in the organization. In the UI, this field is shown as Seniority Level. Possible values are:
  • ceo—Key value
  • directorOrManager—Key value
  • executive—Key value
  • individualContributor
  • vp—VP or Head of Department. Key value.
Key values represent key contacts on an opportunity or account. If a buyer relationship map doesn’t show contacts with key values, then Salesforce prompts you to add them. Having all key values represented on the map provides a complete picture of the deal or account, increasing sales success. This field is available with all profiles except custom and minimum-access. To provide access, use field-level security in Object Manager.
![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When importing contact data, users need the Set Audit Fields upon Record Creation permission to assign values to audit fields such as CreatedDate. Audit fields are automatically updated during API operations unless you set these fields yourself. ## Usage Use this object to manage individual people who are associated with an account. You can create, query, delete, or update any attachment associated with a contact. Create or update contacts by converting a lead with the convertLead() call. ## Associated Objects This object has these 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. [AccountChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [ContactFeed](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.") (API version 18.0) Feed tracking is available for the object. [ContactHistory](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.") (API version 11.0) History is available for tracked fields of the object. [ContactOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactownersharingrule.htm "Represents the rules for sharing a contact with a User other than the owner.") Sharing rules are available for the object. [ContactShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactshare.htm "Represents a list of access levels to a Contact along with an explanation of the access level. For example, if you have access to a record because you own it, the ContactAccessLevel is All and RowCause is Owner.") Sharing is available for the object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # ContactCenterChannel Represents a junction object that relates a Bring Your Own Channel for Contact Center as a Service (CCaaS) messaging channel to a CallCenter object for Bring Your Own Channel for CCaaS. This object also represents the routing details for a voicemail configuration and routing information for callback requests. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, Salesforce Voice with Amazon Connect, Salesforce Voice with Partner Telephony, Salesforce Voice with Partner Telephony from Amazon Connect, or Bring Your Own Channel for Contact Center as a Service (CCaaS) must be enabled. To access this object, you must be a SysAdmin user or have ViewSetup user permissions. ## Fields | Field | Details | | --- | --- | | ChannelId | Type reference Properties Create, Filter, Group, Sort, Update Description For Bring Your Own Channel for CCaaS, this field represents the unique ID of the Bring Your Own Channel messaging channel (MessagingChannel) that’s associated with the contact center (CallCenterId). Available in API version 60.0 and later. This field is a relationship field. Relationship Name Channel Refers To MessagingChannel | | ContactCenterId | Type reference Properties Create, Filter, Group, Sort Description This field is a relationship field. For Bring Your Own Channel for CCaaS, this field represents the unique ID of the contact center (CallCenterId) that’s associated with the Bring Your Own Channel messaging channel (MessagingChannel). Available in API version 60.0 and later. This field is a relationship field. Relationship Name ContactCenter Relationship Type Master-detail Refers To CallCenter (the master object) | | OmniCallbackFallbackQueueId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description If callbacks are configured for the contact center and the contact center uses Omni-Channel Unified Routing, this field represents the unique ID of the fallback queue to use if contact request routing through an Omni-Channel flow fails. Don't change the value in this field. Instead, configure contact request routing in Lightning Experience. Available in API version 65.0 and later. This field is a relationship field. Relationship Name OmniCallbackFallbackQueue Refers To Group | | OmniCallbackHandler | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If callbacks are configured for the contact center and the contact center uses Omni-Channel Unified Routing, this field represents the unique ID of the flow or queue used to route contact requests. Don't change the value in this field. Instead, configure contact request routing in Lightning Experience. Available in API version 65.0 and later. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Available in API version 63.0 only. For internal use. | | VoicemailFallbackQueueId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description If voicemail routing is configured for the contact center, this field represents the unique ID of the fallback queue to use if voicemail routing fails. Don't change the value in this field. Instead, configure voicemail routing in Lightning Experience. This field is a relationship field. Relationship Name VoicemailFallbackQueue Refers To Group | | VoicemailHandler | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If voicemail routing is configured for the contact center, this field represents the unique ID of the flow used to route voicemails. Don't change the value in this field. Instead, configure voicemail routing in Lightning Experience. | # ContactCleanInfo Stores the metadata Data.com Clean uses to determine a contact record’s clean status. Helps you automate the cleaning or related processing of contact records. ContactCleanInfo includes a number of bit vector fields. This object is removed in API version 67.0 ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). Contact Clean Info provides a snapshot of the data in your Salesforce contact record and its matched Data.com record at the time the Salesforce record was cleaned. Contact Clean Info includes a number of bit vector fields, whose component fields each correspond to individual object fields and provide related data or status information about those fields. For example, the bit vector field IsDifferent has an IsDifferentEmail field. If the IsDifferentEmail field’s value is False, that means the Email field value is _the same_ on the Salesforce contact record and its matched Data.com record. ContactCleanInfo bit vector fields include: - CleanedBy indicates who (a user) or what (a Clean job) cleaned the contact record. - IsDifferent indicates whether or not a field on the contact record has a value that differs from the corresponding field on the matched Data.com record. - IsFlaggedWrong indicates whether or not a field on the contact record has a value that is flagged as wrong to Data.com. - IsReviewed indicates whether or not a field on the contact record is in a Reviewed state, which means that the value was reviewed but not accepted. ## Fields | Field Name | Details | | --- | --- | | Address | Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | City | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the contact. | | CleanedByJob | Type boolean Properties Filter Description Indicates whether the contact record was cleaned by a Data.com Clean job (true) or not (false). | | CleanedByUser | Type boolean Properties Filter Description Indicates whether the contact record was cleaned by a Salesforce user (true) or not (false). | | ContactId | Type reference Properties Filter, Group, Sort Description The unique, system-generated ID assigned when the contact record was created. | | ContactStatusDataDotCom | Type picklist Properties Filter, Group, Nillable, Sort Description The status of the contact per Data.com. Values are: Contact is Active per Data.com, Phone is Wrong per Data.com , Email is Wrong per Data.com, Phone and Email are Wrong per Data.com, Contact Not at Company per Data.com, Contact is Inactive per Data.com, Company this contact belongs to is out of business per Data.com, Company this contact belongs to never existed per Data.com or Email address is invalid per Data.com. | | Country | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the contact. | | DataDotComID | Type string Properties Filter, Group, Nillable, Sort Description The ID Data.com maintains for the contact. | | Email | Type email Properties Filter, Group, Nillable, Sort Description The email address for the contact. | | FirstName | Type string Properties Filter, Group, Nillable, Sort Description The contact’s first name. | | IsDifferentCity | Type boolean Properties Filter Description Indicates whether the contact’s City field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCountry | Type boolean Properties Filter Description Indicates whether the contact’s Country field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCountryCode | Type boolean Properties Filter Description Indicates whether the contact’s Country Code field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentEmail | Type boolean Properties Filter Description Indicates whether the contact’s Email field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentFirstName | Type boolean Properties Filter Description Indicates whether the contact’s First Name field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentLastName | Type boolean Properties Filter Description Indicates whether the contact’s Last Name field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentPhone | Type boolean Properties Filter Description Indicates whether the contact’s Phone field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentPostalCode | Type boolean Properties Filter Description Indicates whether the contact’s Postal Code field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentState | Type boolean Properties Filter Description Indicates whether the contact’s State field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentStateCode | Type boolean Properties Filter Description Indicates whether the contact’s State Code field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentStreet | Type boolean Properties Filter Description Indicates whether the contact’s Street field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentTitle | Type boolean Properties Filter Description Indicates whether the contact’s Title field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsFlaggedWrongAddress | Type boolean Properties Filter, Update Description Indicates whether the contact’s Address field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongEmail | Type boolean Properties Filter, Update Description Indicates whether the contact’s Email field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongName | Type boolean Properties Filter, Update Description Indicates whether the contact’s Name field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongPhone | Type boolean Properties Filter, Update Description Indicates whether the contact’s Phone field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongTitle | Type boolean Properties Filter, Update Description Indicates whether the contact’s Title field value is flagged as wrong to Data.com (true) or not (false). | | IsInactive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the contact has been reported to Data.com as Inactive (true) or not (false). | | IsReviewedAddress | Type boolean Properties Filter, Update Description Indicates whether the contact’s Address field value is in a Reviewed state (true) or not (false). | | IsReviewedEmail | Type boolean Properties Filter, Update Description Indicates whether the contact’s Email field value is in a Reviewed state (true) or not (false). | | IsReviewedName | Type boolean Properties Filter, Update Description Indicates whether the contact’s Name field value is in a Reviewed state (true) or not (false). | | IsReviewedPhone | Type boolean Properties Filter, Update Description Indicates whether the contact’s Phone field value is in a Reviewed state (true) or not (false). | | IsReviewedTitle | Type boolean Properties Filter, Update Description Indicates whether the contact’s Title field value is in a Reviewed state (true) or not (false). | | LastMatchedDate | Type dateTime Properties Filter, Sort Description The date the contact record was last matched and linked to a Data.com record. | | LastName | Type string Properties Filter, Group, Nillable, Sort Description The contact’s last name. | | LastStatusChangedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of who or what last changed the record’s Clean Status field value: a Salesforce user or a Clean job. | | LastStatusChangedDate | Type dateTime Properties Filter, Nillable, Sort Description The date on which the record’s Clean Status field value was last changed. | | Latitude | Type double Properties Filter, Nillable, Sort Description Used with Longitude to specify the precise geolocation of a billing address. Data not currently provided. | | Longitude | Type double Properties Filter, Nillable, Sort Description Used with Latitude to specify the precise geolocation of a billing address. Data not currently provided. | | Name | Type string Properties Filter, Group, Sort, Update Description Field label is **Contact Clean Info Name**. The name of the contact. Maximum size is 255 characters. | | Phone | Type phone Properties Filter, Group, Nillable, Sort Description The phone number for the contact. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the contact. | | State | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the contact. | | Street | Type textarea Properties Filter, Group, Nillable, Sort Description Details for the billing address of the contact. | | Title | Type string Properties Filter, Group, Nillable, Sort Description The contact’s title. | ## Usage Developers can create triggers that read the Contact Clean Info fields to help automate the cleaning or related processing of contact records. Create a customized set of Title field values. Use triggers to map values from fields on imported or cleaned records onto a standard set of values. ## 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. [ContactCleanInfoChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # ContactDailyMetric Represents the daily engagement metrics for a contact. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Inbox must be enabled. ## Fields | Field | Details | | --- | --- | | AllCallsCallBackLater | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this contact with the call result Call Back Later. | | AllCallsLeftVoicemail | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this contact with the call result Left Voicemail. | | AllCallsMeaningfulConnect | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this contact with the call result Meaningful Connect. | | AllCallsNotInterested | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this contact with the call result Not Interested. | | AllCallsUncategorized | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this contact with no call result specified. | | AllCallsUnqualified | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this contact with the call result Unqualified. | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total of hard and soft bounced emails for this contact in the day. This is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of successfully delivered emails for this contact in the day. This is a calculated field. | | AllEmailsDeliveredRate | Type percent Properties Filter, Nillable, Sort Description The percentage of tracked emails sent that were successfully delivered to this contact. This field is a calculated field. Available in API version 54.0 and later. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of hard bounced emails for this contact in the day. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that triggered an out of office reply for this contact in the day. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact in the day. This is a calculated field. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails soft bounced for this contact in the day. | | AllEmailsTrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with engagement tracking enabled in the day. | | AllEmailsUntrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact without engagement tracking enabled in the day. | | AllTotalCallsCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of calls to this contact with all call results in the day. This is a calculated field. | | ContactId | Type reference Properties Filter, Group, Sort Description The ID of the related contact. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | DailyCutOffTimeStamp | Type dateTime Properties Filter, Sort Description The time of day when each 24-hour metrics period starts and ends. | | Date | Type date Properties Filter, Group, Sort Description The date on which the engagement occurred. | | DateInt | Type int Properties Filter, Group, idLookup, Sort Description The date on which the engagement occurred, in yyyymmdd format. | | HardBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with hard bounce tracking. Available in API version 54.0 and later. | | InboundEngagementsCount | Type int Properties Filter, Group, Nillable, Sort Description The number of inbound engagements for this contact in the day. This field is a calculated field. The value is the sum of UniqueEmailsOpenedCount, UniqueEmailsRepliedCount, and UniqueEmailsLinkClickedCount. Available in API version 58.0 and later. | | LinkClickTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with link click tracking. Available in API version 54.0 and later. | | OpenTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with open tracking. Available in API version 54.0 and later. | | OutOfOfficeTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with out-of-office tracking. Available in API version 54.0 and later. | | OutboundEngagementsCount | Type int Properties Filter, Group, Nillable, Sort Description The number of outbound engagements for this contact in the day. This field is a calculated field. The value is the sum of AllTotalCallsCount and AllEmailsDeliveredCount. Available in API version 58.0 and later. | | ReplyTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with reply tracking. Available in API version 54.0 and later. | | SoftBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with soft bounce tracking. Available in API version 54.0 and later. | | TrackableSendHardBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with hard bounce tracking that hard bounced. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendLinkClickRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with link tracking that had link clicks. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendOpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with open tracking that were opened by the recipient. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendOutOfOfficeRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with out-of-office tracking that received out-of-office replies. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendReplyRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with reply tracking that received replies. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendSoftBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with soft bounce tracking that soft bounced. This field is a calculated field. Available in API version 54.0 and later. | | UniqueEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails in which the contact clicked a link in the day. | | UniqueEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails opened by the contact in the day. | | UniqueEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails replied to by the contact in the day. | # ContactMonthlyMetric Represents the monthly engagement metrics for a contact. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Inbox must be enabled. ## Fields | Field | Details | | --- | --- | | AllCallsCallBackLater | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this contact with the call result Call Back Later. | | AllCallsLeftVoicemail | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this contact with the call result Left Voicemail. | | AllCallsMeaningfulConnect | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this contact with the call result Meaningful Connect. | | AllCallsNotInterested | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this contact with the call result Not Interested. | | AllCallsUncategorized | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this contact with no call result specified. | | AllCallsUnqualified | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this contact with the call result Unqualified. | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total of hard and soft bounced emails for this contact in the month. This is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of successfully delivered emails for this contact in the month. This is a calculated field. | | AllEmailsDeliveredRate | Type percent Properties Filter, Nillable, Sort Description The percentage of tracked emails sent that were successfully delivered to this contact. Available in API version 54.0 and later. This field is a calculated field. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of hard bounced emails for this contact in the month. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that triggered an out of office reply for this contact in the month. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact in the month. This is a calculated field. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails soft bounced for this contact in the month. | | AllEmailsTrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with engagement tracking enabled in the month. | | AllEmailsUntrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact without engagement tracking enabled in the month. | | AllTotalCallsCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of calls to this contact with all call results in the month. This is a calculated field. | | ContactId | Type reference Properties Filter, Group, Sort Description The ID of the related contact. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | HardBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with hard bounce tracking. Available in API version 54.0 and later. | | LinkClickTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with link click tracking. Available in API version 54.0 and later. | | Month | Type date Properties Filter, Group, Sort Description The month in which the engagement occurred. | | MonthInt | Type int Properties Filter, Group, idLookup, Sort Description The month in which the engagement occurred, in yyyymm format. | | OpenTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with open tracking. Available in API version 54.0 and later. | | OutOfOfficeTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with out-of-office tracking. Available in API version 54.0 and later. | | ReplyTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with reply tracking. Available in API version 54.0 and later. | | SoftBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this contact with soft bounce tracking. Available in API version 54.0 and later. | | TrackableSendHardBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with hard bounce tracking that hard bounced. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendLinkClickRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with link tracking that had link clicks. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendOpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with open tracking that were opened by the recipient. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendOutOfOfficeRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with out-of-office tracking that received out-of-office replies. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendReplyRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with reply tracking that received replies. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendSoftBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this contact with soft bounce tracking that soft bounced. Available in API version 54.0 and later. This field is a calculated field. | | UniqueEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails in which the contact clicked a link in the month. | | UniqueEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails opened by the contact in the month. | | UniqueEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails replied to by the contact in the month. | # ContactOwnerSharingRule Represents the rules for sharing a contact with a User other than the owner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ContactAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group, UserRole, or User for Contacts. The possible values are: - Read - Edit | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. This field is available in API version 24.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. A Contact owned by a User in the source Group triggers the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access. | ## Usage Use this object to manage the sharing rules for contacts. #### See Also - [Contact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm "Represents a contact, which is a person associated with an account.") - [ContactShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactshare.htm "Represents a list of access levels to a Contact along with an explanation of the access level. For example, if you have access to a record because you own it, the ContactAccessLevel is All and RowCause is Owner.") - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") # ContactPointAddress Represents a contact’s billing or shipping address, which is associated with an individual or person account. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActiveFromDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the contact’s address became active. | | ActiveToDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the contact’s address is no longer active. | | Address | Type address Properties Filter, Nillable Description The full address. | | AddressType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the type of address. Possible values are: - Billing - Shipping | | BestTimeToContactEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The latest time to contact the individual. | | BestTimeToContactStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The earliest time to contact the individual. | | BestTimeToContactTimezone | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time zone applied to the best time to contact the individual. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The address city. | | ContactPointPhoneId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the primary phone number associated with this address. This is a relationship field. Relationship Name ContactPointPhone Relationship Type Lookup Refers To ContactPointPhone | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The address country. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a contact’s address is the preferred method of communication (true) or not (false). The default value is false. | | IsPrimary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a contact’s address is their primary address (true) or not (false). The default value is false. | | IsThirdPartyAddress | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the address is associated with a third party (true) or not (false). The default value is false. This field is available in API version 57.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last referenced a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the contact point address record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account’s owner associated with this contact. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the contact’s parent record. Only an individual or account can be a contact’s parent. Because this is a master-detail relationship, users must have Edit access to the parent record to create or modify a Contact Point Address. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Master-detail Refers To Account, Individual | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The address postal code. | | PreferenceRank | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Preference rank when there are multiple contact point addresses. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The address state. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The address street. | | UsageType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specify the usage type of this address. For instance, whether it’s a work address or a home address. Possible values are: - Home - Inactive - Temporary - Work | ## 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. [ContactPointAddressChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ContactPointAddressHistory](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. [ContactPointAddressShare](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. # ContactPointConsent Represents a customer's consent to be contacted via a specific contact point, such as an email address or phone number. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields With certain page layout and field-level security settings, some fields aren't visible or editable. | Field | Details | | --- | --- | | BusinessBrandId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Business Brand that the individual has given consent to for a contact point. This is a relationship field. This field is available in API version 53.0 and later. Relationship Name BusinessBrand Relationship Type Lookup Refers To BusinessBrand | | CaptureContactPointType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Indicates how you captured consent. Possible values are: - Email - MailingAddress - Phone - Social - Web | | CaptureDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Required. Date when consent was captured. | | CaptureSource | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. Indicates how you captured consent. For example, a website or online form. | | ContactPointId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the contact point record through which the customer is consenting to be contacted. This is a polymorphic relationship field. Relationship Name ContactPoint Relationship Type Lookup Refers To ContactPointAddress, ContactPointEmail, ContactPointPhone | | DataUsePurposeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the data use purpose record that you want to associate this consent with. This is a relationship field. Relationship Name DataUsePurpose Relationship Type Lookup Refers To DataUsePurpose | | DoubleConsentCaptureDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date when double opt-in was captured. | | EffectiveFrom | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date when consents starts. | | EffectiveTo | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date when consent ends. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the contact point type consent record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the account owner associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PartyId | Type reference Properties Filter, Group, Nillable, Sort Description The unique ID of the Individual who is providing the consent. Relationship Name Party Relationship Type Lookup Refers To Individual | | PartyRoleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Party Role for the individual you want to associate consent with. This is a polymorphic relationship field. This field is available in API version 53.0 and later. Relationship Name PartyRole Relationship Type Lookup Refers To Customer, Seller | | PrivacyConsentStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. Identifies whether the individual or person account associated with this record agrees to this form of contact. Possible values are: - NotSeen - OptIn - OptInPending—Available in API version 58.0 and later. - OptOut - Seen | ## 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. [ContactPointConsentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ContactPointConsentHistory](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. [ContactPointConsentOwnerSharingRule](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. [ContactPointConsentShare](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. # ContactPointEmail Represents a contact’s email, which is associated with an individual or person account. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActiveFromDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the contact’s email became active. | | ActiveToDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the contact’s email is no longer active. | | BestTimeToContactEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The latest time to contact the individual. | | BestTimeToContactStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The earliest time to contact the individual. | | BestTimeToContactTimezone | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The timezone applied to the best time to contact the individual. | | EmailAddress | Type email Properties Create, Filter, Group, Sort, Update Description Required. The email address of the contact. | | EmailDomain | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The domain of the contact’s email, which is everything after the @ sign. | | EmailLatestBounceDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when an email failed to reach its recipient. | | EmailLatestBounceReasonText | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason why the email didn’t reach its recipient. | | EmailMailBox | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A subset of the contact’s email, which is everything before the @ sign. | | IsPrimary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a contact’s email is their primary email (true) or not (false). | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Required. The name of the contact point email record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account’s owner associated with this contact. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the contact’s parent. Only an individual or account can be a contact’s parent. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account, Individual | | UsageType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specify the usage type of this email. For instance, whether it’s a work email or a temporary email. Possible values are: - Home - Temp - Work | ## 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. [ContactPointConsentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ContactPointEmailHistory](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. [ContactPointEmailOwnerSharingRule](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. [ContactPointEmailShare](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. # ContactPointPhone Represents a contact’s phone number, which is associated with an individual or person account. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActiveFromDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the contact’s phone number became active. | | ActiveToDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the contact’s phone number is no longer active. | | AreaCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The area code of the phone number’s location for the contact. | | BestTimeToContactEndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The latest time to contact the individual. | | BestTimeToContactStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The earliest time to contact the individual. | | BestTimeToContactTimezone | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The timezone applied to the best time to contact the individual. | | ExtensionNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number extension for the contact. | | FormattedInternationalPhoneNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The internationally recognized format for the contact’s phone number. | | FormattedNationalPhoneNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The nationally recognized format for the contact’s phone number. | | IsBusinessPhone | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a contact’s phone number is a business number (true) or not (false). | | IsFaxCapable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a contact’s phone number is a fax number (true) or not (false). | | IsPersonalPhone | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a contact’s phone number is a personal number (true) or not (false). | | IsPrimary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a contact’s phone number is their primary number (true) or not (false). | | IsSmsCapable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a contact’s phone number can receive text messages (true) or not (false). | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Required. The name of the contact point phone record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account’s owner associated with this contact. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the contact’s parent. Only an individual or account can be a contact’s parent. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account, Individual | | PhoneType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of phone number for the contact. Possible values are: - Home - Mobile | | PreferenceRank | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Specify how this phone numbers ranks in terms of preference among the contact’s other phone numbers. | | TelephoneNumber | Type phone Properties Create, Filter, Group, Sort, Update Description Required. The phone number for the contact. | | UsageType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specify the usage type of this number. For instance, whether it’s a work phone or a home phone. Possible values are: - Home - Temp - Work | ## 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. [ContactPointConsentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ContactPointPhoneHistory](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. [ContactPointPhoneOwnerSharingRule](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. [ContactPointPhoneShare](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. # ContactPointTypeConsent Represents consent for a contact point type, such as email or phone. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if Data Protection and Privacy is enabled. ## Fields With certain page layout and field-level security settings, some fields aren't visible or editable. | Field Name | Details | | --- | --- | | BusinessBrandId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Business Brand that the individual has given consent to for a contact point type. this is a relationship field. This field is available in API version 53.0 and later. Relationship Name BusinessBrand Relationship Type Lookup Refers To BusinessBrand | | CaptureContactPointType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Indicates how you captured consent. Possible values are: - Email - MailingAddress - Phone - Social - Web | | CaptureDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Required. Date when consent was captured. | | CaptureSource | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. Indicates how you captured consent. For example, a website or online form. | | ContactPointType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Represents the contact method you want to apply consent to. Possible values are: - Email - MailingAddress - Phone - Social - Web | | DataUsePurposeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the record for data use purpose that you want to associate this consent with. This is a relationship field. Relationship Name DataUsePurpose Relationship Type Lookup Refers To DataUsePurpose | | DoubleConsentCaptureDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date when double opt-in was captured. | | EffectiveFrom | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date when consents starts. | | EffectiveTo | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date when consent ends. | | EngagementChannelType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required if a ContactPointType isn’t selected. Represents the contact method you want to apply consent to. Possible values are: - Billboard - Email - MailingAddress - Phone - SMS - Social - Web This is a relationship field. Relationship Name EngagementChannelType Relationship Type Lookup Refers To EngagementChannelType | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the contact point type consent record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PartyId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. Represents the record based on the Individual object you want to associate consent with. This is a relationship field. Relationship Name Party Relationship Type Lookup Refers To Individual | | PartyRoleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Party Role for the individual you want to associate consent with. This is a polymorphic relationship field. This field is available in API version 53.0 and later. Relationship Name PartyRole Relationship Type Lookup Refers To Customer, Seller | | PrivacyConsentStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. Identify whether the individual associated with this record agrees to this form of contact. Possible values are: - NotSeen - Seen - OptIn - OptInPending—Available in API version 58.0 and later. - OptOut - OptOutPending—Available in API version 58.0 and later. | ## 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. [ContactPointConsentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 47.0) Change events are available for the object. [ContactPointTypeConsentHistory](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. [ContactPointTypeConsentOwnerSharingRule](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. [ContactPointTypeConsentShare](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. # ContactProspectingAgentResearch Represents research done by a prospecting agent on a contact record. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | ContactId | Type reference Properties Filter, Group, Sort Description This field is a relationship field. Relationship Name Contact Relationship Type Master-detail Refers To Contact (the master object) | | IsQualified | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The default value is false. | | Rationale | Type textarea Properties Nillable Description The explanation of why the account was qualified or not. The rationale provides extra context to guide human users in their decision making. | | RelatedResearchId | Type reference Properties Filter, Group, Nillable, Sort Description This field is a polymorphic relationship field. Relationship Name RelatedResearch Refers To AccountPrspAgntRsrch, PrspAgntExtlCoRsrch | | ResearchRunKey | Type string Properties Filter, Group, Nillable, Sort Description The date and time the research was complete. | # ContactRequest Represents a customer’s request for support to get back to them about an issue. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AvailableCallbackAttempts | Type integer Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the number of retries that are possible for a voice callback. Applies to calls routed through Omni-Channel Unified Routing. Valid values are 0 through 5. The default is 0. Available in API version 66.0 and later. | | DelayBetweenCallbackAttempts | Type integer Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the delay between voice callback attempts in minutes. Applies to calls routed through Omni-Channel Unified Routing. Valid values are 0 through 10,080, and the default is 0. Available in API version 66.0 and later. | | IsCallback | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines how a voice call callback is handled after an agent accepts the callback work item. If set to true, when an agent accepts the work item, the Omni-Channel utility doesn’t immediately dial the callback phone number. Instead, the agent can determine how to handle the call. For example, after the agent accepts the work item, they can view the callback details, transfer the call, or contact the end user at another phone number. If the agent makes a call by using click-to-dial, the call appears as a Callback call in the Omni-Channel utility. If set to false, when the agent accepts the work item in the Omni-Channel utility, the contact request is opened. The agent can review callback details. If they call with click-to-dial, the call appears as an Outbound call in the Omni-Channel utility. The default value is false. Available in API version 60.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The contact request number. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the Salesforce record that owns the request. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PreferredChannel | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The channel the customer selected as their preferred method of communication in the contact request flow. For example: - Phone | | PreferredPhone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number the customer provided when requesting help in the contact request flow. | | RequestDescription | Type textarea Properties Create, Nillable, Update Description The description of the customer’s issue that they provided when requesting help in the contact request flow. | | RequestReason | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The reason the customer provided when requesting help in the contact request flow. These values are customizable in Object Manager. The default values are: - Account - Billing - Case - General - Order - Other - Product | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The status of the contact request. For example: - Abandoned - Attempted - Contacted - New For voice callbacks initiated through a callback request, Salesforce doesn’t update the Status field value. It remains set to New. | | WhatId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Salesforce record the contact request is related to, such as an account, case, opportunity, voice call, or work order. This is a polymorphic relationship field. Relationship Name What Relationship Type Lookup Refers To Account, Case, Contact Request, Opportunity, WorkOrder | | WhoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Salesforce contact record the contact request is related to, such as a contact, lead, or user. This is a polymorphic relationship field. Relationship Name Who Relationship Type Lookup Refers To Contact, Lead, User | ## Usage Contact request records are created when a customer fills out an online form. This form is created using a flow that uses the type ContactRequestFlow. There’s a guided setup experience to create this flow on the Customer Contact Requests page in Setup. You then add the flow to an Experience Cloud site using either the Flows component or the Contact Request Button & Flow component. Contact Request works in Experience Cloud sites, whether they require authentication or not. Make sure that your users have the Run Flows permission, including your Guest User profile. Without this permission, members won’t see the button or the form to submit contact requests. By default, all Standard User and System Administrator profiles have access to the object. Make sure that your users profiles, like service agents, have at least read access on the contact request object. You can create queues for contact requests and route them with Omni-Channel. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ContactRequestOwnerSharingRule](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. [ContactRequestShare](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. #### See Also - [_Salesforce Help_: Set Up and Manage Contact Requests](https://help.salesforce.com/articleView?id=contact_request.htm&language=en_US " Salesforce Help: Set Up and Manage Contact Requests - HTML (New Window)") # ContactRequestShare Represents a list of access levels to a ContactRequest with an explanation of the access level. This object is available in API version 45.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to contact requests. The possible values are: - Read - Edit - All (This value is not valid for create() or update() calls.) This value must be set to an access level that is higher than the organization’s default access level for contact requests. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent object, if any. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To ContactRequest | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Possible values are: - Manual—The User or Group has access because a user with “All” access manually shared the ContactRequest with them. - Owner—The User is the owner of the ContactRequest. - Rule—The User or Group has access via a ContactRequest sharing rule. - GuestRule—The User or Group has access via a ContactRequest guest user sharing rule. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the ContactRequest. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object lets you determine which users and groups can view and edit ContactRequest records owned by other users. If you attempt to create a new record that matches an existing record, the create() call updates any modified fields and returns the existing record. #### See Also - [_Salesforce Help_: Set Up and Manage Contact Requests](https://help.salesforce.com/articleView?id=contact_request.htm&language=en_US " Salesforce Help: Set Up and Manage Contact Requests - HTML (New Window)") # ContactShare Represents a list of access levels to a Contact along with an explanation of the access level. For example, if you have access to a record because you own it, the ContactAccessLevel is All and RowCause is Owner. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only users with access to the Contact object can access this object. ## Fields | Field | Details | | --- | --- | | ContactId | Type reference Properties Filter, Group, Sort Description ID of the Contact associated with this sharing entry. This field can't be updated. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | ContactAccessLevel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Level of access that the User or Group has to cases associated with the account Contact. The possible values are: - Read - Edit - All This value is not valid for create or update. This field must be set to an access level that is higher than the organization’s default access level for contacts. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | RowCause | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Rule—The User or Group has access via a Contact sharing rule. - GuestRule—The User or Group has access via a Contact guest user sharing rule. - ImplicitChild—The User or Group has access to the Contact via sharing access on the associated Account. After faster account sharing recalculation is enabled for your org, sharing entries with this value aren’t returned in queries. Instead of storing implicit child shares, record access is determined dynamically. - ImplicitPerson—The User or Group has access to the business contact of a person account via access to the person account itself. - GuestPersonImplicit—The guest user has access to the business contact of a person account via a Contact sharing rule. - PortalImplicit—The Contact is associated with the portal user. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. - ARImplicit—The User, who belongs to a partner or customer account, has access to the Contact via an account relationship data sharing rule. - Manual—The User or Group has access because a User with “All” access manually shared the Contact with them. - Owner—The User is the owner of the Contact. | | UserOrGroupId | Type reference Properties Filter, Group, Sort Description ID of the User or Group that has been given access to the Contact. This field can't be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object allows you to determine which users and groups can view or edit Contact records owned by other users. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note After faster account sharing recalculation is enabled for your org, we no longer store implicit share records between accounts and their child contact records. Sharing entries that have a value of ImplicitChild in the RowCause field aren’t returned when you query this object. Instead, the system dynamically determines whether users can access child contact records when they try to access them. This change speeds up ownership and sharing recalculation for accounts. For more information, see the [Faster Account Sharing Recalculation](https://help.salesforce.com/s/articleView?id=000394638&type=1&language=en_US) knowledge article. #### See Also - [AccountShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm "Represents a sharing entry on an account.") # ContactSuggestionInsight Represents a suggestion for a new contact record. Available in API versions 45.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To add or decline contact suggestions, users need a Sales Cloud Einstein license and edit access on accounts. As of the Spring ’20 release, Pardot and Sales Engagement users no longer have access to this object. ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Sort Description The ID of the related account. | | Address | Type address Properties Filter, Nillable Description The address of the suggested contact. | | City | Type string Properties Filter, Group, Nillable, Sort Description The city of the suggested contact. | | ContactTitle | Type string Properties Filter, Group, Nillable, Sort Description The title of the suggested contact. | | Country | Type string Properties Filter, Group, Nillable, Sort Description The country of the suggested contact. | | CreatedRecordId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the created contact record. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Division | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The division of the suggested contact. | | Email | Type email Properties Filter, Group, Nillable, Sort Description The email address of the suggested contact. | | FirstName | Type string Properties Filter, Group, Nillable, Sort Description The first name of the suggested contact. | | GeocodeAccuracy | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Accuracy level of the geocode for the address. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | LastName | Type string Properties Filter, Group, Sort Description The last name of the suggested contact. | | LastOperationUserId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who last performed a related operation. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Latitude | Type double Properties Filter, Nillable, Sort Description Used in conjunction with Longitude to specify the precise geolocation of an address. | | Longitude | Type double Properties Filter, Nillable, Sort Description Used in conjunction with Latitude to specify the precise geolocation of an address. | | Phone | Type phone Properties Filter, Group, Nillable, Sort Description The phone number of the suggested contact. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort Description The postal code of the suggested contact. | | RationaleLabel | Type string Properties Filter, Group, Nillable, Sort Description The reason why this entry is a suggested contact. | | State | Type string Properties Filter, Group, Nillable, Sort Description The state of the suggested contact. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the suggested contact. Possible values include: - New - Pending - Added - Declined | | Street | Type textarea Properties Filter, Group, Nillable, Sort Description The street of the suggested contact. | ## Usage This object is read-only and isn’t supported in workflows, triggers, process builder, or Visualforce pages. # ContactTag Associates a word or short phrase with a Contact. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage ContactTag stores the relationship between its parent TagDefinition and the Contact being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. # ContCalloutSummaryEventLog Continuation Callout Summary events contain information about all of the asynchronous callouts performed during a transaction, their response status codes, execution times, and URL endpoint destinations. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ContinuationIdentifier | Type string Properties Filter, Group, Nillable, Sort Description A unique ID identifying a sequence of events within a request. | | Duration | Type double Properties Filter, Nillable, Sort Description Total duration of continuation, in milliseconds. | | IsSuccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the continuation was successful or not. | | OriginRequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the request that initiated a callout. | | RequestFormSize | Type string Properties Filter, Group, Nillable, Sort Description Continuation request form size, in bytes. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | ResponseSize | Type string Properties Filter, Group, Nillable, Sort Description The size of the callout response, in bytes. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. | | StatusCode | Type int Properties Filter, Group, Nillable, Sort Description The HTTP status or internal code returned by the remote endpoint. A status code of 200 indicates that the request was successful. Other status code values indicate the type of problem that was encountered. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 20130715233322.670. | | Url | Type string Properties Filter, Group, Nillable, Sort Description The callout endpoint URL. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | VisualforceControllerSize | Type string Properties Filter, Group, Nillable, Sort Description Continuation Visualforce controller size, in bytes. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. | # Content Distribution Event Type Content Distribution events contain information about content distributions and deliveries to users. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
ACTION
Type
String
Description
The action that’s used when a delivery is viewed.
Possible Values
  • VIEW
  • INSERT
  • UPDATE
DELIVERY_ID
Type
Id
Description
The 15-character ID of the content delivery.
DELIVERY_LOCATION
Type
String
Description
The location of the delivery.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ContentDistribution.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
RELATED_ENTITY_ID
Type
Id
Description
The 15-character ID of the record that’s associated with the delivery distribution.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
VERSION_ID
Type
Id
Description
The 15-character ID of the content version.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Content Document Link Event Type Content Document Link events contain sharing information for content documents. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
DOCUMENT_ID
Type
Id
Description
The 15-character ID of the document that’s being shared.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ContentDocumentLink.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
SHARED_WITH_ENTITY_ID
Type
Id
Description
Who the document was shared with.
SHARING_OPERATION
Type
String
Description
The type of sharing operation on the document.
Possible Values
  • INSERT
  • UPDATE
  • DELETE
SHARING_PERMISSION
Type
String
Description
What permissions the document was shared with.
Possible Values
  • V: Viewer
  • C: Collaborator
  • I: Inferred—that is, the sharing permissions were inferred from a relationship between the viewer and document. For example, a document’s owner has a sharing permission to the document itself. Or, a document can be a part of a content collection, and the viewer has sharing permissions to the collection rather than explicit permissions to the document directly.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Content Transfer Event Type Content Transfer events contain information about content transfer events, such as downloads, uploads, and previews. This information includes events performed on files and attachments to records. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
DOCUMENT_ID
Type
Id
Description
The 15-character ID of the document that’s being shared.
DOCUMENT_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the document that’s being shared.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ContentTransfer.
FILE_PREVIEW_TYPE
Type
String
Description
The content type of the file preview.
FILE_TYPE
Type
String
Description
The content type of the file version.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
SIZE_BYTES
Type
Number
Description
The size of the file transfer, in bytes.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
TRANSACTION_TYPE
Type
String
Description
The operation that was performed, including operations on files and attachments to records. For example, you can track operations in the Attachments related list on a case.
Possible Values
  • VersionDownloadAction and VersionDownloadApi represent downloads via the user interface and API respectively.
  • VersionRenditionDownload represents a file preview action.
  • saveVersion represents a file that’s being uploaded.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
VERSION_ID
Type
Id
Description
The 15-character ID of the content version.
VERSION_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the content version.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # ContentAsset Represents a Salesforce file that has been converted to an asset file in a custom app in Lightning Experience. Use asset files for org setup and configuration. Asset files can be packaged and referenced by other components. This object is available in API version 38.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules - Only admin users can edit or delete ContentAssets. - Users with file access can create and query ContentAssets. - It isn’t necessary to create asset files for regular, collaborative use of Salesforce Files. “Assetize” files only when they’re used in setup and configuration situations. - Neither the file (ContentDocument) nor the asset settings record (ContentAssets) can be deleted if the asset file is referenced by another component. - ContentAsset doesn’t support search or most recently used (MRU) lists. - ContentAsset doesn’t support Apex triggers. ## Fields | Field | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the document. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the asset file in the API. ContentAsset.DeveloperName: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | IsVisibleByExternalUsers | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether unauthenticated users can see the asset file. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language for this document. This field defaults to the user's language unless the org is multi-language enabled. Specifies the language of the labels returned. The value must be a valid user locale (language and country), such as de\_DE or en\_GB. For more information on locales, see the Language field on the CategoryNodeLocalization object. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for the asset file. This internal label doesn’t get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. | # ContentBody Represents the body of a file in Salesforce CRM Content or Salesforce Files. This object is available in API version 40.0 and later. ## Supported Calls describeSObjects() ## Special Access Rules Cannot be queried, inserted, updated, or deleted directly. ## Fields | Field | Details | | --- | --- | | Id | Type ID Properties , Filter, Group, idLookup, Sort Description ID of the file body. | ## Usage ContentBody is intended for internal Salesforce use. If you need to access the file content body, please use [ContentVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm "Represents a specific version of a document in Salesforce CRM content or Salesforce Files. This object is available in versions 17.0 and later for Salesforce CRM content documents. This object is available in versions 20.0 and later for Salesforce Files."). # ContentDistribution Represents information about sharing a document externally. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules - Content deliveries must be enabled to query content deliveries. - Users (including users with the “View All Data” permission) can query only the files that they have access to. If the file is managed by a Content Library, the user must have “Deliver Content” enabled in the library permission definition and be a member of the library. If the file isn’t managed by a Content Library, the user must have the “Enable Creation of Content Deliveries for Salesforce Files” permission. - Users can query the DistributionPublicUrl and Password fields only if they are the file owner, if the file is shared with them, or if the RelatedRecordId specifies a record that the users can access. - If the shared document is deleted, the delete cascades to any associated ContentDistribution. The ContentDistribution is still queryable by using the QueryAll verb. - If the shared document is archived, the only fields that users can edit are ExpiryDate and PreferencesExpires. - Customer Portal users can’t access this object. - Guest users of Experience Cloud sites can't access or create this object. - Chatter Free users can’t access this object. ## Fields | Field Name | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the shared document. | | ContentDownloadUrl | Type string Properties Sort, Nillable Description The link for downloading the file. This field is available in API version 40.0 and later. | | ContentVersionId | Type reference Properties Create, Filter, Group, Sort Description ID of the shared document version. This is a relationship field. Relationship Name ContentVersion Relationship Type Lookup Refers To ContentVersion | | DistributionPublicUrl | Type string Properties Nillable, Sort Description URL of the link to the shared document. | | ExpiryDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date when the shared document becomes inaccessible. | | FirstViewDate | Type dateTime Properties Filter, Nillable, Sort Description Date when the shared document is first viewed. | | LastViewDate | Type dateTime Properties Filter, Nillable, Sort Description Date when the shared document was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the content delivery. | | OwnerId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the user who owns the shared document. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | PdfDownloadUrl | Type string Properties Sort, Nillable Description The link for downloading the file as a PDF. This field is available in API version 40.0 and later. | | Password | Type string Properties Group, Nillable, Sort Description A password that allows access to a shared document. | | PreferencesAllowOriginalDownload | Type boolean Properties Create, Filter, Update Description When true, the shared document can be downloaded as the file type that it was uploaded as. When false, download availability depends on whether a preview of the file exists. If a preview exists, the file can’t be downloaded. If a preview doesn’t exist, the file can still be downloaded. If the shared document is a link, it can’t be downloaded. | | PreferencesAllowPDFDownload | Type boolean Properties Create, Filter, Update Description When true, the shared document can be downloaded as a PDF if the original file type is PDF or if a PDF preview has been generated. | | PreferencesAllowViewInBrowser | Type boolean Properties Create, Filter, Update Description When true, a preview of the shared document can be viewed in a Web browser. | | PreferencesExpires | Type boolean Properties Create, Filter, Update Description When true, access to the shared document expires on the date that’s specified by ExpiryDate. | | PreferencesLinkLatestVersion | Type boolean Properties Create, Filter, Update Description When true, users see the most recent version of a shared document. When false, users see the version of the document that’s shared, even if it isn’t the most recent version. | | PreferencesNotifyOnVisit | Type boolean Properties Create, Filter, Update Description When true, the owner of the shared document is emailed the first time that someone views or downloads the shared document. | | PreferencesNotifyRndtnComplete | Type boolean Properties Create, Filter, Update Description When true, the owner of the shared document is emailed when renditions of the shared document that can be previewed in a Web browser are generated. | | PreferencesPasswordRequired | Type boolean Properties Create, Filter, Update Description When true, a password, specified by Password, is required to access the shared document. | | RelatedRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the record, such as an Account, Campaign, or Case, that the shared document is related to. This is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To Account, Campaign, Case, Contact, EmailMessage, Lead, ListEmail, Opportunity | | ViewCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times that the shared document has been viewed. | ## Usage Use this object to create, update, delete, or query information about a document shared externally via a link or via Salesforce CRM Content delivery. The ContentDistribution object supports triggers before and after these operations: insert, update, delete. It supports triggers after undelete. ## Example The VP of Marketing wants file authors to specify whether their files can be shared with external people using content delivery. He also wants some files to have a password. You can add a custom field DeliveryPolicy on the ContentVersion object. Make the custom field a picklist with the values, Allowed, Blocked, and Password required. Add the field to the ContentVersion layout so that the user can set the delivery policy per file. Then, add an insert trigger for the ContentDistribution object to enforce the rules based on the delivery policy set in the file. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The ContentVersionId for ContentDistribution must be unique. This trigger for the ContentDistribution object enforces the delivery policy rules for each file: trigger deliveryPolicy on ContentDistribution (before insert) { for (ContentDistribution cd : trigger.new) { String versionId = DeliveryPolicyHelper.getContentVersionId(cd); ContentVersion version = \[select DeliveryPolicy\_\_c from ContentVersion where Id = :versionId\]; String policy = version.DeliveryPolicy\_\_c; if (policy.equals('Blocked')) { cd.addError('This file is not allowed to be delivered.'); } else if (policy.equals('Password required')){ if (!DeliveryPolicyHelper.requirePassword(cd)) { cd.addError('To deliver this file, set a password.'); } } } } The trigger calls this helper class: public class DeliveryPolicyHelper { public static String getContentVersionId(ContentDistribution cd) { if (cd.ContentVersionId != null) { return cd.ContentVersionId; } else { String versionId = \[select LatestPublishedVersionId from ContentDocument where Id = :cd.ContentDocumentId\].get(0).LatestPublishedVersionId; return versionId; } } public static boolean requirePassword(ContentDistribution cd) { return cd.PreferencesPasswordRequired; } } ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Apex has a per organization limit of 10 concurrent requests that last longer than 5 seconds. A trigger that uploads files can easily hit this limit. # ContentDistributionEventLog Content Distribution events contain information about content distributions and deliveries to users. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, Nillable, Sort Description The action that’s used when a delivery is viewed. | | DeliveryIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the content delivery. | | DeliveryLocation | Type string Properties Filter, Group, Nillable, Sort Description The location of the delivery. | | RelatedObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the record that’s associated with the delivery distribution. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 20130715233322.670. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | VersionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the content version. | # ContentDistributionView Represents information about views of a shared document. This read-only object is available in API version 32.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve(), update() ## Special Access Rules - Content deliveries must be enabled to query content deliveries. - Users (including users with the “View All Data” permission) can query only the files that they have access to. If the file is managed by a Content Library, the user must have “Deliver Content” enabled in the library permission definition and be a member of the library. If the file isn’t managed by a Content Library, the user must have the “Enable Creation of Content Deliveries for Salesforce Files” permission. - ContentDistributionView can be deleted by an admin. - If the shared document is deleted, the delete cascades to any associated ContentDistributionView. The ContentDistributionView is still queryable by using the QueryAll verb. - Customer Portal users can’t access this object. - Chatter Free users can’t access this object. ## Fields | Field Name | Details | | --- | --- | | DistributionId | Type reference Properties Filter, Group, Sort Description ID of the content delivery that the document is part of. This is a relationship field. Relationship Name Distribution Relationship Type Lookup Refers To ContentDistribution | | IsDownload | Type boolean Properties Defaulted on create, Filter, Group, Sort Description true if the shared document is downloaded; false if the shared document is viewed. | | IsInternal | Type boolean Properties Defaulted on create, Filter, Group, Sort Description true if the shared document is viewed by a user in the same organization; false if viewed by an external user. | | ParentViewId | Type reference Properties Filter, Group, Nillable, Sort Description ID of this instance of accessing the shared document. | ## Usage Use this read-only object to query information about users who are accessing shared documents. # ContentDocLinkEventLog Content Document Link events contain sharing information for content documents. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | DocumentIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the document that’s being shared. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | SharedWithObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Who the document was shared with. | | SharingOperation | Type string Properties Filter, Group, Nillable, Sort Description The type of sharing operation on the document. Possible Values - INSERT - UPDATE - DELETE | | SharingPermission | Type string Properties Filter, Group, Nillable, Sort Description What permissions the document was shared with. Possible Values - V: Viewer - C: Collaborator - I: Inferred—that is, the sharing permissions were inferred from a relationship between the viewer and document. For example, a document’s owner has a sharing permission to the document itself. Or, a document can be a part of a content collection, and the viewer has sharing permissions to the collection rather than explicit permissions to the document directly. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | # ContentDocument Represents a document that was uploaded to a library in Salesforce Files or Salesforce CRM content. This object is available in versions 17.0 and later for Salesforce CRM.This object is available in API version 21.0 and later for Salesforce Files. The maximum number of documents that can be published is 30,000,000. Archived files count toward this limit and toward storage usage limits. - Contact Manager, Group, Professional, Enterprise, Unlimited, and Performance Edition customers can publish a maximum of 200,000 new versions per 24-hour period. - Developer Edition and trial users can publish a maximum of 2,500 new versions per 24-hour period. ## Supported Calls delete(), describeLayout()describeSObjects(), query(), retrieve(), search(), undelete(), update() ## Special Access Rules - By default, users (including users with the View All Data permission) can only query files they have access to, including: - Salesforce files in their personal library and in libraries they're a member of, regardless of library permissions (API version 17.0 and later). - Salesforce files they own, shared directly with them, posted on their profile, or posted on groups they can see (API version 21.0 and later). Turn on the Query All Files permission to let your View All Data users bypass the restrictions on querying files. - Query All Files returns all files, including files in non-member libraries and files in unlisted groups. - Users can’t edit, upload new versions, or delete files they don’t have access to. - View All Data permission is required to enable Query All Files. - For API version 62.0 and later, enable the Query Non Vetoed Files permission in Data Cloud orgs to let your integration or API users view and SOQL query only public and non-vetoed files in the org. - Customer and partner portal users must have the View Content in Portal permission to query content in libraries where they have access. - A Salesforce CRM content document can be deleted if any of these statements is true. - The document is published into a personal library or is in the user's upload queue. - The document is published into a public library, the user trying to delete the document is the file owner, and is a member of that library. - The document is published into a public library and the user trying to delete the document isn’t the owner but has the Manage Library or Delete Content library permission enabled. For API version 25.0 and later, you can change ownership of Salesforce Files and Salesforce CRM content documents. - A user can change ownership of a Salesforce CRM content document or Salesforce file if any of these statements is true. - The user is the current owner. - The user has the Modify All Data permission enabled. - For a file in a Content Library, the user either has the Manage Salesforce CRM content permission enabled, or has the Manage Library permission enabled for the library containing the document. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When the owner of a ContentDocument is changed, [ContentDocumentLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm "Represents the link between a Salesforce CRM Content document, Salesforce file, or ContentNote and where it's shared. A file can be shared with other users, groups, records, and Salesforce CRM Content libraries. This object is available in versions 21.0 and later for Salesforce CRM Content documents and Salesforce Files.") may be triggered. This action deletes the ContentDocumentLink to the old owner and inserts one to the new owner. When you change document ownership, keep these considerations in mind. - The user who’s becoming the document owner must be a visible, active user. The original owner can be inactive. - If the new document owner doesn’t have access to the library that contains the document, library administrators must give the new owner membership to the library. ## Fields | Field | Details | | --- | --- | | ArchivedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who archived the document. This field is available in API version 24.0 and later. | | ArchivedDate | Type date Properties Filter, Group, Nillable, Sort Description The date when the document was archived. This field is available in API version 24.0 and later. | | ContentAssetId | Type reference Properties Filter, Group, Nillable, Sort, Update Description If the ContentDocument is an asset file, this field points to the asset. For most entities, the value of this field is null. This field is available in API version 38.0 and later. This is a relationship field. Relationship Name ContentAsset Relationship Type Lookup Refers To ContentAsset | | ContentModifiedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the document was modified. ContentModifiedDate updates when, for example, the document is renamed or a new document version is uploaded. When you’re uploading the first version of a document, ContentModifiedDate can be set to the current time or anytime in the past. This field is available in API version 32.0 and later. | | ContentSize | Type int Properties Filter, Group, Nillable, Sort Description The size of the document in bytes for documents smaller than 2 GB. This field is available in API version 31.0 and later. In API version 65.0 and later, we recommend that you use the ContentSizeLong field even for files smaller than 2 GB. | | ContentSizeLong | Type long Properties Filter, Group, Nillable, Sort Description The size of the document in bytes up to 10 GB. This field is available in API version 65.0 and later. | | Description | Type textarea Properties Filter, Nillable, Sort, Update Description A description of the document. This field is available in API version 31.0 and later. | | Division | Type picklist Properties Defaulted on Create, Filter, Group, Restricted picklist, Sort Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled. | | FileExtension | Type string Properties Filter, Group, Nillable, Sort Description File extension of the document. This field is available in API version 31.0 and later. | | FileType | Type string Properties Filter, Group, Nillable, Sort Description Type of document, determined by the file extension. This field is available in API version 31.0 and later. | | IsArchived | Type boolean Properties Defaulted on Create, Filter, Group, Sort, Update Description Indicates whether the document was archived (true) or not (false). | | IsInternalOnly | Type boolean Properties Defaulted on Create, Filter, Group, Sort, Update Description Indicates that a file is for internal use only. When true, prevents users with the Query Non Vetoed Files permission from viewing and performing SOQL query on public and non vetoed files in a Data Cloud org. Default value is false. This field is available in API version 62.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | LatestPublishedVersionId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the latest document version (ContentVersion). This is a relationship field. Relationship Name LatestPublishedVersion Relationship Type Lookup Refers To ContentVersion | | MalwareScanDate | Type dateTime Properties Filter, Group, Nillable, Sort Description The date the document was scanned for malware. This field is available in API version 66.0 and later. | | MalwareScanStatus | Type picklist Properties Filter, Group, Sort Description Indicates whether the document was scanned for malware and whether it’s safe or malicious. This field is available in API version 66.0 and later. - NotScanned—The file hasn’t yet been scanned for malware. This is the default value. - Scheduled—The file scan is in progress. - Clean—The file was scanned and doesn’t contain malware. - Malicious—The file was scanned and contains malware. - Skipped—The file can’t be scanned because it’s either larger than 100 MB or it’s a Salesforce-generated file, such as a Content Note. - Failed—The file wasn’t scanned because of an error. | | OwnerId | Type reference Properties Filter, Group, Sort, Update Description ID of the owner of this document. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | ParentId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the library that owns the document. Created automatically when inserting a ContentVersion via the API for the first time. This field is available in API version 24.0 and later when Salesforce CRM content is enabled. | | PublishStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Indicates if and how the document is published. Valid values are: - P—The document is published to a public library and is visible to other users. Label is **Public**. - R—The document is published to a personal library and is not visible to other users. Label is **Personal Library**. - U—The document is not published because publishing was interrupted. Label is **Upload Interrupted**. | | SharingOption | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Controls whether sharing is frozen for a file. Only administrators and file owners with Collaborator access to the file can modify this field. Default is Allowed, which means that new shares are allowed. When set to Restricted, new shares are prevented without affecting existing shares. This field is available in API versions 35.0 and later. | | SharingPrivacy | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Controls sharing privacy for a file. Only administrators and file owners with Collaborator access to the file can modify this field. Valid values are: - N—Default. Label is **Visible to Anyone With Record Access** - P—The file is private on records but can be shared selectively with others. Label is **Private on Records**. This field is available in API versions 41.0 and later. | | Title | Type string Properties Filter, Group, idLookup, Sort, Update Description The title of a document. | ## Usage - Use this object to retrieve, query, update, and delete the latest version of a document in a library or a Salesforce file. Use the ContentVersion object to create, query, retrieve, search, edit, and update a specific version of a Salesforce CRM content document or Salesforce file. - A document record is a container for multiple version records. You create a version to add a document to the system. The new version contains the actual file data which allows the document to have multiple versions. The version stores the body of the uploaded document. - To create a document, create version via the ContentVersion object without setting the ContentDocumentId. This process automatically creates a parent document record. When adding a new version of the document, you must specify an existing ContentDocumentId which initiates the revision process for the document. When the latest version is published, the title, owner, and publish status fields are updated in the document. - You can’t add new versions of archived documents. - When you delete a document, all versions of that document are deleted, including ratings, comments, and tags. - A ContentDocument insert trigger executes when a file (ContentDocument) is added to the file library. - A ContentDocument delete trigger executes when a file is deleted, but the cascaded ContentDocumentLink delete does not trigger ContentDocumentLink triggers. - The query() call doesn’t return archived documents. The queryAll() call returns archived documents. - To query a file that is accessible only through a record share, you must specify the content ID of the file. When SOQL querying the ContentDocument object, the ContentDocumentId must be compounded by an AND operator. For example, SELECT Id, Title FROM ContentDocument WHERE (Id = '' and Title LIKE '%%' SELECT Id, Title, MyCustomField\_c FROM ContentDocument WHERE (Id IN ('<Id1>', '<Id2>')) AND (Title LIKE '%<title1>%' OR (Title LIKE '%<title2>%') - If you query versions in the API, versions with a PublishStatus of Upload Interrupted are not returned. - Assign topics to ContentDocument using TopicAssignment in API version 37.0 or later. ## Associated Objects This object has the following associated objects. Unless noted, associated objects are available in the same API version as this object. [ContentDocumentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. [ContentDocumentFeed](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.") (API version 20.0) Feed tracking is available for the object. [ContentDocumentHistory](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. #### See Also - [ContentDocumentHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocumenthistory.htm "Represents the history of a document. This object is available in versions 17.0 and later.") - [ContentVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm "Represents a specific version of a document in Salesforce CRM content or Salesforce Files. This object is available in versions 17.0 and later for Salesforce CRM content documents. This object is available in versions 20.0 and later for Salesforce Files.") <!-- document id=93953437d338b40c4f8a615f18e08a8833b1337e8eebcbac884ba4f04461332a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentdocumenthistory.md --> # ContentDocumentHistory Represents the history of a document. This object is available in versions 17.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules - Customer and Partner Portal users must have the “View Content in Portal” permission to query content in libraries where they have access. - A user can query all versions of a document from their personal library and any version that is part of or shared with a library where they are a member, regardless of library permissions. ## Fields | Field | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Sort Description ID of the document. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Division | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled. | | Field | Type picklist Properties Filter, Group, Sort, Restricted picklist Description The name of the field that was changed. Possible values include: - contentDocPublished—The document is published into a library. - contentDocUnpublished—The document is archived or removed from a library, either directly or when the owning library is changed. - contentDocRepublished—The document is removed from the archive. - contentDocFeatured—The document is featured. - contentDocSubscribed—The document is subscribed to. - contentDocUnsubscribed—The document is no longer subscribed to. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed. | ## Usage Use this read-only object to query the history of a document. #### See Also - [ContentDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm "Represents a document that was uploaded to a library in Salesforce Files or Salesforce CRM content. This object is available in versions 17.0 and later for Salesforce CRM.This object is available in API version 21.0 and later for Salesforce Files.") <!-- document id=53e26a2bd6abd31e67b6501c9c9c6ee5acae15e0ef04cfc1d8425a37826c67e9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentdocumentlink.md --> # ContentDocumentLink Represents the link between a Salesforce CRM Content document, Salesforce file, or ContentNote and where it's shared. A file can be shared with other users, groups, records, and Salesforce CRM Content libraries. This object is available in versions 21.0 and later for Salesforce CRM Content documents and Salesforce Files. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules - In API versions 59.0 and later, turn on the Query All Files permission to query without a filter on id, LinkedEntityId, and documentID fields. The View All Data permission is required to turn on Query All Files. - In API versions 33.0 and later, you can create and delete ContentDocumentLink objects with a LinkedEntityId of any record type that can be tracked in the feed, even if feed tracking is disabled for that record type. - In API versions 25.0 and later, you can create ContentDocumentLink objects with a LinkEntityId of type User, CollaborationGroup, or Organization. - In API versions 21.0 and later, users with explicit Viewer access (the file has been directly shared with the user) to a file can delete ContentDocumentLink objects between the file and other users who have Viewer access. In the same API versions, any user with Viewer access to a file can delete ContentDocumentLink objects between the file and organizations or groups of which they’re a member. - For orgs with Digital Experiences enabled, a document can be shared with only users and groups that are a part of the Experience Cloud site the file was created in. ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d481504e126">Field</th> <th class="featureTableHeader " id="d481504e129">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d481504e126" data-title="Field"><span class="keyword parmname" id="ContentDocumentIDField"><a name="ContentDocumentIDField"><!-- --></a>ContentDocumentId</span></td> <td class="entry" headers="d481504e129" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">ID of the document.</dd> <dd class="dd">This is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">ContentDocument</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">ContentDocument</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d481504e126" data-title="Field"><span class="keyword parmname" id="LinkEntityIdField"><a name="LinkEntityIdField"><!-- --></a>LinkedEntityId</span></td> <td class="entry" headers="d481504e129" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">ID of the linked object. Can include Chatter users, groups, records (any that support Chatter feed tracking including custom objects), and Salesforce CRM Content libraries.</dd> <dd class="dd">Using the API only, you can relate notes to custom settings.</dd> <dd class="dd">This is a polymorphic relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">LinkedEntity</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Account, Accreditation, ActivationTarget, ActivationTrgtIntOrgAccess, ApiAnomalyEventStore, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CollaborationGroup, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContentWorkspace, Contract, ConversationEntry, CoverageBenefit, CoverageBenefitItem, CredentialStuffingEventStore, CreditMemo, CreditMemoLine, Dashboard, DashboardComponent, DataStream, DelegatedAccount, DocumentChecklistItem, EmailMessage, EmailTemplate, EngagementChannelType, EnhancedLetterhead, EnrollmentEligibilityCriteria, Event, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Identifier, Image, IndividualApplication, Invoice, InvoiceLine, Lead, ListEmail, Location, MarketSegment, MarketSegmentActivation, MemberPlan, MessagingSession, MktCalculatedInsight, OperatingHours, Opportunity, Order, OrderItem, Organization, OtherComponentTask, OutgoingEmail, PartyConsent, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, Product2, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, ProviderSearchSyncLog, PurchaserPlan, PurchaserPlanAssn, ReceivedDocument, Report, ReportAnomalyEventStore, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SessionHijackingEventStore, Shift, Shipment, ShipmentItem, Site, SkillRequirement, SocialPost, Solution, Task, ThreatDetectionFeedback, Topic, User, Visit, VisitedParty, Visitor, VoiceCall, VolunteerProject, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup, WorkTypeGroupMember</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d481504e126" data-title="Field"><span class="keyword parmname">ShareType</span></td> <td class="entry" headers="d481504e129" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Restricted picklist, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Required. The permission granted to the user of the shared file in a library. This is determined by the permission the user already has in the library. This field is available in API version 25.0 and later.<dl class="dl detailList"> <dt class="dt dlterm"><samp class="codeph nolang">V</samp></dt> <dd class="dd">Viewer permission. The user can explicitly view but not edit the shared file.</dd> <dt class="dt dlterm"><samp class="codeph nolang">C</samp></dt> <dd class="dd">Collaborator permission. The user can explicitly view and edit the shared file. You can retrieve the ShareType for ContentDocumentLink, but you can't create a ContentDocumentLink with a <span class="keyword parmname">ShareType</span> of <samp class="codeph nolang">C</samp> from an Apex trigger. </dd> <dt class="dt dlterm"><samp class="codeph nolang">I</samp></dt> <dd class="dd">Inferred permission. The user’s permission is determined by the related record. For shares with a library, this is defined by the permissions the user has in that library. <p class="p">Inferred permission on shares with libraries and file owners is available in API versions 21.0 and later. Inferred permission on shares with standard objects is available in API versions 36.0 and later. Inferred permission can’t be used on shares with the Organization object.</p> </dd> </dl> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d481504e126" data-title="Field"><span class="keyword parmname">Visibility</span></td> <td class="entry" headers="d481504e129" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Specifies whether this file is available to all users, internal users, or shared users. This field is available in API version 26.0 and later.<p class="p">Valid values are:</p> <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">AllUsers</samp>—The file is available to all users who have permission to see the file. </li> <li class="li"> <samp class="codeph nolang">InternalUsers</samp>—The file is available only to internal users who have permission to see the file. </li> <li class="li"> <samp class="codeph nolang">SharedUsers</samp>—The file is available to all users who can see the feed to which the file is posted. SharedUsers is used only for files shared with users, and is available only when an org has private org-wide sharing on by default. The <samp class="codeph nolang">SharedUsers</samp> value is available in API version 32.0 and later. </li> </ul> <p class="p">Note the following exceptions for <span class="keyword parmname">Visibility</span>.</p> <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">AllUsers</samp> & <samp class="codeph nolang">InternalUsers</samp> values apply to files posted on standard and custom object records, but not to users, groups, or content libraries. </li> <li class="li">For posts to a record feed, <span class="keyword parmname">Visibility</span> is set to <samp class="codeph nolang">InternalUsers</samp> for all internal users by default. </li> <li class="li">External users can set <span class="keyword parmname">Visibility</span> only to <samp class="codeph nolang">AllUsers</samp>.</li> <li class="li">On user and group posts, only internal users can set <span class="keyword parmname">Visibility</span> to <samp class="codeph nolang">InternalUsers</samp>. </li> <li class="li">For posts to a user feed, if the organization-wide default for user sharing is set to private, <span class="keyword parmname">Visibility</span> is set to <samp class="codeph nolang">SharedUsers</samp>. </li> <li class="li">Only internal users can update Visibility.</li> <li class="li">Visibility can be updated on links to files posted on standard and custom object records, but not to users, groups, or content libraries.</li> <li class="li">Visibility is updatable in API version 43.0 and later.</li> </ul> </dd> </dl> <p class="p">The visibility setting on ContentDocumentLink determines a file’s visibility on a record post. When a file has multiple references posted in a feed, the file’s visibility is determined by the most visible setting.</p> </td> </tr> </tbody> </table> ## Usage Use this object to query the locations where a file is shared or query which files are linked to a particular location. For example, the following query returns a particular document shared with a Chatter group: SELECT ContentDocument.title FROM ContentDocumentLink WHERE ContentDocumentId = '069D00000000so2' AND LinkedEntityId = '0D5000000089123' - You can't run a query without filters against ContentDocumentLink. - You can't filter on ContentDocument fields if you're filtering by ContentDocumentId. You can only filter on ContentDocument fields if you're filtering by LinkedEntityId. - You can't filter on the related object fields. For example, you can't filter on the properties of the account to which a file is linked. You can filter on the properties of the file, such as the title field. A SOQL query must filter on one of Id, ContentDocumentId, or LinkedEntityId. The ContentDocumentLink object supports triggers before and after these operations: insert, update, delete. A ContentDocumentLink trigger executes whenever there is an addition or deletion of the ContentDocumentLink. When a file is deleted, a ContentDocument delete trigger executes, but the cascaded ContentDocumentLink delete does not trigger ContentDocumentLink triggers. ## Example This trigger for the ContentDocumentLink object prevents public XLSX files from being shared. trigger NoShareXLSX on ContentDocumentLink (after insert) { for (ContentDocumentLink cdl : trigger.new) { if (!CDLHelper.isSharingAllowed(cdl)) { cdl.addError('Sorry, you cannot share this file.'); } } } The trigger calls this helper class. public class CDLHelper { /\*\* \* Gets FileExtension of the inserted content. \*/ public static String getFileExtension(ContentDocumentLink cdl) { String fileExtension; String docId = cdl.ContentDocumentId; FileExtension = \[select FileExtension from ContentVersion where ContentDocumentId = :docId\].get(0).FileExtension; return FileExtension; } /\*\* \* Checks the file's PublishStatus and FileExtension to decide whether user can share the file with others. \* PublishStatus 'P' means the document is in a public library. \*/ public static boolean isSharingAllowed(ContentDocumentLink cdl) { String docId = cdl.ContentDocumentId; ContentVersion version = \[select PublishStatus,FileExtension from ContentVersion where ContentDocumentId = :docId\].get(0); if (version.PublishStatus.equals('P') && (version.FileExtension != null && version.FileExtension.equals('xlsx'))) { return false; } return true; } /\*\* \* Gets the parent account name if the file is linked to an account. \*/ public static String getAccountName(ContentDocumentLink cdl) { String name; String id = cdl.LinkedEntityId; if (id.substring(0,3) == '001') { name = \[select Name from Account where Id = :id\].get(0).Name; } return name; } } ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Apex has a per organization limit of 10 concurrent requests that last longer than 5 seconds. A trigger that uploads files, like bulk ContentVersion creation, can easily hit the SOQL queries limit. ## Associated Objects This object has the following associated objects. Unless noted, associated objects are available in the same API version as this object. [ContentDocumentLinkChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. #### See Also - [ContentDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm "Represents a document that was uploaded to a library in Salesforce Files or Salesforce CRM content. This object is available in versions 17.0 and later for Salesforce CRM.This object is available in API version 21.0 and later for Salesforce Files.") <!-- document id=cab05c27bc14bbf2508b48cdd41dedc36e628b72d876983aa126569775825790 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentdocumentlistviewmapping.md --> # ContentDocumentListViewMapping Represents an association between a ListView and a Quip ContentDocument. Applies to Quip file types only. Maintains the mapping between a list view and Quip document when the list view is exported to a newly created Quip document. This object is available in API version 44.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To use this object, the Files Connect and Quip permissions must be enabled in the org. To insert and update this object through the API, the QuipMassAction gater permission must also be enabled. ## Fields | Field | Details | | --- | --- | | ContentDocumentId | Type reference Properties Create, Filter, Group, Sort Description ID of the document. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this document. | | ListViewId | Type reference Properties Create, Filter, Group, Sort Description ID of the list view associated with the document. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the document. | ## Usage ContentDocumentListViewMapping is used primarily by the Quip list view integration feature. Only Quip file types (Quip sheets and docs) are supported. The ContentDocumentId field must point to a Quip file. <!-- document id=2ca13aba2b1569b4115fcd19c4078d9b6d999d28ac5c06ff70859e9569c939d0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentdocumentsubscription.md --> # ContentDocumentSubscription Represents a subscription for a user following or commenting on a file in a library. This object is available in API version 42.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Only users with Modify All Data permission have access to this object. ## Fields | Field | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Sort Description ID of the file. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | IsCommentSub | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the user made comments on the file. | | IsDocumentSub | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the user follows the file. | | UserId | Type reference Properties Filter, Group, Sort Description ID of the user following or commenting on the file. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | <!-- document id=7b6fcc764676a82c90cc55b4a4ef778e146e6f04325cb3ed5889f544263f11e6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentfolder.md --> # ContentFolder Represents a folder in a content library for adding files. This object is available in API version 34.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules - Salesforce CRM Content or Chatter must be enabled to access ContentFolder. - All users with a content feature license can modify folders in their personal library. - To modify a folder, the user must be a member of the library and have permission to modify folders. ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the folder. | | ParentContentFolderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the ParentFolder. This is a relationship field. Relationship Name ParentContentFolder Relationship Type Lookup Refers To ContentFolder | ## 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. [ContentFolderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. <!-- document id=31dfd0b852dd1e88f48636fce11f354f129be46e5d44ec9acd13164dd8e04175 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentfolderitem.md --> # ContentFolderItem Represents a file (ContentDocument) or folder (ContentFolder) that resides in a ContentFolder in a ContentWorkspace. This object is available in API version 35.0 and later. ## Supported Calls describeSObjects(), describeLayout(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ContentSize | Type int Properties Filter, Group, Nillable, Sort Description The size of the file or folder in bytes, when the size is smaller than 2 GB. In API version 66.0 and later, we recommend that you use the ContentSizeLong field even for files smaller than 2 GB. | | ContentSizeLong | Type long Properties Filter, Group, Nillable, Sort Description The size of the file or folder in bytes up to 10 GB. This field is available in API version 66.0 and later. | | FileExtension | Type string Properties Filter, Group, Nillable, Sort Description Specifies the file extension if the ContentFolderItem is a file. | | FileType | Type string Properties Filter, Group, Nillable, Sort Description Specifies the type of file if the ContentFolderItem is a file. | | IsFolder | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the ContentFolderItem is a folder, and not a file. | | ParentContentFolderId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the ContentFolder that the ContentFolderItem resides in. This is a relationship field. Relationship Name ParentContentFolder Relationship Type Lookup Refers To ContentFolder | | Title | Type string Properties Filter, Group, Sort Description The name of the file or folder. | <!-- document id=5cbeb9d18fbb278956637cd7019a5c50f2fb300b65f11e162cc48a46528fc0d1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentfolderlink.md --> # ContentFolderLink Defines the association between a library and its root folder. This object is available in API version 34.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules - Salesforce CRM Content must be enabled to access ContentFolderLink. - ContentFolderLink is read-only in the context of a library. ## Fields | Field Name | Details | | --- | --- | | ContentFolderId | Type reference Properties Filter, Group, Sort Description ID of the folder. This is a relationship field. Relationship Name ContentFolder Relationship Type Lookup Refers To ContentFolder | | EnableFolderStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the status of enabling folders for the library. Valid values are: - C — Completed folder enablement - S — Started folder enablement - F — Failed folder enablement This field is available in API version 39.0 and later. | | ParentEntityId | Type reference Properties Filter, Group, Sort Description Name of the entity the folder hierarchy is linked to. | <!-- document id=2a1203bd520bb150de7464b3baaf1fb1b5a88c5150f8858182e38bd536c33660 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentfoldermember.md --> # ContentFolderMember Defines the association between a file and a folder. This object is available in API version 34.0 and later. ## Supported Calls describeSObjects(), delete(), query(), retrieve(), update() ## Special Access Rules - Salesforce CRM Content or Chatter must be enabled to access ContentFolderMember. - All users with a content feature license can modify folders in their personal library. - To modify ContentFolderMember, the user must be a member of the library and have permission to modify folders. ## Fields | Field Name | Details | | --- | --- | | ChildRecordId | Type reference Properties Filter, Group, Sort Description ID of the file. This is a relationship field. Relationship Name ChildRecord Relationship Type Lookup Refers To ContentDocument | | ParentContentFolderId | Type reference Properties Filter, Group, Sort, Update Description ID of the folder the file is in. This is a relationship field. Relationship Name ParentContentFolder Relationship Type Lookup Refers To ContentFolder | <!-- document id=af953d7d746b0c9ad0fc8d16a8402cbeba7564b07fdbb9be84ca577c593450e7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contenthubitem.md --> # ContentHubItem Represents a file or folder in a Files Connect external data source, such as Microsoft SharePoint or OneDrive for Business. This object is available in API version 33.0 and later. ## Special Access Rules Chatter and Files Connect must be enabled for the organization. ## Supported Calls describeSObjects(), query(), search() ## Fields | Field Name | Details | | --- | --- | | ContentHubRepositoryId | Type reference Properties Filter, Group, Nillable Description The ID for the related external data source described by the [ContentHubRepository](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenthubrepository.htm "Represents a Files Connect external data source such as Microsoft SharePoint or OneDrive for Business. This object is available in API version 33.0 and later.") object. | | ContentItemSize | Type long Properties Group, Nillable Description The size of the file or folder. Available in API version 65.0 and later. | | ContentModifiedDate | Type dateTime Properties Nillable Description Date the file or folder content last changed. | | ContentSize | Type int Properties Group, Nillable Description The size of the file or folder that's less than 2 GB. | | Description | Type string Properties Filter, Group, Nillable Description Explanation of item in external data source. | | ExternalContentUrl | Type url Properties Group, Nillable Description The URL of the document content in the external data source. | | ExternalDocumentUrl | Type url Properties Group, Nillable Description The URL of the detail page in the external data source. | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description ID for the file or folder in the external data source. | | FileExtension | Type string Properties Group, Nillable Description File format extension, such as .doc or .pdf | | FileType | Type string Properties Group, Nillable Description Complete file type, such as “Microsoft Word Document.” | | IsFolder | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether item is a folder or file. | | MimeType | Type string Properties Filter, Group, Nillable Description MIME type of the content. | | Name | Type string Properties Filter, Nillable, Sort Description Name of the file or folder in the external data source. | | Owner | Type string Properties Filter, Group, Nillable Description Username of the content owner in the external data source. | | ParentId | Type string Properties Filter, Group, Nillable Description The ID of the parent folder for the record. This field isn’t returned in queries or searches of the ContentHubItem object. It supports only WHERE clauses, such as the following: WHERE ContentHubRepositoryId = <ID of external source> and ParentId = <ID of parent folder or record>. Or specify WHERE ParentId = <name of root folder> to return the children of the root folder. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip The ParentId field supports both Salesforce IDs (in the format “0CHxxx”) and external IDs. | | Title | Type string Properties Group, Nillable Description The title that appears in the content, which often differs from the Name of the containing file or folder. | | UpdatedBy | Type string Properties Group, Nillable Description Username for the person who last updated the file. | ## Usage The following SOQL query examples show how to retrieve files and folders from a Files Connect external data source. These examples use placeholders for ID values for the repository ID and folder IDs. Before running these queries, replace the placeholders with valid ID values for your external data source and folders. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important You must filter queries and searches on ContentHubItem with the ContentHubRepositoryId field; for example, SELECT Id FROM ContentHubItem WHERE ContentHubRepositoryId = <ID of external data source>. **Example 1:** Get the ID and name of the root folder in an external file source. SELECT Id, Name FROM ContentHubItem WHERE ContentHubRepositoryId = '<repository ID>' AND ParentId = NULL **Example 2:** List all folders and files under the specified root folder. SELECT Id, Name FROM ContentHubItem WHERE ContentHubRepositoryId = '<repository ID>' AND ParentId = '<root folder ID>' **Example 3:** List all external file data sources by querying ContentHubRepository. SELECT DeveloperName FROM ContentHubRepository **Example 4:** List all files and folders in a given folder and external file source. SELECT Id, Name FROM ContentHubItem WHERE ContentHubRepositoryId = '<repository ID>' AND ParentId = '<parent folder ID>' **Example 5:** To return only folders in the result set, add IsFolder = true in the WHERE clause to a query that returns files and folders. For example, the following query lists all folders under the root folder. SELECT Id, Name FROM ContentHubItem WHERE ContentHubRepositoryId = '<repository ID>' AND ParentId = '<root folder ID>' AND IsFolder = true **Example 6:** Retrieve a link that is used to open the specified document in an external source. SELECT ExternalDocumentUrl FROM ContentHubItem WHERE ContentHubRepositoryId = '<repository ID>' AND Id = '<document ID>' **SOSL Example:** Retrieve the ID and name of all documents that contain the search string. The result set is limited to the first 10 documents. FIND {<search string>} RETURNING ContentHubItem(Id, Name WHERE ContentHubRepositoryId = '<repository ID>') LIMIT 10 <!-- document id=b6a0f56ec0f38cde56287dd120cd3d174e349607c57db867f6a4d68093f7e10f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contenthubrepository.md --> # ContentHubRepository Represents a Files Connect external data source such as Microsoft SharePoint or OneDrive for Business. This object is available in API version 33.0 and later. ## Special Access Rules Chatter and Files Connect must be enabled for the organization. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Master label for the external data source. This display value is the internal label and does not get translated. | | Type | Type string Properties Filter, Group, Nillable, Sort Description The data source type. Possible values are: - contenthubGoogleDrive - contenthubOffice365 - contenthubOneDrive - contenthubSharepoint - contenthubBox - contenthubQuip | <!-- document id=f5c12f29bc38530fa7401a89a70615292a2a77c7d87249b5e7f8b4855946da9c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentnote.md --> # ContentNote Represents a note created with the enhanced note-taking tool, released in Winter ’16. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update() ## Special Access Rules - Notes must be enabled. ## Fields | Field | Details | | --- | --- | | Content | Type base64 Properties Create, Nillable, Update Description The content or body of the note, which can include properly formatted HTML or plain text. When a document is uploaded or downloaded via the API, it must be base64 encoded (for upload) or decoded (for download). Any special characters within plain text in the Content field must be escaped. You can escape special characters by calling content.escapeHtml4(). If the input contains unsafe HTML characters or new lines, we automatically strip them out before saving the content. | | ContentModifiedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the document was modified. ContentModifiedDate updates when, for example, the document is renamed or a new document version is uploaded. This field is available in API version 48.0 and later. | | ContentSize | Type int Properties Filter, Group, Nillable, Sort Description The size of the note in bytes for notes smaller than 2 GB. In API version 66.0 and later, use the ContentSizeLong field. | | ContentSizeLong | Type long Properties Filter, Group, Nillable, Sort Description The size of the note in bytes, up to 10 GB. This field is available in API version 66.0 and later. | | FileExtension | Type string Properties Filter, Group, Nillable, Sort Description File extension of the note. | | FileType | Type string Properties Filter, Group, Nillable, Sort Description Type of file for the note. All notes have a file type of SNOTE. | | IsReadOnly | Type boolean Properties Defaulted on create, Group, Sort Description Indicates whether the note is read only. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the note was last viewed. This field is available in API version 35.0 and later. | | LatestContentId | Type reference Properties Filter, Group, Nillable, Sort Description Lookup to the note's ContentBody. This field is available in API version 52.0 and later. This is a relationship field. Relationship Name LatestContent Relationship Type Lookup Refers To ContentBody | | LatestPublishedVersionId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the ContentVersion for the latest published version of the note. | | OwnerId | Type reference Properties Create (for users assigned the Set Audit Fields Upon Creation permission), Defaulted on create, Filter, Group, Sort, Update (for users assigned the Set Audit Fields Upon Creation permission) Description ID of the owner of the note. | | SharingPrivacy | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Controls sharing privacy for a file. Only Salesforce admins and file owners with Collaborator access to the file can modify this field. Default is Visible to Anyone With Record Access. When set to Private on Records, the file is private on records but can be shared selectively with others. This field is available in API versions 41.0 and later. | | TextPreview | Type string Properties Filter, Group, Nillable, Sort Description A preview of the note’s content. This field is available in API version 35.0 and later. | | Title | Type string Properties Create, Filter, Group, idLookup, Namefield, Sort, Update Description Title of the note. | ## Usage - Use ContentNote to create, query, retrieve, search, edit, and update notes. - ContentNote is built on ContentVersion, and so it has many of the same usages. - Not all fields can be set for notes. Only the Content and Title fields can be updated. - The maximum file size that you can upload via the SOAP API is 50 MB. When a document is uploaded or downloaded via the API, it’s converted to base64. This conversion increases the document size by approximately 37%. Account for the base64 conversion increase so that the file you plan to upload is less than 50 MB after conversion. - You can convert old Note records to Lightning Experience, so users can view and edit notes from the Notes & Attachments related list in Lightning Experience. Users can edit their converted notes, which are accessible from the Notes related list and Notes tab. Copy old Note records to newly created ContentNote records. Users assigned the Set Audit Fields Upon Creation permission can set the owner, created date, and last modified date on ContentNote records. - SOQL and SOSL queries on the ContentNote return only the most recent version of the note. - To relate a note to a record, use [ContentDocumentLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm "Represents the link between a Salesforce CRM Content document, Salesforce file, or ContentNote and where it's shared. A file can be shared with other users, groups, records, and Salesforce CRM Content libraries. This object is available in versions 21.0 and later for Salesforce CRM Content documents and Salesforce Files."). Review the LinkedEntityID field in [ContentDocumentLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm "Represents the link between a Salesforce CRM Content document, Salesforce file, or ContentNote and where it's shared. A file can be shared with other users, groups, records, and Salesforce CRM Content libraries. This object is available in versions 21.0 and later for Salesforce CRM Content documents and Salesforce Files.") for a list of objects that notes can relate to. For example, the following Apex code creates a note and escapes any special characters so they’re converted to their HTML equivalents. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Apex code doesn’t need to be encoded to base64 before it’s uploaded and downloaded. ContentNote cn = new ContentNote(); cn.Title = 'test1'; String body = 'Hello World. Before insert/update, escape special characters such as ", ', &, and other standard escape characters.'; cn.Content = Blob.valueOf(body.escapeHTML4()); insert(cn); In this example, the following code creates a note using text that is already formatted as HTML, so it doesn’t need to be escaped. ContentNote cn = new ContentNote(); cn.Title = 'test2'; String body = '<b>Hello World. Because this text is already formatted as HTML, it does not need to be escaped. Special characters such as ", etc. must already use their HTML equivalents.</b>'; cn.Content = body; insert(cn); <!-- document id=91363c31ad6c3c4de3e20ffe2b70b54c94678547894ccd7166325dad3ba3fe1d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentnotification.md --> # ContentNotification Represents a notification for a file. This object is available in API version 42.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Only users with Modify All Data permission have access to this object. ## Fields | Field | Details | | --- | --- | | EntityIdentifierId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the object with the notification. | | EntityType | Type string Properties Filter, Group, Nillable, Sort Description Type of object with the notification. One of the following. - ContentDocument - ContentTagName - ContentVersion - ContentWorkspace - ContentWorkspacePermission - User | | Nature | Type string Properties Filter, Group, Nillable, Sort Description Type of notification. | | Subject | Type textarea Properties Filter, Nillable, Sort Description Subject of the notification. | | Text | Type textarea Properties Filter, Nillable, Sort Description Text of the notification. | | UsersId | Type reference Properties Filter, Group, Sort Description ID of the user who received the notification. This is a relationship field. Relationship Name Users Relationship Type Lookup Refers To User | <!-- document id=df5f4e65062cb4ef02f4d5d8c13ecccd16a6ac15e6107ab27305c54b9e3e76e5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contenttagsubscription.md --> # ContentTagSubscription Represents a subscription for a user following a tag on a file. This object is available in API version 42.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Only users with Modify All Data permission have access to this object. ## Fields | Field | Details | | --- | --- | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user following the tag on the file. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | <!-- document id=6cc7da51d38289724f2b6a725160d4148a850941229900d7b1fe34c54e2be315 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contenttaxonomy.md --> # ContentTaxonomy Represents a content taxonomy, which is used to classify and organize Salesforce CMS content. To create a hierarchy of terms in a content taxonomy, use this object in addition to the ContentTaxonomyTerm, ContentTaxonomyRelatedTerm, and ContentTaxonomyTermRelatedTerm objects. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To view this object, users need the permission View Content Taxonomy enabled. To edit this object, users need View Content Taxonomy and Manage Content Taxonomy enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the content taxonomy. This description appears in the API and in the Content Taxonomy tab in the Digital Experiences App. The maximum length is 255 characters. | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The combined language and locale ISO code. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the content taxonomy. | #### See Also - [ContentTaxonomyRelatedTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomyrelatedterm.htm "Represents the relationship between a term and the content taxonomy to which the term belongs. This object is available in API version 63.0 and later.") - [ContentTaxonomyTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomyterm.htm "Represents a term in a content taxonomy. Terms describe what content is or how it's used, and they’re organized in parent-child relationships in the taxonomy hierarchy. This object is available in API version 63.0 and later.") - [ContentTaxonomyTermRelatedTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomytermrelatedterm.htm "Represents the relationship between two terms in a content taxonomy. This object is available in API version 63.0 and later.") - [ContentTaxonomyTermRelationshipType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomytermrelationshiptype.htm "Represents the type of relationship between two terms in a content taxonomy. This object is available in API version 63.0 and later.") <!-- document id=d0536269ad22b68ed22fdd55059b38e9734cf4e8e367fd546fefa378cbf9c10d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contenttaxonomyrelatedterm.md --> # ContentTaxonomyRelatedTerm Represents the relationship between a term and the content taxonomy to which the term belongs. This object is available in API version 63.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules To view this object, users need the permission View Content Taxonomy enabled. To edit this object, users need View Content Taxonomy and Manage Content Taxonomy enabled. ## Fields | Field | Details | | --- | --- | | ContentTaxonomyId | Type reference Properties Create, Filter, Group, Sort Description The ID of the content taxonomy to which the term belongs. This field is a relationship field. Relationship Name ContentTaxonomy Relationship Type Lookup Refers To ContentTaxonomy object | | ContentTaxonomyTermId | Type reference Properties Create, Filter, Group, Sort Description The ID of the term that belongs to the content taxonomy. This field is a relationship field. Relationship Name ContentTaxonomyTerm Relationship Type Lookup Refers To ContentTaxonomyTerm object | ## Usage To include a term in a taxonomy, you must use this object in addition to the ContentTaxonomyTerm and ContentTaxonomy objects. #### See Also - [ContentTaxonomy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomy.htm "Represents a content taxonomy, which is used to classify and organize Salesforce CMS content. To create a hierarchy of terms in a content taxonomy, use this object in addition to the ContentTaxonomyTerm, ContentTaxonomyRelatedTerm, and ContentTaxonomyTermRelatedTerm objects. This object is available in API version 63.0 and later.") - [ContentTaxonomyTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomyterm.htm "Represents a term in a content taxonomy. Terms describe what content is or how it's used, and they’re organized in parent-child relationships in the taxonomy hierarchy. This object is available in API version 63.0 and later.") <!-- document id=da56a5e650ac63a228fcff4eb95e64dff30db049b04d1cefd0625ae4afd29264 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contenttaxonomyterm.md --> # ContentTaxonomyTerm Represents a term in a content taxonomy. Terms describe what content is or how it's used, and they’re organized in parent-child relationships in the taxonomy hierarchy. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To view this object, users need the permission View Content Taxonomy enabled. To edit this object, users need View Content Taxonomy and Manage Content Taxonomy enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the content taxonomy term. This description appears in the API and in the Content Taxonomy tab in the Digital Experiences App. The maximum length is 255 characters. | | DeveloperName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique name of the content taxonomy term in the API. This field is unique within your organization. The name: - must be 80 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can't include spaces - can't end with an underscore - can't contain 2 consecutive underscores | | ExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The external ID of the content taxonomy term. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the content taxonomy term. The name must be between 2 and 255 characters long. | ## Usage To include a term in a taxonomy, you must also use the objects ContentTaxonomyRelatedTerm and ContentTaxonomy. If you create only a ContentTaxonomyTerm, then the term isn’t considered part of the taxonomy, and isn't visible. To relate this term to another term in your taxonomy, use the object ContentTaxonomyTermRelatedTerm. #### See Also - [ContentTaxonomy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomy.htm "Represents a content taxonomy, which is used to classify and organize Salesforce CMS content. To create a hierarchy of terms in a content taxonomy, use this object in addition to the ContentTaxonomyTerm, ContentTaxonomyRelatedTerm, and ContentTaxonomyTermRelatedTerm objects. This object is available in API version 63.0 and later.") - [ContentTaxonomyRelatedTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomyrelatedterm.htm "Represents the relationship between a term and the content taxonomy to which the term belongs. This object is available in API version 63.0 and later.") - [ContentTaxonomyTermRelatedTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomytermrelatedterm.htm "Represents the relationship between two terms in a content taxonomy. This object is available in API version 63.0 and later.") <!-- document id=dbf0e915971dfaff058042a66c0da763eaa047edf042e01e35a0c30247c20b58 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contenttaxonomytermrelatedterm.md --> # ContentTaxonomyTermRelatedTerm Represents the relationship between two terms in a content taxonomy. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules To view this object, users need the permission View Content Taxonomy enabled. To edit this object, users need View Content Taxonomy and Manage Content Taxonomy enabled. ## Fields | Field | Details | | --- | --- | | ContentTaxonomyId | Type reference Properties Create, Filter, Group, Sort Description The ID of the content taxonomy to which the term belongs. This field is a relationship field. Relationship Name ContentTaxonomy Relationship Type Lookup Refers To ContentTaxonomy object | | ContentTaxonomyTermId | Type reference Properties Create, Filter, Group, Sort Description The ID of the primary term that has a relationship with another term. This field is a relationship field. Relationship Name ContentTaxonomyTerm Relationship Type Lookup Refers To ContentTaxonomyTerm object | | ContentTaxonomyTrmRelaTypeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the type of relationship between the two taxonomy terms. This field is a relationship field. Relationship Name ContentTaxonomyTrmRelaType Relationship Type Lookup Refers To ContentTaxonomyTermRelationshipType object | | RelatedContentTaxonomyTermId | Type reference Properties Create, Filter, Group, Sort Description The ID of the term that is related to the primary term. This field is a relationship field. Relationship Name RelatedContentTaxonomyTerm Relationship Type Lookup Refers To ContentTaxonomyTerm object | ## Usage To relate a term to another term in a content taxonomy, use this object in addition to the ContentTaxonomyTerm object. This object can’t be updated. You can only create and delete it. #### See Also - [ContentTaxonomyTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomyterm.htm "Represents a term in a content taxonomy. Terms describe what content is or how it's used, and they’re organized in parent-child relationships in the taxonomy hierarchy. This object is available in API version 63.0 and later.") <!-- document id=7124d8c7b137acadfa8ff17b1a7ca281f91db377d780d4e1d9ded04604aede77 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contenttaxonomytermrelationshiptype.md --> # ContentTaxonomyTermRelationshipType Represents the type of relationship between two terms in a content taxonomy. This object is available in API version 63.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To view this object, users need the permission View Content Taxonomy enabled. ## Fields | Field | Details | | --- | --- | | ContentTaxonomyTrmRelaCatg | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Category of the relationship type. Possible values are: - HasBroader | | Description | Type textarea Properties Filter, Group, Nillable, Sort Description Description of the relationship type. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Name of the relationship type. | ## Usage ContentTaxonomyRelationshipType can’t be created, updated, or deleted. In API version 63.0, the default category for the relationship type is HasBroader. <!-- document id=dee6d13bdc145f93133aeca44bd1212c799fc84a89144d1429e02cade5dddc40 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contenttransfereventlog.md --> # ContentTransferEventLog ContentTransferEventLog stores information about content transfer events, such as downloads, uploads, and previews. This information includes events performed on files and attachments to records. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | DocumentIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the document that’s being shared. | | FilePreviewType | Type string Properties Filter, Group, Nillable, Sort Description The content type of the file preview. | | FileSize | Type double Properties Filter, Nillable, Sort Description The size of rendition being added (bytes). | | FileType | Type string Properties Filter, Group, Nillable, Sort Description The content type of the file version. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The operation that’s being performed. Possible Values - meta\_deploy - meta\_list - meta\_retrieve - meta\_synchronous\_create - meta\_synchronous\_read - meta\_synchronous\_upsert | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 18-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943YAS | | VersionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the content version. | <!-- document id=cada7fb138b88f911dc5a330e3cba32ccfeb4801b89b25ba85aaff327ec90894 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentusersubscription.md --> # ContentUserSubscription Represents a subscription for a user following another user. This object is available in API version 42.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Only users with Modify All Data permission have access to this object. ## Fields | Field | Details | | --- | --- | | SubscribedToUserId | Type reference Properties Filter, Group, Sort Description ID of the user who is followed by another user. This is a relationship field. Relationship Name SubscribedToUser Relationship Type Lookup Refers To User | | SubscriberUserId | Type reference Properties Filter, Group, Sort Description ID of the user who follows another user. This is a relationship field. Relationship Name SubscriberUser Relationship Type Lookup Refers To User | <!-- document id=dd907f9ac8c2bc534ea22d8c7b0fe4676c554f6154ff06e60bef61c515beb561 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentversion.md --> # ContentVersion Represents a specific version of a document in Salesforce CRM content or Salesforce Files. This object is available in versions 17.0 and later for Salesforce CRM content documents. This object is available in versions 20.0 and later for Salesforce Files. The maximum number of versions that can be published in a 24-hour period is 200,000. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Depending on how files are shared, queries on ContentDocument and ContentVersion without specifying an ID don’t return all files a user has access to. For example, if a user only has access to a file because they have access to a record that the file is shared with, the file won't be returned in a query such as "SELECT Id FROM ContentDocument." ## Supported Calls create(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules - All users with a content feature license can create versions in their personal library. Customer and Partner Portal users must also supply the NetworkId of the Experience Cloud site in the request. - By default, users (including users with the “View All Data” permission) can only query files they have access to, including: - Salesforce Files in their personal library and in libraries they're a member of, regardless of library permissions (API version 17.0 and later). - Salesforce Files they own, shared directly with them, posted on their profile, or posted on groups they can see (API version 21.0 and later). Enable the Query All Files permission to let your View All Data users bypass the restrictions on querying files. - Query All Files returns all files, including files in non-member libraries and files in unlisted groups. - Users can’t edit, upload new versions, or delete files they don’t have access to. - View All Data permission is required to enable Query All Files. - All users can update versions in their personal library. - The owner of a version or document can update the document if they’re a member of the library, regardless of library permissions. - To update a Salesforce CRM Content document, the user must be a member of the library with one of these library privileges enabled: - Add Content - Add Content On Behalf of Others - Manage Library - Customer and Partner Portal users must have the View Content in Portal permission to query content in libraries where they have access. - Customer and Partner Portal users can only publish, version, or edit documents if they have a Salesforce CRM Content feature license. - FileType is defined by either ContentUrl for links or PathOnClient for documents, but not both. - In API version 34.0 and later, any file can be shared with libraries, whether the file originated in Chatter or in Salesforce CRM Content. - In API version 39.0 and later, custom Apex download handlers can be created that can control access to documents. See the [Apex Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_dev_guide.htm "HTML (New Window)") for more information. ## Fields | Field | Details | | --- | --- | | Checksum | Type string Properties Filter, Group, Nillable, Sort Description MD5 checksum for the file. | | ContentBodyId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Allows inserting a file version independently of the file blob being uploaded. This field is available for query and insert only. It can only point to a ContentBody record. This field is available in API version 40.0 and later. This is a relationship field. Relationship Name ContentBody Relationship Type Lookup Refers To ContentBody | | ContentDocumentId | Type reference Properties Create, Filter, Group, Sort Description ID of the document. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | ContentLocation | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Origin of the document. Valid values are: - **S**—Document is located within Salesforce. Label is **Salesforce**. - **E**—Document is located outside of Salesforce. Label is **External**. - **L**—Document is located on a social network and accessed via Social Customer Service. Label is **Social Customer Service**. - **SfDrive**—For internal use only. - **SCS**—For internal use only. | | ContentModifiedById | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user who modified the document. This is a relationship field. Relationship Name ContentModifiedBy Relationship Type Lookup Refers To User | | ContentModifiedDate | Type dateTime Properties Create, Filter, Nillable, Sort Description Date the document was modified. ContentModifiedDate updates when, for example, the document is renamed or a new document version is uploaded. When uploading the first version of a document, ContentModifiedDate can be set to the current time or any time in the past. | | ContentSize | Type int Properties Filter, Group, Nillable, Sort Description The size of the document in bytes for documents smaller than 2 GB. The value is zero for links. In API version 66.0 and later, we recommend that you use the ContentSizeLong field even for documents smaller than 2 GB. | | ContentSizeLong | Type long Properties Filter, Group, Nillable, Sort Description The size of the document in bytes up to 10 GB. The value is zero for links. This field is available in API version 66.0 and later. | | ContentUrl | Type url Properties Create, Filter, Nillable, Sort, Update Description URL for links. This is only set for links. One of the fields that determines the FileType. The character limit in API versions 33.0 and later is 1,300. The character limit in API versions 32.0 and earlier was 255. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the content version. | | Division | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the org has the Division permission enabled. | | ExternalDataSourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the external document referenced in the ExternalDataSource object. This is a relationship field. Relationship Name ExternalDataSource Relationship Type Lookup Refers To ExternalDataSource | | ExternalDocumentInfo1 | Type string Properties Create, Filter, Nillable, Sort, Update Description Stores the URL of the file in the external content repository. The integration from the external source determines the content for this string. After the reference or copy is created, the URL of the external file is updated when you: - Republish a file reference in Lightning Experience - Open the document - Create a file reference in the Connect REST API with reuseReference set to true. When the file is updated, the shared link is updated to the most current version. | | ExternalDocumentInfo2 | Type string Properties Create, Filter, Nillable, Sort, Update Description Contains the external file ID. Salesforce determines the content for this string, which is private. The content can change without notice, depending on the external system. After the file reference is created, this field isn’t updated, even if the file path changes. | | FeaturedContentBoost | Type int Properties Filter, Group, Nillable, Sort Description Read only. Designates a document as featured. | | FeaturedContentDate | Type date Properties Filter, Group, Nillable, Sort Description Date the document was featured. | | FileExtension | Type string Properties Filter, Group, Nillable, Sort Description File extension of the document. This field is available in API version 31.0 and later. | | FileType | Type string Properties Filter, Group, Sort Description Type of content determined by ContentUrl for links or PathOnClient for documents. | | FirstPublishLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the location where the version was first published. If the version is first published into a user's personal library or My Files, the field will contain the ID of the user who owns the personal library or My Files. In Lightning Experience, if the first version is published into a public library, the field will contain the ID of that library. Accepts all record IDs supported by ContentDocumentLink (anything a file can be attached to, like records and groups). Setting FirstPublishLocationId allows you to create a file and share it with an initial record/group in a single transaction, and have the option to create more links to share the file with other records or groups later. When a file is created, it’s automatically linked to the record, and PublishStatus will change to Public from Pending/Personal. This field is only set the first time a version is published via the API. FirstPublishLocationId can’t be set to another ID when a new content version is inserted. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Salesforce updates the FirstPublishLocationId updates automatically when a new OwnerId is added to the ContentVersion. For example, when you publish a new version with a different OwnerId than the current OwnerId, the FirstPublishLocationId of all previous versions updates to the previous OwnerId. The new published version sets the FirstPublishLocationId to the new OwnerId. This is a polymorphic relationship field. Relationship Name FirstPublishLocation Relationship Type Lookup Refers To Account, Accreditation, ActivationTarget, ActivationTrgtIntOrgAccess, ApiAnomalyEventStore, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CollaborationGroup, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContentWorkspace, Contract, ConversationEntry, CoverageBenefit, CoverageBenefitItem, CredentialStuffingEventStore, CreditMemo, CreditMemoLine, Dashboard, DashboardComponent, DataStream, DelegatedAccount, DocumentChecklistItem, EmailMessage, EmailTemplate, EngagementChannelType, EnhancedLetterhead, EnrollmentEligibilityCriteria, Event, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Identifier, Image, IndividualApplication, Invoice, InvoiceLine, Lead, ListEmail, Location, MarketSegment, MarketSegmentActivation, MemberPlan, MessagingSession, MktCalculatedInsight, OperatingHours, Opportunity, Order, OrderItem, Organization, OtherComponentTask, OutgoingEmail, PartyConsent, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, Product2, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, ProviderSearchSyncLog, PurchaserPlan, PurchaserPlanAssn, ReceivedDocument, Report, ReportAnomalyEventStore, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SessionHijackingEventStore, Shift, Shipment, ShipmentItem, Site, SkillRequirement, SocialPost, Solution, Task, ThreatDetectionFeedback, Topic, User, Visit, VisitedParty, Visitor, VoiceCall, VolunteerProject, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup, WorkTypeGroupMember | | IsAssetEnabled | Type boolean Properties Create, Group, Defaulted on create Description Can be specified on insert of ContentVersion to automatically convert a ContentDocument file into a ContentAsset. This field can be SOQL queried, but it can’t be edited. This field is available in API version 38.0 and later. | | IsLatest | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the latest version of the document (true) or not (false). | | IsMajorVersion | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description true if the document is a major version; false if the document is a minor version. Major versions can’t be replaced. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language for this document. This field defaults to the org’s default language unless the multi language setting is enabled. Specifies the language of the labels returned. The value must be a valid user locale (language and country), such as de\_DE or en\_GB. For more information on locales, see the [Language](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_categorynodelocalization.htm "When the Translation Workbench is enabled for your organization, the CategoryNodeLocalization object provides the translation of the label of a solution category.") field on the CategoryNodeLocalization object. | | MalwareScanDate | Type dateTime Properties Filter, Group, Nillable, Sort Description The date the document was scanned for malware. This field is available in API version 66.0 and later. | | MalwareScanStatus | Type picklist Properties Filter, Group, Sort Description Indicates whether the document was scanned for malware and whether it’s safe or malicious. This field is available in API version 66.0 and later. Valid values are: - NotScanned—The file hasn’t yet been scanned for malware. This is the default value. - Scheduled—The file scan is in progress. - Clean—The file was scanned and doesn’t contain malware. - Malicious—The file was scanned and it contains malware. - Skipped—The file can’t be scanned because it’s either larger than 100 MB or it’s a Salesforce-generated file, such as a Content Note. - Failed—The file wasn’t scanned because of an error. | | NegativeRatingCount | Type int Properties Filter, Group, Nillable, Sort Description Read only. The number of times different users have given the document a thumbs down. Rating counts for the latest version are not version-specific. If Version 1 receives 10 thumbs-down votes, and Version 2 receives 2 thumbs-down votes, the NegativeRatingCount on Version 2 is 12. However, rating counts are not retroactive for prior versions. The NegativeRatingCount on Version 1 is 10. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Experience Cloud site that this file originated from. This field is available in API version 26.0 and later, if digital experiences is enabled for your org. You can add a NetworkId only when creating a file. You can’t change or add a NetworkId for an existing file. | | Origin | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The source of the content version. Valid values are: - **C**—Content document from the user's personal library. Label is **Content**. The FirstPublishLocationId must be the user's ID. If FirstPublishLocationId is left blank, it defaults to the user's ID. - **H**—Salesforce file from the user's My Files. Label is **Chatter**. The FirstPublishLocationId must be the user's ID. If FirstPublishLocationId is left blank, it defaults to the user's ID. Origin can only be set to **H** if Chatter is enabled for your organization. This field defaults to C. Label is **Content Origin**. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this document. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | PathOnClient | Type string Properties Create, Filter, Nillable, Sort Description The complete path of the document. One of the fields that determines the FileType. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Specify a complete path including the file extension in order for the document to be visible in the Preview tab. | | PositiveRatingCount | Type int Properties Filter, Group, Nillable, Sort Description Read only. The number of times different users have given the document a thumbs up. Rating counts for the latest version are not version-specific. If Version 1 receives 10 thumbs-up votes, and Version 2 receives 2 thumbs-up votes, the PositiveRatingCount on Version 2 is 12. However, rating counts are not retroactive for prior versions. The PositiveRatingCount on Version 1 is 10. | | PublishStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Indicates if and how the document is published. Valid values are: - P—The document is published to a public library and is visible to other users. Label is **Public**. - R—The document is published to a personal library and is not visible to other users. Label is **Personal Library**. - U—The document is not published because publishing was interrupted. Label is **Upload Interrupted**. | | RatingCount | Type int Properties Filter, Group, Nillable, Sort Description Read only. Total number of positive and negative ratings. | | ReasonForChange | Type string Properties Create, Filter, Nillable, Sort, Update Description The reason why the document was changed. This field can only be set when inserting a new version (revising) a document. | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Update Description ID of the record type of the version. Custom fields are restricted in RecordTypeId. When an administrator creates a custom field via the API it must be added to at least one page layout: - If the custom field is added to the page layout associated with the General record type, the RecordTypeId that corresponds to that record type does not have to be set on the version record. - If the custom field is added to the page layout associated with a custom record type, the RecordTypeId that corresponds to that record type must be set on the version record. | | SharingOption | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Controls whether sharing is frozen for a file. Only administrators and file owners with Collaborator access to the file can modify this field. Default is Allowed, which means that new shares are allowed. When set to Restricted, new shares are prevented without affecting existing shares. This field is available in API versions 35.0 and later. | | SharingPrivacy | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Controls sharing privacy for a file. Only administrators and file owners with Collaborator access to the file can modify this field. Default is Visible to Anyone With Record Access. When set to Private on Records, the file is private on records but can be shared selectively with others. This field is available in API versions 41.0 and later. | | TagCsv | Type textarea Properties Create, Nillable, Sort, Update Description Text used to apply tags to a content version via the API. | | TextPreview | Type string Properties Nillable, Filter,Group, Sort Description A preview of a document. Available in API version 35.0 and later. | | Title | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The title of a document. | | VersionData | Type base64 Properties Create, Nillable, Update Description The content or body of the note, which can include properly formatted HTML or plain text. When a document is uploaded or downloaded via the API, it should be base64 encoded (for upload) or decoded (for download). Any special characters within plain text in the Content field must be escaped. You can escape special characters by calling content.escapeHtml4(). This field can't be set for links. The maximum file size you can upload via the SOAP API is 50 MB. When a document is uploaded or downloaded via the API, it is converted to base64 and stored in VersionData. This conversion increases the document size by approximately 37%. Account for the base64 conversion increase so that the file you plan to upload is less than 50 MB after conversion. If a custom Apex download handler is active, this field is accessed from the API, and the download is not allowed, Salesforce will return a CONTENT\_CUSTOMIZED\_DOWNLOAD\_EXCEPTION error. | | VersionDataURL | Type string Properties Filter, Group, Nillable, Sort Description The URL used to fetch a file from the binary data endpoint. This field is only populated on direct queries to ContentVersion, and not when queried through a related entity’s foreign key to ContentVersion. If available, access preview images of a file by appending a thumb query parameter to this URL. For example: myContentVersion.VersionDataUrl + '?thumb=THUMB240BY180' Available thumb parameter values are: - THUMB720BY480 — corresponds to the big-thumbnail preview format - THUMB240BY180 — corresponds to the thumbnail preview format - THUMB120BY90 — corresponds to the tiny-thumbnail preview format See [File Preview](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_files_preview_format.htm "HTML (New Window)") in the Connect REST API Developer Guide for additional details about file previews. This field can't be set for links. This field is available in API versions 55.0 and later. | | VersionNumber | Type string Properties Filter, Group, Nillable, Sort Description The version number. The number increments with each version of the document, for example, 1, 2, 3. | ## Usage - Use this object to create, query, retrieve, search, edit, and update a specific version of a Salesforce CRM Content document or Salesforce file. Use the ContentDocument object to retrieve, query, update, and delete the latest version of a document, but not a content pack, in a library or a Salesforce file. - Use this object to create, query, retrieve, search, edit, and update a specific version of a Salesforce file. Use the ContentDocument object to retrieve, query, update, and delete the latest version of a Salesforce file. - To query a file that is shared only with a record, you must specify the content ID of the file. - Not all fields can be set for Salesforce Files. - You can only update a version if it is the latest version and if it is published. - You can't archive versions. - Using API version 32.0 and later, you can update record types on versions. - You can't delete a version via the API. - The maximum file size you can upload via the SOAP API is 50 MB. When a document is uploaded or downloaded via the API, it is converted to base64 and stored in VersionData. This conversion increases the document size by approximately 37%. Account for the base64 conversion increase so that the file you plan to upload is less than 50 MB after conversion. - To download a document via the API, you must export the VersionData of the document. This does not increase the download count. - When you upload a document from your local drive using the Data Loader, you must specify the actual path in both VersionData and PathOnClient. VersionData identifies the location and extracts the format and PathOnClient identifies the type of document being uploaded. - SOQL queries on the ContentVersion object return all versions of the document. SOSL searches on the ContentVersion object return only the most recent version of the document. - To query a file that is accessible only through a record share, you must specify the content ID of the file. When SOQL querying the ContentVersion object, either the ContentVersionId or the ContentDocumentId must be compounded by an AND operator. For example, SELECT FileExtension, Title FROM ContentVersion WHERE (ContentDocumentId = '<ContentDocumentId>' or Id='<ContentVersionId>') and IsLatest=true SELECT Id, VersionData, FileExtension, Title FROM ContentVersion WHERE ContentDocumentId='<ContentDocumentId>' AND FirstPublishLocationId = '<FirstPublishLocationId>' - If you query versions in the API, versions with a PublishStatus of Upload Interrupted are not returned. - Documents published into a personal library assume the default record type that is set for the user profile of the person publishing the document (General, if no default is set for the user profile). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note An administrator can rename the default (_Content Version Layout_) page layout. - Contact Manager, Group, Professional, Enterprise, Unlimited, and Performance Edition customers can publish a maximum of 200,000 new versions per 24–hour period. Developer Edition and trial users can publish a maximum of 2,500 new versions per 24–hour period. - Custom validation rules can prevent an update of documents published into a personal library via the API. ## Applying Tags to ContentVersion Records Tags can be applied to ContentVersion records using either Enterprise or Partner API. To apply tags to a ContentVersion record, set a value in the TagCsv field. For example, setting this field to one,two,three creates and associates three tags to that version. - The maximum length of the TagCsv field is 2,000 characters. - The maximum length of an individual tag is 100 characters. - When tags are applied to a version, the content is indexed automatically and the tags are searchable. - You can't apply tags to a TagCsv that is published into a personal library. You can apply tags to a TagCsv that's in a shared library or folder. - You can't apply tags using the ContentDocument object. - You can't change or delete tag names. You can remove tags from a document, but that doesn't delete the tag. - Tags are case insensitive. You can't have two tags with the same name even if they use different uppercase and lowercase letters. The case of the original tag is always used. To delete tags from a ContentVersion record, perform a standard API update, and remove any values from the TagCsv field that you want to delete. For example, if the original TagCsv is one,two,three, perform an API update specifying one,three in the TagCsv field to delete two. To delete all tags from a ContentVersion you perform a standard API update by setting the field to null. If you create a ContentVersion record and want to revise it via the API, you insert another ContentVersion record but associate it to the same ContentDocument record as the original. This has an impact on tagging: - If you insert the revision and do not set any value in the TagCsv field, any tags applied to the previous version are automatically applied to the new version. - If you insert the revision and specify a new TagCsv field, no tags transfer over and the tags you specify are applied instead. When you perform a SOQL query for a ContentVersion record and select the TagCsv field, all the tags associated with that record are returned. The tags in the string are always ordered alphabetically even if they were inserted in a different order. You can't use the TagCsv field as part of a filter in a SOQL query. You can't query all tags in your organization. Library tagging rules: - API tagging respects the tagging restrictions that exist on any library that the document is published into. For example, if the library is in restricted tagging mode and only allows tags one,three, you can't save a version with a TagCsv of one,two,three. - If the library is in guided tagging mode, you can apply tags to the ContentVersion. You can't query the value of guided tags on a library, but you can query the tagging model of a library. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ContentVersionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. [ContentVersionHistory](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. #### See Also - [ContentDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm "Represents a document that was uploaded to a library in Salesforce Files or Salesforce CRM content. This object is available in versions 17.0 and later for Salesforce CRM.This object is available in API version 21.0 and later for Salesforce Files.") - [ContentVersionHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentversionhistory.htm "Represents the history of a specific version of a document. This object is available in version 17.0 and later.") <!-- document id=c3971327ba35f743a6aeacfe0cef1bdab00e3d512b14a37ea8477456f667781a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentversioncomment.md --> # ContentVersionComment Represents a comment on a version of a file. This object is available in API version 42.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Only users with Modify All Data permission have access to this object. ## Fields | Field | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Sort Description ID of the file. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | ContentVersionId | Type reference Properties Filter, Group, Sort Description ID of the version of the file. This is a relationship field. Relationship Name ContentVersion Relationship Type Lookup Refers To ContentVersion | | UserComment | Type textarea Properties Filter, Nillable, Sort Description ID of the user who commented on the file. | <!-- document id=3ea1775d147e8cf499876173546bbeb448796f5194e6d4fc46b93b7747ed89fa url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentversionhistory.md --> # ContentVersionHistory Represents the history of a specific version of a document. This object is available in version 17.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules - Customer and Partner Portal users must have the “View Content in Portal” permission to query content in libraries where they have access. - A user can query all versions of a document from their personal library and any version that is part of or shared with a library where they are a member, regardless of library permissions. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To record an event in contentVersionViewed, make sure: - All files are published to a Content Library. - The details page is viewed in Salesforce Classic. ## Fields | Field | Details | | --- | --- | | ContentVersionId | Type reference Properties Filter, Group, Sort Description ID of the version. This is a relationship field. Relationship Name ContentVersion Relationship Type Lookup Refers To ContentVersion | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Division | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. Possible values include: - contentVersionCreated—A new version is created. - contentVersionUpdated—The title, description, or any custom field on the version is changed. - contentVersionDownloaded—A version is downloaded. - contentVersionViewed—The version details are viewed. - contentVersionRated—The version is rated. - contentVersionCommented—The version receives a comment. - contentVersionDataReplaced—The new version replaces the previous version, which can happen only when the new version is uploaded immediately after the previous version. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed. | ## Usage Use this read-only object to query the history of a document version. #### See Also - [ContentVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm "Represents a specific version of a document in Salesforce CRM content or Salesforce Files. This object is available in versions 17.0 and later for Salesforce CRM content documents. This object is available in versions 20.0 and later for Salesforce Files.") <!-- document id=d909407409d185fa223cdf7ac46b5996f6160e4968f6aef2fc1656510ee3e9a8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentversionrating.md --> # ContentVersionRating Represents a rating on a version of a file. This object is available in API version 42.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Only users with Modify All Data permission have access to this object. ## Fields | Field | Details | | --- | --- | | ContentVersionId | Type reference Properties Filter, Group, Sort Description ID of the version of the file. This is a relationship field. Relationship Name ContentVersion Relationship Type Lookup Refers To ContentVersion | | Rating | Type int Properties Filter, Group, Nillable, Sort Description Rating of the file. | | UserComment | Type textarea Properties Filter, Nillable, Sort Description Comment made by the user who rated the file. | | UserId | Type reference Properties Filter, Group, Sort Description ID of the user who rated the file. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | <!-- document id=149346674394333f15204def95b214d9bf30f02cf8377d800494d85910a129ea url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentworkspace.md --> # ContentWorkspace Represents a content library. This object is available in versions 17.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object doesn’t apply to personal libraries. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note create( ), update( ) and delete( ) on ContentWorkspace are supported in API version 40.0 and later only. ## Special Access Rules - The Access Libraries user permission allows orgs to make libraries available to users without requiring that they have the legacy Salesforce CRM Content license. This permission is available for profiles and permission sets on most standard user licenses, and isn’t available for High Volume Customer Portal, Customer Community, or Chatter Free licenses. Available in API versions 40.0 and later. - Users with the Create Libraries user perm or the Manage Salesforce CRM Content administrator permission can create libraries (ContentWorkspaces) from the Libraries tab in Salesforce Classic and from the API. - Customer and Partner Portal users can only edit the library document object if they have a Salesforce CRM Content feature license. - Customer and Partner Portal users can query this object if they have the “View Content in Portal” permission. A user can query all public libraries where they’re members, regardless of library permissions. - Automated process users can’t publish documents to libraries (ContentWorkspaces). ## Fields | Field | Details | | --- | --- | | DefaultRecordTypeId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the default content type for the library. Content types are the containers for custom fields in Salesforce CRM Content. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Text description of the content library. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique name of the library in the API. Allows a link to the library to be packaged when an asset file is added to a package. Although libraries aren’t a packageable entity, references to libraries with a developer name will be included in the package when asset files are packaged. These links can then be restored in the target org. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Label is Unique Name. This field is available in API version 39.0 and later. | | IsRestrictContentTypes | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read only. Indicates whether content types have been restricted (true) or not (false). | | IsRestrictLinkedContentTypes | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read only. Indicates whether linked content types have been restricted (true) or not (false). | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the library. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The unique name of the library in the API. Allows a link to the library to be packaged when an asset file is added to a package. Limit: 15 characters. This field is available in API version 39.0 and later. | | RootContentFolderId | Type reference Properties Filter, Group, Nillable, Sort Description ID of root folder of the library. This field is available in API version 39.0 and later. | | ShouldAddCreatorMembership | Type boolean Properties Create, Defaulted on create, Group Description Automatically create a library membership for the user creating the library. Note this field isn’t meant for query and always returns false in query. This field is available in API version 40.0 and later. | | TagModel | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of tagging assigned to a library. Valid values are: - U — Unrestricted. No restrictions on tagging. Users can enter any tag when publishing or editing content. - G — Guided. Users can enter any tag when publishing or editing content, but they’re also offered a list of suggested tags. - R — Restricted. Users must choose from a list of suggested tags. | | WorkspaceImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of a library image. Image files can be assigned to libraries for branding and easy identification. Library image is visible to all users, even if they aren’t library members. This field is available in API version 43.0 and later. Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of a library image. Image files can be assigned to libraries for branding and easy identification. Library image is visible to all users, even if they are not library members. This field is available in API version 43.0 and later. This is a relationship field. Relationship Name WorkspaceImage Relationship Type Lookup Refers To ContentAsset | | WorkspaceType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Differentiates between different types of libraries. Valid values are: - R — Regular library - B — Org asset library This field is available in API version 39.0 and later. | ## Usage Use this object to query libraries to find out where documents can be published. If the content type isn’t specified when publishing a new version into a library, it is determined by the DefaultRecordTypeId of the primary library. As of 40.0, you can create, update, or delete a library via the API. #### See Also - [ContentWorkspaceDoc](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentworkspacedoc.htm "Represents a link between a document and a public library in Salesforce CRM Content. This object is available in versions 17.0 and later.") <!-- document id=1aa1610cf9f6c0c37e61e977f68bdb6be3b1b1004f177977e0438b7fcf7458e3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentworkspacedoc.md --> # ContentWorkspaceDoc Represents a link between a document and a public library in Salesforce CRM Content. This object is available in versions 17.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object does not apply to documents and versions in a personal library. ## Supported Calls create(), delete(), describeSObjects()query(), retrieve(), update(), upsert() ## Special Access Rules - Customer and Partner Portal users must have the “View Content in Portal” permission in order to query and obtain content in libraries where they have access. - Customer and Partner Portal users can only edit documents if they have a Salesforce CRM Content feature license. - To create a ContentWorkspaceDoc, you must be a member of the library with one of these library privileges enabled: - “Add Content” - “Add Content On Behalf of Others” - “Manage Library” - To query all library documents in a library, a user must be a member of that library, regardless of library permissions. ## Fields | Field | Details | | --- | --- | | ContentDocumentId | Type reference Properties Create, Filter, Group, Sort Description Read only. ID of the library document. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | ContentWorkspaceId | Type reference Properties Create, Filter, Group, Sort Description Read only. ID of the library. This is a relationship field. Relationship Name ContentWorkspace Relationship Type Lookup Refers To ContentWorkspace | | IsOwner | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read only. Indicates whether the library owns the document and determines permissions for that document (true) or not (false). Documents can belong to more than one library, but only one library owns the document and determines its permissions. | ## Usage - Use this object to link a document to one or more libraries. - To share a document with additional libraries, create additional ContentWorkspaceDoc records which join the document to the additional libraries. - Inserting a ContentWorkspaceDoc triggers the publish process for public libraries. - A document can be published into many public libraries, but it will always be owned by one library which controls the security of the document. - A document can only be published into the document owner's personal library. You can't publish into another user's personal library. Personal libraries are not visible via the API. - To publish a document into a personal library, you must specify your user ID as the first publish location ID. If you leave the first publish location ID blank, it defaults to the current user's ID. - A document can be published from a personal library into a public library, but once it has been published into the public library, it can't be published into the personal library again. - You can't publish a document from a personal library into a public library that has restricted content types. - You can't update or delete a library document via the API. #### See Also - [ContentWorkspace](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentworkspace.htm "Represents a content library. This object is available in versions 17.0 and later.") <!-- document id=44f05a0c6fef9d2bffbc9afabaeb2ae61e4d2aa2b9eb6c550c1ab753d13063ab url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentworkspacemember.md --> # ContentWorkspaceMember Represents a member of a content library. This object is available in API version 40.0 and later. Manage library membership from the API. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules A user can create/update/delete memberships if they have the Manage Salesforce CRM Content admin perm or the Manage Library permission for the library concerned. ## Fields | Field | Details | | --- | --- | | ContentWorkspaceId | Type reference Properties Create, Filter, Group, Sort Description ID of the library. This is a relationship field. Relationship Name ContentWorkspace Relationship Type Lookup Refers To ContentWorkspace | | ContentWorkspacePermissionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The id of the library permission or role. This is a relationship field. Relationship Name ContentWorkspacePermission Relationship Type Lookup Refers To ContentWorkspacePermission | | MemberId | Type reference Properties Create, Filter, Group,Namepointing, Sort Description ID of the library member (the member is either a user or a group). This is a polymorphic relationship field. Relationship Name Member Relationship Type Lookup Refers To Group, User | | MemberType | Type picklist Properties Filter, Group, Nillable,Restricted picklist, Sort Description The type of library member. Valid values are: - G - Group - U - User | ## Usage Use this object to create, update, or delete members from a library. <!-- document id=9e855d8bae34813f9e93f629273ca632558e4a9514c16742a75d898430d9d282 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentworkspacepermission.md --> # ContentWorkspacePermission Represents a library permission. This object is available in API version 40.0 and later. A library permission is a group of privileges assigned to each content library member. It determines which tasks a member can perform in a particular library. The same user can have a different library permission in each of his or her libraries. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Library permissions do not apply to personal libraries. All library users can save files in their personal libraries. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(),update(), upsert() ## Special Access Rules The ability to create permissions requires either the Manage Salesforce CRM Content admin perm or the Manage Content Permissions user perm. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description | | Name | Type string Properties Create, Filter, Group, idLookup, Namefield, Sort, Update Description Name of the library. | | PermissionsAddComment | Type boolean Properties Create, Filter, Update Description Permission for user to post comments to any content in the library and view all comments in the library. Users can edit or delete their own comments. | | PermissionsAddContent | Type boolean Properties Create, Filter, Update Description Permission for user to publish new content to the library, upload new content versions, or restore archived (deleted) content. Content authors can also change any tags associated with their content and archive or delete their own content. | | PermissionsAddContentOBO | Type boolean Properties Create, Filter, Update Description Permission for user to choose an author when publishing content in the library. | | PermissionsArchiveContent | Type boolean Properties Create, Filter, Update Description Permission for user to archive and restore any content in the library. | | PermissionsChatterSharing | Type boolean Properties Create, Filter, Update Description Permission for user to make content from this library accessible outside of the library, sharing with a record or in Chatter. From a record or from Chatter, select a file from the library and attach it to a record or a post. | | PermissionsDeleteContent | Type boolean Properties Create, Filter, Update Description Permission for user to delete any content in the library. Authors can undelete their own content from the Recycle Bin. | | PermissionsDeliverContent | Type boolean Properties Create, Filter, Update Description Permission for user to share content outside the org via a content delivery or public link. | | PermissionsFeatureContent | Type boolean Properties Create, Filter, Update Description Permission for user to identify any content in the library as “featured.” | | PermissionsManageWorkspace | Type boolean Properties Create, Filter, Update Description Permission for user to perform any action in the library. This privilege is required to edit a library’s name and description, add or remove library members, or delete a library. Manage Library is a super permission which provides all other permission options listed except Deliver Content. Creating a library requires the Manage Salesforce CRM Content app permission or Create Libraries system permission. | | PermissionsModifyComments | Type boolean Properties Create, Filter, Update Description Permission for user to edit or delete comments made to any content in the library. | | PermissionsOrganizeFileAndFolder | Type boolean Properties Create, Filter, Update Description Permission for user to create, rename, and delete folders in libraries. | | PermissionsTagContent | Type boolean Properties Create, Filter, Update Description Permission for user to add tags when publishing content or editing content details in the library. | | PermissionsViewComments | Type boolean Properties Create, Filter, Update Description Permission for user to view comments. | | Type | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Provides the type of access a user has to a library. Valid values are: - Library Administrator - Author - Viewer - Custom | <!-- document id=69ff21a34c035efd0371bdb4eed53cf92641d4e4fa3e07b5b20f8d2d7a092116 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contentworkspacesubscription.md --> # ContentWorkspaceSubscription Represents a subscription for a user following a library. This object is available in API version 42.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Only users with Modify All Data permission have access to this object. ## Fields | Field | Details | | --- | --- | | ContentWorkspaceId | Type reference Properties Filter, Group, Sort Description ID of the library. This is a relationship field. Relationship Name ContentWorkspace Relationship Type Lookup Refers To ContentWorkspace | | UserId | Type reference Properties Filter, Group, Sort Description ID of the user following the library. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | <!-- document id=b6e439663f796844ad98a220ced2287d018b155073f658080b87833cfe31f97d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contextparammap.md --> # ContextParamMap Represents optional context data for a Conversation or a ConversationParticipant. This object is available in API version 57.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ContextEntityId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Conversation or ConversationParticipant record. This field is a polymorphic relationship field. Relationship Type Lookup Refers To Conversation, ConversationParticipant | | MapKey | Type string Properties Filter, Group, Nillable, Sort Description The key for the context data. | | MapValue | Type string Properties Filter, Nillable, Sort Description The value for the context data. | <!-- document id=3a54177bd145987b69d4f1bbb726b98c008cecce2a0c8e1db6f357af69784269 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_continuationcalloutsummary.md --> # Continuation Callout Summary Event Type Continuation Callout Summary events contain information about all of the asynchronous callouts performed during a transaction, their response status codes, execution times, and URL endpoint destinations. This event type is available in the EventLogFile object in API version 43.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or the [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | CONTINUATION\_ID | Type String Description A unique ID identifying a sequence of events within a request. Example SFDC-Continuation-14e3cg85-961d-389e-7bz1-3d171543162a | | DURATION | Type Number Description Total duration of continuation, in milliseconds. | | EVENT\_TYPE | Type String Description The type of event. The value is always ContinuationCalloutSummary. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. For example: 00D000000000123. | | ORIGIN\_REQUEST\_ID | Type Id Description The ID of the request that initiated a callout. Example TID:5ILoVKlztX\_rDDJcp7 | | REQUEST\_FORM\_SIZE | Type String Description Continuation request form size, in bytes. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RESPONSE\_SIZE | Type String Description The size of the callout response, in bytes. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. | | STATUS\_CODE | Type String Description The HTTP status or internal code returned by the remote endpoint. A status code of 200 indicates that the request was successful. Other status code values indicate the type of problem that was encountered. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. Examples - 2000—The timeout was reached, and the server didn’t get a chance to respond. - 2001—There was a connection failure. - 2002—Exceptions occurred. - 2003—The response hasn’t arrived (which also means that the Apex asynchronous callout framework hasn’t resumed). - 2004—The response size is too large (greater than 1 MB). | | SUCCESS | Type Boolean Description Indicates whether the continuation was successful (1) or not (0). | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | URL | Type String Description The callout endpoint URL. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. Example http://prod.location.amazonaws.com:1000/orders/order/\_search | | USER\_ID | Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. For example: 00590000000I1SNIA0. | | VF\_CONTROLLER\_SIZE | Type String Description Continuation Visualforce controller size, in bytes. Depending on how many HTTP requests were used in a continuation, this field can contain up to three space-separated values. | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=a9b1eb99a5c8346a0ce8306817b2df4efdf1ad526481d588c17410698dd051a0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contract.md --> # Contract Represents a contract (a business agreement) associated with an Account. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Sort,Update Description Required. ID of the Account associated with this contract. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | ActivatedById | Type reference Properties Filter, Group, Nillable, Sort,Update Description ID of the User who activated this contract. This field is a relationship field. Relationship Name ActivatedBy Relationship Type Lookup Refers To User | | ActivatedDate | Type dateTime Properties Filter, Nillable, Sort, Update Description Date and time when this contract was activated. | | | | | ActivityMetricId | Type reference Properties Filter, Group, Nillable, Sort Description When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric. This field is a relationship field. Relationship Name ActivityMetric Refers To ActivityMetric | | ActivityMetricRollupId | Type reference Properties Filter, Group, Nillable, Sort Description When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup. This field is a relationship field. Relationship Name ActivityMetricRollup Refers To ActivityMetricRollup | | AggregationStrategy | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The aggregation strategy when creating a pricing contract. Valid value is Cumulative. This field is available with Revenue Cloud in API version 64.0 and later. | | BillingAddress | Type address Properties Filter, Nillable Description The compound form of the billing address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. The maximum size is 40 characters. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address of this account. The maximum size is 80 characters. | | BillingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the contract's billing address. | | BillingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The accuracy of the geocode for the billing address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address of this account. The maximum size is 20 characters. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. The maximum size is 80 characters. | | BillingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the contract's billing address. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street address for the billing address. | | CompanySignedDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date your organization signed the contract. | | CompanySignedId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user who signed the contract. This field is a relationship field. Relationship Name CompanySigned Relationship Type Lookup Refers To User | | ContractNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Number of the contract. | | ContractTerm | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of months that the contract is valid. | | CustomerSignedDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the customer signed the contract. | | CustomerSignedId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Contact who signed this contract. This field is a relationship field. Relationship Name CustomerSigned Relationship Type Lookup Refers To Contact | | CustomerSignedTitle | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Title of the customer who signed the contract. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the contract. | | EndDate | Type date Properties Filter, Group, Nillable, Sort, Description Read-only. Calculated end date of the contract. This value is calculated by adding the ContractTerm to the StartDate. If the **Auto-calculate Contract End Date** setting is disabled, the contract end date is editable. | | HasContractCotermination | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the contract can be coterminated (true) or not (false). The default value is false. This field is available with Revenue Cloud in API version 65.0 and later. | | IsPricingContract | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the contract has related contract item prices (true) or if there are no contract item prices for the contract (false). This field is available with Revenue Cloud in API version 63.0 and later. | | IsDeleted | Type boolean Properties Defaulted on create or filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). The label is **Deleted**. | | LastActivityDate | Type date Properties Filter, Group, Nillable, Sort Description Value is the most recent: - The due date of the most recent event is logged against the record. - The due date of the most recently closed task associated with the record. | | LastApprovedDate | Type dateTime Properties Filter, Nillable, Sort Description Last date the contract was approved. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user only accessed this record or list view (LastReferencedDate) but didn’t view it. | | OwnerExpirationNotice | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Number of days ahead of the contract end date (15, 30, 45, 60, 90, and 120). Used to notify the owner in advance that the contract is ending. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who owns the contract. This field is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | Pricebook2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the pricebook, if any, associated with this contract. | | PricingSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Source of the pricing for the contract. Valid values are: - LastTransaction - PriceBookListPrice—Price Book or List Price Available in API version 60.0 and later. | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to this object. | | RenewalTerm2 | Type double Properties Create, Filter, Nillable, Sort, Update Description The default subscription term for renewals. For example, if the Renewal Term Unit is months and you want a 6-month term, set the Renewal Term to 6. Available in API version 60.0 and later. | | RenewalTermUnit | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of time for a subscription term. Valid values are: - Annual—UI label is **Years** - Months - Quarterly—Available in API version 61.0 and later. - Semi-Annual—Available in API version 61.0 and later. Available in API version 60.0 and later. | | ShippingAddress | Type address Properties Filter, Nillable Description The compound form of the shipping address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | ShippingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address. City maximum size is 40 characters. | | ShippingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address. Country maximum size is 80 characters. | | ShippingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the contract's shipping address. | | ShippingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The accuracy of the geocode for the shipping address. Valid values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip Available in API version 60.0 and later. | | ShippingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | ShippingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | ShippingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address. The postal code maximum size is 20 characters. | | ShippingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address. The maximum size for the state is 80 characters. | | ShippingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the contract's shipping address. | | ShippingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street address of the shipping address. The maximum size is 255 characters. | | SourceQuoteId | Type reference Properties Create, Filter, Group, Sort,Update Description ID of the source quote associated with this contract. This field is available with Revenue Cloud in API version 64.0 and later. This field is a relationship field. Relationship Name Contract Relationship Type Lookup Refers To Quote | | SpecialTerms | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Special terms that apply to the contract. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort,Update Description Start date for this contract. The label is **Contract Start Date**. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The picklist of values that indicate order status. Each value is within one of two status categories defined in StatusCode. For example, the status picklist may contain: Ready to Ship, Shipped, Received as values within the Activated StatusCode. Valid values are: - Activated - Draft - In Approval Process Available in API version 60.0 and later. | | StatusCode | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status category for the contract. A contract can be Draft, InApproval, or Activated. Label is **Status Category**. Valid values are: - Activated - Draft - InApproval Available in API version 60.0 and later. | | UnitPriceUplift | Type percent Properties Create, Filter, Nillable, Sort, Update Description Indicates the percentage increase of a line item’s unit price. This field is available with Revenue Cloud in API version 64.0 and later. | ## Usage The Contract object represents a business agreement. The Status field specifies the current state of a contract. Status strings (defined in the ContractStatus object) represent its current state (Draft, InApproval, or Activated). Client applications must initially create a Contract in a non-Activated state. Client applications can subsequently activate a Contract by updating it and setting the value in its Status field to Activated; however, the Status field is the only field you can update when activating the Contract. After a Contract has been activated, your client application can't change its status; however, before activation, your client application can change the status value from Draft to InApproval via the API. Also, your client application can delete contracts whose status is Draft or InApproval but not when a contract status is Activated. Client applications can use the API to create, update, delete, and query any Attachment associated with a contract. ## Associated Objects This object has these 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. [AccountChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 46.0) Change events are available for the object. [ContractFeed](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.") (API version 18.0) Feed tracking is available for the object. [ContractHistory](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. #### See Also - [ContractContactRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractcontactrole.htm "Represents the role that a Contact plays on a Contract.") - [ContractStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractstatus.htm "Represents the status of a Contract, such as Draft, InApproval, Activated, Terminated, or Expired.") <!-- document id=63793da3e545a3bff8a6aa528a964186793fdc5f4a8cac9eb8a9cddee44499ef url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contractcontactrole.md --> # ContractContactRole Represents the role that a Contact plays on a Contract. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ContactId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the Contact associated with this Contract. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | ContractId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Contract. This is a relationship field. Relationship Name Contract Relationship Type Lookup Refers To Contract | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsPrimary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort,Update Description Specifies whether this Contact plays the primary role on this Contract (true) or not (false). Each contract has one primary contact role. Default is false. Labels is **Primary**. | | Role | Type picklist Properties Create, Filter, Nillable, Group, Sort, Update Description Name of the role played by the Contact on this Contract, such as Decision Maker, Approver, Buyer, and so on. Must be unique—there can't be multiple records in which the ContractId, ContactId, and Role values are identical. Different contacts can play the same role on the same contract. A contact can play different roles on the same contract. | #### See Also - [ContractStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractstatus.htm "Represents the status of a Contract, such as Draft, InApproval, Activated, Terminated, or Expired.") <!-- document id=c497c8c05b3cc250c7813b334d78d34da053ab9017ee16925dcd0d10a3643188 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contractlineitem.md --> # ContractLineItem Represents a product covered by a service contract (customer support agreement). This object is available in API version 18.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Nillable, Update Description Required. ID of the Asset associated with the contract line item. Must be a valid asset ID. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the contract line item. | | Discount | Type percent Properties Create, Filter, Nillable, Update Description The discount for the product as a percentage. When updating, if you specify Discount without specifying TotalPrice, the TotalPrice will be adjusted to accommodate the new Discount value, and the UnitPrice will be held constant. If you specify both Discount and Quantity, you must also specify either TotalPrice or UnitPrice so the system can determine which one to automatically adjust. | | EndDate | Type date Properties Create, Filter, Nillable, Update Description The last day the contract line item is in effect. | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | LastViewedDate | Type date Properties Filter, Nillable, Sort, Update Description The 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. | | LineItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Update Description Automatically-generated number that identifies the contract line item. | | ListPrice | Type currency Properties Filter, Nillable Description Corresponds to the UnitPrice on the PricebookEntry that is associated with this line item, which can be in the standard pricebook or a custom pricebook. A client application can use this information to show whether the unit price (or sales price) of the line item differs from the pricebook entry list price. | | LocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location associated with the contract line item. If you have access to the location entity, it doesn’t necessarily mean you can access the location id field. To access the location, you must have userHasLocation user access. | | ParentContractLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The line item’s parent line item, if it has one. | | PricebookEntryId | Type reference Properties Create, Filter, Update Description Required. ID of the associated PricebookEntry. Only exists if Product2 is enabled. | | Product2Id | Type reference Properties Filter, Group, Nillable, Sort Description The product related to the contract line item. | | Quantity | Type double Properties Create, Filter, Update Description Number of units of the contract line item (product) included in the associated service contract. | | RootContractLineItemId | Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level line item in a contract line item hierarchy. Depending on where a line item lies in the hierarchy, its root could be the same as its parent. | | ServiceContractId | Type reference Properties Create, Filter Description Required. ID of the ServiceContract associated with the contract line item. Must be a valid service contract ID. | | StartDate | Type date Properties Create, Filter, Nillable, Update Description The first day the contract line item is in effect. | | Status | Type picklist Properties Filter, Nillable Description Status of the contract line item. | | Subtotal | Type currency Properties Filter, Nillable Description Contract line item's sales price multiplied by the Quantity. | | TotalPrice | Type currency Properties Filter, Nillable Description This field is available only for backward compatibility. It represents the total price of the ContractLineItem If you specify Discount and Quantity, this field or UnitPrice is required. This field is nillable, but you can't set both TotalPrice and UnitPrice to null in the same update request. To insert the TotalPrice for a contract line item via the API (given only a unit price and the quantity), calculate this field as the unit price multiplied by the quantity. | | UnitPrice | Type currency Properties Create, Filter, Update Description The unit price for the contract line item. In the user interface, this field’s value is calculated by dividing the total price of the contract line item by the quantity listed for that line item. Label is **Sales Price**. This field or TotalPrice is required. You can’t specify both. If you specify Discount and Quantity, this field or TotalPrice is required. | ## 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. [ContractLineItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [ContractLineItemFeed](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. [ContractLineItemHistory](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. <!-- document id=cff5bcd497e39667d4fbb8b1744795bc60708ca56b86641ca021db85e05f2fe2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contractlineoutcome.md --> # ContractLineOutcome Represents information on a contract line outcome’s captured data and other related parameters that are used when capturing data. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Field Service must be enabled. - Entitlements must be enabled. ## Fields | Field | Details | | --- | --- | | CalculationMethod | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The method used for calculating the contract line outcome’s captured data to determine the outcome value. Select Average or As Captured to calculate the contract line outcome. Average calculates the outcome value based on the average of all data captured to date. As Captured calculates the outcome value based on the asset’s current data at the time of the compliance check. Possible values are: - AsCaptured - Average | | CaptureFrequency | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The frequency at which data capturing and contract compliance check for the contract line outcome occurs. Possible values are: - Daily - Monthly - Weekly | | ComplianceStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates if the criteria were met. Compliant–The outcome is compliant with the contract. Not Compliant–The outcome isn’t compliant with the contract. Not Available–The outcome’s compliance information isn’t available yet. Invalid–The outcome isn’t valid because the option selected for the Criteria Field of the recordset filter criteria was deleted. To restart the calculation, create a new contract line outcome. Possible values are: - Compliant - Invalid - NotAvailable - NotCompliant The default value is NotAvailable. | | ContractLineItemId | Type reference Properties Create, Filter, Group, Sort, Update Description The contract line item associated with the contract line outcome. This field is a relationship field. Relationship Name ContractLineItem Relationship Type Lookup Refers To ContractLineItem | | Description | Type textarea Properties Create, Nillable, Update Description A description of the contract line outcome. | | EndDate | Type dateTime Properties Create, Filter, Sort, Update Description The contract line outcome's data capture end date. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the contract line outcome was last modified. Its UI label is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the contract line outcome was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the contract line outcome. | | NextDataCaptureDate | Type dateTime Properties Filter, Nillable, Sort Description The date of the next data capture and compliance check based on the capture frequency. The date is auto-populated and updated after each capture | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The contract line outcome’s owner. By default, the owner is the user who created the contract line outcome record. Its UI label is Contract Line Outcome Owner. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RecordsetFilterCriteriaId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the recordset filter criteria in which the contract line outcome’s conditions are defined. This field is a relationship field. Relationship Name RecordsetFilterCriteria Relationship Type Lookup Refers To RecordsetFilterCriteria | | ServiceContractId | Type reference Properties Filter, Group, Nillable, Sort Description The service contract associated with the contract line item and the contract line outcome. This field is a relationship field. Relationship Name ServiceContract Relationship Type Lookup Refers To ServiceContract | | StartDate | Type dateTime Properties Create, Filter, Sort, Update Description The contract line outcome's data capture start date. | ## Usage Use this object to define the data capture frequency and other related parameters that are used when capturing data in order to evaluate a service contract’s compliance. ## 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. [ContractLineOutcomeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ContractLineOutcomeFeed](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. [ContractLineOutcomeHistory](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. [ContractLineOutcomeOwnerSharingRule](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. [ContractLineOutcomeShare](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. #### See Also - [ContractLineOutcomeData](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractlineoutcomedata.htm "Represents the contract line outcome’s captured data. It stores the data that was captured between the contract line outcome’s start date and end date. This object is available in API version 58.0 and later.") <!-- document id=589084bd15be2b05647b63d61bf086891012181747f26feab937881270dc92f6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contractlineoutcomedata.md --> # ContractLineOutcomeData Represents the contract line outcome’s captured data. It stores the data that was captured between the contract line outcome’s start date and end date. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Field Service must be enabled. - Entitlements must be enabled. ## Fields | Field | Details | | --- | --- | | CalculatedValue | Type double Properties Filter, Nillable, Sort Description The value calculated based on the contract line outcome’s calculation method and the captured data. | | CaptureDate | Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the data was captured. | | ContractLineOutcomeId | Type reference Properties Create, Filter, Group, Sort Description The contract line outcome associated with the contract line outcome data record. This field is a relationship field. Relationship Name ContractLineOutcome Relationship Type Lookup Refers To ContractLineOutcome | | KeyPerformanceIndicator | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The key performance indicators (fields or asset attributes) that define the contract line outcome’s compliance status. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the contract line outcome data record was last modified. Its UI label is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the contract line outcome data record was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the contract line outcome data record. | | Value | Type double Properties Create, Filter, Nillable, Sort, Update Description The actual value of the key performance indicator. | ## 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. [ContractLineOutcomeDataChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ContractLineOutcomeDataFeed](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. [ContractLineOutcomeDataHistory](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. [ContractLineOutcomeDataOwnerSharingRule](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. [ContractLineOutcomeDataShare](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. <!-- document id=1ac18f7c5deb4e112de22defde31807599c7169fa65b12cf874007248a0d34d9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contractstatus.md --> # ContractStatus Represents the status of a Contract, such as Draft, InApproval, Activated, Terminated, or Expired. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an id or primary label. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default contract status value (true) or not (false) in the picklist. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Label for this contract status value. This display value is the internal label that does not get translated. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the contract status picklist. These numbers are not guaranteed to be sequential, as some previous contract status values might have been deleted. | | StatusCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Code indicating the status of a contract. One of the following values: - Draft - InApproval - Activated Two other values (Terminated and Expired) are defined but are not available for use via the API. | ## Usage This object represents a value in the contract status picklist. The contract status picklist provides additional information about the status of a Contract, such as its current state (Draft, InApproval, or Activated). You can query these records to retrieve the set of values in the contract status picklist, and then use that information while processing Contract objects to determine more information about a given contract. For example, the application could test whether a given contract is activated based on its Status value and the value of the StatusCode property in the associated ContractStatus object. #### See Also - [ContractContactRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractcontactrole.htm "Represents the role that a Contact plays on a Contract.") <!-- document id=8f7c7497106280578369bacfe2323219c05f290ecb83251a5fdee5f2c0e4c549 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_contracttag.md --> # ContractTag Associates a word or short phrase with a Contract. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage ContractTag stores the relationship between its parent TagDefinition and the Contract being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. <!-- document id=5614775994254650aab46a85168d6282664c67624140c22800cff5b90a8cb5f5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_convanalysissummary.md --> # ConvAnalysisSummary Represents the information stored for each run or refresh of Sales Signals. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Users need the Sales Signals permission set and the Sales Signals feature must be enabled. ## Fields | Field | Details | | --- | --- | | AnalysisDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the actual data analysis was done, accounting for the delay between the refresh start time and the data analysis. | | DataModelVersion | Type string Properties Create, Filter, Group, Nillable, Sort Description The data model version generated by Hawking. | | Error | Type textarea Properties Create, Nillable, Update Description The error message sent by Hawking when a refresh fails. | | FlowIdentifier | Type string Properties Create, Filter, Group, Sort Description Required. The UUID used to track the Hawking flow ID. | | RefreshDate | Type dateTime Properties Create, Filter, Sort Description Required. The date when the admin started the refresh of their ECI data for processing. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The status of the refresh or run. Possible values are: - FAILED - PARTIALLY\_FAILED - PROCESSING - SUCCESS | | TotalCalls | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of calls that were analyzed for Sales Signals. | | TotalMentions | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of mentions or keywords that were analyzed. | <!-- document id=379e3028c7f0b089258695087e57a046f9f99e9cea8d7174be81521b594b235f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_convanalysistopic.md --> # ConvAnalysisTopic Represents a topic generated from the Sales Signals refresh or run. For example, a product experiencing issues due to high pricing could be a topic identified through the analysis of multiple calls. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Users need the Sales Signals permission set and the Sales Signals feature must be enabled. ## Fields | Field | Details | | --- | --- | | CallPercentage | Type double Properties Create, Filter, Sort Description Required. The percentage of calls that apply to a topic, out of the total number of calls that were analyzed. | | Category | Type string Properties Create, Filter, Group, Sort Description Required. A classification or grouping used to filter topics. This field is used in conjunction with Keyword. | | ConvAnalysisSummaryId | Type reference Properties Create, Filter, Group, Sort Description Required. The conversation analysis summary associated with the topic. This field is a relationship field. Relationship Name ConvAnalysisSummary Relationship Type Master-detail Refers To ConvAnalysisSummary (the parent object) | | GenerationsIdentifier | Type string Properties Create, Filter, Group, Sort Description Required. The ID used to track the LLM-generated response for feedback purposes. | | Keyword | Type string Properties Create, Filter, Group, Sort Description Required. A specific word used in conjunction with Category to filter topics. For example, Product:Salesforce, where the keyword is Salesforce. | | MentionCount | Type int Properties Create, Filter, Group, Sort Description Required. The number of call insights associated with the topic. | | Order | Type int Properties Create, Filter, Group, Sort Description Required. A numerical value used to sort topics in a sequence. | | Summary | Type textarea Properties Create, Update Description Required. A detailed explanation of the topic. | | Title | Type string Properties Create, Filter, Group, Sort, Update Description Required. The title of the topic that describes it. | | TopicSentiment | Type string Properties Create, Filter, Group, Nillable, Sort Description The sentiment of the topic, whether it’s negative, neutral, or positive. | | TotalCalls | Type int Properties Create, Filter, Group, Nillable, Sort Description The total number of calls analyzed for the topic. | | TotalCallsForCategoryKeyword | Type int Properties Create, Filter, Group, Nillable, Sort Description The total number of calls analyzed for category:keyword. Multiple topics can be under a single category:keyword. | | TotalMentionsForCategoryKeyword | Type int Properties Create, Filter, Group, Nillable, Sort Description The total number of mentions analyzed for category:keyword. | | TurnIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort Description UUID that is generated and used to track a group of LLM-generated content. | <!-- document id=f6e549aef6be39f0881ab76e7e1df4207a8ab369af1f717221b8579d6ecbbd39 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_convanalysistopicentry.md --> # ConvAnalysisTopicEntry Represents a single entry under the ConvAnalysisTopic object. An entry represents a segment of a video or voice call that is associated with a conversation analysis topic. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Users need the Sales Signals permission set and the Sales Signals feature must be enabled. ## Fields | Field | Details | | --- | --- | | BulletGenerationsIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort Description The generation ID used to track the LLM-generated response for feedback purposes. | | CallId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The unique identifier of the voice or video call that corresponds to the entry. This field is a polymorphic relationship field. Relationship Name Call Refers To VideoCall, VoiceCall | | ConvAnalysisTopicId | Type reference Properties Create, Filter, Group, Sort Description Required. The conversation analysis topic associated with the entry. This field is a relationship field. Relationship Name ConvAnalysisTopic Relationship Type Master-detail Refers To ConvAnalysisTopic (the parent object) | | SnippetStartTime | Type double Properties Create, Filter, Nillable, Sort, Update Description The timestamp when the call is associated with the current topic entry. | | Summary | Type textarea Properties Create, Nillable, Update Description The LLM-generated call summary that corresponds to the parent topic. | <!-- document id=a939cbf0fb4a02367741e7f2926d9aa8de6e645f38d753149239e4d61772c9bd url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_conversation.md --> # Conversation Represents a conversation between an end user and an agent. Available in API version 49.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available for Einstein Conversation Insights customers whose data is stored natively on the Salesforce Platform. If you turned on Einstein Conversation Insights for the first time starting in Spring ’26, this object is available to query and access using Salesforce tools. For existing ECI customers, data migration and access to related Salesforce Platform objects is scheduled to begin in Summer ’26. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ConversationChannelId | Type reference Properties Filter, Group, idLookup, Sort Description The record ID of the channel used to initialize the conversation. This can either be a messaging channel for the Messaging product or a call center for the Service Cloud Voice product. Available in API version 50.0 and later. Service Cloud Voice is now Salesforce Voice. You may see references to Service Cloud Voice in Salesforce applications and documentation. | | ConversationIdentifier | Type string Properties Filter, Group, idLookup, Sort Description A unique identifier generated for the conversation. | | EndTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time that a conversation ends. | | Name | Type string Properties Defaulted on create, Filter, idLookup, Sort Description The internal name of the conversation. The value can be the Salesforce record ID of the conversation or an auto-incremented number string. If your integration sorts records by Name, use CreatedDate instead. | | StartTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time that a conversation starts. | <!-- document id=bfcf8c988ef51205dafdd7bbbb94c857df364191c7ad61a983c412c0a804f9f8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_conversationapilog.md --> # ConversationApiLog Logs of an API operation on a specific conversation object done using the Conversation Service API. This object is available in API version 63.0 and later. This object stores the logs of operations done on the [Conversation Service API](https://developer.salesforce.com/docs/service/conversation-service-api/overview). The Conversation Service API enables you to interact with conversational data on the Conversation Platform, offering tools to manage, access, and maintain your data effectively. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Action | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The specific action performed using the Conversation Service API. Possible values are: - Delete | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Autogenerated name of the logs. | | Operation | Type string Properties Create, Filter, Group, Sort Description Name of the operation that triggered the Conversation Srevice API log. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Owner ID that triggered the Conversation API log. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | RequestedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The User ID that triggered the Conversation API log. This field is a relationship field. Relationship Name RequestedBy Refers To User | | RequestedDate | Type dateTime Properties Create, Filter, Sort Description The date of the operation that triggered the Conversation API log. | | RequestedEntityIdentifier | Type string Properties Create, Filter, Group, Sort Description The entity ID being created, updated, or deleted. | | RequestedEntityType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of entity being created, updated, or deleted. Possible values are: - MessagingEndUser—Messaging End User | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the Conversation API operation. Possible values are: - Completed - Enqueued - Failed - InProgress—In Progress - Requested | <!-- document id=1cd7157f36c6f4ca139fdb19a9cd5ef0903144988bef64b42436c2366147b3c4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_conversationchanneldefinition.md --> # ConversationChannelDefinition Represents a configurable definition of a conversation channel that’s implemented for Interaction Service for Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS messaging channels. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, interaction service must be configured. Access to standard objects requires Salesforce admin privileges or the Customize Application permission. ## Fields | Field | Details | | --- | --- | | CapabilitiesSupportsCustomChannelParameters | Type boolean Properties Create, Filter, Update Description Indicates whether admins can configure custom parameters and parameter mappings for messaging channels. Custom parameters and parameter mappings are used to pass additional information at runtime to Omni-Channel flows. The default value is false. Available in API version 61.0. | | CapabilitiesSupportsDoubleOptInConsent | Type boolean Properties Filter Description Indicates whether the channel supports (true) the Double Opt-In consent level. The default value is false. If set to true, then capabilitiesSupportsExplicitConsent must also be set to true. This field is optional and isn’t supported for Bring Your Own Channel for Messaging. It's only supported for Bring Your Own Channel for CCaaS. | | CapabilitiesSupportsExplicitConsent | Type boolean Properties Filter Description Indicates whether the channel supports (true) the Explicit Opt-In consent level. This field is optional. | | CapabilitiesSupportsImplicitConsent | Type boolean Properties Filter Description Indicates whether the channel supports (true) the Implicit Opt-In consent level. This value is required and must always be set to true. The default value is false. | | CapabilitiesSupportsIsoCountryCode | Type boolean Properties Filter Description Indicates whether the channel supports (true) ISO country codes. The default value is false. | | CapabilitiesSupportsKeywords | Type boolean Properties Filter Description Indicates whether the channel supports (true) keywords. The default value is false. | | ConnectedAppOauthLink | Type string Properties Filter, Group, Sort Description DO NOT SET OR CHANGE THIS VALUE. This value is automatically generated. This field represents the OAuth link for the external client app (ECA) or connected app if the ConnectedAppType is Partner. This is a string identifier to the ECA or connected app containing the partner Org ID and the consumer ID minus the key prefixes. | | ConnectedAppType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The owner of the external client app (ECA) or connected app used to manage authentication between Salesforce Interaction Service and the Messaging or CCaaS partner’s system. Possible values are: - Partner - Customer The default value is Partner. If set to Partner, the partner creates the ECA or connected app and includes it in their managed package. If set to Customer, the admin creates the ECA or connected app. Available in API version 62.0. | | ConsentOwner | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The system the customer uses to manage consent levels. Possible values are: - Partner - Salesforce The default value is Salesforce. For example, if set to Salesforce, consent levels are managed by the Salesforce system. If set to Partner, consent levels are managed by the partner’s telephony system. For Bring Your Own Channel for Messaging, this value must be set to Salesforce. | | ConversationVendorInfoId | Type reference Properties Filter, Group, Nillable, Sort Description The ConversationChannelDefinition.ConversationVendorInfoId value used to link this record to the ConversationVendorInfo record. For example, 0m8000000000000123. This field is a relationship field. Relationship Name ConversationVendorInfo Relationship Type Lookup Refers To ConversationVendorInfo | | customEventChnlAddrIdField | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The mapping field that points to the custom field used to point to the ChannelAddressIdentifier field. This field is deprecated in API version 60.0 and will be removed in API version 61.0. Use a combination of customEventTypeField and customEventPayloadField instead. | | CustomEventPayloadField | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The mapping field that points to the custom field used to point to the Payload field in the format <orgNamespace>\_\_<CustomFieldName>\_\_c. This is the API name of the custom Payload field in the custom platform event. For example, devorg\_\_Payload\_\_c. | | customEventRecipientField | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The mapping field that points to the custom field used to point to the Recipient field. This field is deprecated in API version 60.0 and will be removed in API version 61.0. Use a combination of customEventTypeField and customEventPayloadField instead. | | CustomEventTypeField | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The mapping field that points to the custom field used to point to the Platform event type (EventType) field, in the format <orgNamespace>\_\_<CustomFieldName>\_\_c. This is the API name of the custom EventType field in the custom platform event. For example, devorg\_\_EventType\_\_c. | | CustomIconId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description For Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS, this field represents the name of the status resource image used to identify the channel integration, such as a channel logo. For the best results, set the image size to 50px x 50px and save the image in SVG file format. This field is optional. Available in API version 61.0 and later. This field is a relationship field. Relationship Name CustomIcon Relationship Type Lookup Refers To StaticResource | | CustomPlatformEvent | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The API name of the custom platform event created for the Interaction Service API in the format <orgNamespace>\_\_<CustomPlatformEventName>\_\_e. For example, devorg\_\_TestEvent\_\_e. | | CustomerConnectedAppOauthLink | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description DO NOT SET OR CHANGE THIS VALUE. This value is automatically generated. This field represents the OAuth link for the external client app or connected app created by an admin if the ConnectedAppType is Customer. Available in API version 62.0. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the custom metadata type object in the API in the format <Prefix>\_<ConversationChannelDefinition>, where Prefix matches the prefix you gave to the name of the Interaction Service external client app or connected app. For example, Partner1\_ChannelDefinition1, where Partner1 is the prefix and ChannelDefinition1 is the given name. | | EventCapabilitiesIsInboundAcknwOptionExposed | Type boolean Properties Create, Filter, Update Description Indicates whether the partner supports read receipts and delivery receipts for inbound messages (true) or whether the partner doesn’t support these inbound acknowledgments and the functionality is hidden from the Salesforce admin in the Messaging settings (false). The default value is false. This field is available in API version 65.0 and later. Use this field instead of IsInboundReceiptsEnabled. | | EventCapabilitiesIsProgressIndicatorOptExposed | Type boolean Properties Create, Filter, Update Description Indicates whether the partner supports progress indicators for AI agents (true) or whether the partner doesn’t support them and the functionality is hidden from the Salesforce admin in the Messaging settings (false). The default value is false. This field is available in API version 65.0 and later. | | EventCapabilitiesIsRoutingWorkResultSupported | Type boolean Properties Create, Filter, Update Description Indicates whether the Routing Work Result event is sent as a Custom Platform event (true) or not (false). The default value is false. This field is available in API version 65.0 and later. Use this field instead of IsRoutingWorkResultEnabled. | | EventCapabilitiesIsTypingIndicatorOptionHidden | Type boolean Properties Create, Filter, Update Description Indicates whether the partner doesn’t support typing indicators for outbound messages and the functionality is hidden from the Salesforce admin in the Messaging settings (true) or whether outbound typing indicators are supported by the partner (false). The default value is false, meaning the outbound typing indicator feature is supported by default. To disable the outbound typing indicator feature, set this value to true. This field is available in API version 65.0 and later. Use this field instead of IsTypingIndicatorDisabled. | | IsConferenceSupported | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the partner supports conferencing for Bring Your Own Channel (true), or not (false). With conferencing, more than two participants are allowed in a Messaging session. The default is false. This field is available in API version 64.0 and later. | | IsInboundReceiptsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the partner supports read receipts and delivery receipts for inbound messages (true) or whether the partner doesn’t support these inbound acknowledgements and the functionality is hidden from the Salesforce admin in the Messaging settings (false). The default value is false. Available in API versions 63.0 to 65.0. In API version 66.0 and later, this field is removed. Use EventCapabilitiesIsInboundAcknwOptionExposed instead. | | IsRoutingWorkResultEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the Routing Work Result event is sent as a Custom Platform event or not. The default value is false. Available in API versions 64.0 and 65.0. In API version 66.0 and later, this field is removed. Use EventCapabilitiesIsRoutingWorkResultSupported instead. | | IsTypingIndicatorDisabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the partner doesn’t support typing indicators for outbound messages and the functionality is hidden from the Salesforce admin in the Messaging settings (true) or whether outbound typing indicators are supported by the partner (false). The default value is false, meaning the outbound typing indicator feature is supported by default. To disable the outbound typing indicator feature, set this value to true. Available in API versions 63.0 to 65.0. In API version 66.0 and later, this field is removed. Use EventCapabilitiesIsTypingIndicatorOptionHidden instead. | | MasterLabel | Type string Properties Filter, Group, Sort Description The UI label name for the custom metadata type object in the API. This name appears in several places in the UI, so include the partner channel name for easy identification. For example, Channel Definition 1. | | MaxParticipantsForCnfrOverride | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the limit for how many participants can be in a messaging conference. If set, this field overrides the platform limit for the number of participants in a conference. If not set or if set to a value higher than the messaging platform limit, the limit defaults to the messaging platform limit of how many participants can be in a messaging conference at one time. This field is available in API version 64.0 and later. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. NamespacePrefix is null if the publisher is Salesforce. | | RoutingOwner | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The system the customer uses to manage routing for Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS. Possible values are: - Partner - Salesforce The default value is Salesforce. For example, if set to Salesforce, routing is managed by the Salesforce system. If set to Partner, routing is managed by the partner’s system. For Bring Your Own Channel for Messaging, this value must be set to Salesforce. | <!-- document id=43c6e7021fd1675275a87bdcad2aaf2506232294312fb9d436e0267dde942159 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_conversationcontextentry.md --> # ConversationContextEntry Represents the context of a message or an event in the chat history between an agent and a messaging user. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | ConversationContextEntryName | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The autogenerated number of the entry. | | CustomDetailContextKey | Type textarea Properties Create, Nillable Description The key or name of the pre-chat field specified by the admin in the pre-chat implementation, for example, customer\_email. | | CustomDetailContextValue | Type textarea Properties Create, Nillable Description The value entered in the pre-chat field by a user before starting the chat. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The Conversation ID this entry is associated with. | ## 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. [ConversationContextChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. <!-- document id=f100539e8e52a86b001ad835b8795644392a316c3667904aef35835e5b1c892c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_conversationentry.md --> # ConversationEntry Represents a message or event in a voice call or messaging session. The schema on this page only applies to conversation entries for legacy chat. Refer to the ConversationEntry (Off-Core) schema in the [Messaging Object Model](https://developer.salesforce.com/docs/service/messaging-object-model/guide/overview.html) guide to see the ConversationEntry schema for Enhanced Channels. This object is available in API version 43.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To use the ConversationEntry object, enable the Access Conversation Entries user permission, which is available in API version 50.0 and later. Earlier versions do not require permissions. ## Fields | Field | Details | | --- | --- | | ActorId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the author. The possible values can be null or any ID in the following domain set: - BotDefinition - LiveChatVisitor - MessagingEndUser - User This is a polymorphic relationship field. Relationship Name Actor Relationship Type Lookup Refers To MessagingEndUser, User | | ActorName | Type string Properties Create, Filter, Nillable, Sort Description The name of the author sending the message or event. | | ActorType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The author of this entry in the chat history. The valid values include: - Agent - Bot - EndUser - Supervisor - System | | ClientDuration | Type int Properties Create, Filter, Group, Nillable, Sort Description The length in milliseconds for the entry. This field is used with voice messages and other applicable use cases. This value may be 0 if not set by the client. This field is available in API version 51.0 and later. | | ClientTimestamp | Type dateTime Properties Create, Filter, Nillable, Sort Description The timestamp sent by the client when it generated the entry. This field is available in API version 51.0 and later. | | ConversationId | Type reference Properties Create, Filter, Group, Sort Description The MessagingSession ID this entry belongs to. This is a polymorphic relationship field. Relationship Name Conversation Relationship Type Lookup Refers To MessagingSession, VoiceCall | | EntryEndTime | Type datetime Properties Create, Filter, Nillable, Sort Description The timestamp that this entry ended in the chat history. This field is available in API version 48.0 and later. | | EntryTime | Type datetime Properties Create, Filter, Sort Description The timestamp of this entry in the chat history. | | EntryTimeMilliSecs | Type int Properties Create, Filter, Group, Nillable, Sort Description The milliseconds value for the time when an entry was received by the server. Note that the related EntryTime field does not provide millisecond accuracy. This field is available in API version 51.0 and later. | | EntryType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of entry in the chat history. Can be a message (text) or an event. The possible values include: - Text - AdminOptedIn - AdminOptedOut - BotEscalated - ChatbotClosedIdleSession - ChatbotEndedChatByAction—Conversation ended by automated action - ChatbotEndedTransferNotConfigured—Conversation ended because transfer fail is not configured - ChatbotEstablished - ChatbotNotEstablished - EndUserOptedIn - EndUserOptedOut | | HasAttachments | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether a message has attachments associated with it (true) or not (false). | | Message | Type textarea Properties Create, Nillable Description The message or event sent by the author. In ConversationEntry records for enhanced Messaging channels or Messaging for In-App and Web, the Message field is blank due to data storage differences from standard channels. | | MessageDeliverTime | Type datetime Properties Create, Filter, Nillable, Sort Description Unused field reserved for future use. | | MessageIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort Description The unique ID for the message. Maximum size is 36 characters. | | MessageReadTime | Type datetime Properties Create, Filter, Nillable, Sort Description Unused field reserved for future use. | | MessageSendTime | Type datetime Properties Create, Filter, Nillable, Sort Description Unused field reserved for future use. | | MessageStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The status of the message sent by the author. The valid values include: - Delivered - Error - Pending - Read - Sent | | MessageStatusCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The code associated with a message status. MessageStatusCode is only populated when a message is undeliverable | | Seq | Type int Properties Create, Filter, Group, Sort Description The sequence position of this entry in the chat history. | | ServerReceivedTimestamp | Type dateTime Properties Create, Filter, Nillable, Sort Description The timestamp recorded when the server received the entry. This is a unique value and is used for ordering. This value can also be referred to as the “transcripted timestamp.” This field is available in API version 51.0 and later. | ## Usage ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important The schema on this page only applies to conversation entries for legacy chat. The legacy chat product is in maintenance-only mode, and we won't continue to build new features. Refer to the ConversationEntry (Off-Core) schema in the [Messaging Object Model](https://developer.salesforce.com/docs/service/messaging-object-model/guide/overview.html) guide to see the ConversationEntry schema for Enhanced Channels. In standard SMS, WhatsApp, and Facebook Messenger channels, a ConversationEntry record is created for each message sent by a messaging end user or an agent, bot, or automation. Each ConversationEntry record is associated with a MessagingSession record, which represents the interaction between the messaging end user and the business. Access and work with ConversationEntry records like any standard object. You can report on messaging activity and track the conversation workflow end to end. You can also download or delete transcripts, redact sensitive text, and customize your workflows with solutions built on the ConversationEntry object. In enhanced Messaging channels, Messaging for In-App and Web, and Service Cloud Voice ("enhanced channels"), inbound and outbound messages are processed in one of two ways depending on your location. - A ConversationEntry record is created but the Message field is blank, or - No ConversationEntry record is created. To get the fullest picture of conversations in enhanced channels, use Data Cloud, the Connect REST API, or the Conversation Transcript Export tool to access transcripts. See [Accessing Messaging and Voice Conversation Data](https://help.salesforce.com/s/articleView?id=service.conversation_transcript_access.htm&type=5&language=en_US "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note ConversationEntry records aren’t created until the messaging session ends and the agent closes the session tab. One exception is for the first message in any standard messaging session, whose ConversationEntry record is created immediately. <!-- document id=20bc1d3d9e19bc2cd7b7653965670bb1830c00b7298673c8010dce398f9a3a23 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_conversationparticipant.md --> # ConversationParticipant Represents an active participant in a conversation. A new ConversationParticipant record is created each time a participant joins a conversation. This object is available in API version 49.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available for Einstein Conversation Insights customers whose data is stored natively on the Salesforce Platform. If you turned on Einstein Conversation Insights for the first time starting in Spring ’26, this object is available to query and access using Salesforce tools. For existing ECI customers, data migration and access to related Salesforce Platform objects is scheduled to begin in Summer ’26. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AppType | Type string Properties Filter, Group, Nillable, Sort Description The type of app used by the participant, such as messaging, chatbot, live\_message, agent. The nillable property is available in API version 51.0 and later. | | ConversationId | Type reference Properties Filter, Group, Nillable, Sort Description The record ID of the conversation that this participant is part of. | | JoinedTime | Type dateTime Properties Filter, Sort Description The date and time that a participant joined a conversation. | | LastActiveTime | Type dateTime Properties Filter, Sort Description The date and time that a participant was last active during a conversation. | | LeftTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time that a participant left a conversation. | | Name | Type string Properties Defaulted on create, Filter, idLookup, Sort Description The internal name of the conversation participant record. The value is the Salesforce record ID of the ConversationParticipant record or an auto-incremented number string. If your integration sorts records by Name, use JoinedTime instead. | | ParticipantContext | Type string Properties Filter, Group, Nillable, Sort Description An identifier, such as a Facebook page, to add context about this participant. | | ParticipantEntityId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the record connected to this participant record, such as a Contact, Messaging End User, or User record. | | ParticipantKey | Type string Properties Filter, idLookup, Group, Nillable, Sort Description A value that uniquely identifies this participant. | | ParticipantRole | Type string Properties Filter, Group, Nillable, Sort Description The role of this participant in the conversation, such as Agent, End User, or Supervisor. | <!-- document id=3b9817d5660651e48237febf2d9976b1a6e45c1be3263c76f7cc29852e1cb406 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_conversationvendorinfo.md --> # ConversationVendorInfo This setup object connects the partner vendor system to the Service Cloud feature. For example, for Salesforce Voice with Telephony Providers, this object contains information about the partner telephony or Contact Center as a Service (CCaaS) partner system. For Bring Your Own Channel for Messaging this object contains information about the partner messaging system, and for Bring Your Own Channel for CCaaS, this object contains information about the CCaaS partner system. This object is available in API version 52.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Service Cloud Voice is now Salesforce Voice. You may see references to Service Cloud Voice in Salesforce applications and documentation. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This object requires an add-on license for Salesforce Voice for Partner Telephony or Digital Engagement. ## Fields The fields in the ConversationVendorInfo object apply to all Service Cloud features unless otherwise stated in the field description. For example, if a field applies to just one Salesforce Voice telephony model setup or is applied differently by different partner systems, this is stated in the field description. | Field | Details | | --- | --- | | AwsAccountKey | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The 12-digit AWS subaccount ID that’s automatically provisioned for you when Salesforce Voice was turned on. Available in API version 55.0 and later. Applies to the following implementation: - Salesforce Voice with Amazon Connect | | AwsRootEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address used by Salesforce to create the root user for the provisioned AWS subaccount when Salesforce Voice was turned on. Available in API version 55.0 and later. Applies to the following implementation: - Salesforce Voice with Amazon Connect | | AwsTenantVersion | Type double Properties Create, Filter, Nillable, Sort, Update Description The version number of the SVCTenantStack AWS CloudFormation stack that’s deployed. The stack is deployed in AWS region "us-east-1". Available in API version 55.0 and later. Applies to the following implementation: - Salesforce Voice with Amazon Connect | | agentSSOSupported | Type boolean Properties Create, Filter, Group, Update Description If set to true, agents can single sign-on (SSO) into their contact center using Salesforce as the identity provider (IdP). Behind the scenes, Salesforce is used as the SAML IdP in the Single Sign-On external client app for the contact center. If set to false, an IdP other than Salesforce is used or an IdP isn’t used at all. The default value is false. If this value is set to false and you want to use Salesforce as the IdP for your contact center, set this value and the namedCredentialSupported value to true and configure the service\_cloud\_voice.PartnerSSO interface in your Apex integration class. Available in API version 53.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | BridgeComponent | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Lightning component used to communicate between the telephony or messaging system and other Lightning components. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | CapabilitiesSupportsIntelligence | Type boolean Properties Create, Filter, Update Description If set to true, Salesforce ingests real-time signals sent from a partner telephony system. If set to false, Salesforce doesn't ingest real-time intelligence signals from a partner telephony system. The default value is false. Available in API version 59.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony | | CapabilitiesSupportsKeyProvisioning | Type boolean Properties Create, Filter, Update Description If set to true, Salesforce has permission to automatically provision public keys to contact centers. The default value is false. Available in API version 54.0 and later. Applies to the following implementation: - Salesforce Voice with Partner Telephony | | CapabiltiesSupportsMultiVendorConfig | Type boolean Properties Create, Filter, Update Description Indicates whether multiple Connector URLs are supported (true) or not supported (false) for contact centers. The default value is false. Available in API version 65.0 and later. Applies to this telephony model: - Salesforce Voice with Partner Telephony | | CapabilitiesSupportsPartnerPhoneNumbers | Type boolean Properties Create, Filter, Update Description If set to true, Salesforce has permission to access relevant agents’ phone numbers while configuring contact center channels. The default value is false. Available in API version 54.0 and later. Applies to the following implementation: - Salesforce Voice with Partner Telephony | | CapabilitiesSupportsQueueManagement | Type boolean Properties Create, Filter, Update Description If set to true, support queue management. The default value is false. Available in API version 56.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | CapabilitiesSupportsUnifiedRouting | Type boolean Properties Create, Filter, Update Description Indicates whether unified routing is supported (true) or not supported (false) for inbound voice calls in voice channels. The default value is false. Once this value is set to true, it can’t be changed to false. Available in API version 63.0 and later. Applies to the following implementation: - Salesforce Voice with Partner Telephony | | ClientAuthMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The client authentication mode. Possible values are: - Custom - Mixed - SSO Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect | | ConnectorUrl | Type url Properties Create, Filter, Group, Sort, Update Description The URL that hosts your Salesforce Voice or Bring Your Own Channel for CCaaS connector. This value could be a Visualforce page or a public URL. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | customConfig | Type CustomEntityDefinition Properties Create, Filter, Group, Update Description The foreign key to the CustomEntityDefinition, which contains partner-specific custom settings. Available in API version 53.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | CustomIconId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the static resource used to identify the contact center integration, such as a Contact Center as a Service (CCaaS) provider logo. The static resource must be in SVG format. This field is optional. Available in API version 62.0 and later. This field is a relationship field. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Bring Your Own Channel for CCaaS This field is a relationship field. Relationship Name CustomIcon Refers To StaticResource | | CustomLoginUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL that hosts your telephony system or CCaaS system login page. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS (supported when combined with a telephony CCaaS integration) | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName or View Setup and Configuration permissions can view, group, sort, and filter this field. | | IsTaxCompliant | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Amazon tax settings for the AWS subaccount provisioned for Salesforce Voice have been confirmed (true). The default value is false. Available in API version 55.0 and later. Applies to the following implementation: - Salesforce Voice with Amazon Connect | | einsteinConversationInsights Supported | Type boolean Properties Create, Filter, Group, Update Description If set to true, Einstein Conversation Insights is turned on. The default value is false. Available in API version 53.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect | | integrationClass | Type ApexClass Properties Create, Filter, Group, Update Description The foreign key to the partner Apex class implementing supported interfaces. Available in API version 53.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | IntegrationClassName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Deprecated in API version 53.0. Don't set this field. Instead, use integrationClass. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect | | keyProvisioningSupported | Type boolean Properties Create, Filter, Group, Update Description If set to true, key provisioning and renewal are automated. The default value is false. Available in API version 54.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the master label (MasterLabel) in the user interface. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The partner vendor's display name as it appears in the UI. This name appears in several places in the UI, so include the partner vendor name for easy identification. For Salesforce Voice, this label also represents the telephony provider name in the contact center record. For Salesforce Voice with Amazon Connect, this field is always set to Service Cloud Voice. | | namedCredential | Type Named Credential Properties Create, Filter, Group, Update Description A sample-named credential that can be used for Apex callouts to the partner system. Available in API version 53.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | namedCredentialSupported | Type boolean Properties Create, Filter, Group, Update Description If set to true and if supported by the partner telephony, then prescriptive setup through a named credential is enabled allowing server-to-server communication with a named credential. Available in API version 53.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that’s associated with this object. Applies to the following implementations: - Salesforce Voice with Amazon Connect - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | partnerContactCenterList Supported | Type boolean Properties Create, Filter, Group, Update Description If set to true, enables the customer to select one contact center from a list of multiple contact centers to connect with Salesforce. The default value is false. Available in API version 53.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | partnerPhoneNumbersSupported | Type boolean Properties Create, Filter, Group, Update Description If set to true, displays a list of phone numbers used to create contact center channels. The default value is false. Available in API version 54.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect | | partnerTransfer DestinationsSupported | Type boolean Properties Create, Filter, Group, Update Description If set to true, allows Salesforce to fetch contact center queues so that Salesforce and contact center queues can be mapped. The default value is false. Available in API version 53.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | phoneNumberProcurementSupported | Type boolean Properties Create, Filter, Group, Update Description If set to true, reps can procure and claim phone numbers from your telephony system's inventory when setting up a contact center. The default value is false. To turn on phone number procurement, set this value to true and configure the service\_cloud\_voice.VFSProvider interface in your Apex integration class. Available in API version 66.0 and later. Applies to the following implementation: - Salesforce Voice with Partner Telephony | | ServerAuthMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Deprecated in API 53.0. Server authentication mode. Set this value to None. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect | | TelephonySettingsComponent | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the Lightning Web Component (LWC) that is used to display additional agent settings in the Omni-Channel widget. This value is in the format mynamespace:componentName, where mynamespace is the namespace associated with the Service Cloud Voice package that was created, and componentName is the FQDN of the Lightning component. Available in API version 54.0 and later. Applies to the following implementation: - Salesforce Voice with Partner Telephony | | ​​universalCallRecording AccessSupported​​​​​​​​ | Type boolean Properties Create, Filter, Group, Update Description If set to true, Universal Call Recording Access is turned on. The default value is false. If this value is set to false and you want to turn on Universal Call Recording, set this value to true and configure the service\_cloud\_voice.RecordingMediaProvider interface in your Apex integration class. Available in API version 54.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect | | userSyncingSupported | Type boolean Properties Create, Filter, Group, Update Description If set to true, supports automated user syncing whenever a user is added to or removed from a contact center. The default value is false. Available in API version 53.0 and later. Applies to the following implementations: - Salesforce Voice with Partner Telephony - Salesforce Voice with Partner Telephony from Amazon Connect - Bring Your Own Channel for CCaaS | | vendorType | Type picklist Properties Create, Filter, Group, Update Description The Service Cloud feature the partner vendor supports. Possible values are: - Amazon\_Connect — For Salesforce Voice with Amazon Connect. - BringYourOwnChannelPartner — For Bring Your Own Channel for Messaging. Available in API version 60.0 and later. - BringYourOwnContactCenter — For Bring Your Own Channel for Contact Center as a Service (CCaaS). Available in API version 60.0 and later. - ServiceCloudVoicePartner — For Salesforce Voice with Partner Telephony or Salesforce Voice with Partner Telephony from Amazon Connect. If you're inserting or updating the record, this field must be set. Available in API version 53.0 and later. | | voicemailPersonalizationSupported | Type boolean Properties Create, Filter, Group, Update Description If set to true, reps can personalize voicemail greetings that are stored in your telephony system. The default value is false. To turn on voicemail personalization, set this value to true and configure the service\_cloud\_voice.VFSProvider interface in your Apex integration class. Available in API version 66.0 and later. Applies to the following implementation: - Salesforce Voice with Partner Telephony | <!-- document id=62351c1ba6080c19f7991e7e42378c215df13112fcfc2dfe15ebcfca35a328cc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_convintelligencesignalrule.md --> # ConvIntelligenceSignalRule Represents a conversation intelligence signal rule. The rule triggers actions based on real-time intelligence signals from your telephony system or keywords mentioned by support reps or customers. The rule contains a set of conditions (subrules) and the filter logic used to evaluate those conditions to determine whether to trigger actions. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This type requires an add-on license for Salesforce Voice for Amazon Connect, Salesforce Voice for Partner Telephony with Amazon Connect, Salesforce Voice for Partner Telephony, or Digital Engagement. ## Fields | Field | Details | | --- | --- | | ActionType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Action to take based on the conversation intelligence signal detected during a conversation. Possible values are: Possible values are: - AlertSupervisor–Sends an alert to the supervisor. - AlertSupervisorAndAgent–Sends an alert to the rep and supervisor. - LaunchFlow–Triggers an auto-launched flow. If set, also set ActionValue. - LaunchNBA–Recommends the next best action to the rep. | | ActionValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Action to perform based on the ActionType specified. If ActionType is set to LaunchFlow, this value is the DeveloperName of the flow to be launched. For example, EmailAlert. For all other ActionType values, don’t set this parameter. | | ConversationChannelId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID (ChannelAddressIdentifier) of the Messaging channel or name (InternalName) of the Voice channel. This field is a polymorphic relationship field. Relationship Name ConversationChannel Refers To CallCenter, MessagingChannel | | Criteria | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. Filter logic applied to the rule conditions (subrules). For example, ((1 AND 2) OR 3). The numbers in the formula are derived from the ConvIntelligenceSignalSubrule.Order value plus 1. For example, filter logic (1 AND 2) is calculated by adding the first condition (Order\=0) with the second condition (Order\=1). | | DeveloperName | Type string Properties Required. Create, Filter, Group, Sort, Update Description API name of the conversation intelligence signal rule. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates whether the conversation intelligence signal rule is active (true) or inactive (false). The default value is false. | | Label | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the conversation intelligence signal rule. | | ParticipantRole | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If Service is set to KeywordMatch, this value determines whether the rule applies to utterances made by reps, customers, or both roles. Possible values are: Possible values are: - Agent - AgentOrCustomer - Customer If Service is not set to KeywordMatch, don’t set this parameter. | | Service | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Salesforce- or partner-provided intelligence source. For Salesforce-provided intelligence sources, set this parameter to KeywordMatch. For partner-provided intelligence sources, possible values are: - AmazonConnectContactLens If none of the options apply to you, contact your Salesforce representative for the service name. | <!-- document id=238a6bd54038d34ccf2a0ed55eda3c9e7aad595273d000f3322df32397baf6f3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_convintelligencesignalsubrule.md --> # ConvIntelligenceSignalSubRule Represents a condition (subrule) within a conversation intelligence signal rule. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This type requires an add-on license for Salesforce Voice for Amazon Connect, Salesforce Voice for Partner Telephony with Amazon Connect, Salesforce Voice for Partner Telephony, or Digital Engagement. ## Fields | Field | Details | | --- | --- | | ConvIntelligenceSignalRuleId | Type reference Properties Create, Filter, Group, Sort Description Unique ID of the conversation intelligence signal rule. This field is a relationship field. Relationship Name ConvIntelligenceSignalRule Relationship Type Master-detail Refers To ConvIntelligenceSignalRule (the master object) | | OperandValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Value of the signal type used to determine if the rule condition is met. For example, escalate\_level\_1. | | Operator | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Filter logic operator used to determine if the rule condition is met. Possible values are: - Equals - GreaterThan - LessThan - NotEquals | | Order | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Order the condition appears in relation to the other conditions in the list, with zero (0) being the first condition listed. If Type is set to Keyword, the maximum value is 24. For all other Type values, the maximum value is 4. This value is used when applying filter logic to the rule. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Type of conversation intelligence signal used by the rule to determine whether to trigger an action. This value depends on the ConvIntelligenceSignalRule.ConversationChannelId and ConvIntelligenceSignalRule.Service values. If Service is set to KeywordMatch, possible values are: - Keyword–A word or group of words spoken or typed. If Service is set to AmazonConnectContactLens, possible values are: - Category–Category name defined in your telephony system. If Service is set to another value, contact your Salesforce representative for the conversation intelligence signal types available for your intelligence source. | <!-- document id=e8d1e56761b3f4b23d931d70aecdf568ba341171edec1340bd981eeeadbba1c2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_convmessagesendrequest.md --> # ConvMessageSendRequest Represents a request to send a template-based messaging component to a series of messaging users in an enhanced messaging channel or Messaging for In-App. This object is available in API version 60.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Messaging and its associated objects are available only in Enterprise, Unlimited, and Developer Editions for Service Cloud or Sales Cloud with the Digital Engagement add-on license.  ## Fields | Field | Details | | --- | --- | | AllowExistingSessionStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates whether the message can be sent only at certain times. Possible values are: - Any—Send the message regardless of whether the messaging user is engaged in an active messaging session with the business. - Closed—Send the message unless the messaging user is engaged in a messaging session with a status other than Error or Ended, in which case it’s never sent. - NonActive—Send the message unless the messaging user is engaged in a messaging session with a status of Active, in which case it’s never sent. | | CommSubscriptionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related communication subscription, if applicable. This field is a relationship field that refers to CommSubscription. | | CompletedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the request completes and all messages associated with the request are sent or failed to be sent. | | FailedMessageCount | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of messages that failed to be delivered to a messaging user. For example, if a flow sends the message to 50 messaging users and 4 don’t receive the message, this value is 4. | | FailedMessageErrorReasons | Type textarea Properties Nillable Description The error reason for each of the failed messages. For example, if 4 messages fail to send, this field shows the error reason for each failed message. | | FailedMessageIdentifiers | Type textarea Properties Nillable Description The IDs of the messages that failed to send. For example, if 4 messages fail to send, this field shows 4 message IDs. | | FailedMeuPlatformKeys | Type textarea Properties Filter, Group, Nillable, Sort Description A list of platform keys for messaging end users with messages that failed to send. Available in API version 65.0 and later. | | InProgressMessageCount | Type int Properties Defaulted on Create, Filter, Group, Sort Description The number of messages in the process of being sent. | | InProgressMessageIdentifiers | Type textarea Properties Filter, Group, Nillable, Sort Description A list of IDs of the messages being sent. | | InProgressMessagingEndUserIds | Type textarea Properties Filter, Group, Nillable, Sort Description A list of IDs of messaging end users with messages that are being sent. Available in API version 65.0 and later. | | InProgressMessagingSessionIds | Type textarea Properties Filter, Group, Nillable, Sort Description A list of IDs of messaging sessions with messages that are being sent. Available in API version 65.0 and later. | | InProgressMeuPlatformKeys | Type textarea Properties Filter, Group, Nillable, Sort Description A list of platform keys for messaging end users with messages that are being sent. Available in API version 65.0 and later. | | MessageDefinition | Type string Properties Filter, Group, Sort Description The name of the messaging component being sent. Only active messaging components can be sent. | | MessageDefinitionParameters | Type textarea Properties Nillable Description A list of parameters used to dynamically construct the message that is being sent. Available in API version 65.0 and later. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated ID for the request that uses the format MSJ-{00000000}. | | PendingMessageCount | Type int Properties Filter, Group, Sort Description The number of messages that haven’t yet been sent. | | PendingMessageEndUserIds | Type textarea Properties Nillable Description A list of IDs of the messaging end users with pending messages. Available in API version 65.0 and later. | | PendingMeuPlatformKeys | Type textarea Properties Nillable Description A list of platform keys of the messaging end users with pending messages. Available in API version 65.0 and later. | | PendingMessageIdentifiers | Type textarea Properties Nillable Description A list of IDs of the pending messages. | | RequestConsentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the flow applies the consent settings of the messaging end user or the communication subscription. Possible values are: - CommunicationSubscription - MessagingEndUser | | RequestStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the request. Possible values are: - Completed - Pending - In Progress—The system is actively trying to send the message. If a message can’t be sent, the RequestStatus returns to Pending and sending is tried again later. | | RequestType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of request. Possible values are: - SendNotificationMessages | | SessionLongevityPreference | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether to end the session after the message is sent. Possible values are: - KeepSessionOpen—After the flow sends the message, keep the messaging session in a New state. If the end user doesn’t respond within 48 hours, the session ends. Use this option if you expect customers to respond to automated messages and want service reps to see their response in context. - EndSession—After the flow sends the message, end the messaging session. If the customer responds, a new messaging session is created and routed to your support team. - KeepSessionOpenOrAppend—If there’s an existing session with the messaging end user in the New state, use that session to send the message. Otherwise, follow the behavior documented for the KeepSessionOpen option. Available in API version 65.0 and later. | | ShouldEnforceChannelConsent | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the existing Messaging channel consent preferences are applied when determining who receives the message. Setting this value to true is the most common approach. The default value, false, allows you to add custom consent logic—for example, to customize a flow to send the message to both implicitly opted-in users and explicitly opted-in users. | | SuccessMessageCount | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of messages that were successfully sent to messaging users. Delivery can occur much later than sending, depending on factors such as the connectivity status of the recipient. Delivery is reflected in the messaging session transcript. | | SuccessMessageIdentifiers | Type textarea Properties Nillable Description A list of IDs of the messages that were sent. | | SuccessMeuPlatformKeys | Type textarea Properties Filter, Group, Nillable, Sort Description A list of platform keys for messaging end users with messages that were sent. Available in API version 65.0 and later. | | TotalMessageCount | Type int Properties Filter, Group, Nillable, Sort Description The number of messages that the related flow attempted to send. This field is a calculated field. | ## Usage A ConvMessageSendRequest can be generated by a flow, Apex code, or REST API call that invokes the sendConversationMessages invocable action. Use the ConvMessageSendRequest object to query messages sent by the sendConversationMessages invocable action. <!-- document id=22f34342e410a60e2584b90e3b402ced9d70de2e86bd2ea01e14c4e9cafb22a9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_cors_violation.md --> # CORS Violation Record Event Type CORS Violation Record events capture information about Cross-Origin Resource Sharing (CORS) violations. Cross-origin requests to Lightning apps are blocked unless the request comes from a URL listed in your CORS allowlist. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="event-type-desc"><a name="event-type-desc"></a>The type of event.</span> The value is always <samp class="codeph nolang">CorsViolation</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">HOST</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The URL of the requested Salesforce resource.</dd><dd class="dd"><span class="ph" id="host_origin_desc"><a name="host_origin_desc"></a>If JavaScript code at <span class="ph filepath">https://www.example.com</span> requests a resource from <span class="ph filepath">https://www.salesforce.com</span>, the origin is <span class="ph filepath">https://www.example.com</span> and the host is <span class="ph filepath">https://www.salesforce.com</span>.</span></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the organization.</dd><dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORIGIN</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The URL of the site making the cross-origin request to Salesforce.</dd><dd class="dd">If JavaScript code at <span class="ph filepath">https://www.example.com</span> requests a resource from <span class="ph filepath">https://www.salesforce.com</span>, the origin is <span class="ph filepath">https://www.example.com</span> and the host is <span class="ph filepath">https://www.salesforce.com</span>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd><dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. Timezone is GMT.</dd></dl></td></tr></tbody></table> <!-- document id=eb3df5f3f784fe1f90292fadaf27a5ef3b7d008b629e9a7aabdb24e2bed32187 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_corswhitelistentry.md --> # CorsWhitelistEntry Represents an entry in the cross-origin resource sharing (CORS) allowlist. Origins included in the allowlist can request REST resources from that Salesforce org. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls create(), delete(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description This picklist contains the following fully-supported languages: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Primary label for the CORS allowlist entry. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description For managed packages, this field is the namespace prefix assigned to the package. For unmanaged packages, this field is blank. | | UrlPattern | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The origin URL pattern must include the HTTPS protocol (unless you’re using your localhost) and a domain name, and can include a port. The wildcard character (\*) is supported and must be in front of a second-level domain name. For example, https://\*.example.com adds all subdomains of example.com to the allowlist. The origin URL pattern can be an IP address. But an IP address and a domain that resolve to the same address aren’t the same origin, and you must add them to the CORS allowlist as separate entries. Google Chrome™ and Mozilla® Firefox® browser extensions are also allowed as resources in API version 53 and later. Chrome extensions must use the prefix chrome-extension:// and 32 characters without digits or capital letters, for example chrome-extension://abdkkegmcbiomijcbdaodaflgehfffed. Firefox extensions must use the prefix moz-extension:// and an 8-4-4-4-12 format of small alphanumeric characters, for example moz-extension://1234ab56-78c9-1df2-3efg-4567891hi1j2. | ## Usage Cross-Origin Resource Sharing (CORS) allows web browsers to request resources from other origins. For example, using CORS, the JavaScript for a web application at https://www.example.com can request a resource from https://www.salesforce.com. To allow access to supported Salesforce APIs, Apex REST resources, and Lightning Out from JavaScript code in a web browser, add the requesting origin to your Salesforce CORS allowlist. If a browser that supports CORS makes a request to an origin in the Salesforce CORS allowlist, Salesforce returns the origin in the Access-Control-Allow-Origin HTTP header, along with any additional CORS HTTP headers. If the origin isn’t included in the allowlist, Salesforce returns HTTP status code 403. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important CORS doesn’t support requests for unauthenticated resources, including OAuth endpoints. You must pass an OAuth token with requests that require it. [CORS](http://www.w3.org/TR/cors/ "HTML (New Window)") is a W3C recommendation to enable browsers to request resources from origins other than their own. <!-- document id=588fa711783bbdab07bcb078a16183f21f9500e5d928645b9b90995e236f255a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_coupon.md --> # Coupon A coupon associated with a promotion. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The Coupon object is available if the B2B Commerce or Marketing license is enabled. ## Fields | Field | Details | | --- | --- | | BusinessUnitId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The business unit associated with the coupon. This field is a relationship field. Relationship Name BusinessUnit Refers To BusinessUnit | | CouponCode | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Coupon code for the coupon. A buyer can use the coupon code to qualify for a promotion. | | CouponListName | Type string Properties Create, Filter, Nillable, Sort, Update Description Display name of the coupon. It’s different from the auto-generated system name and provides context for identifying the coupon's campaign purpose. It applies only to multi-code coupons. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the coupon. | | EndDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The end date and time when the coupon is no longer active. | | IsNewCodePerAssignment | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a new code is generated for each assignment. This field applies only to coupons of multi-code type. The default value is false. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the coupon. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of this coupon. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PromotionId | Type reference Properties Create, Filter, Group, Sort Description ID of the promotion associated with the coupon. Optional for coupons of multi-code type. This is a relationship field. Relationship Name Promotion Relationship Type Lookup Refers To Promotion | | RedemptionLimitAllBuyers | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times this coupon can be used in total. This field is available in API version 61.0 and later. | | RedemptionLimitPerBuyer | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times this coupon can be used per customer. This field is available in API version 61.0 and later. | | StartDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The start date and time when the coupon is active. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Status of the coupon. Possible values are: - Active - Inactive The default value is Inactive | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of coupon. Use Single-Code or leave the field blank to create Commerce batch coupons with one shared code. Use Multi-Code for marketing campaigns to distribute unique codes to individual recipients. This field is available only when both Commerce and Marketing licenses are enabled. Possible values are: - Multi-Code - Single-Code | | Value | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the coupon. This field applies only to coupons of multi-code type. | ## 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. [CouponChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. <!-- document id=988be8e4257c12477d5b9b5b6a6f524f3908fc17e4f777ca0b6e069ba293bb8e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_couponcoderedemption.md --> # CouponCodeRedemption Tracks each coupon code redemption. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available through the B2B Commerce license. To access this object, the Promotions Coupon Redemption Limit user permission must be assigned. ## Fields | Field | Details | | --- | --- | | Buyer | Type string Properties Create, Filter, Group, Sort Description Information about the buyer. Can be any buyer-specific information. | | CouponId | Type reference Properties Create, Filter, Group, Sort Description ID of the redeemed coupon. This field is a relationship field. Relationship Name Coupon Relationship Type Lookup Refers To Coupon | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Salesforce generated coupon code, such as CCR-000000002. Can’t be edited. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who created the coupon code redemption. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Transaction | Type string Properties Create, Filter, Group, idLookup, Sort Description ID of the transaction where the coupon code was redeemed. Must be a valid cart ID. | <!-- document id=ff4c00dccf268a91670607366d3352c7d903220c65886d1a029321ff66f6f545 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_creditmemo.md --> # CreditMemo Represents a document that is used to reduce the amount that a buyer owes a seller under the terms of an earlier invoice. This object is available in API version 48.0 and later. A credit memo always decreases the balance of an invoice. Users can apply positive credit memos to positive invoices, for example, a $10 credit memo reduces the balance of a $100 invoice line to $90. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Special Access Rules This object is available with Order Management, Subscription Management, and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_creditmemo.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | AppType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Read-only field that indicates which Salesforce application generated the credit memo. Possible values are: - Commerce Cloud - Revenue Cloud This field is available in API versions 54.0 to 55.0 | | Balance | Type currency Properties Filter, Nillable, Sort Description Amount of the credit memo that's available for allocation. | | BillToContactId | Type reference Properties Filter, Group, Nillable, Sort, Update Description Inherited from the account’s Bill to Account field. This field is a relationship field. Relationship Name BillToContact Relationship Type Lookup Refers To Contact | | BillingAccountId | Type reference Properties Filter, Group, Sort, Update Description The customer account associated with this credit memo. This field is a relationship field. Relationship Name BillingAccount Relationship Type Lookup Refers To Account | | CreationMode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the credit memo originated in Salesforce or an external system. Possible values are: - External - Salesforce This field is available in API version 55.0 and later. | | CreditDate | Type date Properties Filter, Group, Nillable, Sort Description The date when the credit memo was posted. | | CreditMemoNumber | Type string Properties Filter, Group, Nillable, Sort, Update Description A credit memo numbering alternative to DocumentNumber, containing a number in a format of your choice. Credit memo numbering is optional. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the credit memo. The default value is USD. This field is available in API version 55.0 and later. | | Description | Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the credit memo. | | DocumentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated number for organizing financial documents, for example DOC-0000123. | | EffectiveDate | Type date Properties Filter, Group, Nillable, Sort Description Represents the effective date of the credit memo. If this field is empty, the credit date is used. For reporting purposes only; this field drives no other logic. This field is available in API version 55.0 and later. | | ExternalReference | Type string Properties Filter, Group, Nillable, Sort, Update Description Contains an external system’s ID for the credit memo. This field is available in API version 55.0 and later. | | ExternalReferenceDataSource | Type string Properties Filter, Group, Nillable, Sort, Update Description Contains the name of the external system that also contains the credit memo. This field is available in API version 55.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was only referenced (LastReferencedDate) and not viewed. | | NetCreditsApplied | Type currency Properties Filter, Nillable, Sort Description Represents the total difference between the credit applied to and credit unapplied from the invoice. This field is a calculated field. This field is available in API version 55.0 and later. | | OwnerId | Type reference Properties Filter, Group, Sort, Update Description The user who owns a credit memo record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ReferenceEntityId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The ID of the record that this credit memo was generated from. For example, the order, order summary, or invoice. This field is a polymorphic relationship field. Relationship Name ReferenceEntity Relationship Type Lookup Refers To Invoice, Order This field is available in API version 53.0 and later. | | SourceAction | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates which Salesforce API created the credit memo. Possible values are: - Invoice—Indicates that Credit Invoice API created the credit memo and applied it to the invoice. - NegativeInvoiceLineConversion—Indicates that Subscription Management created the credit memo when a negative invoice line was converted. - Standalone—Indicates that the Credit Memo API created the credit memo. - VoidPostedInvoice—Indicates that the Void a Posted Invoice API created the credit memo to offset the amount that was voided on the invoice. This field is available in API version 55.0 and later. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description Status of the credit memo. Possible values are: - Canceled—Indicates that the credit memo isn't being used and doesn't have a financial impact. - Error—Indicates that the credit memo has an error and doesn’t have a financial impact. - Pending—Indicates that the credit memo is being processed but hasn't yet been posted as a financial transaction. - Posted—The credit memo has been recorded as a financial transaction. Most fields can’t be edited. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description Sum of TotalAmount values for the credit memo’s adjustment lines. This field is a calculated field. | | TotalAdjustmentAmountWithTax | Type currency Properties Filter, Nillable, Sort Description The sum of the credit memo’s adjustment line amounts, including tax. This field is available in API version 49.0 and later. | | TotalAdjustmentTaxAmount | Type currency Properties Filter, Nillable, Sort Description The sum of the credit memo’s adjustment line tax. Adjustment line balances are excluded. This field is available in API version 49.0 and later. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description Sum of the credit memo’s TotalLineAmount and TotalAdjustmentAmount. This field is a calculated field. | | TotalAmountWithTax | Type currency Properties Filter, Nillable, Sort Description Total credit memo amount, with tax included. This field is a calculated field. | | TotalChargeAmount | Type currency Properties Filter, Nillable, Sort Description Sum of TotalAmount values for the credit memo’s charge lines. This field is a calculated field. | | TotalChargeAmountWithTax | Type currency Properties Filter, Nillable, Sort Description The sum of the credit memo’s charge line amounts, including tax. This field is available in API version 49.0 and later. | | TotalChargeTaxAmount | Type currency Properties Filter, Nillable, Sort Description This field is available in API version 49.0 and later. | | TotalCreditAmountApplied | Type currency Properties Filter, Nillable, Sort Description Credit memo amount that's been applied to invoices. This field is available in API version 53.0 and later. | | TotalCreditAmountUnapplied | Type currency Properties Filter, Nillable, Sort Description Credit memo amount that's been unapplied from invoices. This field is available in API version 55.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Sum of TotalAmount values for the credit memo’s tax lines. This field is a calculated field. | ## Associated Objects This object has the following associated objects. If the API version isn’t specified, the associated objects are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. [CreditMemoFeed](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. [CreditMemoHistory](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. [CreditMemoOwnerSharingRule](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. [CreditMemoShare](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. <!-- document id=50b46b8c8c31b44cce94ab8e68bb9a5a10d7068091c893eb77ff5b65f713a3b8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_creditmemoaddressgroup.md --> # CreditMemoAddressGroup Stores the buyer's address information, which is used to determine the amount of tax to credit to a buyer when a credit memo is issued. This object is available in API version 55.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_creditmemoaddressgroup.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Address | Type address Properties Filter, Nillable Description Buyer’s address. | | City | Type string Properties Filter, Group, Nillable, Sort Description Buyer's city. | | Country | Type string Properties Filter, Group, Nillable, Sort Description Buyer's country. | | CreditMemoAddressGroupNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number, such as 0000123, that represents the address group. | | CreditMemoId | Type reference Properties Filter, Group, Sort Description ID of the credit memo associated with the address group. This field is a relationship field. Relationship Name CreditMemo Relationship Type Lookup Refers To CreditMemo | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the credit memo. The default value is USD. | | GeocodeAccuracy | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The accuracy rating for the geocode of the address group. An accuracy rating contains information about the location of a latitude and longitude. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this address group. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this address group. | | Latitude | Type double Properties Filter, Nillable, Sort Description Latitude of the buyer’s address. | | Longitude | Type double Properties Filter, Nillable, Sort Description Longitude of the buyer’s address. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort Description The buyer’s postal code or ZIP code. | | State | Type string Properties Filter, Group, Nillable, Sort Description The buyer’s state. | | Street | Type textarea Properties Filter, Group, Nillable, Sort Description The buyer’s street number and name. | ## 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. [CreditMemoAddressGroupHistory](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. <!-- document id=4d39ad1a4a6503b5bd15aa29900de24e1f9ecbc360f47da566dd279da2ebe375 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_creditmemoinvapplication.md --> # CreditMemoInvApplication Represents an amount applied from a credit memo to an invoice. This object is available in API version 48.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_creditmemoinvapplication.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Filter, Sort Description The amount of the credit memo that was applied to or unapplied from the invoice. | | AppliedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the credit memo was applied. If the credit memo invoice application's type is Unapplied, this value is inherited from the Applied date of the credit memo referenced in the AssociatedLineId. | | AssociatedLineId | Type reference Properties Filter, Group, Nillable, Sort Description For a credit memo invoice application that represents an unapplied credit memo, this field shows the original credit memo invoice application. This field is a relationship field. Relationship Name AssociatedLine Relationship Type Lookup Refers To CreditMemoInvApplication | | CreditMemoBalance | Type currency Properties Filter, Nillable, Sort Description The balance of a credit memo after a credit memo is applied or unapplied. This field is a snapshot of the credit memo's balance after the action. It isn't updated after further changes to the credit memo balance. | | CreditMemoId | Type reference Properties Filter, Group, Sort Description The credit memo that was applied or unapplied. This field is a relationship field. Relationship Name CreditMemo Relationship Type Lookup Refers To CreditMemo | | CreditMemoInvoiceNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Number of the invoice to which a credit memo is applied. | | Date | Type dateTime Properties Filter, Nillable, Sort Description Date when the credit memo amount was applied to the invoice. | | Description | Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the credit applied to an invoice. | | EffectiveDate | Type dateTime Properties Filter, Nillable, Sort Description The effective date of the application or unapplication of credit. Users can provide this value when applying or unapplying the credit memo. This field is optional and provided only for reporting purposes. It doesn't affect the credit memo invoice application's other fields. | | HasBeenUnapplied | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Shows whether this credit memo application has been unapplied from the target invoice. Possible values are: - NA - No - Yes | | ImpactAmount | Type currency Properties Filter, Nillable, Sort Description The net adjustment to the invoice's balance after a credit memo is applied or unapplied. If a credit memo was applied, this value is the negative version of the credit memo invoice application's Amount. If a credit memo was unapplied, this value is the positive version of the credit memo invoice application's Amount. This field is a calculated field. | | InvoiceBalance | Type currency Properties Filter, Nillable, Sort Description The balance of the credit memo after a credit memo is applied or unapplied. This field is a snapshot of the credit memo's balance after the action. It isn't updated after further changes to the credit memo balance. | | InvoiceId | Type reference Properties Filter, Group, Sort Description ID of the invoice to which credit is applied. This field is a relationship field. Relationship Name Invoice Relationship Type Lookup Refers To Invoice | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates whether the credit memo line application was generated because of an apply action (application) or an unapply action (unapplication). Possible values are: - Applied - Unapplied | | UnappliedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when this application was unapplied from the target invoice. | ## 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. [CreditMemoInvApplicationFeed](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. [CreditMemoInvApplicationHistory](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. <!-- document id=bc9f7f56bb2ed395bff160354396b030e99b42008e6f373fbd7a37ae73e21b25 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_creditmemoline.md --> # CreditMemoLine Represents product, service, adjustment, or tax line items that were included in a credit memo. This object is available in API version 48.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Special Access Rules This object is available with Order Management, Subscription Management, and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_creditmemoline.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | AdjustmentAmount | Type currency Properties Filter, Nillable, Sort, Update Description Amount of this credit memo line item if its type is Adjustment. | | AdjustmentAmountWithTax | Type currency Properties Filter, Nillable, Sort Description Sum of the adjustment amount and the adjustment tax amount. This field is available in API version 49.0 and later. This field is available when Subscription Management is enabled. | | AdjustmentTaxAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the tax related to the adjustment amount. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. | | BillingAddressId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the billing address related to this credit memo line. This field is a relationship field. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. Relationship Name BillingAddress Relationship Type Lookup Refers To CreditMemoAddressGroup | | ChargeAmount | Type currency Properties Filter, Nillable, Sort, Update Description Amount of this credit memo line item if its type is Charge. | | ChargeAmountWithTax | Type currency Properties Filter, Nillable, Sort Description Sum of the adjustment amount and the adjustment tax amount. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. | | ChargeTaxAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the tax related to the charge amount. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. | | CreditMemoId | Type reference Properties Filter, Group, Sort Description ID of the parent credit memo. This field is a relationship field. Relationship Name CreditMemo Relationship Type Lookup Refers To CreditMemo | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the credit memo line. The default value is USD. | | Description | Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the credit memo line. | | EndDate | Type date Properties Filter, Group, Nillable, Sort, Update Description For credit memos made from a time-based service, the end date of the line item being credited. | | LineAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the credit memo line. This field is a calculated field. This field is available in API version 49.0 and later. | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description Name of the credit memo line. | | Product2Id | Type reference Properties Filter, Group, Nillable, Sort, Update Description The product or service being credited in the credit memo line. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ReferenceEntityItemId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The order product or invoice line corresponding to this credit memo line. This field is a polymorphic relationship field. This field is available in API version 53.0 and later. Relationship Name ReferenceEntityItem Relationship Type Lookup Refers To OrderItemSummary, OrderProduct, InvoiceLine | | ReferenceEntityItemType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of transaction that generated the credit memo line. Possible values are: - DeliveryCharge - OrderProduct | | ReferenceEntityItemTypeCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of object that generated the credit memo line. Possible values are: - Charge - Product | | RelatedLineId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The credit memo line related to this line item. This field is a relationship field. Relationship Name RelatedLine Relationship Type Lookup Refers To CreditMemoLine | | ShippingAddressId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the shipping address. This field is a relationship field. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. Relationship Name ShippingAddress Relationship Type Lookup Refers To CreditMemoAddressGroup | | StartDate | Type date Properties Filter, Group, Nillable, Sort, Update Description For credit memo lines generated from a time-based service, the first date of the billing for the service. | | Status | Type string Properties Filter, Group, Nillable, Sort Description State of the credit memo line. Inherited from the credit memo. | | TaxAmount | Type currency Properties Filter, Nillable, Sort, Update Description Total tax for the credit memo. | | TaxCode | Type string Properties Filter, Group, Nillable, Sort, Update Description The code used to calculate the tax rate for the invoice line. | | TaxDocumentNumber | Type string Properties Filter, Group, Nillable, Sort Description The document number that tracks taxes calculated for this credit memo line. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. | | TaxEffectiveDate | Type date Properties Filter, Group, Nillable, Sort, Update Description The date used to calculate the credit memo line’s TaxAmount. | | TaxName | Type string Properties Filter, Group, Nillable, Sort, Update Description User-defined name for applied tax. | | TaxRate | Type percent Properties Filter, Nillable, Sort, Update Description Percentage value used for calculating tax. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description The total amount of the credit memo line before any applicable tax. | | TotalAmountWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of tax for this credit memo line, with tax included. Sum of TotalAmount and TaxAmount. | | TaxStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Tracks whether the taxes were calculated for this credit memo line. Possible values are: - Complete - Error - None The default value is None. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. | | TaxTransactionNumber | Type string Properties Filter, Group, Nillable, Sort Description Tracks the transaction number of the tax calculated for this credit memo line. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. | | TaxTreatmentId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the tax treatment for the credit memo line. This field is a relationship field. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. Relationship Name TaxTreatment Relationship Type Lookup Refers To TaxTreatment | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of transaction for the invoice line. Possible values are: - Adjustment - Charge - Tax | ## 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. [CreditMemoLineFeed](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. [CreditMemoLineHistory](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. <!-- document id=9b9739ce2a60beaa630b13c1c2a5ef55467de49fc2b73077ce2d30d5c8ddf456 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_crisis.md --> # Crisis Represents a major crisis event that affects an Employee in an InternalOrganizationUnit. This object is available in API version 48.0 and later. In API version 49.0 and later, this object supports reports, criteria-based sharing rules, and history tracking, plus you can exclude individual fields from custom page layouts. Work.com uses this object to track and describe crisis situations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, you must be assigned a Workplace Command Center permission set license and the Provides access to Workplace Command Center features system permission. ## Fields | Field | Details | | --- | --- | | CrisisType | Type picklist Properties Create, Filter, Group, Sort, Update Description Required. The type or category of crisis. Possible values are: - Economic Crisis - Natural Disaster - Pandemic - War | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The crisis description. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the crisis ended. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The crisis record name. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this record. Default value is the user logged in to the API to perform the create operation. | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description Required. The date the crisis started. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CrisisHistory](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.") (API version 49.0) History is available for tracked fields of the object. [CrisisOwnerSharingRule](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. [CrisisShare](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.") (API version 49.0) Sharing is available for the object. #### See Also - [_Workplace Command Center for Work.com Developer Guide_: Extend Work.com with Custom Solutions](https://developer.salesforce.com/docs/atlas.en-us.264.0.ajax.meta/workdotcom_dev_guide/wdc_cc_overview.htm " Workplace Command Center for Work.com Developer Guide: Extend Work.com with Custom Solutions - HTML (New Window)") <!-- document id=78313c56ef92b8df3c9f4cb786a8f8b40199a6fa3fb4de99d5641fbd75cc4fe8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_cronjobdetail.md --> # CronJobDetail Contains details about the associated scheduled job, such as the job’s name and type. This object is available in API version 29.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | JobType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the associated scheduled job. The following are the available job types. Use the job type value when querying for a specific job type. - 1—Data Export - 3—Dashboard Refresh - 4—Reporting Snapshot - 6—Scheduled Flow - 7—Scheduled Apex - 8—Report Run - 9—Batch Job - A—Reporting Notification | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the associated scheduled job. | ## Usage Use this object to query additional information about a scheduled job, such as the job’s name and type. <!-- document id=507c1994dd6ce6db66f6eda5818919c9ed6ee90d8ae41d85d1d476110a75e5ed url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_crontrigger.md --> # CronTrigger Contains schedule information for a scheduled job. CronTrigger is similar to a cron job on UNIX systems. This object is available in API version 17.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CronExpression | Type string Properties Filter, Group, Nillable, Sort Description The cron expression used to initiate the schedule. Syntax: Seconds Minutes Hours Day\_of\_month Month Day\_of\_week Optional\_year See [schedule(jobName, cronExpression, schedulableClass)](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexref/apex_methods_system_system.htm "HTML (New Window)") in the Apex Reference Guide. | | CronJobDetailId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the CronJobDetail record containing more details about this scheduled job. This is a relationship field. Relationship Name CronJobDetail Relationship Type Lookup Refers To CronJobDetail | | EndTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the job either finished or will finish. | | NextFireTime | Type dateTime Properties Filter, Nillable, Sort Description The next date and time the job is scheduled to run. null if the job is not scheduled to run again. | | OwnerId | Type reference Properties Filter, Group, Nillable, Sort Description Owner of the job. | | PreviousFireTime | Type dateTime Properties Filter, Nillable, Sort Description The most recent date and time the job ran. null if the job has not run before current local time. | | StartTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the most recent iteration of the scheduled job started. | | State | Type string Properties Filter, Group, Nillable, Sort Description The current state of the job. The job state is managed by the system. Possible values are: - WAITING—The job is waiting for execution. - ACQUIRED—The job has been picked up by the system and is about to execute. - EXECUTING—The job is executing. - COMPLETE—The trigger has fired and is not scheduled to fire again. - ERROR—The trigger definition has an error. - DELETED—The job has been deleted. - PAUSED—A job can have this state during patch and major releases. After the release has finished, the job state is automatically set to WAITING or another state. - BLOCKED—Execution of a second instance of the job is attempted while one instance is running. This state lasts until the first job instance is completed. - PAUSED\_BLOCKED—A job has this state due to a release occurring. When the release has finished and no other instance of the job is running, the job’s status is set to another state. | | TimesTriggered | Type int Properties Filter, Group, Nillable, Sort Description The number of times this job has been triggered. | | TimeZoneSidKey | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Returns the timezone ID. For example, America/Los\_Angeles. | ## Usage Use this object to query scheduled jobs in your organization. <!-- document id=92556edcb42dace79262898d3fbf86a51751e40589920f81a1c889435ce7968f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_cryptoprodcatgwalletgroup.md --> # CryptoProdCatgWalletGroup Specifies if CryptoWalletGroup is in the allowlist or airdrop for the ProductCategory. A custom object between ProductCategory and CryptoWalletGroup adding the CryptoWalletGroup to allowlist or airdrop. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object has read, create, update, delete, modify all, and view all access. ## Fields | Field | Details | | --- | --- | | CryptoWalletGroupId | Type reference Properties Create, Filter, Group, Sort Description The CryptoWalletGroup ID. This field is a relationship field. Relationship Name CryptoWalletGroup Relationship Type Lookup Refers To CryptoWalletGroup | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the record. | | ProductCategoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the category. This field is a relationship field. Relationship Name ProductCategory Relationship Type Lookup Refers To ProductCategory | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies if CryptoProdCatgWalletGroup is active and functional, or inactive and disabled. Possible values are: - Active - Inactive | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines whether the list of wallets is for minting allowlist or for executing an airdrop. Possible values are: - Airdrop - Allowlist | <!-- document id=c0a45aea34083fdf4dfedfbe6cd194c6e8931a09dc95826b7f5997913c245e0a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_cspviolation.md --> # CSP Violation Event Type CSP violation events capture details about blocked resource requests from Lightning Experience pages based on your content security policy (CSP). The CSP Violation event type is available in the EventLogFile object in API version 63.0 and later. This event is free for all customers with a 24-hour data retention period. The CSP violation event is available in the API but not in the Event Monitoring Analytics app. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or the [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To help preserve performance, Salesforce uses throttling, a technique that limits the number of generated CSP violation events when the volume is exceptionally high. Therefore, if your org generates a high volume of CSP violations over a short period of time, some of those violations can fail to generate a CSP violation event. ## Fields | Field | Details | | --- | --- | | BLOCKED\_URI | Type String Description The full string of the blocked resource. If the call to the blocked resource used a URL, BLOCKED\_URI is the full URL. Or, for violations with a DIRECTIVE of script-src directives, inline or eval. Examples - https://www.example.com/images/picture.png - file://host1:0002/media/video.mp4 - inline | | BLOCKED\_URI\_DOMAIN | Type String Description If BLOCKED\_URI is a URL, the domain for that URL. To allow resources to be loaded from the BLOCKED\_URI, BLOCKED\_URI\_DOMAIN is the endpointUrl value to add or update in the [CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_csptrustedsite.htm "Represents a trusted URL. For each CspTrustedSite, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite included only CSP directives and was referred to as CSP Trusted Sites in Salesforce Setup. Available in API version 39.0 and later.") Metadata API. Example www.example.com | | COLUMN\_NUMBER | Type Number Description The column number in the document or worker script at which the violation occurred. This value is relevant only when DIRECTIVE is script-src. For those violations, use this value with LINE\_NUMBER to identify the location of the violation. Example 27 | | CONTEXT | Type String Description The content security policy (CSP) context for the request. The CSP context controls which pages can load content from a [CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_csptrustedsite.htm "Represents a trusted URL. For each CspTrustedSite, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite included only CSP directives and was referred to as CSP Trusted Sites in Salesforce Setup. Available in API version 39.0 and later."). CSP violation events capture details about blocked resource requests from only Lightning Experience pages, this value is always Lightning. | | DIRECTIVE | Type String Description The CSP directive that blocked the resource request. Possible Values - font-src - frame-src - img-src - media-src - style-src - script-src For information on these directives and a full list of all CSP directives, see [MDN Web Docs: Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy). | | DISPOSITION | Type String Description The CSP violation handling instruction for the user agent at the time of the violation. Possible Values - enforce—Enforce the policy violation. For violations with this DISPOSITION, the resource request was blocked. - report—Report the policy violation. For violations with this DISPOSITION, the resource request wasn’t blocked, but the violation was reported. | | EVENT\_TYPE | Type String Description The type of event. The value is always CspViolation | | LINE\_NUMBER | Type Number Description The line number in the document or worker script at which the violation occurred. This value is relevant only when DIRECTIVE is script-src. For those violations, use this value with COLUMN\_NUMBER to identify the location of the violation. Example 12 | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 0000000062\_0000x8Lz- | | RESOURCE\_SAMPLE | Type String Description A sample of the resource that caused the violation, usually the first 40 characters, or the empty string. Example var lastRow = 4;greyLink('fRemoveRowLink var SFDCSessionVars={"server":"https:\\\\/\\\\ LoginHint.getSavedIdentities(false); LoginHint.saveHintEdit(); function handleLogin(){document.login.un… | | SOURCE | Type String Description The page where this CSP violation originated. For example, if your CSP policy prevented an image from loading on a Visualforce page, SOURCE contains the URL of that page. Example https://MyDomainName.my.salesforce.com/apex/HelloWorld | | SOURCE\_FILE | Type String Description The URL of the script in which the violation occurred. If the violation didn’t occur in a script, SOURCE\_FILE is null. Example https://www.example.com/script\_xyz.js | | TIMESTAMP | Type DateTime Description The access time of Salesforce services in GMT. Example 20220715233322.670 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). The time zone is always GMT. Example 2022-07-27T11:32:59.555Z. | ## Usage Only one CSP violation event log file is available at a time. When the daily incremental event log file is generated during the daily background process, the new file replaces the existing file. If the event log file doesn’t exist, either the log generation process hasn’t run yet or there’s no violation data to report for that 24-hour window. The event log file is generated only when at least one violation occurred for the day. To collect CSP violation logs for multiple days, schedule a daily query of the CSP Violation event type via REST API. For example, you can configure a cron job in Unix or a scheduled task in Windows to run the query. #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=206c0761bbf8d63edf178314a15e5cfd333aab430e9f850e0291dd1536b03772 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_csptrustedsite.md --> # CspTrustedSite Represents a trusted URL. For each CspTrustedSite, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite included only CSP directives and was referred to as CSP Trusted Sites in Salesforce Setup. Available in API version 39.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CanAccessCamera | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this CspTrustedSite can access the user’s camera. The default value is false. This field takes effect only when the enablePermissionsPolicy field equals true and the grantCameraAccess field equals TrustedUrls in the SecuritySettings metadata API type. This field is available in API version 59.0 and later. | | CanAccessMicrophone | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this CspTrustedSite can access the user’s microphone. The default value is false. This field takes effect only when the enablePermissionsPolicy field equals true and the grantMicrophoneAccess field is TrustedUrls in the SecuritySettings metadata API type. This field is available in API version 59.0 and later. | | Context | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Declares the scope of the CSP directives for this trusted URL. Possible values are: - All—Apply the CSP directives to all supported context types. - Communities—Apply the CSP directives to Experience Builder sites only. - FieldServiceMobileExtension—Apply the CSP directives to the Field Service Mobile Extensions only. - LEX—Apply the CSP directives to Lightning Experience only. - LightningOut—Reserved for future use. Available in API version 64.0 and later - VisualForce—Apply the CSP directives to custom Visualforce pages only. This value is available in API version 55.0 and later. For custom Visualforce pages, content is restricted to trusted URLs only if the page’s cspHeader attribute is set to true. This field is available in API version 44.0 and later. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the trusted URL. Limit: 255 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer name of the trusted URL. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | EndpointUrl | Type string Properties Create, Filter, Group, Sort, Update Description The URL for this CspTrustedSite. - This field must include a domain name and can include a port. For example, https://example.com or https://example.com:8080. To reduce repetition, you can use the wildcard character \* (asterisk). For example, \*.example.com. Don't include placeholders or invalid characters. For example, don't use malformed^url.example.com, and https://{subdomain}.example.com. - For a third-party API, the URL must begin with https://. For example, https://example.com. - For a WebSocket connection, the URL must begin with wss://. For example, wss://example.com. - For a Chrome extension, use the 32-character extension ID in the format chrome-extension://abcdefghijklmnopabcdefghijklmnop. The ID can contain only lowercase letters a–p. Wildcards aren’t supported in Chrome extension URIs. Before February 2025, it was possible to save a malformed URL. Malformed URLs are excluded from generated CSP HTTP headers. To keep your Trusted URLs list accurate, remove any malformed entries. You can use an Apex class to find all malformed URLs. See the knowledge article, [Identify Malformed Trusted URLs](https://help.salesforce.com/s/articleView?id=005317938&type=1&language=en_US). To add a URL based on parameters, build the URL before you update the EndpointUrl field. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this CspTrustedSite is active. | | IsApplicableToConnectSrc | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Lightning components, third-party APIs, and WebSocket connections can load URLs using script interfaces from this trusted URL. | | IsApplicableToFontSrc | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Lightning components, third-party APIs, and WebSocket connections can load fonts from this trusted URL. | | IsApplicableToFrameSrc | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Lightning components, third-party APIs, and WebSocket connections can load resources contained in <iframe> elements from this trusted URL. | | IsApplicableToImgSrc | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Lightning components, third-party APIs, and WebSocket connections can load images from this trusted URL. | | IsApplicableToMediaSrc | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Lightning components, third-party APIs, and WebSocket connections can load audio and video from this trusted URL. | | IsApplicableToStyleSrc | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Lightning components can load style sheets from this trusted URL. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language for the trusted URL. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Master label for this trusted URL. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Namespace prefix for this trusted URL. | ## Usage For each CSPTrustedSite, at least one field starting with grantAccess or isApplicableTo must be set to true. In API versions 50.0 to 58.0, if all isApplicable fields are false, the isApplicableToImgSrc field is set to true. In API version 49.0 and earlier, if all isApplicable fields are false, those fields all default to true. To ensure smooth integration across Salesforce products, Salesforce includes URLs in each of the CSP directives that correspond to the isApplicable fields, even though those URLs aren’t defined as CspTrustedSite components. Salesforce regularly updates those URLs based on the latest requirements. <!-- document id=c9ce756cece2a76468e9c8d1daf46fbcc268fec877c271567372feb0803f1510 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_cspviolationeventlog.md --> # CspViolationEventLog CSP violation events capture details about blocked resource requests from Lightning Experience pages based on your content security policy (CSP). This object is available in API version 63.0 and later. This event is free for all customers with a 24-hour data retention period. The CSP violation event is available in the API but not in the Event Monitoring Analytics app. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | BlockedUri | Type string Properties Filter, Group, Nillable, Sort Description The full string of the blocked resource. If the call to the blocked resource used a URL, BLOCKED\_URI is the full URL. Or,for violations with a DIRECTIVE of script-src directives, inline or eval. Examples - https://www.example.com/images/picture.png - file://host1:0002/media/video.mp4 - inline | | BlockedUriDomain | Type string Properties Filter, Group, Nillable, Sort Description If BLOCKED\_URI is a URL, the domain for that URL. To allow resources to be loaded from the BLOCKED\_URI, BLOCKED\_URI\_DOMAIN is the endpointUrl value to add or update in the [CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_csptrustedsite.htm) Metadata API. | | ColumnNumber | Type double Properties Filter, Nillable, Sort Description The column number in the document or worker script at which the violation occurred. This value is relevant only when DIRECTIVE is script-src. For those violations, use this value with LINE\_NUMBER to identify the location of the violation. Example 27 | | Context | Type string Properties Filter, Group, Nillable, Sort Description The content security policy (CSP) context for the request. The CSP context controls which pages can load content from a [CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_csptrustedsite.htm). CSP violation events capture details about blocked resource requests from only Lightning Experience pages, this value is always Lightning. | | Directive | Type string Properties Filter, Group, Nillable, Sort Description The CSP directive that blocked the resource request. Possible Values - font-src - frame-src - img-src - media-src - style-src - script-src For information on these directives and a full list of all CSP directives, see [MDN Web Docs: Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy). | | Disposition | Type string Properties Filter, Group, Nillable, Sort Description The CSP violation handling instruction for the user agent at the time of the violation. Possible Values - enforce—Enforce the policy violation. For violations with this DISPOSITION, the resource request was blocked. - report—Report the policy violation. For violations with this DISPOSITION, the resource request wasn’t blocked, but the violation was reported. | | LineNumber | Type double Properties Filter, Nillable, Sort Description The line number in the document or worker script at which the violation occurred. This value is relevant only when DIRECTIVE is script-src. For those violations, use this value with COLUMN\_NUMBER to identify the location of the violation. Example 12 | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | ResourceSample | Type string Properties Filter, Group, Nillable, Sort Description A sample of the resource that caused the violation, usually the first 40 characters, or the empty string. | | Source | Type string Properties Filter, Group, Nillable, Sort Description The page where this CSP violation originated. For example, if your CSP policy prevented an image from loading on a Visualforce page, SOURCE contains the URL of that page. | | SourceFile | Type string Properties Filter, Group, Nillable, Sort Description The URL of the script in which the violation occurred. If the violation didn’t occur in a script, SOURCE\_FILE is null. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | UniqueIdentifier | Type string Properties Filter, Group, Nillable, Sort Description A string identifier for the CSP violation. | ## Usage Only one CSP violation event log file is available at a time. When the daily incremental event log file is generated during the daily background process, the new file replaces the existing file. If the event log file doesn’t exist, either the log generation process hasn’t run yet or there’s no violation data to report for that 24-hour window. The event log file is generated only when at least one violation occurred for the day. To collect CSP violation logs for multiple days, schedule a daily query of the CSP Violation event type via REST API. For example, you can configure a cron job in Unix or a scheduled task in Windows to run the query. <!-- document id=dc24291f9123ea951378b121e46c5b0f9119a0eb6074b5624f69b80be247f51d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_currencytype.md --> # CurrencyType Represents the currencies used by an organization for which the multicurrency feature is enabled. ## Supported Calls create(), describeSObjects(), getUpdated(), query(), retrieve(), search(), update() ## Special Access Rules - This object is not available in single-currency organizations. - You need the “Customize Application” permission to edit this object. - Your client application can't delete this object. ## Fields | Field | Details | | --- | --- | | ConversionRate | Type double Properties Filter Description Required. Conversion rate of this currency type against the corporate currency. | | DecimalPlaces | Type int Properties Filter Description Required. For this currency, specifies the number of digits to the right of the decimal point, such as zero (0) for JPY or 2 for USD. | | IsActive | Type boolean Properties Defaulted on create, Filter Description Indicates whether this currency type is active (true) or not (false). Inactive currency types do not appear in picklists in the user interface. Label is **Active**. This field defaults to false if no value is provided when updating or inserting a record. | | IsCorporate | Type boolean Properties Defaulted on create, Filter Description Indicates whether this currency type is the corporate currency (true) or not (false). Label is **Corporate Currency**. All other currency conversion rates are applied against this corporate currency. If a currency is already defined as the corporate currency in the user interface, it can't be unset. When a non-corporate currency is set to a corporate currency, the system reconfigures all conversion rates based on the new corporate currency. | | IsoCode | Type picklist Properties Filter, Restricted picklist Description Required. ISO code of the currency. Must be one of the valid alphabetic, three-letter currency ISO codes defined by the ISO 4217 standard, such as USD, GBP, or JPY. Must be unique within your organization. Label is **Currency ISO Code**. The CUC (Cuban Convertible Peso) picklist value is not available in API version 65.0 and later. | ## Usage This object is for multicurrency organizations only. Use this object to define the currencies your organization uses. When updating an existing record, make sure to provide values for all fields to avoid undesired changes to the CurrencyType. For example, if a value for IsActive is not provided, the default (false) is used, which could result in a currently active CurrencyType becoming inactive. #### See Also - [DatedConversionRate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datedconversionrate.htm "Represents the dated exchange rates used by an organization for which the multicurrency and the effective dated currency features are enabled.") - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=b6f6ba18760aa262bfe8fe6592f596e74807daa6454437be980c0efa8c01d0f0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_custexpintltransfsetup.md --> # CustExpIntlTransfSetup Stores information for different data sources that are processed for customer insights. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DataSourceChannelName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the associated communication channel, such as Web, Email, Chat, or Voice. | | DataSourceChannelType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the channel type as standard or custom. Possible values are: - Custom - Standard The default value is Standard. | | IsDataProcessingPaused | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether data processing for the channel is temporarily paused (true). Use this field to control channel operations without deactivating the channel. The default value is false. | | IsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the channel is active for processing data (true). The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the current user last viewed or modified this record, a record related to this record, or a list view. If this value is null, the current user has never viewed or modified a record related to this object. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the current user last viewed or modified this record. If this value is null, the current user has never viewed or modified this record. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the Customer Experience Intelligence Transformer Setup record. | | ProcessingStartDate | Type dateTime Properties Create, Filter, Sort, Update Description The date to start processing data in the specified communication channel. | <!-- document id=f77e3000308e7f444df3777843d903e09452511616c742604875c3bf1c15c949 url=/legacydeveloper/current/en-us/object_reference/custom_fields.md --> # Custom Fields Salesforce administrators can define custom fields for standard or custom objects in their organization using the user interface. During creation, the custom flag—a Boolean field in the Field object—is set to true. Client applications cannot define custom fields via the API. Usually, client applications do not need to know whether a field is a standard field or a custom field. Note that all numeric custom fields are handled as type double. ## Objects That Support Custom Fields | Standard Object | Master-Detail | Lookup | Custom Fields | | --- | --- | --- | --- | | Account | Yes | Yes | Yes | | Campaign | Yes | Yes | Yes | | Case | Yes | Yes | Yes | | Contact | Yes | Yes | Yes | | Contract | Yes | Yes | Yes | | Event | No | No | Yes | | Lead | No | No | Yes | | Opportunity | Yes | Yes | Yes | | Product2 | No | Yes | Yes | | Solution | Yes | Yes | Yes | | Task | No | No | Yes | | User | No | Yes | Yes | ## Naming Conventions for Custom Fields Custom objects have an associated name field that is defined by your Salesforce administrator. Custom fields must have unique names within the same object. In the API, the names of custom fields are identified by a suffix of two underscores immediately followed by a lowercase “c” character. For example, a custom object labeled “Issue” in the user interface is seen as Issue\_\_c in that organization's WSDL. Similarly, a custom field labeled “Hire Date” in the user interface is seen as Hire\_Date\_\_c in that organization's WSDL. ## External ID Attribute on Custom Fields In the user interface, you can identify one custom field on an object as being an external ID field. The field type must be a text, number, or email field. An external ID contains record IDs from a system outside of Salesforce. You can match against this field during import or integration, or when upserting records. ## Uniqueness for Custom Fields In the user interface, you can specify that a custom field on a custom object contain unique values across all the records of that custom object type. The uniqueness can be either case sensitive or case insensitive. In the API, you can find out if a field is unique by issuing a describe call against the custom object and inspecting two attribute values: - If the unique field is set to true, the custom field values must be unique across all records of that custom object type in the organization. A value of false means the field can have the same value in different records of that custom object type. - If the caseSensitive field is set to true, the uniqueness (if enabled) is case sensitive. For example “ABC” and “abc” are considered two unique values. If the value is false, then “ABC” and “abc” are considered the same value. These values cannot be set or modified using API calls. If a custom field on a custom object has unique set to true, and you try to insert a duplicate value, a DUPLICATE\_VALUE exception code is returned. ## Default Values in Custom Fields You can set a default value on a custom field using a formula field: - The user logged in for API activity must be have the “Customize Application” permission. - The field must have a data type of currency, date, datetime, int, double, percent, string, textarea, email, phone, or url. You cannot use composite fields like Address, Person, Names, nor Fiscal Periods. Note that you can set a checkbox as checked or unchecked by default using the user interface, but you cannot set it using a formula field. - Default formulas run on fields, and the results are saved, even if the fields are hidden by field-level security. - Default values are not used for lead conversion, importing, or merging records. ## Managed Packages and API Names If you have an unmanaged package and a managed package version becomes available, the API names of custom fields, custom objects, and Scontrol objects in the package change. A namespace prefix is added to each component to make it unique: _name_\_\_c becomes _prefix_\_\__name_\_\_c. To move from an unmanaged package to a managed package version of the same application, export your data, uninstall the old package, and install the new package. Then review the name changes and import your data with the relevant mapping. <!-- document id=b618f0c13ab80d47a9887140c72a430ae0d18343da633393ab79da6c75cced62 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_custommetadatatype__mdt.md --> # Custom Metadata Type\_\_mdt Represents a custom metadata record. This object is available in API version 34.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. The object name is a variable with the syntax CUSTOM\_METADATA\_TYPE\_\_mdt, where CUSTOM\_METADATA\_TYPE is the ObjectName for the custom metadata type associated with the custom metadata record. For example, PicklistUsage\_\_mdt represents a custom metadata record based on the PicklistUsage custom metadata type. ## Supported Calls describeSObjects(), describeLayout(), query(), retrieve() #### See Also - [System Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/system_fields.htm "System fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example, the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies a record.") - [Field Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm "In addition to the primitive data types, the API defines the following data types for fields.") - [API Field Properties](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/access_for_fields.htm) ## Fields ### _Custom Field_\_\_c - **Type**: Any Type - **Properties**: Filter, Group, Nillable, Sort - **Description**: A custom field on the record. ### DeveloperName - **Type**: string - **Properties**: Defaulted on create, Filter, Group, Sort - **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 org. 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. ### isProtected - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: When a custom metadata type’s records are released in a managed package, access to them is limited in specific ways. Code that’s in the same managed package as custom metadata records can read the records. Code that’s in the same managed package as custom metadata types can read the records that belong to that type. Code that’s in a managed package that doesn’t contain either the type or the protected record can’t read the protected records. Code that the subscriber creates and code that’s in an unmanaged package can’t read the protected records. The developer can modify protected records only with a package upgrade. The subscriber can’t read or modify protected records. The developer name of a protected record can’t be changed after release. Records that are hidden by these access rules are also unavailable to REST, SOAP, SOQL, and Setup. ### Label - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The custom metadata record label. This label value is always the same as the MasterLabel value. ### Language - **Type**: string - **Properties**: Filter, Group, restrictedPicklist, Sort - **Description**: The language of the custom metadata record. This value is always the default language of the developing organization. ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The primary label for the custom metadata record. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. ### QualifiedApiName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: A concatenation of the namespace prefix and developer name. The format is NamespacePrefix\_\_DeveloperName. ### SystemModStamp - **Type**: dateTime - **Properties**: Defaulted on create, Filter, Sort - **Description**: Date and time when a user or automated process such as a trigger last modified this record. In this context, trigger refers to Salesforce code that runs to implement standard functionality, and not an Apex trigger. This field is available In API version 56.0 and later. <!-- document id=5bcdef9def4615bb7060b1286b4c2ca91b25dcf33cab679779297de4a70eaaf8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_custom_object__c.md --> # Custom Object \_\_c \_\_c Represents a custom object. The custom object name is a variable with the syntax CUSTOM\_OBJECT\_\_c, where CUSTOM\_OBJECT is the object’s Name associated with the record, followed by two underscores and c. For example, a custom object labeled “Issue” in the Salesforce user interface is Issue\_\_c in that organization’s WSDL. System fields and properties behave the same on custom objects as they do on standard objects, unless otherwise noted in the following details. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [System Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/system_fields.htm "System fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example, the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies a record.") - [Field Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm "In addition to the primitive data types, the API defines the following data types for fields.") - [API Field Properties](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/access_for_fields.htm) ## Fields ### ConnectionReceivedId - **Type**: reference - **Properties**: Filter, Nillable - **Description**: ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce. ### ConnectionSentId - **Type**: reference - **Properties**: Filter, Nillable - **Description**: ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections. ### CreatedById - **Type**: reference - **Properties**: Aggregatable, Defaulted on create, Filter, Group, Sort - **Description**: ID of the [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) who created this record. ### CreatedDate - **Type**: dateTime - **Properties**: Aggregatable, Defaulted on create, Filter, Sort - **Description**: Date and time when this record was created. ### CurrencyIsoCode - **Type**: picklist - **Properties**: Defaulted on createFilter, Group, Restricted picklist, Sort - **Description**: Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. ### Id - **Type**: Id - **Properties**: Aggregatable, Defaulted on create, Filter, Group, idLookup, Sort - **Description**: Globally unique string that identifies a record. For information on IDs, see [ID Field Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/field_types.htm#i1435616 "HTML (New Window)"). ### IsDeleted - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. ### LastActivityDate - **Type**: dateTime - **Properties**: Filter, Group, Nillable, Sort - **Description**: Value is one of the following, whichever is the most recent: - Due date of the most recent event logged against the object. - Due date of the most recently closed task associated with the object. ### LastModifiedDate - **Type**: dateTime - **Properties**: Aggregatable, Defaulted on create, Filter, Sort - **Description**: Date and time when a user last modified this record. ### LastModifiedById - **Type**: reference - **Properties**: Aggregatable, Defaulted on create, Filter, Group, Sort - **Description**: ID of the [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm "HTML (New Window)") who last updated this object. ### LastReferencedDate - **Type**: dateTime - **Properties**: Aggregatable, Filter, Sort, Nillable - **Description**: Date and time when the current user last viewed or modified this record, a record related to this record, or a list view. If this value is null, the current user has never viewed or modified a record related to this object. This field doesn’t exist on records for a custom object unless a [custom object tab](https://help.salesforce.com/s/articleView?id=platform.creating_custom_object_tabs.htm&type=5&language=en_US "HTML (New Window)") is created for that object. See [Use LastReferencedDate and LastViewedDate fields in a SOQL query](https://help.salesforce.com/s/articleView?id=000382652&type=1&language=en_US "HTML (New Window)"). ### LastViewedDate - **Type**: dateTime - **Properties**: Aggregatable, Filter, Sort, Nillable - **Description**: Date and time when the current user last viewed or modified this record. If this value is null, the current user has never viewed or modified this record. This field doesn’t exist on records for a custom object unless a [custom object tab](https://help.salesforce.com/s/articleView?id=platform.creating_custom_object_tabs.htm&type=5&language=en_US "HTML (New Window)") is created for that object. See [Use LastReferencedDate and LastViewedDate fields in a SOQL query](https://help.salesforce.com/s/articleView?id=000382652&type=1&language=en_US "HTML (New Window)"). ### Name - **Type**: string - **Properties**: Aggregatable, Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Label is **Object Name**. Name of the object. Maximum size is 80 characters. When the object is created using an API update() call, and the Name field is null, Salesforce sets the value to the record ID. When the object is created using an API create() call, Salesforce sets the initial value to the record ID. You can’t set the Name field to null. ### OwnerId - **Type**: reference - **Properties**: Aggregatable, Create, Defaulted on create, Filter, Group, Namepointing, Sort, Update - **Description**: The ID of the user who currently owns this object. user logged in to the API to perform the create() call. - **Default value**: the ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Nillable, Update - **Description**: ID of the record type assigned to this object. Create at least one record type before this field appears for custom or standard objects. ### SystemModStamp - **Type**: dateTime - **Properties**: Aggregatable, Defaulted on create, Filter, Sort - **Description**: Date and time when a user or automated process such as a trigger last modified this record. In this context, trigger refers to Salesforce code that runs to implement standard functionality, and not an Apex trigger. <!-- document id=365b46468cbd71c47e7fea45edb5c00702a07b55acbca9f7e111f1746e255d99 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_customobject__feed.md --> # Custom Object\_\_Feed Represents the feed, specifically posts and feed-tracked changes, on a custom object. A custom object feed shows posts and changes to the object’s tracked fields. The object name is variable and uses CUSTOM\_OBJECT\_\_Feed syntax, where CUSTOM\_OBJECT is the name of the custom object. For example, Textile\_\_Feed represents a feed on the custom object Textile\_\_c. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules In the internal org, users can delete all feed items they created. This rule varies in Experience Cloud sites where threaded discussions and delete-blocking are enabled. Site members can delete all feed items they created, provided the feed items don’t have content nested under them—like a comment, answer, or reply. Where the feed item has nested content, only feed moderators and users with the Modify All Data permission can delete threads. To delete feed items they didn’t create, users must have one of these permissions: - Modify All Data - Modify All Records on the parent object, like Textile\_\_c. - Moderate Chatter Users with the Moderate Chatter permission can delete only the feed items and comments they can see. Only users with this permission can delete items in unlisted groups. ## Fields ### BestCommentId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the comment marked as best answer on a question post. This field is available in API version 44.0 and later. ### Body - **Type**: textarea - **Properties**: Nillable, Sort - **Description**: The body of the post. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. ### CommentCount - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The number of comments associated with this feed item. In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say that you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, comments aren’t counted until approved by an admin or someone with Can Approve Feed Post and Comment or Modify All Data. Feed moderation has implications on how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until the end of comments is returned. ### ConnectionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your org. ### ContentData - **Type**: base64 - **Properties**: Nillable - **Description**: Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost. ### ContentDescription - **Type**: textarea - **Properties**: Nillable, Sort - **Description**: Available in API version 36.0 and earlier only. The description of the file specified in ContentData. ### ContentFileName - **Type**: string - **Properties**: Group, Nillable, Sort - **Description**: Available in API version 36.0 and earlier only. This field is required if Type is ContentPost.The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost. ### ContentSize - **Type**: int - **Properties**: Group, Nillable, Sort - **Description**: Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert. ### ContentType - **Type**: string - **Properties**: Group, Nillable, Sort - **Description**: Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert. ### FeedPostId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only. ID of the associated FeedPost. A FeedPost represents the following types of changes in a feed item: changes to tracked fields, text posts, link posts, and content posts. ### InsertedById - **Type**: reference - **Properties**: Group, Nillable, Sort - **Description**: ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user. ### IsRichText - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the feed item Body contains rich text. If you post a rich text feed comment using SOAP API, set IsRichText to true and escape HTML entities from the body. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: - <p> Though the <br> tag isn’t supported, you can use <p> </p> to create lines. - <a> - <b> - <code> - <i> - <u> - <s> - <ul> - <ol> - <li> - <img> The <img> tag is accessible only through the API and must reference files in Salesforce similar to this example: <img src="sfdc://069B0000000omjh"></img> In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. ### LikeCount - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The number of likes associated with this feed item. ### LinkUrl - **Type**: url - **Properties**: Nillable, Sort - **Description**: The URL of a LinkPost. ### NetworkScope - **Type**: picklist - **Properties**: Group, Nillable, Restricted picklist, Sort - **Description**: Specifies whether this feed item is available in the default Experience Cloud site, a specific Experience Cloud site, or all sites. This field is available in API version 26.0 and later, if digital experiences is enabled for your org. NetworkScope can have the following values: - NetworkId—The ID of the Experience Cloud site in which the FeedItem is available. If left empty, the feed item is only available in the default Experience Cloud site. - AllNetworks—The feed item is available in all Experience Cloud sites. Note the following exceptions for NetworkScope: - Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. - For feed items with a record parent, users can set NetworkScope only to AllNetworks. - You can’t filter a feed item on the NetworkScope field. ### ParentId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the custom object record that is tracked in the feed. The feed is displayed on the detail page for this record. ### RelatedRecordId - **Type**: reference - **Properties**: Group, Nillable, Sort - **Description**: ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost. ### Title - **Type**: string - **Properties**: Group, Nillable, Sort - **Description**: The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name. ### Type - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The type of feed item: - ActivityEvent—indirectly generated event when a user or the API adds a [Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_task.htm) associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or [Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_event.htm) associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. - AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. - AnnouncementPost—Not used. - ApprovalPost—generated when a user submits an approval. - BasicTemplateFeedItem—Not used. - CanvasPost—a post made by a canvas app posted on a feed. - CollaborationGroupCreated—generated when a user creates a public group. - CollaborationGroupUnarchived—Not used. - ContentPost—a post with an attached file. - CreatedRecordEvent—generated when a user creates a record from the publisher. - DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. - DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. - LinkPost—a post with an attached URL. - PollPost—a poll posted on a feed. - ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. - QuestionPost—generated when a user posts a question. - ReplyPost—generated when Chatter Answers posts a reply. - RypplePost—generated when a user creates a Thanks badge in WDC. - TextPost—a direct text entry on a feed. - TrackedChange—a change or group of changes to a tracked field. - UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: - CaseCommentPost—generated event when a user adds a case comment for a case object - EmailMessageEvent—generated event when an email related to a case object is sent or received - CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. - ChangeStatusPost—generated event when a user changes the status of a case - AttachArticleEvent—generated event when a user attaches an article to a case If you set Type to ContentPost, also specify ContentData and ContentFileName. ### Visibility - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if digital experiences is enabled for your org. Visibility can have the following values: - AllUsers—The feed item is available to all users who have permission to see the feed item. - InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: - For record posts, Visibility is set to InternalUsers for all internal users by default. - External users can set Visibility only to AllUsers. - On user and group posts, only internal users can set Visibility to InternalUsers. ## Usage A feed for a custom object is automatically created when a user enables feed tracking for the custom object. Use feeds to track changes to the custom objects they serve. For example, Textile\_\_Feed tracks changes to a Textile\_\_c object. Use feed objects to retrieve the content of feed fields, such as type of feed or feed ID. Note the following SOQL restrictions. No SOQL limit if logged-in user has View All Data permission. If not, specify a LIMIT clause of 1,000 records or fewer. SOQL ORDER BY on fields using relationships is not available. Use ORDER BY on fields on the root object in the SOQL query. ## What About StandardObjectNameFeed Objects? Similar to custom objects, standard objects can have associated feed objects. For a list of StandardObjectNameFeed objects, see [StandardObjectName Feed](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."). <!-- document id=6f1884b5ed9b6ad3442bd095017bf7c11da97f711fab9cb1bbf4fe6d81c6bdd7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_custom_objects_list.md --> # Custom Objects This section provides details on custom objects, entities that support custom objects, and their standard fields. When you create or enable features for a custom object, Salesforce creates entities to support your custom object. For example, when you enable sharing rules for a custom object, Salesforce creates a MyObjectName\_\_Share object. To verify the complete list of fields for an object or entity, you can use a describe call from the API, or inspect with an appropriate tool, for example, inspecting the WSDL or using a schema viewer. - **[FSL\_\_Time\_Dependency\_\_c](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fsl__time_dependency__c.htm)** Represents a dependency between two service appointments. This object is used to define scheduling relationships between two appointments. It allows you to determine the order and timing in which dependent appointments should be scheduled. - **[Custom Metadata Type\_\_mdt](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custommetadatatype__mdt.htm)** Represents a custom metadata record. This object is available in API version 34.0 and later. - **[Custom Object \_\_c \_\_c](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custom_object__c.htm)** Represents a custom object. - **[Custom Object\_\_Feed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customobject__feed.htm)** Represents the feed, specifically posts and feed-tracked changes, on a custom object. <!-- document id=55b81606e721cf694d472c0bdb8fb4876084a96aea47fc0d6e585fdb188afae9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_custom_objects.md --> # Custom Objects In the user interface, you can extend your org’s data by defining custom objects. Custom objects are custom database tables that allow you to store information unique to your organization. For custom objects, the custom flag—a Boolean field in the describe results—is true. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. Client applications with sufficient permissions can invoke API calls on existing custom objects. You can create custom objects with the user interface, or by using the metadata WSDL with a client application or using the Salesforce Extensions for Visual Studio Code. For more information about using the metadata WSDL to create custom objects, see the [Lightning Platform Metadata API Developer's Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/). For more information about Visual Studio Code, see [Salesforce Extensions for Visual Studio Code.](https://forcedotcom.github.io/salesforcedx-vscode/ "HTML (New Window)") ## Naming Conventions for Custom Objects Your Salesforce admin defines an associated name field for each custom object during setup. Custom objects must have unique names within your org. In the API, the names of custom objects include a suffix of two underscores followed by a lowercase “c”. For example, a custom object labeled “Issue” in the Salesforce user interface is Issue\_\_c in that organization’s WSDL. Relationships change the naming convention. For a custom object record to appear in the Salesforce user interface, its name field must be populated. If you use the API to create a custom object record that doesn’t have a name, the record’s ID is used as its name. ## Relationships Among Custom Objects Custom objects behave and relate to other objects just like standard objects do. For example, cascading deletes are supported in custom objects in a master-detail relationship. Custom objects can also have many-to-many relationships with other custom objects or standard objects. A many-to-many relationship allows each record of one object to be linked to multiple records from another object and vice versa. Custom objects require special treatment so that they can participate in Relationship Queries. For the relationship field name of a custom object, \_\_r is appended to the name to create the ID. Also, \_\_c is appended to the name to create the parent object pointer. For example, if the relationship field name is MyRel, the name of the ID becomes MyRelId\_\_r, the parent object pointer becomes MyRel\_\_c, and the relationship name is MyRel\_\_r. For more information, see Understanding Relationship Names, Custom Objects, and Custom Fields in the [Salesforce SOQL and SOSL Reference Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/ "HTML (New Window)"). This table summarizes whether a standard object can be: - The master in a master-detail relationship with a custom object. Master-detail relationships involve cascading deletes and sharing rules that the parent controls. - The lookup in a lookup relationship on a custom object. In other words, whether a custom object can have a lookup to the standard object. - Extended with custom fields. | Standard Object | Master-Detail | Lookup | Custom Fields | | --- | --- | --- | --- | | Account | Yes | Yes | Yes | | Campaign | Yes | Yes | Yes | | Case | Yes | Yes | Yes | | Contact | Yes | Yes | Yes | | Contract | Yes | Yes | Yes | | Event | No | No | Yes | | Lead | No | No | Yes | | Opportunity | Yes | Yes | Yes | | Product2 | No | Yes | Yes | | Solution | Yes | Yes | Yes | | Task | No | No | Yes | | User | No | Yes | Yes | ## Audit Fields for Custom Objects Custom objects can have the same audit fields as standard objects. When you create a custom object, the four audit fields, CreatedById, CreatedDate, LastModifiedById, and LastModifiedDate, are created and populated for the object. These fields are read only. If you import data into Salesforce custom objects and want to retain the audit field values from the source system, you can set the values when you create the custom objects. The only audit field you can’t set a value for is SystemModstamp. Your organization must be API enabled, and you must have the “Modify All Data” permission. 1. From Setup, enter User Interface in the Quick Find box, then select **User Interface** under Customize. 2. Under Setup, select **Enable “Set Audit Fields upon Record Creation” and “Update Records with Inactive Owners” User Permissions**. 3. In the permission set or profile that you want to set audit fields with, enable the permission **Set Audit Fields upon Record Creation**. 4. Using the API, create a record and set its audit fields. Note these restrictions: - CreatedDate can't be greater than the LastModifiedDate. - You can't set any date field to be greater than the current time. ## Sharing and Custom Objects A sharing rule object is created for each custom object that doesn’t have a master-detail relationship to another object. They’re similar to standard object sharing rules, for example AccountOwnerSharingRule. If the user creating the custom object has the “Manage Sharing” permission, a sharing rule object is automatically created for it. Apex sharing reasons can be retrieved describing the custom object's sharing object, and examining the information in the rowCause field. The name of a sharing object for each custom object is of the form: MyObjectName\_\_Share, similar to AccountShare and other standard object sharing objects. ## Tags and Custom Objects When a custom object is created, a Tag object related to it’s also created. These object names are of the form: MyObjectName\_\_Tag, similar to AccountTag and other standard object tag objects. ## Standard Fields for Custom Objects When a custom object is created, Salesforce assigns some standard fields to the object or entity. For details, see [Custom Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_custom_objects_list.htm "HTML (New Window)"). ## Required Fields in Custom Objects In the user interface, you can mark a custom field as required, and this rule is also enforced in the API. Each custom field has a nillable attribute, with a data type boolean. The default value is false. If set to true, each request supplies a value (or leaves the current value) to this field. Otherwise, the request fails. When the value is set to true, the next time the field is edited or created, the validation applies. If no value is supplied or default value specified, the request fails. To edit the nillable attribute, you must log in as a user with the “Customize Application” permission. If you change a custom object field to be required in an existing client application or integration, be sure that a value is supplied for that field. For example, if the custom picklist field Education Level on the contact object is required, supply a default value for that custom field. If a required field doesn’t have a specified or default value, an error with the status code REQUIRED\_FIELD\_MISSING is returned. ## Managed Packages and API Names If you have an unmanaged package and a managed package version becomes available, the API names of custom fields, custom objects, and Scontrol objects in the package change. A namespace prefix is added to each component to make it unique: _name_\_\_c becomes _prefix_\_\__name_\_\_c. To move from an unmanaged package to a managed package version of the same application, export your data, uninstall the old package, and install the new package. Then review the name changes and import your data with the relevant mapping. For details, see the [ISVforce Guide](https://resources.docs.salesforce.com/264/latest/en-us/sfdc/pdf/salesforce_packaging_guide.pdf "Adobe Acrobat PDF (New Window)"). #### See Also - [Custom Objects](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_custom_objects_list.htm "This section provides details on custom objects, entities that support custom objects, and their standard fields.") <!-- document id=6c1c1703f52dfa6d1f1e10e802ffba3894a0bf20fb9dcf31ba85b1a15f0b0828 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_custombrand.md --> # CustomBrand Represents a custom branding and color scheme. This object is available in API version 28.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available only when your org has digital experiences enabled. ## Fields | Field Name | Details | | --- | --- | | ParentId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the parent entity that this branding applies to. The parent entity can be an Experience Cloud site, organization, topic, or reputation level. The branding applies to the entity that the ParentId references. For example, if the ParentId references a network ID, the branding applies to that Experience Cloud site only, and if the ParentId references an organization ID, the branding applies to the organization that it is accessed through, and so on. Label is Branded Entity ID. | ## Usage Use this object along with [CustomBrandAsset](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custombrandasset.htm "Represents a branding element in a custom branding scheme. For example, a color, logo image, header image, or footer text. A CustomBrandAsset can apply to an Experience Cloud site or to an org using the Salesforce mobile app. This object is available in API version 28.0 and later.") to apply a custom branding scheme to your Experience Cloud site. The branding scheme for the site shows in both the user interface and in the Salesforce mobile app. You must have Create and Manage Experiences to customize site branding. You can also use this object to apply a custom branding scheme to your org when it is accessed through the Salesforce mobile app. #### See Also - [Network](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_network.htm "Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. Experience Cloud sites let you share information, records, and files with coworkers and stakeholders all in one place. This object is available in API version 26.0 and later.") <!-- document id=8455c5b15efbc631d0047d649a545a6ff0d7e87f36ed88814f078f7c79b1c659 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_custombrandasset.md --> # CustomBrandAsset Represents a branding element in a custom branding scheme. For example, a color, logo image, header image, or footer text. A CustomBrandAsset can apply to an Experience Cloud site or to an org using the Salesforce mobile app. This object is available in API version 28.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available only when your org has digital experiences enabled. ## Fields | Field Name | Details | | --- | --- | | AssetCategory | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Values include: - MotifZeronaryColor—The background color for the header. Label is Zeronary motif color. If this CustomBrandAsset is for a network, this is the header color for the network. If it is for an org, this is the header color when users access the Salesforce mobile app. - MotifPrimaryColor—The color used for the active tab. Label is Primary motif color. Not used for the Salesforce mobile app branding. - MotifSecondaryColor—The color used for the top borders of lists and tables. Label is Secondary motif color. Not used for the Salesforce mobile app branding. - MotifTertiaryColor—The background color for section headers on edit and detail pages. Label is Tertiary motif color. Not used for the Salesforce mobile app branding. - MotifQuaternaryColor—If this CustomBrandAsset is for a network, this is the background color for network pages. If it is for an org, this is the background color on a splash page. Label is Quaternary motif color. - MotifZeronaryComplementColor—Font color used with zeronaryColor. Label is Zeronary motif colors complement color. - MotifPrimaryComplementColor—Font color used with primaryColor. Label is Primary motif colors complement color. Not used for the Salesforce mobile app branding. - MotifTertiaryComplementColor—Font color used with tertiaryColor. Label is Tertiary motif colors complement color. Not used for the Salesforce mobile app branding. - MotifQuaternaryComplementColor—Font color used with quaternaryColor. Label is Quaternary motif colors complement color. Not used for the Salesforce mobile app branding. - PageHeader—An image that appears on the header of the pages. Can be an .html, .gif, .jpg, or .png file. Label is Page Header. Not used for the Salesforce mobile app branding. - PageFooter—An image that appears on the footer of the pages. Must be an .html file. Label is Page Footer. Not used for the Salesforce mobile app branding. - LoginFooterText—The text that appears in the footer of the login page. Label is Footer text displayed on the login page. Not used for the Salesforce mobile app branding. - LoginLogoImageId—The logo that appears on the login page for external users. In the Salesforce mobile app, this logo also appears on the Experience Cloud site splash page. Label is Logo image displayed on the login page. - LargeLogoImageId—Only used for the Salesforce mobile app. The logo that appears on the splash page when you start the Salesforce mobile app. Label is Large logo image. - SmallLogoImageId—Only used for the Salesforce mobile app. The logo that appears on the publisher in the Salesforce mobile app. Label is Small logo image. - StaticLogoImageURL—The logo that appears on the login page for external users. Label is Static logo image url. - LoginQuaternaryColor—The background color that appears on the Experience Cloud site login page for external users. Label is Login background color. - LoginRightFrameUrl—The URL to the contents that appears on right side of the Experience Cloud site login page for external users. Label is Login right frame url. - LogoAssetId—Navigation tile menu item images. Label is Logo asset image. - LoginPrimaryColor—The background color of the login button. Label is Login primary color. - LoginBackgroundImageUrl—The path to the image URL that appears as the background on the Experience Cloud site’s login page. Label is Background image url. - LargeLogoAssetId—Navigational topic images. Label is Large logo asset image. - MediumLogoAssetId—Featured topic images. Label is Medium logo asset image. | | AssetSourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the document uploaded to the Documents folder if the value of AssetCategory is: - PageHeader - PageFooter - LoginLogoImageId - LargeLogoImageId - SmallLogoImageId ID of the content asset if the value of the AssetCategory is: - LogoAssetId - LargeLogoAssetId - MediumLogoAssetId | | CustomBrandId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the associated [CustomBrand](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custombrand.htm "Represents a custom branding and color scheme. This object is available in API version 28.0 and later."). This is a relationship field. Relationship Name CustomBrand Relationship Type Lookup Refers To CustomBrand | | ForeignKeyAssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description This field was removed in API version 41.0, and is available in earlier versions for backward compatibility only. Use AssetSourceId instead. ID of the document used if the value of AssetCategory is PageHeader, PageFooter, or LoginLogoImageId. | | TextAsset | Type string Properties Create, Filter, Nillable, Sort, Update Description Text used if the AssetCategory is LoginFooterText. | ## Usage Use this object to add basic branding elements—color scheme, header or footer images, login page logo, or footer text—to the branding scheme ([CustomBrand](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custombrand.htm "Represents a custom branding and color scheme. This object is available in API version 28.0 and later.")) for your Experience Cloud site. You must have Create and Manage Experiences to customize site branding. If you’re using digital experiences in the Salesforce mobile app, the loading page shows the logo. #### See Also - [Network](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_network.htm "Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. Experience Cloud sites let you share information, records, and files with coworkers and stakeholders all in one place. This object is available in API version 26.0 and later.") <!-- document id=f18abe73c113e9ca9f73409fc59184b68e7a99830c9b5bc935b5436f0b6868a0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_customer.md --> # Customer Represents the customer role of an individual with respect to a particular company or organization. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CustomerStatusType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the customer account. Possible values are: - Active - Inactive | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of this customer. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PartyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. Represents the individual object related to this customer record. This is a relationship field. Relationship Name Party Relationship Type Lookup Refers To Individual | | TotalLifeTimeValue | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total revenue amount gained from this customer. | <!-- document id=38982190b7d310bade882604ec35e7e44522503c9623d21c6e2724d4c3cf3af2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_customfielddisplayvalue.md --> # CustomFieldDisplayValue Stores variation details for the product attribute item view. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules CustomFieldDisplayValue is available only if the B2B or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | Color | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The color variation in hexadecimal value format, for example #FF0000. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency ISO code allowed by the organization. Possible value is: - USD—U.S. Dollar The default value is USD. | | CustomFieldDisplayId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the custom field display that this variation is associated with. This field is a relationship field. Relationship Name CustomFieldDisplay Refers To CustomFieldDisplay | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the custom field display value. | | PickListApiValue | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The API name of the color variation picklist value, for example, red\_c. | ## Usage This object only gets populated when display type in the CustomFieldDisplay object is ColorSwatch. ## 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 CustomFieldDisplayValue. [CustomFieldDisplayValueChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [CustomFieldDisplayValueFeed](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. [CustomFieldDisplayValueHistory](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. <!-- document id=d1a2e4569e0d9de879752cdf20ca11dcfe41f8b6996bfde5b89c9a0d44893fbf url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_customhelpmenuitem.md --> # CustomHelpMenuItem Represents the items within a section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources. This object is available in API version 44.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Packaging Considerations Although you can package custom Help Menu section information, the section won't appear in the Help Menu Setup page or the Help Menu user interface of orgs where the package is installed. Instead, customers must view the data in the CustomHelpMenuItem and CustomHelpMenuSection objects and then manually add resources on the Help Menu Setup page. ## Fields | Field | Details | | --- | --- | | LinkUrl | Type url Properties Create, Filter, Sort, Update Description Required. The URL for the resource. Specify up to 1,000 characters. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Required. The name of the resource. Specify up to 100 characters. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the custom help section the item belongs to. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To CustomHelpMenuSection | | SortOrder | Type int Properties Create, Filter, Group, Sort, Update Description Required. The order of the item within the custom section. Valid values are 1 through 15. | <!-- document id=cc5e835b899e537d18992e87c8c67c1698efe5e9a7a8b712d5d6ba539907fd45 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_customhelpmenusection.md --> # CustomHelpMenuSection Represents a section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources. This object is available in API version 44.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Packaging Considerations Although you can package custom Help Menu section information, the section won't appear in the Help Menu Setup page or the Help Menu user interface of orgs where the package is installed. Instead, customers must view the data in the CustomHelpMenuItem and CustomHelpMenuSection objects and then manually add resources on the Help Menu Setup page. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the custom help section 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. The label corresponds to section title in the user interface. Limit: 80 characters. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Language of the label. Possible values are: - da (Danish) - de (German) - en\_US (English) - es (Spanish) - es\_MX (Spanish (Mexico)) - fi (Finnish) - fr (French) - it (Italian) - ja (Japanese) - ko (Korean) - nl\_NL (Dutch) - no (Norwegian) - pt\_BR (Portuguese (Brazil)) - ru (Russian) - sv (Swedish) - th (Thai) - zh\_CN (Chinese (Simplified)) - zh\_TW (Chinese (Traditional)) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Required. The name of the resource. Specify up to 100 characters. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | <!-- document id=96458aab4c9b00790b37e7440236a4e9333cf2ebce8eaef3754f7cf012347c76 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_customhttpheader.md --> # CustomHttpHeader Represents a custom HTTP header that provides context information from Salesforce such as region, org details, or the role of the person viewing the external object. This object is available in API version 43.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Filter, Nillable, Sort Description A text description of the header field’s purpose. | | HeaderFieldName | Type string Properties Filter, Group, Sort Description Name of the header field. The name must contain at least one alphanumeric character or underscore. It can also include: ! # $ % & ' \* + - . ^ \_ \` | ~ | | HeaderFieldValue | Type string Properties Filter, Sort Description A formula that resolves to the value for the header. The values in the formula must evaluate to a string. If the formula resolves to null and an empty string, the header isn’t sent. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the custom HTTP header is available to use. | | ParentId | Type reference Properties Filter, Group, Sort Description ID of the entity that the custom HTTP header is related to. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To ExternalDataSource, NamedCredential | ## Usage For each OData external data source, define up 10 HTTP headers to request data. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note HTTP headers aren’t supported on named credentials. <!-- document id=afa007d5d51df049ea65b15298aea9cfe5406051f9000aab02d38a5634ebfd08 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_custommsgchannel.md --> # CustomMsgChannel Represents a custom conversation channel and stores event-driven Messaging settings. Custom conversation channels are implemented for Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS Messaging channels. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Access to standard objects requires Salesforce admin privileges or the Customize Application permission. ## Fields | Field | Details | | --- | --- | | ChannelDefinitionId | Type reference Properties Create, Filter, Group, Sort, Update Description Specifies the ConversationChannelDefinition for the custom channel. This field is a relationship field. Relationship Name ChannelDefinition Refers To ConversationChannelDefinition | | EventCapabilitiesIsInboundAcknowledgementEnabled | Type boolean Properties Create, Filter, Update Description Indicates whether the Salesforce admin has enabled read receipts and delivery receipts for inbound messages in the Messaging settings (true) or whether the admin hasn’t enabled these inbound acknowledgments (false). The default value is false, meaning inbound acknowledgments are disabled by default even if supported by the partner. This field is available in API version 65.0 and later. Use this field instead of HasInboundReceipts. | | EventCapabilitiesIsProgressIndicatorEnabled | Type boolean Properties Create, Filter, Update Description Indicates whether the Salesforce admin has enabled AI agent progress indicators in the Messaging settings (true) or whether the admin hasn’t enabled progress indicators (false). The default value is false, meaning progress indicators for AI agents are disabled by default even if supported by the partner. This field is available in API version 65.0 and later. | | EventCapabilitiesIsTypingIndicatorDisabled | Type boolean Properties Create, Filter, Update Description Indicates whether the Salesforce admin has enabled typing indicators for outbound messages in the Messaging settings (false) or whether the admin hasn’t enabled outbound typing indicators (true). The default value is false, meaning the outbound typing indicators are enabled by default. This field is available in API version 65.0 and later. Use this field instead of HasTypingIndicator. | | HasInboundReceipts | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Salesforce admin has enabled read receipts and delivery receipts for inbound messages in the Messaging settings (true) or whether the admin hasn’t enabled these inbound acknowledgments (false). The default value is false, meaning inbound acknowledgments are disabled by default even if supported by the partner. Available in API versions 63.0 to 65.0. In API version 66.0 and later, this field is removed. Use EventCapabilitiesIsInboundAcknowledgementEnabled instead. | | HasTypingIndicator | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Salesforce admin has enabled typing indicators for outbound messages in the Messaging settings (true) or whether the admin hasn’t enabled outbound typing indicators (false). The default value is true, meaning the outbound typing indicator feature is enabled by default if supported by the partner. To disable the outbound typing indicator feature, set this value to false. Available in API versions 63.0 to 65.0. In API version 66.0 and later, this field is removed. Use EventCapabilitiesIsTypingIndicatorDisabled instead. | | MessagingChannelId | Type reference Properties Create, Filter, Group, Sort, Update Description Specifies the Messaging Channel ID for the custom channel. This field is unique within your organization. This field is a relationship field. Relationship Name MessagingChannel Refers To MessagingChannel | <!-- document id=802f6be2c46e9564189c4b121462fbc8308b3eaa6825f65a6cae72fe937438b4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_customnotificationtype.md --> # CustomNotificationType Stores information about custom notification types. This object is available in API version 47.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CustomNotifTypeName | Type string Properties Create, Filter, Group, idLookup, Sort, Unique, Update Description Specifies a notification type name. The notification type name is unique within your organization. The notification type name isn’t namespaced, so it can’t be duplicated across installed packages. Maximum number of characters: 80. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies a general description of the notification type, which is displayed with the notification type name. Maximum number of characters: 255. | | Desktop | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the desktop delivery channel is enabled (true) or not (false). The default value is false. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Specifies the API name of the notification type. | | IsSlack | Type boolean Properties Reserved for future use. Description Reserved for future use. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the language of the custom notification type. The value for this field is the language value of the org. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Specifies the notification type label. | | Mobile | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the mobile delivery channel is enabled (true) or not (false). The default value is false. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Specifies the namespace of the notification type, if installed with a managed package. | <!-- document id=e4f067dd839bd42de4d0d7d6380748f71ebde1037c74bf76fc7d4edd49088f5d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_custompermission.md --> # CustomPermission Represents a permission created to control access to a custom process or app, such as sending email. This object is available in API version 31.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only users who have one of these permissions can access this object: - View Setup and Configuration - Manage Session Permission Set Activations - Assign Permission Sets ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Filter, Group, Nillable, Sort Description A description of the custom permission. Limit: 255 characters. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the custom permission 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. The label corresponds to **Name** in the user interface. Limit: 80 characters. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsLicensed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description When enabled (true) indicates that the appropriate Salesforce license is required before accessing the permission. This field is available in API version 50.0 and later. | | IsProtected | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the custom permission is protected (true) or not (false). Protected components that have been installed in other organizations can’t be linked to or referenced by components created in the subscriber organization. A developer can delete a protected component contained in a managed package in a future release of the package without worrying about failing installations. However, after a component is marked as unprotected and is released globally, the developer can’t delete it. The default value is false. This field is available in API version 50.0 and later. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the custom permission. Valid values are: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. | | MasterLabel | Type string Properties Filter, Group, Sort Description The custom permission label, which corresponds to **Label** in the user interface. Limit: 80 characters. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | ## Usage Use the CustomPermission object to determine users’ access to custom permissions. For example, to query all permission sets where the Button1 permission is enabled: SELECT Id, DeveloperName, (select Id, Parent.Name, Parent.Profile.Name from SetupEntityAccessItems) FROM CustomPermission WHERE DeveloperName = 'Button1' To query all permission sets and profiles with custom permissions: SELECT Assignee.Name, PermissionSet.Id, PermissionSet.Profile.Name, PermissionSet.isOwnedByProfile, PermissionSet.Label FROM PermissionSetAssignment WHERE PermissionSetId IN (SELECT ParentId FROM SetupEntityAccess WHERE SetupEntityType = 'CustomPermission') To query for all SetupEntityAccess rows with custom permissions: SELECT Id,ParentId,Parent.Name, SetupEntityId FROM SetupEntityAccess WHERE SetupEntityType='CustomPermission' AND ParentId IN (SELECT Id FROM PermissionSet WHERE isOwnedByProfile = false) #### See Also - [CustomPermissionDependency](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custompermissiondependency.htm "Represents the dependency between two custom permissions when one custom permission requires that you enable another custom permission. This object is available in API version 32.0 and later.") - [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.") - [Profile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profile.htm "Represents a profile, which defines a set of permissions to perform different operations. Operations can include creating a custom profile or querying, adding, updating, or deleting information.") - [SetupEntityAccess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_setupentityaccess.htm "Represents the enabled setup entity access settings (such as for Apex classes) for the parent PermissionSet. This object is available in API version 25.0 and later.") <!-- document id=0ab27bd50d7765563a255cc17ae10de35b3f43dfae4d2456fd9173a19e070347 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_custompermissiondependency.md --> # CustomPermissionDependency Represents the dependency between two custom permissions when one custom permission requires that you enable another custom permission. This object is available in API version 32.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only users with View Setup and Configuration permission can access this object. ## Fields | Field Name | Details | | --- | --- | | CustomPermissionId | Type reference Properties Filter, Group, Sort Description The ID of the custom permission that requires the permission that’s specified in RequiredCustomPermissionId. This is a relationship field. Relationship Name CustomPermission Relationship Type Lookup Refers To CustomPermission | | RequiredCustomPermissionId | Type reference Properties Filter, Group, Sort Description The ID of the custom permission that must be enabled when CustomPermissionId is enabled. This is a relationship field. Relationship Name RequiredCustomPermission Relationship Type Lookup Refers To CustomPermission | ## Usage The following Apex class contains a method that returns the IDs of all custom permissions that are required for the given custom permission ID. To use this class, save it in your organization. public class CustomPermissionUtil { public String\[\] getAllRequiredCustomPermissions(String customPermId) { return getAllRequiredHelper(new String\[\]{customPermId}); } private String\[\] getAllRequiredHelper(String\[\] customPermIds) { CustomPermissionDependency\[\] requiredPerms = \[SELECT RequiredCustomPermissionId FROM CustomPermissionDependency WHERE CustomPermissionId IN :customPermIds\]; String\[\] requiredPermIds = new String\[\]{}; for (CustomPermissionDependency cpd : requiredPerms) { requiredPermIds.add(cpd.RequiredCustomPermissionId); } if (requiredPermIds.size() > 0) { customPermIds.addall(getAllRequiredHelper(requiredPermIds)); return customPermIds; } else { return customPermIds; } } } For more information about using Apex classes, see the [Apex Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_dev_guide.htm). #### See Also - [CustomPermission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custompermission.htm "Represents a permission created to control access to a custom process or app, such as sending email. This object is available in API version 31.0 and later.") <!-- document id=1f04156cde5be036232ada88a79fc3224f9dfbfd3371b452743aa90510d1c37f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_customreporttype.md --> # CustomReportType A custom report type for Lightning Experience and Data 360 reports. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Category | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The category for the custom report type. Possible values are: - accounts—Accounts & Contacts - activities—Activities - admin—Administrative Reports - busop—Contracts and Orders - calibration—WDC Calibration - campaigns—Campaigns - cases—Customer Support Reports - commerce—Commerce Reports - content—File and Content Reports - data\_cloud—Data 360 - employee—Employees - flow—Flows - forecasts—Forecasts - individual—Individuals - leads—Leads - opportunities—Opportunities - other—Other Reports - products—Price Books, Products and Assets - quotes—Quotes - semantic\_model—Semantic Models - territory—Territory Management - territory2—Territory Management - usage\_entitlement—Usage Entitlements - wdc—WDC | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description for the custom report type. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the custom report type in the API. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The label for the custom report type. This display value is the internal label that doesn't get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this custom report type. | | OptionsFlagIsAutoGenerated | Type boolean Properties Create, Filter, Update Description | | OptionsFlagIsDeployed | Type boolean Properties Create, Filter, Update Description Indicates whether the custom report type displays the IsDeployed option flag (true) or not (false). | | OptionsFlagIsHidden | Type boolean Properties Create, Filter, Update Description Indicates whether the custom report type displays the IsHidden option flag (true) or not (false). | <!-- document id=7e6d25130269d2835ac808a69b0039bcd403b9a2de9cace7e74f1ad4d946f5a0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dandbcompany.md --> # DandBCompany Represents a Dun & Bradstreet® company record, which is associated with an account added from Data.com. This object is available in API version 25.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning You can update fields in the DandBCompany object; however, field changes may be overwritten by Data.com Clean jobs or by using the Data.com Clean button. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Only organizations with Data.com Premium Prospector or Data.com Premium Clean can access this object. ## Fields | Field Name | Details | | --- | --- | | Address | Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where a company is physically located. Maximum size is 40 characters. | | CompanyCurrencyIsoCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The code used to represent a company’s local currency. This data is provided by the International Organization for Standardization (ISO) and is based on their three-letter currency codes. For example, USD is the ISO code for United States Dollar. Maximum size is 3 characters. | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where a company is physically located. Maximum size is 40 characters. | | CountryAccessCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The required code for international calls. Maximum size is 4 characters. | | CurrencyCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency in which the company’s sales volume is expressed. The full list of values can be found at the Optimizer Resources page maintained by Dun & Bradstreet. Maximum size is 4 characters. | | Description | Type textarea Properties Create, Nillable, Update Description A brief description of the company, which may include information about its history, its products and services, and its influence on a particular industry. Maximum size is 32000 characters. | | DomesticUltimateBusinessName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The primary name of the Domestic Ultimate, which is the highest ranking subsidiary, specified by country, within an organization’s corporate structure. Maximum size is 255 characters. | | DomesticUltimateDunsNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The D-U-N-S Number for the Domestic Ultimate, which is the highest ranking subsidiary, specified by country, within an organization’s corporate structure. Maximum size is 9 characters. | | DunsNumber | Type string Properties Create, Filter, Group, Sort, Update Description The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. Maximum size is 9 characters. | | EmployeeQuantityGrowthRate | Type double Properties Create, Filter, Nillable, Sort, Update Description The yearly growth rate of the number of employees in a company expressed as a decimal percentage. The data includes the total employee growth rate for the past two years. | | EmployeesHere | Type double Properties Create, Filter, Nillable, Sort, Update Description The number of employees at a specified location, such as a branch location. Maximum size is 15 characters. | | EmployeesHereReliability | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The reliability of the EmployeesHere figure. Available values include: - 0—Actual number - 1—Low - 2—Estimated (for all records) - 3—Modeled (for non-US records) | | EmployeesTotal | Type double Properties Create, Filter, Nillable, Sort, Update Description The total number of employees in the company, including all subsidiary and branch locations. This data is only available on records that have a value of Headquarters/Parent in the LocationStatus field. Maximum size is 15 characters. | | EmployeesTotalReliability | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The reliability of the EmployeesTotal figure. Available values include: - 0—Actual number - 1—Low - 2—Estimated (for all records) - 3—Modeled (for non-US records) A blank value indicates this data is unavailable. | | FamilyMembers | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of family members, worldwide, within an organization, including the Global Ultimate, its subsidiaries (if any), and its branches (if any). Maximum size is 5 characters. | | Fax | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The company’s facsimile number. | | FifthNaics | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional NAICS code used to further classify an organization by industry. Maximum size is 6 characters. | | FifthNaicsDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding NAICS code. Maximum size is 120 characters. | | FifthSic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | FifthSic8 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | FifthSic8Desc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | FifthSicDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | FipsMsaCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Federal Information Processing Standards (FIPS) and the Metropolitan Statistical Area (MSA) codes identify the organization’s location. The MSA codes are defined by the US Office of Management and Budget. Maximum size is 5 characters. | | FipsMsaDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s FIPS MSA code. Maximum size is 255 characters. | | FortuneRank | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The numeric value of the company’s Fortune 1000 ranking. A null or blank value means that the company isn’t ranked as a Fortune 1000 company. | | FourthNaics | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional NAICS code used to further classify an organization by industry. Maximum size is 6 characters. | | FourthNaicsDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding NAICS code. Maximum size is 120 characters. | | FourthSic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | FourthSic8 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | FourthSic8Desc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | FourthSicDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | GeoCodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Available values include: - A – Non-US rooftop accuracy - B – Block level - C – Places the address in the correct city - D – Rooftop level - I – Street intersection - M – Mailing address level - N – Not matched - P – PO BOX location - S – Street level - T – Census tract level - Z – ZIP code level - 0 (zero)– Geocode could not be assigned | | GlobalUltimateBusinessName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The primary name of the Global Ultimate, which is the highest entity within an organization’s corporate structure and may oversee branches and subsidiaries. Maximum size is 255 characters. | | GlobalUltimateDunsNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The D-U-N-S Number of the Global Ultimate, which is the highest entity within an organization’s corporate structure and may oversee branches and subsidiaries. Maximum size is 9 characters. | | GlobalUltimateTotalEmployees | Type double Properties Create, Filter, Nillable, Sort, Update Description The total number of employees at the Global Ultimate, which is the highest entity within an organization’s corporate structure and may oversee branches and subsidiaries. Maximum size is 15 characters. | | ImportExportAgent | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Identifies whether a business imports goods or services, exports goods or services, and/or is an agent for goods. Available values include: - A—Importer/exporter/agent - B—Importer/exporter - C—Importer - D—Importer/agent - E—Exporter/agent - F—Agent (keeps no inventory and does not take title goods) - G—None or data not available - H—Exporter | | IncludedInSnP500 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A true or false value. If true, the company is listed in the S&P 500 Index. If false, the company isn’t listed in the S&P 500 Index. | | Latitude | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used with longitude to specify a precise location, which is then used to assess the Geocode Accuracy. Maximum size is 11 characters. | | LegalStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Identifies the legal structure of an organization. | | LocationStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Identifies the organizational status of a company. Available values are Single location, Headquarters/Parent, and Branch. Available values include: - 0—Single location (no other entities report to the business) - 1—Headquarters/parent (branches and/or subsidiaries report to the business) - 2—Branch (secondary location to a headquarters location) | | Longitude | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used with latitude to specify a precise location, which is then used to assess the Geocode Accuracy. Maximum size is 11 characters. | | MailingAddress | Type address Properties Filter, Nillable Description The compound form of the mailing address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | MailingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where a company has its mail delivered. Maximum size is 40 characters. | | MailingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where a company has its mail delivered. Maximum size is 40 characters. | | MailingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code that a company uses on its mailing address. Maximum size is 20 characters. | | MailingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where a company has its mail delivered. Maximum size is 20 characters. | | MailingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street address where a company has its mail delivered. Maximum size is 255 characters. | | MarketingPreScreen | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The probability that a company will pay with a significant delay compared to the agreed terms. The risk level is based on the standard Commercial Credit Score, and ranges from low risk to high risk. Available values include: - L—Low risk of delinquency - M—Moderate risk of delinquency - H—High risk of delinquency ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Use this information for marketing pre-screening purposes only. | | MarketingSegmentationCluster | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Twenty-two distinct, mutually exclusive profiles, created as a result of cluster analysis of Dun & Bradstreet data for US organizations. | | MinorityOwned | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether an organization is owned or controlled by a member of a minority group. Available values include: - Y—Minority owned - N—Not minority owned | | Name | Type string Properties Create, Filter, Group, Sort, Update Description The primary or registered name of a company. Maximum size is 255 characters. | | NationalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identification number used in some countries for business registration and tax collection. Maximum size is 255 characters. | | NationalIdType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description A code value that identifies the type of national identification number used. The full list of resources can be found at the Optimizer Resources page maintained by Dun & Bradstreet. Maximum size is 5 characters. | | OutOfBusiness | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the company at the specified address has discontinued operations. Available values include: - Y—Out of business - N—Not out of business | | OwnOrRent | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether a company owns or rents the building it occupies. Available values include: - 0—Unknown or not applicable - 1—Owns - 2—Rents | | ParentOrHqBusinessName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The primary name of the parent or headquarters company. Maximum size is 255 characters. | | ParentOrHqDunsNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The D-U-N-S Number for the parent or headquarters. Maximum size is 9 characters. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description A company’s primary telephone number. | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code that corresponds to a company’s physical location. Maximum size is 20 characters. | | PremisesMeasure | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description A numeric value for the measurement of the premises. | | PremisesMeasureReliability | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A descriptive accuracy of the measurement such as actual, estimated, or modeled. | | PremisesMeasureUnit | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A descriptive measurement unit such as acres, square meters, or square feet. | | PrimaryNaics | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The six-digit North American Industry Classification System (NAICS) code is the standard used by business and government to classify business establishments according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the US business economy. The full list of values can be found at the Optimizer Resources page maintained by Dun & Bradstreet. Maximum size is 6 characters. | | PrimaryNaicsDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on its NAICS code. Maximum size is 120 characters. | | PrimarySic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The four-digit Standard Industrial Classification (SIC) code is used to categorize business establishments by industry. The full list of values can be found at the Optimizer Resources page maintained by Dun & Bradstreet. Maximum size is 4 characters. | | PrimarySic8 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The eight-digit Standard Industrial Classification (SIC) code is used to categorize business establishments by industry. The full list of values can be found at the Optimizer Resources page maintained by Dun & Bradstreet. Maximum size is 8 characters. | | PrimarySic8Desc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on its SIC code. The full list of values can be found at the Optimizer Resources page maintained by Dun & Bradstreet. Maximum size is 80 characters. | | PrimarySicDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on its SIC code. Maximum size is 80 characters. | | PriorYearEmployees | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of employees for the prior year. | | PriorYearRevenue | Type double Properties Create, Filter, Nillable, Sort, Update Description The annual revenue for the prior year. | | PublicIndicator | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether ownership of the company is public or private. Available values include: - Y—Public - N—Private | | SalesTurnoverGrowthRate | Type double Properties Create, Filter, Nillable, Sort, Update Description The increase in annual revenue from the previous value for an equivalent period expressed as a decimal percentage. | | SalesVolume | Type double Properties Create, Filter, Nillable, Sort, Update Description The total annual sales revenue in the headquarters’ local currency. Dun & Bradstreet tracks revenue data for publicly traded companies, Global Ultimates, Domestic Ultimates, and some headquarters. | | SalesVolumeReliability | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The reliability of the SalesVolume figure. Available values include: - 0—Actual number - 1—Low - 2—Estimated (for all records) - 3—Modeled (for non-US records) | | SecondNaics | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional NAICS code used to further classify an organization by industry. Maximum size is 6 characters. | | SecondNaicsDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding NAICS code. Maximum size is 120 characters. | | SecondSic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | SecondSic8 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | SecondSic8Desc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | SecondSicDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | SixthNaics | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional NAICS code used to further classify an organization by industry. Maximum size is 6 characters. | | SixthNaicsDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding NAICS code. Maximum size is 120 characters. | | SixthSic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | SixthSic8 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | SixthSic8Desc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | SixthSicDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | SmallBusiness | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the company is designated a small business as defined by the Small Business Administration of the US government. Available values include: - Y—Small business site - N—Not small business site | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where a company is physically located. Maximum size is 20 characters. | | StockExchange | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The corresponding exchange for a company’s stock symbol. For example: NASDAQ or NYSE. Maximum size is 16 characters. | | StockSymbol | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The abbreviation used to identify publicly traded shares of a particular stock. Maximum size is 6 characters. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street address where a company is physically located. Maximum size is 255 characters. | | Subsidiary | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether a company is more than 50 percent owned by another organization. Available values include: - 0—Not subsidiary of another organization - 3—Subsidiary of another organization | | ThirdNaics | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional NAICS code used to further classify an organization by industry. Maximum size is 6 characters. | | ThirdNaicsDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding NAICS code. Maximum size is 120 characters. | | ThirdSic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | ThirdSic8 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters. | | ThirdSic8Desc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | ThirdSicDesc | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters. | | TradeStyle1 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A name, different from its legal name, that an organization may use for conducting business. Similar to “Doing business as” or “DBA”. Maximum size is 255 characters. | | TradeStyle2 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional tradestyle used by the organization. Maximum size is 255 characters. | | TradeStyle3 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional tradestyle used by the organization. Maximum size is 255 characters. | | TradeStyle4 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional tradestyle used by the organization. Maximum size is 255 characters. | | TradeStyle5 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An additional tradestyle used by the organization. Maximum size is 255 characters. | | URL | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description An organization’s primary website address. Maximum size is 104 characters. | | UsTaxId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identification number for the company used by the Internal Revenue Service (IRS) in the administration of tax laws. Also referred to as Federal Taxpayer Identification Number. Maximum size is 9 characters. | | WomenOwned | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether a company is more than 50 percent owned or controlled by a woman. Available values include: - Y—Owned by a woman - N—Not owned by a woman, or unknown | | YearStarted | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The year the company was established or the year when current ownership or management assumed control of the company. Maximum size is 4 characters. | ## Usage Use this object to manage D&B Company records in your organization. <!-- document id=f1673618935b73b3d9b19aa84c89f3c7727c2c522d9f9152ed3305ac29bb4a13 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dashboard.md --> # Dashboard Represents a dashboard, which shows data from custom reports as visual components. Access is read-only. This object is available in API version 20.0 and later. ## Supported Calls describeSObjects(), describeLayout(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | BackgroundDirection | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Returns the direction of the background fade. Available values are: - Top to Bottom - Left to Right - Diagonal (default value) Label is Background Fade Direction. | | BackgroundEnd | Type int Properties Filter, Group, Sort Description Returns the ending fade color in hexadecimal. Label is Ending Color. | | BackgroundStart | Type int Properties Filter, Group, Sort Description Returns the starting fade color in hexadecimal. Label is Starting Color. | | ChartTheme | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Returns the background theme used for charts. Possible values are: - dark—Dark Background - light—Light Background | | ColorPalette | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Returns the color palette used for the dashboard. Possible values are: - Default—Default Palette - accessible—Mineral(Accessible) Palette - bluegrass—Branding Palette - bluegrass—Bluegrass Palette - colorSafe—Color Safe Palette - dusk—Dusk Palette - earth—Lake Palette - fire—Fire Palette - gray—Gray Palette - heat—Heat Palette - justice—Wildflowers Palette - nightfall—Nightfall Palette - pond—Pond Palette - sunrise—Sunrise Palette - tropic—Ocean Palette - unity—Aurora Palette - water—Water Palette - watermelon—Watermelon Palette | | DashboardResultRefreshedDate | Type string Properties Nillable Description Returns the date on which the dashboard results were last refreshed. | | DashboardResultRunningUser | Type string Properties Nillable Description  The user whose security settings were used to generate the dashboard results. | | Description | Type string Properties Filter, Group, Nillable, Sort Description Returns the description of the dashboard. Limit: 255 characters. | | DeveloperName | Type string Properties Filter, Group, Sort Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. 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 Dashboard Unique Name. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | FolderId | Type reference Properties Filter, Group, Sort Description Required. Returns the ID of the Folder that contains the dashboard. See Folder. This is a relationship field. Relationship Name Folder Relationship Type Lookup Refers To Folder, User | | FolderName | Type string Properties Filter, Nillable, Sort Description Name of the folder that contains the dashboard. Available in API version 35.0 and later. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The 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 The 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. | | LeftSize | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Returns the size of the left column of the dashboard. Available values are: - Narrow - Medium - Wide | | MiddleSize | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Returns the size of the middle column of the dashboard. Available values are: - Narrow - Medium - Wide | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | RightSize | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Returns the size of the right column in the dashboard. Available values are: - Narrow - Medium - Wide | | RunningUserId | Type reference Properties Filter, Group, Sort Description Returns the ID of the running user specified for the dashboard. If the dashboard was created in Lightning Experience and is configured to run as the viewing user, it returns the user ID of the dashboard creator. If the dashboard was created in Salesforce Classic and is configured to run as the logged-in user, returns the user ID of the last specified running user. This is a relationship field. Relationship Name RunningUser Relationship Type Lookup Refers To User | | TextColor | Type int Properties Filter, Group, Sort Description Returns the body text color in hexadecimal. Label is Text Color. | | Title | Type string Properties Filter, Group, idLookup, Sort Description Returns the title of the dashboard. Limit: 80 characters. | | TitleColor | Type int Properties Filter, Group, Sort Description Returns the title text color in hexadecimal. Label is Title Color. | | TitleSize | Type int Properties Filter, Group, Sort Description Returns the title font size in points. Label is Title Size. | | Type | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Returns the dashboard type. Available values are: - SpecifiedUser—The dashboard displays data according to the access level of one specific running user. - LoggedInUser—The dashboard displays data according to the access level of the logged-in user. - MyTeamUser—The dashboard displays data according to the access level of the logged-in user, and managers can view dashboards from the point of view of users beneath them in the role hierarchy. | ## Supported Query Scopes Use these scopes to help specify the data that your SOQL query returns. allPrivate Records saved in all users’ private folders. Requires the user permission "Manage All Private Reports and Dashboards" and [Enhanced Analytics Folder Sharing](https://help.salesforce.com/HTViewHelpDoc?id=analytics_sharing_enable.htm&language=en_US). If your organization was created after the Summer ’13 release, you already have Enhanced Analytics Folder Sharing. Available in API version 36.0 and later. created Records created by the user running the query. everything All records except records saved in other users’ private folders. mine Records saved in the private folder of the user running the query. ## Usage Provides read-only access to the current values in the dashboard fields. ## Example: Dashboards in an Inactive User’s Private Folder This SOQL query returns dashboards saved in a specific user’s private folder. SELECT Id FROM Dashboard USING SCOPE allPrivate WHERE CreatedByID = ‘005A0000000Bc2deFG’ ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [DashboardFeed](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. #### See Also - [DashboardTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dashboardtag.htm "Associates a word or short phrase with a Dashboard. This object is available in API version 20.0 and later.") - [Report](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_report.htm "Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only. This object is available in API version 20.0 and later.") <!-- document id=6d575df1bfbb45e3913c641a979dbc0b482b7bb9dbd0cdf67daba8b6615d77fa url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_dashboard.md --> # Dashboard Event Type Dashboard events contain details about report requests from dashboards. These requests are triggered by dashboard refreshes, subscriptions, and filter changes. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When a table component is added to a dashboard and the dashboard is refreshed, event monitoring logs aren't generated for the dashboard refresh. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_IP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.</dd><dd class="dd">For example: <samp class="codeph nolang">96.43.144.26</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CPU_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DASHBOARD_COMPONENT_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the dashboard component.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DASHBOARD_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the dashboard that was run.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DASHBOARD_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the dashboard that was run.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DASHBOARD_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The type of dashboard.</dd><dt class="dt dlterm">Possible Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><span class="keyword parmname">R</span>: Run as running user</li><li class="li"><span class="keyword parmname">C</span>: Run as context user</li><li class="li"><span class="keyword parmname">S</span>: Run as specific user</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="event-type-desc"><a name="event-type-desc"></a>The type of event.</span> The value is always <samp class="codeph nolang">Dashboard</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">IS_SCHEDULED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Boolean</dd><dt class="dt dlterm">Description</dt><dd class="dd">1 if the dashboard component ran successfully, 0 if it didn’t.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">IS_SUCCESS</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Boolean</dd><dt class="dt dlterm">Description</dt><dd class="dd">1 if the dashboard component ran successfully, 0 if it didn’t.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LOGIN_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.</dd><dd class="dd">For example: <samp class="codeph nolang">GeJCsym5eyvtEK2I</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the organization.</dd><dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REPORT_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the report that was run.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REPORT_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the report that was run.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">RUN_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The amount of time that the request took in milliseconds.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.</dd><dd class="dd">For example: <samp class="codeph nolang">d7DEq/ANa7nNZZVD</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd><dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. Timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The URI of the page that’s receiving the request.</dd><dd class="dd">For example: <span class="keyword parmname">/home/home.jsp</span>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">ID</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the URI of the page that’s receiving the request.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="user-id-desc"><a name="user-id-desc"></a>The 15-character ID of the user the dashboard is running as.</span></dd><dd class="dd"><span class="ph" id="user-id-ex"><a name="user-id-ex"></a>For example: <samp class="codeph nolang">00530000009M943</samp></span></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the user the dashboard is running as.</dd><dd class="dd">For example: <samp class="codeph nolang">00590000000I1SNIA0</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">VIEWING_USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The ID of the user who’s viewing the dashboard.</dd></dl></td></tr></tbody></table> #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=ad5fda943954043133a1f67604bbf8ef692c3c82eae424f6987c0d31627bc9c2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dashboardcomponent.md --> # DashboardComponent Represents a dashboard component, which can be a chart, metric, table, or gauge on a dashboard. Access is read-only. This object is available in API version 21.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CustomReportId | Type reference Properties Filter, Group, Nillable, Sort Description Requires the user permission "Manage All Private Reports and Dashboards." The ID of the report that provides data for the dashboard component. See [Report](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_report.htm#sforce_api_objects_report "Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only. This object is available in API version 20.0 and later."). | | DashboardId | Type reference Properties Filter, Group, Sort Description The ID of the dashboard that contains the dashboard component. See [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dashboard.htm#sforce_api_objects_dashboard "Represents a dashboard, which shows data from custom reports as visual components. Access is read-only. This object is available in API version 20.0 and later."). This is a relationship field. Relationship Name Dashboard Relationship Type Lookup Refers To Dashboard | | Name | Type string Properties Filter, Group, Nillable, Sort Description The name of the dashboard component. | ## Usage Provides read only access to the current values in dashboard component fields. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [DashboardComponentFeed](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. <!-- document id=e9df8e70637f4cd3d6533957a5d39a3ab8e7cc546752a896f7449e1f31839769 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dashboardtag.md --> # DashboardTag Associates a word or short phrase with a Dashboard. This object is available in API version 20.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage DashboardTag stores the relationship between its parent TagDefinition and the Dashboard being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. #### See Also - [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dashboard.htm "Represents a dashboard, which shows data from custom reports as visual components. Access is read-only. This object is available in API version 20.0 and later.") <!-- document id=e9d6d84902e7784f3159313edea1ae995a10f55206b68a9b42f6fb9fad91b052 url=/legacydeveloper/current/en-us/object_reference/data_model.md --> # Data Model Entity relationship diagrams (ERDs) for standard Salesforce objects illustrate important relationships between objects. Salesforce ERDs use crow’s foot notation. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note ERDs are hosted in the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide). The Salesforce Data Model Gallery is a curated collection of diagrams that illustrate the underlying data models for Salesforce products, features, and clouds. It’s a resource designed to support customers, developers, solution engineers, and data architects in understanding how data is structured across Salesforce — enabling better solution design, integration planning, and implementation strategy. The data model for your custom objects depends on what you create. <!-- document id=96de888da4900a11207909f0f1cbb2f4180db017f688e0badd2c0c8b4f20f8dc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dataassessmentfieldmetric.md --> # DataAssessmentFieldMetric Represents summary statistics for matched, blank, and differing fields in account records of an org compared to records in Data.com. This object is available in API version 37.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() Child Relationships DataAssessmentFieldMetric is a child object of [DataAssessmentMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataassessmentmetric.htm#sforce_api_objects_DataAssessmentMetric "Represents a summary of statistics for fields matched and unmatched in your account records with Data.com account records. This object is available in API version 37.0 and later.") object. ## Fields | Field Name | Details | | --- | --- | | DataAssessmentMetricId | Type reference Properties Filter, Group, Sort Description A unique number that identifies the parent [DataAssessmentMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataassessmentmetric.htm#sforce_api_objects_DataAssessmentMetric "Represents a summary of statistics for fields matched and unmatched in your account records with Data.com account records. This object is available in API version 37.0 and later.") record. This is a relationship field. Relationship Name DataAssessmentMetric Relationship Type Lookup Refers To DataAssessmentMetric | | FieldName | Type string Properties Filter, Group, Nillable, Sort Description The name of the assessed field. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An optional field used to name your record. | | NumMatchedBlanks | Type int Properties Filter, Group, Nillable, Sort Description The number of matched records that contain blank fields. | | NumMatchedDifferent | Type int Properties Filter, Group, Nillable, Sort Description The number of matched records that have a different value for this field. | | NumMatchedInSync | Type int Properties Filter, Group, Nillable, Sort Description The number of matched records that have the same value for this field. | | NumUnmatchedBlanks | Type int Properties Filter, Group, Nillable, Sort Description The number of unmatched records that contain blank fields. | <!-- document id=9948eb906b7abae0c6ab30c2026983952f02e8b7e574de4ef28b7d3537048312 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dataassessmentmetric.md --> # DataAssessmentMetric Represents a summary of statistics for fields matched and unmatched in your account records with Data.com account records. This object is available in API version 37.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An optional field used to name your record. | | NumDuplicates | Type int Properties Filter, Group, Nillable, Sort Description The number of duplicate records. | | NumMatched | Type int Properties Filter, Group, Nillable, Sort Description The number of matched records. | | NumMatchedDifferent | Type int Properties Filter, Group, Nillable, Sort Description The number of records in your org matched with a Data.com record that have different fields. | | NumProcessed | Type int Properties Filter, Group, Nillable, Sort Description The number of records processed in the data assessment. | | NumTotal | Type int Properties Filter, Group, Nillable, Sort Description The number of records available for data assessment processing. | | NumUnmatched | Type int Properties Filter, Group, Nillable, Sort Description The number of records not matched. | <!-- document id=a3fef3da1352711a1a655fdc2e1908ef017b8b5bbb85f011803c07c9980e4b05 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dataassessmentvaluemetric.md --> # DataAssessmentValueMetric Summarizes the number of fields matched for your account records with Data.com account records.This object is available in API version 37.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() Child Relationships DataAssessmentValueMetric is a child of [DataAssessementFieldMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataassessmentfieldmetric.htm#sforce_api_objects_DataAssessmentFieldMetric "Represents summary statistics for matched, blank, and differing fields in account records of an org compared to records in Data.com. This object is available in API version 37.0 and later."). ## Fields | Field Name | Details | | --- | --- | | DataAssessmentFieldMetricId | Type reference Properties Filter, Group, Sort Description A unique number that identifies the parent [DataAssessementFieldMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataassessmentfieldmetric.htm#sforce_api_objects_DataAssessmentFieldMetric "Represents summary statistics for matched, blank, and differing fields in account records of an org compared to records in Data.com. This object is available in API version 37.0 and later.") record. This is a relationship field. Relationship Name DataAssessmentFieldMetric Relationship Type Lookup Refers To DataAssessmentFieldMetric | | FieldValue | Type string Properties Filter, Group, Nillable, Sort Description The value in the matched field. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An optional field used to name your record. | | ValueCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times this value appears in this field. | <!-- document id=881b7927fa6729e0b0e43b6836342da6581eda81cf6e17102418cace22e0c722 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_databasesaveevent.md --> # Database Save Event Type Database Save events track when records are created, updated, or deleted. This object is available in API version 63.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | DML\_TYPE | Type String Description The type of DML statement. | | EVENT\_TYPE | Type Id Description The type of event. | | FIRST\_ENTITY\_ID | Type String Description The first ID that is logged when an update occurs. If a single record is updated, the ID of that row is logged. If multiple records are updated, only one ID is logged. | | KEY\_PREFIX | Type String Description The key prefix of the entity type that was saved. | | LOGIN\_KEY | Type String Description The string that ties together all events in a given user’s login session.  | | NUM\_ROWS | Type String Description The number of entities that were saved. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. | | REQUEST\_ID | Type String Description Globally unique id for a given request. | | SAMPLE\_FACTOR | Type Number Description The ratio of saved entities that were logged. A value of 1 means every entity saved was logged. A value of 100 means that 1 out of 100 entities saved was logged. | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. Example d7DEq/ANa7nNZZVD | | TIMESTAMP | Type String Description The Timestamp at which the log event was generated. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z | | USER\_ID | Type Id Description The ID of the user who’s using Salesforce services through the UI or the API. Example 005XXXXXXXXXXXX | <!-- document id=5f11d5fa8870514e2fb9db08ff373c0652fa3431b40c0804bcb53ce80174ad03 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_databasesaveeventlog.md --> # DatabaseSaveEventLog Database Save events track when records are created,updated, or deleted This object is available in API version 64.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | DmlType | Type string Properties Filter, Group, Nillable, Sort Description The type of DML operation. | | FirstObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Only the first object ID is logged upon an update. During record updates, the ID of that specific row is logged. When multiple rows are updated, only a single ID is logged. | | KeyPrefix | Type string Properties Filter, Group, Nillable, Sort Description The key prefix of the entity type that was saved | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. The session starts with a login event and ends with either a logout event or the user session expiring. For example, lUqjLPQTWRdvRG4. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. | | RowCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of records in the result set. | | SampleFactor | Type double Properties Filter, Nillable, Sort Description Rate at which entities are logged. If the sample factor is 1 that means every entity saved was logged. If it is 100 that means that 1/100 logs. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. | <!-- document id=18655975f0d4069f791e51281c5b1f49593f3a722b82bce1d22287f6071153fb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datacloudcompany.md --> # DatacloudCompany Represents the fields for Data.com company records. This object is available in API version 30.0 or later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields are removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). ## Supported Calls describeLayout(), describeSObjects(), query() ## Fields | Field Name | Details | | --- | --- | | ActiveContacts | Type int Properties Nillable Description The number of active contacts that are associated with a company. | | AnnualRevenue | Type currency Properties Filter, Nillable Description The amount of money that the company makes in 1 year. Annual revenue is measured in US dollars. | | City | Type string Properties Filter, Nillable, Sort Description The name of the city where the company is located. | | CompanyId | Type string Properties Filter, Nillable Description A unique numerical identifier for the company and theData.com identifier for a company. | | Country | Type string Properties Filter, Nillable, Sort Description A string that represents the standard abbreviation for the country where the company is located. | | CountryCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist Description A standardized name for countries of the world. | | Description | Type string Properties Nillable Description A brief synopsis of the company that provides a general overview of the company and what it does. | | DunsNumber | Type string Properties Filter, Nillable Description A randomly generated nine-digit number that’s assigned by Dun & Bradstreet (D&B) to identify unique business establishments. | | EmployeeQuantityGrowthRate | Type double Properties Nillable Description The yearly growth rate of the number of employees in a company expressed as a decimal percentage. The data includes the total employee growth rate for the past two years. | | ExternalId | Type string Properties Filter, Nillable, Sort Description A unique numerical identifier for the company. The ExternalId is a system-generated number. | | Fax | Type phone Properties Nillable Description The telephone number that’s used to send and receive faxes. | | FortuneRank | Type int Properties Defaulted on create, Group, Nillable Description The numeric value of the company’s Fortune 1000 ranking. A null or blank value means that the company isn’t ranked as a Fortune 1000 company. | | FullAddress | Type string Properties Group, Nillable Description The complete address of a company, including Street, City, State, and Zip. | | IncludedInSnP500 | Type string Properties Group, Nillable Description A true or false value. If true, the company is listed in the S&P 500 Index. If false, the company isn’t listed in the S&P 500 Index. | | Industry | Type string Properties Nillable Description A description of the type of industry such as Telecommunications, Agriculture, or Electronics. | | IsInCrm | Type boolean Properties Defaulted on create, Group Description Whether the record is in Salesforce (true) or not (false). | | IsInactive | Type boolean Properties Defaulted on create, Filter Description A true or false response. True, the company record is not active. False, the company record is active. | | IsOwned | Type boolean Properties Defaulted on create Description A true or false value. True, your organization owns the record. False, your organization doesn’t own the record. | | NaicsCode | Type string Properties Filter, Nillable Description A value that represents the North American Industry Classification System (NAICS) code. NAICS was created to provide details about a business’s service orientation. The code descriptions are focused on what a business does. | | NaicsDesc | Type string Properties Nillable Description A description of the NAICS classification. | | Name | Type string Properties Filter, Nillable, Sort Description The company’s name. | | NumberOfEmployees | Type int Properties Filter, Nillable Description The number of employees working for the company. | | Ownership | Type string Properties Filter, Nillable Description The type of ownership of the company: - Public - Private - Government - Other | | Phone | Type phone Properties Nillable Description A numeric string containing the primary telephone number for the company. | | PremisesMeasure | Type int Properties Group, Nillable Description A numeric value for the measurement of the premises. | | PremisesMeasureReliability | Type string Properties Group, Nillable Description A descriptive accuracy of the measurement such as actual, estimated, or modeled. | | PremisesMeasureUnit | Type string Properties Group, Nillable Description A descriptive measurement unit such as acres, square meters, or square feet. | | PriorYearEmployees | Type int Properties Group, Nillable Description The total number of employees for the prior year. | | PriorYearRevenue | Type double Properties Nillable Description The annual revenue for the prior year. | | SalesTurnoverGrowthRate | Type double Properties Nillable Description The increase in annual revenue from the previous value for an equivalent period expressed as a decimal percentage. | | Sic | Type string Properties Filter, Nillable Description A numeric value that represents the Standard Industrial Codes (SIC). SIC is a numbering convention that indicates what type of service a business provides. It is a four-digit value. | | SicCodeDesc | Type string Properties Group, Nillable Description The SIC numeric code and description for a company. | | SicDesc | Type string Properties Nillable Description A description of the SIC classification. | | Site | Type picklist Properties Filter, Group, Nillable, Restricted picklist Description An organizational status of the company. - Branch: a secondary location to a headquarter location - Headquarter: a parent company with branches or subsidiaries - Single Location: a single business with no subsidiaries or branches | | State | Type string Properties Filter, Nillable, Sort Description The two-letter standard abbreviation for a state. | | StateCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist Description A standard two-letter abbreviation for states and territories of the United States. The state where the company is located. The abbreviation can also be a province or other equivalent to a state, depending on the country where the company is located. | | Street | Type string Properties Nillable Description A postal address for the company. | | TickerSymbol | Type string Properties Nillable Description The symbol that uniquely identifies companies that are traded on public stock exchanges. | | TradeStyle | Type string Properties Nillable Description A legal name under which a company conducts business. | | UpdatedDate | Type dateTime Properties Nillable, Sort Description The last date and time when the information for this company was updated. | | Website | Type url Properties Nillable Description The standard URL for the company’s home page. | | YearStarted | Type string Properties Nillable Description The year when the company was founded. | | Zip | Type string Properties Filter, Nillable Description A numeric postal code that’s designated for the address. | ## Usage Use the DatacloudCompany object to search the Data.com database for companies with the specific criteria that you enter. Use this object to find company records that you are interested in purchasing for your organization. Data.com APIs use the term “company,” which is similar to Salesforce term “accounts.” ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important DatacloudCompany can’t be used in Apex test methods, because an external web service call is required to access it. These calls are not allowed in Apex test methods. <!-- document id=2cb466fa12ba5484b8671361c07ac5c76c5dd8290bc63941aff82a5bac81401e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datacloudcontact.md --> # DatacloudContact The fields and properties for Data.com contact records. This object is available in API version 30.0 or later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields are removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). ## Supported Calls describeSObjects(), query() ## Fields | Field Name | Details | | --- | --- | | City | Type string Properties Filter, Nillable, Sort Description The city where the company is located. | | CompanyId | Type string Properties Filter, Nillable Description The unique numerical identifier for the company and the Data.com company identification number or Data.com Key. | | CompanyName | Type string Properties Filter, Group, Sort Description The name of the company. | | ContactId | Type string Properties Filter, Nillable Description The unique numeric identifier for this contact. | | Country | Type string Properties Filter, Nillable, Sort Description The standard abbreviation or name for the country where the company is located. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can enter a comma-separated list of countries; however, for a country that uses a comma in its name, leave out the comma. For example, enter “Taiwan, ROC” as Taiwan ROC. | | Department | Type picklist Properties Filter, Group, Restricted picklist Description The department in the company that the contact is affiliated with. The values of this field are fixed enumerated values. - Engineering - Finance - Human Resources - IT - Marketing - Operations - Other - Sales - Support | | Email | Type email Properties Filter, Nillable Description A business email address for the contact. | | ExternalId | Type string Properties Filter, Nillable, Sort Description A unique system-generated numerical identifier for the contact. | | FirstName | Type string Properties Filter, Nillable Description The first name of the contact. | | IsInCrm | Type boolean Properties Defaulted on create, Group Description Whether the record is in Salesforce (true) or not (false). | | IsInactive | Type boolean Properties Defaulted on create, Filter Description Whether the record is active (false) or not (true). | | IsOwned | Type boolean Properties Defaulted on create Description - True: You own this record. - False: You do not own this record. | | LastName | Type string Properties Filter, Nillable, Sort Description The last name of the contact. | | Level | Type picklist Properties Filter, Group, Nillable, Restricted picklist Description A human resource label that designates a person’s level in the company. The values of this field are fixed enumerated values. - C-Level - VP - Director - Manager - Staff - Other | | Phone | Type phone Properties Nillable Description The direct-dial telephone number for the contact. | | SocialHandles | Type string Description The social handles for this contact. Social handles are a normalized URL and user name for social media accounts such as, LinkedIn, Facebook, and Twitter. This field is response-only. The DatacloudSocialHandles object is a child of the DatacloudContact object. | | State | Type string Properties Filter, Nillable, Sort Description The state where the company is located, which can also be a province or other equivalent to a state, depending on the country where the company is located. | | Street | Type string Properties Nillable Description The street address for the company where the contact works. | | Title | Type string Properties Filter, Group, Nillable, Sort Description Title of the contact such as CEO or Vice President. | | UpdatedDate | Type dateTime Properties Nillable, Sort Description The last date and time when the information for a contact was updated. | | Zip | Type string Properties Filter, Nillable Description The postal or zip code for the address. | ## Usage This object searches the Data.com database for contacts with the specific criteria that you enter. Use this object to find contact records that you are interested in purchasing for your organization. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important DatacloudContact can’t be used in Apex test methods, because an external web service call is required to access it. These calls are not allowed in Apex test methods. <!-- document id=cf75e1472cb2469d95a0345ef8842269b5215c5255df9c5b3ec07655efed0d6b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dataclouddandbcompany.md --> # DatacloudDandBCompany Represents a set of read-only fields that are used to return D&B company data from Data.com API calls. This object is available in API version 30.0 or later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). ## Supported Calls describeSObjects(), query() ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d585931e89">Field Name</th> <th class="featureTableHeader " id="d585931e92">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">City</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The name of the city where the company is physically located.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">CompanyCurrencyIsoCode</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The code used to represent a company’s local currency. This data is provided by the International Organization for Standardization (ISO) and is based on their three-letter currency codes. For example, USD is the ISO code for United States Dollar.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">CompanyId</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A unique numeric identifier for a company.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Country</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The country where a company is physically located.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">CountryAccessCode</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The required code for international calls.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">CurrencyCode</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The currency in which the company’s sales volume is expressed.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Description</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of the company, which may include information about its history, its products and services, and its influence on a particular industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">DomesticUltimateBusinessName</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The primary name of the Domestic Ultimate, which is the highest ranking subsidiary, specified by country, within an organization’s corporate structure.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">DomesticUltimateDunsNumber</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The D-U-N-S number for the Domestic Ultimate, which is the highest-ranking subsidiary, specified by country, within an organization’s corporate structure.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">DunsNumber</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname" id="employeequantitygrowthrateparmname"><a name="employeequantitygrowthrateparmname"><!-- --></a>EmployeeQuantityGrowthRate</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <a name="employeequantitygrowthratedl"><!-- --></a> <dl class="dl detailList" id="employeequantitygrowthratedl"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="EmployeeQuantityGrowthRatedlDescph"><a name="EmployeeQuantityGrowthRatedlDescph"><!-- --></a>The yearly growth rate of the number of employees in a company expressed as a decimal percentage. The data includes the total employee growth rate for the past two years.</span></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">EmployeesHere</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The number of employees at a specified location, such as a branch location.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">EmployeesHereReliability</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The reliability of the <span class="keyword parmname">EmployeesHere</span> figure. Available values are <kbd class="ph userinput">Actual number</kbd>, <kbd class="ph userinput">Low</kbd>, <kbd class="ph userinput">Estimated (for all records)</kbd>, <kbd class="ph userinput">Modeled (for non-US records)</kbd>. A blank value indicates this data is unavailable. </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">EmployeesTotal</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The total number of employees in the company, including all subsidiary and branch locations. This data is available only on records that have a value of <kbd class="ph userinput">Headquarters/Parent</kbd> in the <span class="keyword parmname">LocationStatus</span> field. </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">EmployeesTotalReliability</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The reliability of the <span class="keyword parmname">EmployeesTotal</span> figure. Available values are <kbd class="ph userinput">Actual number</kbd>, <kbd class="ph userinput">Low</kbd>, <kbd class="ph userinput">Estimated (for all records)</kbd>, <kbd class="ph userinput">Modeled (for non-US records)</kbd>. A blank value indicates this data is unavailable. </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ExternalId</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A system generated numeric identification.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FamilyMembers</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The total number of family members, worldwide, within an organization, including the Global Ultimate, its subsidiaries (if any), and its branches (if any).</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Fax</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">phone</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The company’s facsimile number.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FifthNaics</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p"><span class="ph" id="AdditioanlNaicsCodeDef"><a name="AdditioanlNaicsCodeDef"><!-- --></a>A NAICS code that’s used to further classify an organization by industry.</span></p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FifthNaicsDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p"><span class="ph" id="AdditinalNaicsDescDef"><a name="AdditinalNaicsDescDef"><!-- --></a>A brief description of an organization’s line of business, based on the corresponding NAICS code.</span></p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FifthSic</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A Standard Industrial Classification (SIC) code that’s used to further classify an organization by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FifthSic8</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FifthSic8Desc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FifthSicDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on the corresponding SIC code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FipsMsaCode</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The Federal Information Processing Standards (FIPS) and the Metropolitan Statistical Area (MSA) codes identify the organization’s location. The MSA codes are defined by the US Office of Management and Budget.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FipsMsaDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s FIPS MSA code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname" id="hasfortune1000rankparmname"><a name="hasfortune1000rankparmname"><!-- --></a>FortuneRank</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <a name="hasfortune1000rankdl"><!-- --></a> <dl class="dl detailList" id="hasfortune1000rankdl"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="HasFortune1000RankDescph"><a name="HasFortune1000RankDescph"><!-- --></a>The numeric value of the company’s Fortune 1000 ranking. A null or blank value means that the company isn’t ranked as a Fortune 1000 company.</span></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FourthNaics</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A NAICS code used to further classify an organization by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FourthNaicsDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on the corresponding NAICS code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FourthSic</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A SIC code used to further classify an organization by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FourthSic8</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FourthSic8Desc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">FourthSicDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on the corresponding SIC code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">GeoCodeAccuracy</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The level of accuracy of a location’s geographical coordinates compared with its physical address. Available values include <kbd class="ph userinput">Rooftop level</kbd>, <kbd class="ph userinput">Street level</kbd>, <kbd class="ph userinput">Block level</kbd>, <kbd class="ph userinput">Census tract level</kbd>, <kbd class="ph userinput">Mailing address level</kbd>, <kbd class="ph userinput">ZIP code level</kbd>, <kbd class="ph userinput">Geocode could not be assigned</kbd>, <kbd class="ph userinput">Places the address in the correct city</kbd>, <kbd class="ph userinput">Not matched</kbd>, <kbd class="ph userinput">State or Province Centroid</kbd>, <kbd class="ph userinput">Street intersection</kbd>, <kbd class="ph userinput">PO BOX location</kbd>, <kbd class="ph userinput">Non-US rooftop accuracy</kbd>, <kbd class="ph userinput">County Centroid</kbd>, <kbd class="ph userinput">Sub Locality-Street Level</kbd>, and <kbd class="ph userinput">Locality Centroid</kbd> </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">GlobalUltimateBusinessName</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The primary name of the Global Ultimate, which is the highest entity within an organization’s corporate structure and may oversee branches and subsidiaries.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">GlobalUltimateDunsNumber</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The D-U-N-S number of the Global Ultimate, which is the highest-ranking entity within an organization’s corporate structure and can oversee branches and subsidiaries.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">GlobalUltimateTotalEmployees</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The total number of employees at the Global Ultimate, which is the highest entity within an organization’s corporate structure and may oversee branches and subsidiaries.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ImportExportAgent</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Identifies whether a business imports goods or services, exports goods or services, and/or is an agent for goods.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname" id="hassp500rankparmname"><a name="hassp500rankparmname"><!-- --></a>IncludedInSnP500</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <a name="hassp500rankdl"><!-- --></a> <dl class="dl detailList" id="hassp500rankdl"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="HasSp500RankDescph"><a name="HasSp500RankDescph"><!-- --></a> A true or false value. If <samp class="codeph nolang">true</samp>, the company is listed in the S&P 500 Index. If <samp class="codeph nolang">false</samp>, the company isn’t listed in the S&P 500 Index.</span></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Industry</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A description of the type of industry such as Telecommunications, Agriculture, or Electronics.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">IsOwned</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p" id="isowneddesc"><a name="isowneddesc"><!-- --></a>A true or false value. True, your organization owns the record. False, your organization doesn’t own the record. </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">IsParent</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, </dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A true or false value. True, the company is a parent company. False, the company isn’t a parent company. A parent company owns other companies.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Latitude</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Used with longitude to specify a precise location, which is used to assess the Geocode Accuracy.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">LegalStatus</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Identifies the legal structure of an organization. Available values include <kbd class="ph userinput">Cooperative</kbd>, <kbd class="ph userinput">Nonprofit organization</kbd>, <kbd class="ph userinput">Local government body</kbd>, <kbd class="ph userinput">Partnership of unknown type</kbd>, and <kbd class="ph userinput">Foreign company</kbd>. </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">LocationStatus</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <div class="p">Identifies the organizational status of a company. A numeric value represents each value. <div class="data colSort"> <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d585931e2131">Organizational status</th> <th class="featureTableHeader " id="d585931e2134">Numeric value</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d585931e2131" data-title="Organizational status"> <kbd class="ph userinput">Single location</kbd>: The business has no branches or subsidiaries. </td> <td class="entry" headers="d585931e2134" data-title="Numeric value"><kbd class="ph userinput">0</kbd></td> </tr> <tr> <td class="entry" headers="d585931e2131" data-title="Organizational status"> <kbd class="ph userinput">Headquarters/Parent</kbd>: A parent company that owns more than 50 percent of another company. When the company also has branches, it’s the headquarters. </td> <td class="entry" headers="d585931e2134" data-title="Numeric value"><kbd class="ph userinput">1</kbd></td> </tr> <tr> <td class="entry" headers="d585931e2131" data-title="Organizational status"> <kbd class="ph userinput">Branch</kbd>: A secondary location of a business. </td> <td class="entry" headers="d585931e2134" data-title="Numeric value"><kbd class="ph userinput">2</kbd></td> </tr> </tbody> </table> </div> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>Only the numeric value is accepted in an API request.</p> </div> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Longitude</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Used with latitude to specify a precise location, which is used to assess the Geocode Accuracy.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">MailingCity</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The city where a company has its mail delivered.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">MailingCountry</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The country where a company has its mail delivered.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">MailingState</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The state where a company has its mail delivered.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">MailingStreet</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The street address where a company has its mail delivered.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">MailingZip</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The postal zip code for the company.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">MarketingPreScreen</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <div class="p">The probability that a company pays with a significant delay compared to the agreed terms. The risk level is based on the standard Commercial Credit Score, and ranges from low risk to high risk. Available values are <kbd class="ph userinput">High risk of delinquency</kbd>, <kbd class="ph userinput">Low risk of delinquency</kbd>, and <kbd class="ph userinput">Moderate risk of delinquency</kbd>.<div class="box message confirm"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png" alt="Important"> <div class="mediaBd"> <h4 class="mbs">Important</h4> <p>Use this information for marketing pre-screening purposes only.</p> </div> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">MarketingSegmentationCluster</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Twenty-two distinct, mutually exclusive profiles, created as a result of cluster analysis of Dun & Bradstreet data for US organizations. Available values include <kbd class="ph userinput">High-Tension Branches of Insurance/Utility Industries</kbd>, <kbd class="ph userinput">Rapid-Growth Large Businesses</kbd>, <kbd class="ph userinput">Labor-Intensive Giants</kbd>, <kbd class="ph userinput">Spartans</kbd>, <kbd class="ph userinput">Main Street USA</kbd>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">MinorityOwned</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Indicates whether an organization is owned or controlled by a member of a minority group.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Name</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The primary or registered name of a company.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">NationalId</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The identification number used in some countries for business registration and tax collection.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">NationalIdType</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A code value that identifies the type of national identification number that’s used.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">OutOfBusiness</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Indicates whether the company at the specified address has discontinued operations.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">OwnOrRent</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Indicates whether a company owns or rents the building it occupies.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ParentOrHqBusinessName</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The primary name of the parent or headquarters company. </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ParentOrHqDunsNumber</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The D-U-N-S number for the parent or headquarters.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Phone</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">phone</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A company’s primary telephone number.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname" id="premisesmeasureparmname"><a name="premisesmeasureparmname"><!-- --></a>PremisesMeasure</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <a name="premisesmeasurdl"><!-- --></a> <dl class="dl detailList" id="premisesmeasurdl"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="PremisesMeasureDescph"><a name="PremisesMeasureDescph"><!-- --></a>A numeric value for the measurement of the premises.</span></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname" id="premisesmeasurereliabilityparmname"><a name="premisesmeasurereliabilityparmname"><!-- --></a>PremisesMeasureReliability</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <a name="premisesmeasurereliabilitydl"><!-- --></a> <dl class="dl detailList" id="premisesmeasurereliabilitydl"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="PremisesMeasureReliabilityDescph"><a name="PremisesMeasureReliabilityDescph"><!-- --></a>A descriptive accuracy of the measurement such as actual, estimated, or modeled.</span></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname" id="premisesmeasureunitparmname"><a name="premisesmeasureunitparmname"><!-- --></a>PremisesMeasureUnit</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <a name="premisesmeasureunitdl"><!-- --></a> <dl class="dl detailList" id="premisesmeasureunitdl"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A descriptive measurement unit such as acres, square meters, or square feet.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">PrimaryNaics</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The six-digit North American Industry Classification System (NAICS) code is the standard used by business and government to classify business establishments according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the US business economy.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">PrimaryNaicsDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on its NAICS code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">PrimarySic</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The four-digit SIC code that’s used to categorize business establishments by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">PrimarySic8</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The eight-digit Standard Industrial Classification (SIC) code is used to categorize business establishments by industry. The full list of values can be found at the <a class="xref" href="http://www.dnboptimizer.com/knowledge-center/optimizer-resources.html" target="_blank" title="HTML (New Window)">Optimizer Resources</a> page maintained by Dun & Bradstreet. Maximum size is 8 characters. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">PrimarySic8Desc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">PrimarySicDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on its SIC code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname" id="prioryearemployees_parmname"><a name="prioryearemployees_parmname"><!-- --></a>PriorYearEmployees</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <a name="prior_year_employees_dl"><!-- --></a> <dl class="dl detailList" id="prior_year_employees_dl"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The total number of employees for the prior year.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname" id="prioryearrevenue_parmname"><a name="prioryearrevenue_parmname"><!-- --></a>PriorYearRevenue</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <a name="prior_year_revenue_dl"><!-- --></a> <dl class="dl detailList" id="prior_year_revenue_dl"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The annual revenue for the prior year.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">PublicIndicator</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Indicates whether ownership of the company is public or private.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Revenue</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The annual revenue of a company in US dollars.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname" id="salesturnovergrowthrateparmname"><a name="salesturnovergrowthrateparmname"><!-- --></a>SalesTurnoverGrowthRate</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <a name="salesturnovergrowthratedl"><!-- --></a> <dl class="dl detailList" id="salesturnovergrowthratedl"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="SalesTurnoverGrowthRateDescph"><a name="SalesTurnoverGrowthRateDescph"><!-- --></a>The increase in annual revenue from the previous value for an equivalent period expressed as a decimal percentage.</span></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SalesVolume</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The total annual sales revenue in the headquarters’ local currency. Dun & Bradstreet tracks revenue data for publicly traded companies, Global Ultimates, Domestic Ultimates, and some headquarters.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SalesVolumeReliability</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The reliability of the <span class="keyword parmname">SalesVolume</span> figure. </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SecondNaics</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A NAICS code used to further classify an organization by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SecondNaicsDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on the corresponding NAICS code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SecondSic</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A SIC code used to further classify an organization by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SecondSic8</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SecondSic8Desc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SecondSicDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p"><span class="ph" id="AdditionalSicDescDef"><a name="AdditionalSicDescDef"><!-- --></a>A brief description of an organization’s line of business, based on the corresponding SIC code.</span></p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SixthNaics</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A NAICS code used to further classify an organization by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SixthNaicsDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on the corresponding SIC code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SixthSic</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A SIC code used to further classify an organization by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SixthSic8</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SixthSic8Desc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SixthSicDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on the corresponding SIC code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">SmallBusiness</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Indicates whether the company is designated a small business as defined by the Small Business Administration of the US government.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">State</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The state where a company is physically located.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">StockExchange</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The corresponding exchange for a company’s stock symbol, for example, NASDAQ or NYSE.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">StockSymbol</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The abbreviation that’s used to identify publicly traded shares of a particular stock.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Street</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The street address where a company is physically located.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Subsidiary</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Indicates whether a company is more than 50 percent owned by another organization.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ThirdNaics</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A NAICS code used to further classify an organization by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ThirdNaicsDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on the corresponding NAICS code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ThirdSic</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A SIC code used to further classify an organization by industry.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ThirdSic8</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">An additional SIC code used to further classify an organization by industry. Maximum size is 8 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ThirdSic8Desc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A brief description of an organization’s line of business, based on the corresponding SIC code. Maximum size is 80 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">ThirdSicDesc</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A brief description of an organization’s line of business, based on the corresponding SIC code.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">TradeStyle1</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A name, different from its legal name, that an organization may use for conducting business. Similar to “Doing business as” or “DBA”.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">TradeStyle2</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A tradestyle used by the organization.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">TradeStyle3</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A tradestyle used by the organization.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">TradeStyle4</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A tradestyle used by the organization.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">TradeStyle5</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A tradestyle used by the organization.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">UsTaxId</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The identification number for the company used by the Internal Revenue Service (IRS) in the administration of tax laws. Also referred to as Federal Taxpayer Identification Number.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Website</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">url</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">An organization’s primary website address.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">WomenOwned</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Indicates whether a company is more than 50 percent owned or controlled by a woman.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">YearStarted</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The year when the company was established or the year when current ownership or management assumed control of the company.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d585931e89" data-title="Field Name"><span class="keyword parmname">Zip</span></td> <td class="entry" headers="d585931e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A five or nine-digit code that’s used to help sort mail.</p> </dd> </dl> </td> </tr> </tbody> </table> ## Usage Use this object to return D&B Company information. These fields are read-only. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important DatacloudDandBCompany can’t be used in Apex test methods, because an external web service call is required to access it. These calls are not allowed in Apex test methods. <!-- document id=d588b38755332d2d90e8e69435058252a2e691a35c3664ae517e5c9f5d346e59 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datacloudownedentity.md --> # DatacloudOwnedEntity Represents fields in the DatacloudOwnedEntity object. The DatacloudOwnedEntity object tracks user-purchased records. This object is available in API version 30.0 or later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields are removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | DataDotComKey | Type string Properties Create, Filter, Sort Description The Data.com contact or company record identification number used by the DatacloudPurchaseUsage object to keep track of purchased records. This is equivalent to the Data.com record ID for a contact or company. | | DatacloudEntityType | Type picklist Properties Create, Filter, Restricted picklist, Sort Description The type of Data.com record you want to purchase. - 0—contact - 1—company | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An optional field used to name your record. | | PurchaseType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description A read only field set by the API to identify the purchase type. - Added - Export - API | | PurchaseUsageId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The unique identification number for the DatacloudPurchaseUsage object created by making a REST POST request. - 0—contact - 1—company | | UserId | Type reference Properties Filter, Group, Sort Description A unique identifier for the user making the purchase. | ## Usage The Datacloud object that tracks records that are purchased and owned by a specific user. <!-- document id=ad13c2911291c1112ae3955533d85df940aab34c19f04ba64c7ea8444cbec065 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datacloudpurchaseusage.md --> # DatacloudPurchaseUsage Represents an object used to identify and track Data.com record purchases. This object is available in API version 30.0 or later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields are removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | DatacloudEntityType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of Data.com record you want to purchase. - 0—indicates contact entity type. - 1—indicates company entity type. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An optional field. You can add a description for your purchase. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An optional field used to name your record. | | PurchaseType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A read only field set by the API to identify the purchase type. - Added - Export - API | | Usage | Type double Properties Filter, Sort Description A read only field set by the API. It is used to track the points used to purchase records. | | UserId | Type reference Properties Filter, Group, Sort Description A read only field set by the API that identifies the user purchasing the records. | | UserType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A read only field set by the API with 2 user types. - Monthly Usage - List Pool User | ## Usage The DatacloudPurchaseUsage object allows you to track Data.com record purchases for CRM users. <!-- document id=2120a28ac21f63ff5957cf6ff476ae0e885f3093c79668a3e5b6f8ef29b3e86f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetectjobobjectsession.md --> # DataDetectJobObjectSession For internal use only. This object is available in API version 63.0 and later. #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=3626c6cd2e6aabf50fc8e90f238a9c5fc1f514224051048c70d4dea84a14e02b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetectjobsession.md --> # DataDetectJobSession Represents a run of a DataDetect scan policy that's triggered manually. This object is available in API version 63.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ## Fields | Field | Details | | --- | --- | | DataDetectPolicyId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the scan policy associated with this job session. This field is a relationship field. Relationship Name DataDetectPolicy Refers To DataDetectPolicy | | DataDetectPolicySnapshotId | Type reference Properties Filter, Group, Sort Description ID of the snapshot of the scan policy associated with this job session. This field is a relationship field. Relationship Name DataDetectPolicySnapshot Relationship Type Master-Detail Refers To DataDetectPolicySnapshot | | EndTime | Type dateTime Properties Filter, Nillable, Sort Description Time and date when the data scan completes. | | HasClassicEncryptedField | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that if the user is permitted to view classic encrypted fields, they can view these fields in the scan results. The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated name of the job session. | | NamedEntityCount | Type int Properties Create, Filter, Nillable, Update Description Aggregate count of PII found during the data scan. | | PolicyJobStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of the data scan. Valid values are: - Stopped - Completed - Failed - PartialSuccess - Running - Scheduled - TimedOut The default value is Scheduled. | | RunByUser | Type string Properties Filter, Group, Nillable, Sort Description User who started the job session or data scan. | | SessionStartTime | Type dateTime Properties Filter, Nillable, Sort Description Time and date when the data scan begins. | ## Associated Objects This object has this associated object. If the API version isn’t specified, it's available in the same API version as this object. Otherwise, it's available in the specified API version and later. [DataDetectJobSessionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=80197c942355670abc04c04995871933976ce95c962a6b12425fe2ef884ced22 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetectjobsesssummary.md --> # DataDetectJobSessSummary For internal use only. This object is available in API version 66.0 and later. <!-- document id=b1c6cf66305cf5a8a07290cc01605abd85c01ed5c30e7b478b46035ba5fe433f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetectpolicy.md --> # DataDetectPolicy Represents a set of parameters that specifies the types of sensitive data for search with in a data scan. DataDetect scan policies can also apply filters to a data scan, along with specific objects and fields for scanning. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the scan policy. | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Time and date when the data scan completes. | | IsScheduled | Type Boolean Properties Create, Filter, Group, Nillable, Sort, Update Description Determines if the policy is scheduled or not. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the scan policy. | | OwnerId | Type reference Properties Create, Filter, Group, idLookup, Sort, Update Description The UserID of the person who owns the record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ScanType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Designates whether the data scan type is AIInference or PatternMatching. The default value is PatternMatching. | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Time and date when the data scan begins. Data scans can start anytime within a 30-day window from the current date. | #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=38ed875a4dfddf906d9de415f4231b1df2be94adeb517ba38ca1d2b836f8e36b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetectpolicyobject.md --> # DataDetectPolicyObject Represents an object of the DataDetect scan policy to be scanned. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DataDetectPolicyId | Type reference Properties Create, Filter, Group, Sort Description ID of the scan policy associated with this scan policy object. This field is a relationship field. Relationship Name DataDetectPolicy Relationship Type Master-Detail Refers To DataDetectPolicy | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the scan policy object. | | ObjectReference | Type string Properties Create, Filter, Group, Sort, Update Description Name of the scan policy object to be scanned. | #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=ac9b230cd6e3ac6e01629795957d50811f20762efb8e04ffcad734a7307446be url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetectpolicyobjfield.md --> # DataDetectPolicyObjField Represents an object field of the DataDetect scan policy object to be scanned. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DataDetectPolicyObjectId | Type reference Properties Create, Filter, Group, Sort Description ID of the scan policy object associated with the scan policy object's field. This field is a relationship field. Relationship Name DataDetectPolicyObject Relationship Type Master-Detail Refers To DataDetectPolicyObject | | FieldName | Type string Properties Create, Filter, Group, Sort, Update Description Name of the scan policy object field. | #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=87a96c90c3091ec65d92a24376d5caa5811a9a51de2d4e9ef68c680c1e3b7ed0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetectpolicysnapshot.md --> # DataDetectPolicySnapshot For internal use only. This object is available in API version 64.0 and later. #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=8b322eda4eac380b4fa1a17d0d72ae9b5b0752171db310d275692c449982b8da url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetectscanresult.md --> # DataDetectScanResult Represents the results of a DataDetect data policy scan. This object is available in API version 63.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CreatedDate | Type dateTime Properties Filter, Nillable, Sort Description Time and date when an instance of PII is added to the scan result. | | DataDetectJobSessionId | Type reference Properties Filter, Group, Sort Description ID of the job session associated with the scan policy. This field is a relationship field. Relationship Name DataDetectJobSession Relationship Type Lookup Refers To DataDetectJobSession | | FieldName | Type string Properties Filter, Group, Sort Description UMD name from standard fields, or custom field ID from custom fields. | | NamedEntityCount | Type int Properties Filter, Group, Sort Description Number of times PII is found. | | NamedEntityType | Type string Properties Filter, Group, Sort Description Type of PII found in the record of the scan policy object. | | ObjectName | Type string Properties Filter, Group, Sort Description KeyPrefix of the scan policy object that contains PII. | | RecordIdentifier | Type string Properties Filter, Group, Sort Description Unique identifier for the record. | | SensitiveValues | Type text Properties Filter, Nillable, Sort Description Stores the excerpts in the form of encrypted text. | #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=51925a36e0b2919374315d19c83d09e3b94d2aebc699e48f3552dc4f0ce0fce4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetplcydatasrchexps.md --> # DataDetPlcyDataSrchExps Represents data search expressions for scanning DataDetect scan policies based on Java regex. This object is available in API version 64.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When working with regex, Salesforce recommends Java 17 or later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DataDetectPolicyId | Type reference Properties Create, Filter, Group, Sort Description ID of the scan policy associated with the data search expression. This field is a relationship field. Relationship Name DataDetectPolicy Relationship Type Master-Detail Refers To DataDetectPolicy | | Expression | Type string Properties Create, Filter, Group, Sort, Update Description Regular expression that represents sensitive data to be scanned. | | IsCaseSensitive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Designates whether the expression is case-sensitive (true) or not (false). The default value is false. | | IsKeywordSearch | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Designates whether the expression can be used as a search keyword (true) or not (false). The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the expression. | #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=07610f76f9314e7b66bd7aebfa19f4c26d420f307a3f81bcf3a64dd28e29a65f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetplcymdatscancrit.md --> # DataDetPlcyMdatScanCrit Represents inclusion and exclusion criteria that filter what DataDetect scan policy object fields are to be scanned based on metadata tags. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Criteria | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines category of inclusion or exclusion criteria applied to fields during scan policy creation. Valid values are: - ComplianceCategory—Compliance acts, definitions, or regulations related to the field's data. - DataSensitivity—Level of data sensitivity related to the field's data. - FieldUsage—Data planned for deprecation, or intended to be hidden, related to the active and visible field's data. | | DataDetectPolicyId | Type reference Properties Create, Filter, Group, Sort Description ID of the policy associated with the data search expression. This field is a relationship field. Relationship Name DataDetectPolicy Relationship Type Master-Detail Refers To DataDetectPolicy | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the criteria. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines what criteria, inclusion or exclusion, is applied to a field in the policy scan object. | | Value | Type string Properties Create, Filter, Group, Sort, Update Description Value of the criteria applied to filters. | #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=9f82e544529135c2190d58cc7f7e323da602e88e0472d481dda36934042b29c4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datadetplcysstvdatacatg.md --> # DataDetPlcySstvDataCatg Represents the sensitive data categories that the DataDetect scan policy is required to scan. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DataCategory | Type string Properties Create, Filter, Group, Sort, Update Description Sensitive data category associated with the scan policy. | | DataDetectPolicyId | Type reference Properties Create, Filter, Group, Sort Description ID of the scan policy associated with the sensitive data category. This field is a relationship field. Relationship Name DataDetectPolicy Relationship Type Master-Detail Refers To DataDetectPolicy | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the sensitive data category. | #### See Also - [_Salesforce Help_: Data Detect](https://help.salesforce.com/s/articleView?id=xcloud.einstein_data_detect.htm&type=5&language=en_US) <!-- document id=2108545805e30ca2ff6f4e5cb49bba3c4d9bbf5dcda39eec8ddeedd6653d2c31 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dataencryptionkey.md --> # DataEncryptionKey The DataEncryptionKey object is part of the Bring Your Own Key (BYOK) feature, which allows users to upload a data encryption key (DEK) using a public key generated by the Salesforce Shield Key Management Service (KMS). Customers create their own DEKs and upload them to Salesforce. Users access this entity via the API to list DEK keys for auditing purposes. They can also programmatically use this object to create the certificate and to upload key material. This object is available in API version 63.0 and later. DEKs are used to encrypt and decrypt data. They reside in either the Salesforce database or in an external KMS. They’re created by root keys, and when persisted, wrapped by root keys as well. ## Supported Calls create(), describeSObjects(), query(), queryAll() ## Special Access Rules This object is available as part of the Shield and Salesforce Platform Encryption add-on subscriptions. ## Fields | Field | Details | | --- | --- | | CreatedBy | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The email address of the user who created the DEK. For example, user@example.com. | | DataEncryptionKeyCertName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the certificate whose public key is used to encrypt the DEK during a remote key callout. When you want to create a BYOK-compatible certificate, use this property in a call to create() to name the certificate. You need to know the name to retrieve the certificate later. Specify only the file name. Salesforce will add the .crt extension when it creates the file. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user-defined description of the root key. | | DoesUseKeyDerivation | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the DEK is intended to be used as part of a derived key (true) or not (false). See [Components Involved in Deriving Keys](https://developer.salesforce.com/docs/atlas.en-us.264.0.securityImplGuide.meta/securityImplGuide/security_pe_components.htm "HTML (New Window)") for information on derived keys. The default value is false. | | LastModifiedBy | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The email address of the user who most recently modified the key. For example, user@example.com. | | RootKeyIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique key identifier assigned by Salesforce to the root key used to create the DEK. | | RootKeyKmsIdentifier | Type string Properties Create, Filter, Nillable, Sort, Update Description The unique key identifier from the external KMS, such as an AWS Amazon Resource Name (ARN). For example, arn:aws:kms:us-west-2:123456789000:key/123ab456-7cd8-9012-3e4f-5gh678i901j2 | | SecretValue | Type textarea Properties Create, Nillable, Update Description The encrypted 256-bit secret value encoded in base64. | | SessionToken | Type textarea Properties Create, Nillable, Update Description Contains the token for the session that was active when the DEK was last wrapped. If the session is inactive, a new certificate is required in order to transmit the DEK. | | Source | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The source of the encryption key material. Values are: - AWS—A tenant secret or DEK fetched from the Amazon Key Management Service DEKs with a Source value of AWS are listed as Fetched on the Key Management page in Setup. - Salesforce—A Salesforce-generated DEK. | | Status | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The status of the key. Possible values are: - Activation Pending—Salesforce is waiting for confirmation of a valid key policy in the external key store. - Active—Can be used to encrypt new DEKs and decrypt existing DEKs. - Archived—Can’t encrypt new DEKs. Can be used to decrypt previously created DEKs. - Canceled—Root key activation canceled by a user. - Inactive—The root key, and the DEKs that it encrypts, are inaccessible. Inaccessible DEKs can’t be used to decrypt data, which renders that data also inaccessible. | | Type | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The type of DEK. This value appears in the Type picklist: - Search Index—search index files. For Hyperforce orgs on API version 63.0 and later, create secrets of type SearchIndex using the DataEncryptionKey object. For Hyperforce orgs on API versions 62.0 and earlier, and for all non-Hyperforce orgs, create secrets of type SearchIndex using the [TenantSecret](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecret.htm "This object stores an encrypted organization-specific key fragment that’s used with the primary secret (KDF seed) to produce org-specific data encryption keys. This object is available in API version 34.0 and later.") object. You also specify a type of SearchIndex when you are creating a BYOK-compatible certificate using the DataEncryptionKey object. | | Version | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The version number of this secret. The version number is unique within your org. | ## Usage Four functions are available: describe(),create(), query() and queryAll(). - Use create() to create BYOK-compatible certificates and DEKs. - Use query() or queryAll() to list one or all of your DEKs. - Use describe() to get information abut the DataEncryptionKey object. You use create() and queryAll() together to upload a Search Index Encryption DEK. Check the Examples section for how to do each of these steps. - Create a BYOK-compatible certificate with create(). This will create a temporary DEK to contain the certificate reference. Specify a Type of Search Index and a name for the certificate file. - Use queryAll() to list your DEKs. The temporary DEK will include the name of your certificate file in the DataEncryptionKeyCertName attribute. It will also include a session token in the sessionToken attribute. Save this value for later. - Downlad the certificate using the metadata object API. Specify Certificate for the object name node, and the DataEncryptionKeyCertName for the members node. The certificate file will be in the zip file returned by the metadata object API. - Run the [BYOK Search Index Encryption script](https://help.salesforce.com/s/articleView?id=xcloud.security_pe_byok_script_seas_tle.htm&type=5&language=en_US) to generate the **payload.bin** file which contains the plaintext of your new DEK. Use the certificate file you created when you run the script. Alternatively, generate a key using a method of your choice. It must meet the specifications outlined in [Bring Your Own Key Overview](https://help.salesforce.com/s/articleView?id=xcloud.security_pe_byok.htm&type=5&language=en_US). - Generate a b64 string from the contents of the **payload.bin** file. - Run the DataEncryptionKey.create() method again, this time with the the b64 string and the session token. Specify: "SecretValue":"<b64 string>" "SessionToken":"<session token string>" "Type":"SearchIndex" With success, the temporary DEK is replaced by the uploaded secret. The certificate is deleted, and the session token eventually expires. A call to queryAll() will show the new DEK. The DEK will also appear on the Search Index Encryption Key Management page. ## Examples Use your preferred developer environment to run the examples. Use the Salesforce developer [Introduction to REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/intro_rest.htm) for basic information on making REST calls into Salesforce. Also, [Introducing the Salesforce Shield Platform Encryption REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_encryption_rest_api_guide.meta/platform_encryption_rest_api_guide/api_rest_encryption.htm) gives you starter information on using REST to work with Shield Platform Encryption. Create a BYOK-compatible certificate with create() To create a BYOK-compatible certificate, use a POST method to create an sObject of type DataEncryptionKey. Specify a Type of search index (case insensitive), and an appropriate string value for DataEncryptionKeyCertName. You need to name the certificate to retrieve it later. Specify just the name. Salesforce will add the .crt extension to the file. curl --location 'https://DOMAIN.my.salesforce.com/services/data/v62.0/sobjects/'\\ DataEncryptionKey/create' --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer TOKEN' \\ --data '{ "Type": "search index", "DataEncryptionKeyCertName": "my-byok-compatible-cert" }' List all DEKs with queryAll() To retrieve DEKs, use query or queryAll on the DataEncryptionKey sObject. You must specify a limit for the query. All DEKs are retrieved, including archived DEKs. You use queryAll to get the session token. curl --location 'https://DOMAIN.my.salesforce.com/services/data/v63.0/queryAll/?q=SELECT+FIELDS(ALL)+FROM+DataEncryptionKey+LIMIT+10' \\ --header 'Authorization: Bearer TOKEN' Download your Certificate Retrieve the certificate using [Metadata API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). object to download your new certificate. <?xml version="1.0" encoding="UTF-8"?> <Package xmlns="http://soap.sforce.com/2006/04/metadata"> <types\> <members\>DataEncryptionKeyCertName</members\> <name\>Certificate</name\> </types\> <version\>65.0</version\> </Package\> Your certificate will be contained in the cert folder. Create a DEK with create() To create the final DEK, use a POST method to create an sObject of type DataEncryptionKey. Specify a Type of search index (case insensitive). curl --location 'https://DOMAIN.my.salesforce.com/services/data/v63.0/sobjects/DataEncryptionKey/create' \\ --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer TOKEN' \\ --data '{ "SecretValue":"b64-secret" "SessionToken":"session-token value" "Type": "search index" }' Describe a DataEncryptionKey with describe() To get information about the DataEncryptionKey sObject, use describe. curl --location 'https://DOMAIN.my.salesforce.com/services/data/v62.0/sobjects/'\\ DataEncryptionKey/describe' --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer TOKEN' On success, the response is the full JSON description of the DataEncryptionKey sObject. Return Values for Create() The response for creating a certificate or DEK are the same. On success, the response is be similar to { "totalSize": (COUNT), "done": true, "records": \[ { "attributes": { "type": "DataEncryptionKey", "url": "/services/data/v63.0/sobjects/DataEncryptionKey/(ID)" }, ATTRIBUTE LIST }, \] On error, the response is similar to \[ { "message": "ERROR MESSAGE", "errorCode": "ERROR CODE" } \] <!-- document id=439b6de95fd46303efa5c5bfda2e5b9f4f081e6cb9e8a0608e196b45105a39bb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dataintegrationrecordpurchasepermission.md --> # DataIntegrationRecordPurchasePermission Indicates Lightning Data purchase credits that a Salesforce admin has granted to users. This object is available in API versions 42.0 and later. ## Supported Calls describeSObjects(), create(), delete(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | ExternalObject | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the name of the data service record matched to the Salesforce record. | | UserId | Type reference Properties Create, Filter, Group, Sort, Update Description Indicates the ID of a user to whom purchase credits are assigned. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | | **UserRecordPurchaseLimit** | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the number of purchase credits assigned to a user. | <!-- document id=8ee98f426edaa46f027e23122cd88438e3905ca7c0a8055996377d49e2eba193 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datakitdeployevent.md --> # DataKitDeployEvent Represents a data kit deployment event that notifies subscribers of the status of the data kit component deployment. This object is available in API version 61.0 or later. ## Supported Calls create(), describeSObjects() ## Special Access Rules Users that have access to Data Cloud. ## Fields | Field | Details | | --- | --- | | DataKitDeployStatus | Type picklist Properties Create, Nillable, Restricted picklist Description The deployment status of the components deployed from a data kit. This field is available in API version 63.0 and later. Possible values are: - Active - Deleting - Error - Inactive - Processing | | DataKitName | Type string Properties Create, Nillable Description Name of the data kit from which a component is deployed. | | DataspaceName | Type string Properties Create, Nillable Description Name of the data space into which a component is deployed. | | DeployStartTime | Type dateTime Properties Create, Nillable Description The date and time the deployment starts. | | ErrorDetails | Type textarea Properties Create, Nillable Description Explanation of the error. | | EventCreationDate | Type dateTime Properties Create, Nillable Description The date and time the data kit deploy creation event was created. | | EventPublishDate | Type dateTime Properties Create, Nillable Description The date and time of the data kit deploy publish event. | | EventType | Type picklist Properties Create, Nillable, Restricted picklist Description The event type action of the data kit components. Available in API version 66.0 and later. Possible values are: - Deploy - Undeploy | | EventUuid | Type string Properties Nillable Description The unique ID of the event. | | IsDataKitDeployStatusSuccess | Type string Properties Create, Nillable Description Status of the data kit component deployment. Possible values are: - Active - Failure | | JobIdentifier | Type string Properties Create, Nillable Description Data kit component deployment job identifier. | | ReplayId | Type string Properties Nillable Description The ID of the data kit deploy event replay. | | TemplateName | Type string Properties Create, Nillable Description The template name from which the data kit deploy event is created. | <!-- document id=5f94d41e15b84c68e733fd873ac6e9523b8bfd55af116959149f4116319ca6d4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datakitdeploymentlog.md --> # DataKitDeploymentLog Represents the log details of a data kit component deployment. This object is available in API version 61.0 or later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Users that have access to Data Cloud. ## Fields | Field | Details | | --- | --- | | BundleName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the data stream bundle if a data stream is deployed from a data kit. | | ComponentName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the component that’s deployed from a data kit. | | ComponentTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the data kit template from which the component is deployed. This field is a polymorphic relationship field. Relationship Name ComponentTemplate Refers To DataSourceBundle | | ComponentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the component for which the deployment is tracked in the log details. Possible values are: - MktCalculatedInsight - MktDataLakeObject - MktDataModelObject - MktDataStream - MktDataTransform Possible values available in API version 63.0 and later are: - ActivationTarget - DataAction - DataActionTarget - DataGraph - DataSemanticSearch - EngagementSignal - ExtDataShare - IdentityResolution - MarketSegment - MarketSegmentActivation - MktDataConnection - MktMLModel - PersonalizationObjective - PersonalizationRecommender Possible values available in API version 64.0 and later are: - IrRelatedListEnrichment - MktCalculatedInsight - MktDataLakeObject - MktDataStream - MktDataTransform - PersonalizationPoint - PersonalizationSchema Possible values available in API version 66.0 and later are: - CopyFieldEnrichment - SemanticModel | | DataKitName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the data kit being deployed. | | DataPackageKitDefinition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description ID of the data kit being deployed. Available in API version 63.0 and later. Possible values are: - 1dk.Collections - 1dk.SalesNextGenForecastingDatakit - 1dk.Test\_Fbdk - 1dk.sf\_mktg\_ae\_\_Marketing\_Account\_Engagement\_CRM\_Data | | DataSpaceName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the data space the components are deployed to. | | DeployJob | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The deployment job ID. | | DeploymentAction | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Deployment action of the data kit components. Possible values are: - Deploy - Undeploy | | DeploymentError | Type textarea Properties Create, Nillable, Update Description Contains the error details if the data kit deployment fails. | | DeploymentStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Deployment status of the data kit components. Possible values are: - Failed - Started - Successful | | FileBasedComponentTemplate | Type string Properties Create, Filter, Sort, Update Description ID of the file-based component template that corresponds to the deployment log entry. Available in API version 63.0 and later. | | FlowInterviewIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Identifier of the flow interview if the deployment was triggered using a flow. | | JobIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Identifier of the data kit component deployment job. Available in API version 66.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed the deployment log file. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this deployment log. | | Name | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The name of the deployment log. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user that owns the deployment. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | PublisherOrgComponentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the component in the publisher org. This field is a polymorphic relationship field. Relationship Name PublisherOrgComponent Refers To MktCalculatedInsight, MktDataTransform | | SubscriberOrgComponentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the component in the subscriber org in which the components of a data kit are deployed. This field is a polymorphic relationship field. Relationship Name SubscriberOrgComponent Refers To ActivationTarget, DataGraph, DataStream, ExtDataShare, IdentityResolution, MarketSegment, MarketSegmentActivation, MktCalculatedInsight, MktDataTransform | | TemplateVersion | Type double Properties Create, Filter, Nillable, Sort, Update Description The version of the template from which the deployment was done. | ## Usage Use the DataKitDeploymentLog object to track the deployment of a data kit component. <!-- document id=7e1c1c2f9dbcf5c25d3061917446b38d747b07ecccc12d6bb10634d848f9f0f7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datalakeobjectinstance.md --> # DataLakeObjectInstance Represents a data lake object (DLO). This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccelerationEnabled | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether acceleration is turned on for external DLOs (**YES**) or not (**NO**). Acceleration increases how frequently DLO data is refreshed. Possible values are: - NO - YES | | AccelerationSchedule | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Incremental refresh frequency for an external DLO. How often the system runs acceleration when AccelerationEnabled is **YES**. Possible values are: - EVERY\_12\_HOURS - EVERY\_24\_HOURS - EVERY\_4\_HOURS - EVERY\_7\_DAYS | | Billable | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates if this DLO is usage-metered (billable). Possible values are: - YES | | Category | Type string Properties Filter, Group, Nillable, Sort Description Type of DLO (for example: Engagement). | | DataLakeObjectNamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Namespace prefix of the related MktDataLakeObject developer name in a Developer Edition org. Used with the MktDataLakeObjectDeveloperName field to look up the single DLO that matches a namespaced DLO. | | DataLakeObjectRef | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reference to the MktDataLakeObject that corresponds to this DLO when standard DLOs are enabled. Stores the standard DLO API reference (EnumOrId-style), for example Account\_std\_\_dll, in place of or in addition to the legacy MktDataLakeObject Id. Custom DLOs still use the ID in the other reference field. Possible values are: - Account\_std\_\_dll - ApiGrounding\_std\_\_dll - BenefitType\_std\_\_dll - Benefit\_std\_\_dll - Case\_std\_\_dll - CatalogEnrichment\_std\_\_dll - CatalogMetadataRelationship\_std\_\_dll - CatalogMetadata\_std\_\_dll - ConsumptionResourceTags\_std\_\_dll - Contact\_std\_\_dll - ForecastingFact\_std\_\_dll - ForecastingItem\_std\_\_dll - FtestMain\_std\_\_dll - FtestMetadataDlo\_std\_\_dll - GameDefinition\_std\_\_dll - GameParticipant\_std\_\_dll - GameReward\_std\_\_dll - JournalSubType\_std\_\_dll - JournalType\_std\_\_dll - KnowledgeLayoutAssignment\_std\_\_dll - KnowledgeLayout\_std\_\_dll - ListEmail\_std\_\_dll - LoyaltyAggrPointExprLedger\_std\_\_dll - LoyaltyMemberCurrency\_std\_\_dll - LoyaltyMemberTier\_std\_\_dll - LoyaltyPartnerProduct\_std\_\_dll - LoyaltyPgmEngmtAttrLimit\_std\_\_dll - LoyaltyPgmEngmtAttrProm\_std\_\_dll - LoyaltyPgmEngmtAttribute\_std\_\_dll - LoyaltyPgmGroupMbrRlnsp\_std\_\_dll - LoyaltyPgmMbrAttributeVal\_std\_\_dll - LoyaltyPgmPartnerCurrency\_std\_\_dll - LoyaltyPgmPartnerPromotion\_std\_\_dll - LoyaltyProgramBadge\_std\_\_dll - LoyaltyProgramCurrency\_std\_\_dll - LoyaltyProgramMbrPromotion\_std\_\_dll - LoyaltyProgramMemberCase\_std\_\_dll - LoyaltyProgramMemberMerge\_std\_\_dll - LoyaltyProgramPartner\_std\_\_dll - LoyaltyProgram\_std\_\_dll - LoyaltyTierBenefit\_std\_\_dll - LoyaltyTierGroup\_std\_\_dll - LoyaltyTier\_std\_\_dll - ManagedContentVariant\_std\_\_dll - ManagedContent\_std\_\_dll - MemberBenefit\_std\_\_dll - OpportunityContactRole\_std\_\_dll - ProductCatalog\_std\_\_dll - ProductCategoryProduct\_std\_\_dll - ProductCategory\_std\_\_dll - PromotionLoyaltyPtnrProdt\_std\_\_dll - PromotionMarketSegment\_std\_\_dll - PromotionPartyUsage\_std\_\_dll - Promotion\_std\_\_dll - VoucherDefinition\_std\_\_dll - Voucher\_std\_\_dll | | DataLakeObjectStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Status of this DLO. You can’t change a DLO when it’s in the PROCESSING state. If you make any changes to a DLO, this field will be in the PROCESSING state, and later ACTIVE when the update is complete. Possible values are: - ACTIVE - DELETING - ERROR - INACTIVE - NONE - PROCESSING The default value is PROCESSING. | | DeletionRecordsDataLakeObject | Type string Properties Filter, Group, Nillable, Sort Description API name of the DLO that stores deletion records associated with this DLO. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the DLO. | | ExternalName | Type string Properties Filter, Group, Nillable, Sort Description Name of the DLO in the external data source. | | ExternalObjectErrorCode | Type string Properties Filter, Group, Nillable, Sort Description Provider-specific or internal error code when the external DLO reports an error (pairs with ExternalObjectErrorStatus). | | ExternalObjectErrorStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Activity status of an external DLO. Possible values are: - ACTIVE - ERROR | | HydrationStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description How fully this DLO has been hydrated in storage (all data available vs. partial vs. not yet loaded). Possible values are: - Hydrated - PartiallyHydrated - Unhydrated | | LastDataChangeStatusDateTime | Type dateTime Properties Filter, Nillable, Sort Description Date and time of the most recent data change or ingestion status transition relevant to this DLO. | | LastDataChangeStatusErrorCode | Type string Properties Filter, Group, Nillable, Sort Description Error code explaining the last data change failure. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Last date when a user referenced this record. | | LastRefreshDate | Type dateTime Properties Filter, Nillable, Sort Description Last date when ingested or synced data for this DLO was refreshed. | | LastSyncedFingerprint | Type textarea Properties Nillable Description Content or schema fingerprint from the last successful sync, used to detect when upstream data or layout changes. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Last date when a user viewed this record in the UI. | | MktDataLakeObjectDeveloperName | Type string Properties Filter, Group, Nillable, Sort Description Developer name of the related MktDataLakeObject. For a namespaced DLO, this is paired with DataLakeObjectNamespacePrefix. For a standard DLO, this may be the standard DLO’s API name**.** | | MktDataLakeObjectLabel | Type string Properties Filter, Group, Nillable, Sort Description User-defined label of the DLO. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the DLO. | | ProblemRecordsDataLakeObject | Type string Properties Filter, Group, Nillable, Sort Description API name of the DLO that stores failed records for this DLO. | | Storage | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Where the DLO’s physical data resides. For standard DLOs, the query path can default this to LOCAL when not set. Possible values are: - EXTERNAL—External - LOCAL—Local | | SyncStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Synchronization status of the DLO. For external DLOs, this field exposes connection issues. With standard DLOs, this field is read and written at the same time as DataLakeObjectStatus to reflect ingestion state. Possible values are: - ACTIVE - DELETING - ERROR - INACTIVE - NONE - PROCESSING The default value is PROCESSING. | | TotalNumberOfFields | Type int Properties Filter, Group, Nillable, Sort Description Total number of fields in the DLO. | | TotalRecords | Type long Properties Filter, Group, Nillable, Sort Description Total number of records stored in the DLO. | <!-- document id=577f1844f7c2c7e05a493fab0ad5bb2530ef3df88025e1772cefa6f832eaed44 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datamaskcustomvaluelibrary.md --> # DataMaskCustomValueLibrary Represents a set of user-inputted values in a custom library in Data Mask. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available with the Sandbox Data Mask managed package. ## Fields | Field | Details | | --- | --- | | ContentType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of value used in a field of the custom library. Possible values are: - email - number - phone\_number - string - url | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the value in the custom library. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents whether the library is active or inactive for use. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the custom library. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the custom library. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Represents how the values were added to the library. Possible values are: - default - user\_defined | | Values | Type textarea Properties Create, Nillable, Update Description The content of the value field for masking data. | ## 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. [DataMaskCustomValueLibraryOwnerSharingRule](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. [DataMaskCustomValueLibraryShare](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. <!-- document id=93b5f6587e8c7298cec268d514ef7a171a8d140bf7fdc10d3a20a242a3b4c3d9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datasemanticsearch.md --> # DataSemanticSearch Represents a Data 360 search index object. This object is available in API version 67.0 and later. This object stores Data 360 search index details such as the search index name, search type, and the data model object (DMO) for the index. ## Fields | Field | Details | | --- | --- | | AttachmentDmo | Type string Properties Filter, Group, Nillable, Sort Description A data model object (DMO) that stores metadata and file paths for attachments linked to Salesforce objects in Data 360. It helps manage and reference files associated with Salesforce objects. | | ChunkDmo | Type string Properties Filter, Group, Nillable, Sort Description A chunk data model object (CDMO) that stores chunked content for each field from a chunked object. | | DataSpaceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A unique, system-generated identifier that represents a specific data space. This field is a relationship field. Relationship Name DataSpace Refers To DataSpace | | IndexRefreshedOn | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the search index was refreshed. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed the deployment log file. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this deployment log. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the search index. | | PrimaryDmo | Type string Properties Filter, Group, Nillable, Sort Description The data model object (DMO) that the index is built on. | | RuntimeStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The current search index status. Possible values are: - ABORTED - FAILED - FILE\_COPY\_COMPLETED - FILE\_COPY\_INITIATED - FILE\_COPY\_IN\_PROGRESS - IN\_PROGRESS - NOT\_STARTED - PENDING - READY - SUBMITTED - SUCCESS | | SearchType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of search. Possible values are: - HYBRID - VECTOR | | SemanticSearchApiName | Type string Properties Filter, Group, Nillable, Sort Description The search API name. | | VectorDmo | Type string Properties Filter, Group, Nillable, Sort Description The vector DMO for this search index. | ## Usage This object is used with Data 360 Search Index Connect API. ## 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. [DataSemanticSearchFeed](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. [DataSemanticSearchHistory](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. <!-- document id=ff4f051a5f63e69f7192f1051fc2ed54ec2f3a0a341c74656376d856077ba317 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datasetexport.md --> # DatasetExport Represents a dataset exported from CRM Analytics. When a dataset is exported, the data is converted into a .csv file and the schema is stored in a separate JSON file. These files are stored in two objects: DatasetExport and DatasetExportPart. DatasetExport acts as the header and includes the JSON schema. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CompressedMetadataLength | Type int Properties Filter, Group, Nillable, Sort Description This field is required when a record in an object contains a BLOB (binary large object) field. In the DataExport object, Metadata is the BLOB field. | | Metadata | Type base64 Properties Nillable Description Contains the JSON schema that describes the data in the CSV. This schema includes column metadata such as type, format, and defaultValue. | | MetadataLength | Type int Properties Filter, Group, Nillable, Sort Description This field is required when a record in an object contains a BLOB (binary large object) field. In the DataExport object, Metadata is the BLOB field. | | Owner | Type string Properties Filter, Group, Nillable, Sort Description User ID of the owner, as specified in the userId parameter in the export node of the dataflow that created the record. Only the specified owner can read the content of the record. | | PublisherInfo | Type string Properties Filter, idLookup, Sort Description Identifies the export record to facilitate searching when a user has multiple export records. By default, this column is set to the ID of the dataflow that generated the export record, concatenated with the name of the specific export node. PublisherInfo is unique within your organization. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note A dataflow can have multiple export nodes. | | PublisherType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Target of the export, as specified in the target parameter in the export node of the dataflow that created the record. The value must be EinsteinDiscovery. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Status of the export. The possible values are: - New - InProgress - Completed - Canceled - Failed ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The content of the Metadata field can be downloaded when the status is Completed. | ## Usage This object is used with the DatasetExportPart object for exporting data from a dataset in CRM Analytics for use in Einstein Discovery. An export is initiated using the export node in an Analytics dataflow. #### See Also - [DatasetExportPart](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datasetexportpart.htm "Represents a dataset exported from CRM Analytics. When a dataset is exported, the data is converted into a .csv file and the schema is stored in a separate JSON file. These files are stored in two objects: DatasetExport and DatasetExportPart. DatasetExportPart contains parts of the .csv file.") <!-- document id=4282802fe1f29ac749a49a9abecc880b888a5bb4d750b83d7bb7ab16ee2a628f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datasetexportpart.md --> # DatasetExportPart Represents a dataset exported from CRM Analytics. When a dataset is exported, the data is converted into a .csv file and the schema is stored in a separate JSON file. These files are stored in two objects: DatasetExport and DatasetExportPart. DatasetExportPart contains parts of the .csv file. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CompressedDataFileLength | Type int Properties Filter, Group, Sort Description This field is required when a record in an object contains a BLOB (binary large object) field. In the DataExportPart object, DataFile is the BLOB field. | | DataFile | Type base64 Description Contains a part of the dataset data from the generated .csv file. Maximum size is 32 MB. | | DataFileLength | Type int Properties Filter, Group, Sort Description This field is required when a record in an object contains a BLOB (binary large object) field. In the DataExportPart object, DataFile is the BLOB field. | | DatasetExportId | Type reference Properties Filter, Group, Sort Description ID of the parent record that the part record is associated with. | | Owner | Type string Properties Filter, Group, Sort Description User ID of the owner, as specified in the userId parameter in the export node of the dataflow that created the record. Only the specified owner can read the content of the record. | | PartNumber | Type int Properties Filter, Group, Sort Description Used with the DatasetExportId to uniquely identify the data part. Parts are assembled sequentially based on their numbers. | ## Usage This object is used with the DatasetExport object for exporting data from a dataset in CRM Analytics for use in Einstein Discovery. An export is initiated using the export node in an Analytics dataflow. #### See Also - [DatasetExport](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datasetexport.htm "Represents a dataset exported from CRM Analytics. When a dataset is exported, the data is converted into a .csv file and the schema is stored in a separate JSON file. These files are stored in two objects: DatasetExport and DatasetExportPart. DatasetExport acts as the header and includes the JSON schema.") <!-- document id=ddbae39ac6e465bd87a50bdac3bce2594d2d1a1ebed9a9140dd68385feb5e3e2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datastatistics.md --> # DataStatistics For internal use only. <!-- document id=947975e3ec4e928c9c43e13c472f4b171c5130d909a40af512498c511fa1363d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datauselegalbasis.md --> # DataUseLegalBasis Represents the legal basis for contacting a customer, such as billing or contract. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if Data Protection and Privacy is enabled. ## Fields | Field Name | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the data use legal basis. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Specifies a name for the legal basis. For example, “billing” or “contract”. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Source | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the source of the legal basis. For example, the URL of a contract. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [DataUseLegalBasisChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [DataUseLegalBasisHistory](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. [DataUseLegalBasisOwnerSharingRule](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. [DataUseLegalBasisShare](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. <!-- document id=ca66956eb9661f58077530debd381d88081bc90c35c1b263890d6f87d3be1912 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datausepurpose.md --> # DataUsePurpose Represents the reason for contacting a prospect or customer, such as for billing, marketing, or surveys. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if Data Protection and Privacy is enabled. ## Fields | Field Name | Details | | --- | --- | | CanDataSubjectOptOut | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates whether the customer can decline contact for the described purpose. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the purpose for contacting a customer. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | LegalBasisId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Identifies the legal basis record associated with the data use purpose. This is a relationship field. Relationship Name LegalBasis Relationship Type Lookup Refers To DataUseLegalBasis | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Identifies the reason for contacting a customer. For example, billing or marketing. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PurposeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of an object containing data specific to the data use purpose. This is a polymorphic relationship field. Relationship Name Purpose Relationship Type Lookup Refers To Asset, CareProgram, CareRegisteredDevice, or Product2 | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [DataUsePurposeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [DataUsePurposeHistory](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. [DataUsePurposeOwnerSharingRule](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. [DataUsePurposeShare](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. <!-- document id=baef63ecf2d738bab04880500e9b4da634cec06c759f45d259f19aa60fd1e0e9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dataweaveresource.md --> # DataWeaveResource Represents the DataWeaveScriptResource class that is generated for all DataWeave scripts. This object is available in API version 58.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update() ## Fields | Field | Details | | --- | --- | | ApiVersion | Type double Properties Filter, Sort Description The API version of this component. | | BodyLength | Type int Properties Filter, Group, Sort Description Size of the DataWeave script (in bytes). | | ContentType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Possible value: - dwl: The metadata file for the DataWeave scripts that are deployed to an org. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the object in the API. | | IsGlobal | Type boolean Properties Defaulted on create, Filter, Group, Sort Description When set to true, the generatedDataWeaveScriptResource class is global. The default value is false. | | IsProtected | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Not used | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the MasterLabel. | | MasterLabel | Type string Properties Filter, Group, Sort Description Required. The name of the resource. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | ## Usage Although the DataWeaveResource object supports the create and update field properties, a runtime exception occurs if you try to create, update, or delete using the API. Instead, use the Salesforce Extensions for Visual Studio Code. <!-- document id=73e6e622aa58219b7f181910b56b35d3377aebd07dff1f643bdea48e8015471b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_datedconversionrate.md --> # DatedConversionRate Represents the dated exchange rates used by an organization for which the multicurrency and the effective dated currency features are enabled. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | ConversionRate | Type double Properties Filter, Update Description Required. Conversion rate of this currency type against the corporate currency. | | IsoCode | Type picklist Properties Filter, Restricted picklist Description Required. ISO code of the currency. Must be one of the valid alphabetic, three-letter currency ISO codes defined by the ISO 4217 standard, such as USD, GBP, or JPY. Must be unique within your organization. Label is **Currency ISO Code**. The CUC (Cuban Convertible Peso) picklist value is not available in API version 65.0 and later. Existing DatedConversionRate records for CUC are no longer supported. | | NextStartDate | Type date Properties Filter, Nillable Description Read only. The date on which the next effective dated exchange rate will start. Effectively the day after the end date for this exchange rate. | | StartDate | Type date Properties Filter Description The date on which the effective dated exchange rate starts. The timestamp is determined by the base calendar of the API. | ## Usage This object is for multicurrency organizations with advanced currency management enabled. Use this object to define the exchange rates your organization uses for a date range. This object is not available in single-currency organizations, nor is it available if the organization does not have advanced currency management enabled. <!-- document id=977c4bfcec05c68cca2cdd00058002003e10f825aaa123932a246d9eccbb09b5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dealindirectpartner.md --> # DealIndirectPartner Represents an indirect partner’s involvement in a deal. This object is available in API version 63.0 and later. A DealIndirectPartner record can be created manually or through automation when a partner is associated with an opportunity, lead, or account, capturing role and contact information. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the indirect partner on the deal. This field is a relationship field. Relationship Name Account Refers To Account | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the record was last referenced by the user or system. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and the timestamp when the record was last viewed in the Salesforce UI. Helps monitor user access and engagement. | | LeadId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to a lead associated with this indirect partner record. This field is a relationship field. Relationship Name Lead Refers To Lead | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier for the record, used for lookup and reference purposes. | | OpportunityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Opportunity associated with the indirect partner. This field is a relationship field. Relationship Name Opportunity Refers To Opportunity | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description User or group that owns this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | PartnerName | Type string Properties Create, Filter, Group, Sort, Update Description Name of the indirect partner participating in the deal. This field captures the business or entity name. | | PartnerRoleType | Type picklist Properties Create, Filter, Group, Sort, Update Description The role played by the indirect partner in the deal. Common values might include Reseller, Distributor, and so on. | | PrimaryContactFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description First name of the primary contact at the partner organization. | | PrimaryContactLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Last name of the primary contact at the partner organization. | | PrimaryContactName | Type string Properties Filter, Group, Nillable, Sort Description Full name of the primary contact. This field may be auto-generated by combining first and last names or used for reporting purposes. | | PrimaryContactSalutation | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Salutation for the primary contact. Possible values are: - Dr. - Mr. - Mrs. - Ms. - Mx. - Prof. | <!-- document id=e67aa5d75ff78598e232f30cc63fb4f46a5a698ebb8f10b72b8ef7900a6b5a14 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_declinedeventrelation.md --> # DeclinedEventRelation Represents event participants (invitees or attendees) with the status Declined for a given event. This object is available in API versions 29.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | EventId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the event. This is a relationship field. Relationship Name Event Relationship Type Lookup Refers To Event | | RelationId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the invitee. This is a polymorphic relationship field. Relationship Name Relation Relationship Type Lookup Refers To Calendar, Contact, Lead, User | | RespondedDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates the most recent date and time when the invitee declined an invitation to the event. | | Response | Type string Properties Filter, Group, Nillable, Sort Description Indicates the content of the response field. Label is Comment. | | Type | Type string Properties Filter, Group, Nillable, Sort Description Indicates whether the invitee is a user, lead or contact, or resource. | ## Usage Query invitees who have declined an invitation to an event SELECT eventId, type, response FROM DeclinedEventRelation WHERE eventid='00UTD000000ZH5LA' #### See Also - [AcceptedEventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_acceptedeventrelation.htm "Represents event participants (invitees or attendees) with the status Accepted for a given event.") - [UndecidedEventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_undecidedeventrelation.htm "Represents event participants (invitees or attendees) with the status Not Responded for a given event. This object is available in API versions 29.0 and later.") <!-- document id=45468246b53fe19018ef3ebd9b667c615a56848b197be1080220f14b01ca390c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_delegatedaccount.md --> # DelegatedAccount Represents the external managed account. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When DelegatedAccount records are directly deleted, they aren't sent to the recycle bin and can't be undeleted. The getDeleted() call shows deleted DelegatedAccount records until they're purged, which usually happens the same day or the next day. ## Special Access Rules You must have a Partner or Customer Community Plus license. You can't edit the visibility of DelegatedAccount metadata on user profiles. ## Fields | Field | Details | | --- | --- | | AccessBuyFor | Type boolean Properties Create, Filter, Update Description The access that an admin authorizes for an external user to buy for other accounts. This field is available in API version 50.0 and later. A B2B Commerce license is required to use AccessBuyFor. | | AccessManageUsers | Type boolean Properties Create, Filter, Update Description The access that an admin authorizes for an external user to manage external users on other accounts. This includes managing permission sets, membership, passwords, and activation. This field is available in API version 50.0 and later. Delegated External User Administrator permission is required to use AccessManageUsers. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | ManagedById | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the managing user. This is a relationship field. Relationship Name ManagedBy Relationship Type Lookup Refers To User | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the external managed account. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the record owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the managing users account. This field is available in API version 50.0 and later. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account | | TargetId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the account being managed. This is a relationship field. Relationship Name Target Relationship Type Lookup Refers To Account | <!-- document id=39189e2a69fe56c67c3ebb07111a9f191ad080f5e285f53f43936a4de61b24fa url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_deleteevent.md --> # DeleteEvent Represents a record that has been soft deleted. Search on this object was available in API version 48.0, then removed in API version 50.0. DeleteEvent is a read-only object. You can't create, update, or delete it directly. To create a DeleteEvent record, soft delete a record of another type, like an Account. To remove a DeleteEvent record, use the [emptyRecycleBin()](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_emptyrecyclebin.htm "HTML (New Window)") API or hard delete the corresponding Record. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | DeletedById | Type reference Properties Filter, Group, Sort Description The ID of the user who deleted the record. This is a relationship field. Relationship Name DeletedBy Relationship Type Lookup Refers To User | | DeletedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the record was deleted. | | Record | Type string Properties Filter, Group, Nillable, Sort Description The ID of the record that was deleted. | | RecordName | Type string Properties Filter, Group, Nillable, Sort Description The name of the record that was deleted. | | SobjectName | Type string Properties Filter, Group, Nillable, Sort Description The type of record that was deleted, for example, Account. | <!-- document id=c26cc290ef9f4cd1531b4c37412f26a64323023ee92b3bae11dffb4fe083c782 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_deliveryestimationsetup.md --> # DeliveryEstimationSetup Shows the configuration options for the commerce delivery service offered through a web store or sales channel. Includes settings such as delivery location group, channel, fulfillment types, and default fulfillment time. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The DeliveryEstimationSetup object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | ChannelId | Type reference Properties Create, Filter, Group, Sort, Update Description ID for the web store or sales channel associated with the delivery estimation configuration. | | DefaultBusinessHoursId | Type reference Properties Create, Filter, Group, Sort, Update Description ID for the default business hours. This is a relationship field. Relationship Name DefaultBusinessHours Refers To BusinessHours | | DefaultPickupTime | Type time Properties Create, Filter, Sort, Update Description Default pickup time. | | DefaultProcessingTime | Type int Properties Create, Filter, Group, Sort, Update Description Default processing time. | | DefaultProcessingTimeUnit | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Default processing time unit. Possible values are: - Hours - Days - Weeks | | ExternalReference | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Unique code, reference, or identifier for the delivery estimation configuration record used by external systems. Can be the name of the web store or sales channel associated with the configuration to ensure a unique ID within the organization. For example, DefaultWebstore123. | | isEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the given delivery estimation configuration is active. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last modified. Its label in the user interface is Last Modified Date. | | LastSyncedById | Type reference Properties Filter, Group, Nillable, Sort Description User ID of who performed the last sync for this delivery estimation configuration. This field is available in API version 62.0 and later. This is a relationship field. Relationship Name LastSyncedBy Refers To User | | LastSyncedDate | Type dateTime Properties Filter, Nillable, Sort Description Date the delivery estimation configuration was last synced. This field is available in API version 62.0 and later. | | LastSyncedMessage | Type textarea Properties Nillable Description Message that occurred during the last sync. This field is available in API version 62.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Last time the delivery estimation configuration was viewed. | | LocationGroupId | Type reference Properties Create, Filter, Group, Sort, Update Description Represents a group of Omnichannel Inventory locations. This is a relationship field. Relationship Name LocationGroup Refers To LocationGroup | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the delivery estimation setup configuration. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who currently owns this DeliveryEstimationSetup object. Default value is the user logged in to the API to perform the create. This is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | RoutingType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines an order's route and calculates delivery estimations. This field is available in API version 65.0 and later. Possible values are: - DRE - None - Standard The default value is None. | | ServiceRegion | Type string Properties Filter, Group, Nillable, Sort Description An org's commerce delivery service provisioning region (North America, Europe, or Asia) that's set when Delivery Estimation is enabled in the Order Management app. It can't be changed. If the field is empty, provisioning hasn't occurred yet. Available in API version 63.0 and later. | | SyncStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Sync status of the delivery estimation setup configuration. Possible values are: - Deleting - Deprovisioned - Error - None - Synced - Syncing The default value is NONE. This field is available in API version 62.0 and later. | <!-- document id=6f7f1863cdd91fd728359cf43ab2efa0d2faec8a8522260e12f024021bde236f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsactivitylog.md --> # DevopsActivityLog Represents the history of activities performed within Lifecycle Center. The object provides visibility into the users, actions, and outcomes. This object is available in API version 67.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Activity | Type string Properties Nillable, Sort Description A summary of the specific action performed. | | ActivityDate | Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the activity happened. | | ActivityType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The category of the activity. Possible values are: - BACK\_SYNC\_COMPLETED - BACK\_SYNC\_STARTED - COMMIT\_COMPLETED - COMMIT\_STARTED - PROMOTION\_COMPLETED - PROMOTION\_STARTED - WORK\_ITEM\_CREATED - WORK\_ITEM\_STATE\_TRANSITION The default value is PROJECT\_CREATED. | | Description | Type textarea Properties Create, Nillable, Update Description Detailed information about the activity, such as commit comments. | | DevopsRequestInfoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the associated DevopsRequestInfo record that triggered this activity log entry. This field is a relationship field. Relationship Name DevopsRequestInfo Refers To DevopsRequestInfo | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique identifier for the activity log entry, typically with a DOAL- prefix. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user or group that owns this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ParentActivityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of a parent activity log entry, used to group related sub-actions. This field is a relationship field. Relationship Name ParentActivity Refers To DevopsActivityLog | | PerformedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who performed the action. This field is a relationship field. Relationship Name PerformedBy Refers To User | | PipelineId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the pipeline associated with this activity. This field is a relationship field. Relationship Name Pipeline Refers To DevopsPipeline | | PipelineStageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the specific pipeline stage where the activity occurred. This field is a relationship field. Relationship Name PipelineStage Refers To DevopsPipelineStage | | ProjectId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Lifecycle Center project associated with this activity. This field is a relationship field. Relationship Name Project Refers To DevopsProject | | RequestInfoErrorDetails | Type string Properties Filter, Nillable, Sort Description Error details or logs retrieved from the associated request if the status is FAIL. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The outcome of the activity. Possible values are: - FAIL - SUCCESS The default value is SUCCESS. | | WorkItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the work item related to this activity. This field is a relationship field. Relationship Name WorkItem Refers To WorkItem | ## Usage Use this object to audit activities, troubleshoot errors, and track the history of work items, pipelines, and projects. Lifecycle Center records every operation that occurs, from project creation to final promotion. If an operation fails, the RequestInfoErrorDetails field provides specific log information to help pinpoint issues such as merge conflicts or dependency failures. ## 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. [DevopsActivityLogShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. <!-- document id=93e99e026f64f7f7cab4c29a0b2638d5b7b75f96629001390e0e0866602eabce url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsenvdeployment.md --> # DevopsEnvDeployment Represents a record created during the promotion or deployment process to track deployment actions, status, and associated details within a Lifecycle Center pipeline. This object is available in API version 66.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), , update(), upsert() ## Fields | Field | Details | | --- | --- | | BackSyncStageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the pipeline stage from which changes are back-synced to a development environment. This is a relationship field. Relationship Name BackSyncStage Refers To DevopsPipelineStage | | CheckDeployCompletionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when a validate-only deployment completed. | | CheckDeployDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when a validate-only deployment started. | | CheckDeployRequestInfoId | Type reference Properties Create, Filter, Nillable, Sort, Update Description The ID of the DevopsRequestInfo record tracking the status of the deployment. This is a relationship field. Relationship Name CheckDeployRequestInfo Refers To DevopsRequestInfo | | CheckDeployStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The current status of the deployment. The default value is NEW. Possible values are: - CANCELLED - ERROR - FINALIZING - INTERRUPTED - IN\_PROGRESS - NEW - SUCCESS | | DeployCompletionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the deployment operation completed. | | DeployRequestInfoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the DevopsRequestInfo record tracking the status of the full deployment. This is a relationship field. Relationship Name DeployRequestInfo Refers To DevopsRequestInfo | | DeployStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The current status of the deployment operation. The default value is NEW. Possible values are: - CANCELLED - ERROR - FINALIZING - INTERRUPTED - IN\_PROGRESS - NEW - SUCCESS | | DeploymentDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the deployment started. | | DeploymentIdentifier | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description A unique identifier for the deployment. | | DevopsPipelnStgPromId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the associated pipeline stage promotion record. This is a relationship field. Relationship Name DevopsPipelnStgProm Refers To DevopsPipelnStgProm | | EndRevisionCounter | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The revision counter value representing the end state of the source control after this deployment. | | IsCheckDeploy | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this is a validate-only deployment. The default value is false. | | IsFullDeploy | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether all changes in the branch is deployed instead of just the changes. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn't null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the environment deployment record. | | RunTests | Type textarea Properties Create, Nillable, Update Description A comma-separated list of specific Apex tests to run if TestLevel is set to RunSpecifiedTests. | | StartRevisionCounter | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The revision counter value representing the starting state of the source control before this deployment. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The overall status of the deployment operation. The default value is NEW. | | SwapStageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the pipeline stage associated with the replace environment operation. This is a relationship field. Relationship Name SwapStage Refers To DevopsPipelineStage | | TargetDeployOrgId | Type reference Properties Create, Filter, Group, Sort Description The ID of the target DevopsEnvironment where the change is deployed. This is a relationship field. Relationship Name TargetDeployOrg Relationship Type Parent-detail Refers To DevopsEnvironment | | TestLevel | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies which Apex tests to run during the deployment. The default value is Default. Possible values are: - Default—No tests in sandboxes; all local tests in production. - NoTestRun—No tests are run. - RunAllTestsInOrg—All tests in the org are run, including those from installed packages. - RunLocalTests—All tests in the org are run, excluding those from installed packages. - RunSpecifiedTests—Only the tests specified in the RunTests field are run. | ## Usage Validate-only deployment is not supported in the Lifecycle Center. ## Associated Objects This object has the following associated objects. [DevopsEnvDeployementHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. #### See Also - [DevopsEnvironment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsenvironment.htm "Represents a connection from Lifecycle Center to an environment, which currently can be only a Salesforce org. Developers use development environments to do their work. Each pipeline stage has an associated environment. This object is available in API version 66.0 and later.") - [DevopsEnvDeploymentMbr](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsenvdeploymentmbr.htm "Represents a metadata component or configuration data record included in a deployment to a Lifecycle Center pipeline environment. Use it to verify what was promoted or deployed. This object is available in API version 66.0 and later.") - [DevopsPipelnStgProm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelnstgprom.htm "Represents a stage promotion in Lifecycle Center. Stage promotion moves one or more work items to the next stage in the pipeline. This object is available in API version 66.0 and later.") - [DevopsRequestInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsrequestinfo.htm "Represents a specific request for a Lifecycle Center operation, such as a commit, deploy, promotion, rebase, or back sync, and tracks its overall status and outcome. This object is available in API version 66.0 and later.") <!-- document id=4326e291cb8b0ed216f9270e80ea337330747b41c4ac186f0becb9ff38f16fcf url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsenvdeploymentmbr.md --> # DevopsEnvDeploymentMbr Represents a metadata component or configuration data record included in a deployment to a Lifecycle Center pipeline environment. Use it to verify what was promoted or deployed. This object is available in API version 66.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ChangeType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the type of change for this member. Possible values are: - CHANGE—Update to an existing component. - DATA—Configuration data record. - DELETE—A component marked for removal (destructive change). - NEW—New component. The default value is NEW. | | ChangedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who last modified the member. This field is a relationship field. Relationship Name ChangedBy Refers To User | | ChangedOn | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the component was last modified. | | DevopsEnvDeploymentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent deployment record this member belongs to. This field is a relationship field. Relationship Name DevopsEnvDeployment Relationship Type Master-detail Refers To DevopsEnvDeployment (the parent object) | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | MemberName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the metadata component or data record. | | MemberType | Type string Properties Create, Filter, Group, Sort, Update Description The type of the component, such as CustomObject, ApexClass, or Layout. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique identifier for the deployment member record. | | NumberOfRecords | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of data records associated with this member, applicable when ChangeType is DATA. | | VersionNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The version number of the component being deployed. | ## 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. [DevopsEnvDeploymentMbrFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsEnvDeploymentMbrHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. <!-- document id=2add8ec90fe7d89603239a8e5297010750a4907fe3d3fc3e69509c997b860ba9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsenvironment.md --> # DevopsEnvironment Represents a connection from Lifecycle Center to an environment, which currently can be only a Salesforce org. Developers use development environments to do their work. Each pipeline stage has an associated environment. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CanTrackChanges | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether source tracking is enabled for this environment. The default value is false. | | DoceHubType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Possible values are: - CORE | | ExternalId | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The external reference ID for mapping cross-system records. This field is unique within your org. | | IsDevEnvironment | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the environment is a development environment. The default value is false. | | IsExpired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the connection to the environment is invalid or the environment has expired. For example, a deleted or expired scratch org, or a refreshed sandbox whose org ID no longer matches OrgIdentifier. The default value is false. | | IsTestEnvironment | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Lifecycle Center uses test.salesforce.com for login. When false, Lifecycle Center uses login.salesforce.com. The default value is false. | | IsVibeEnvironment | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this pipeline is associated with a Code Builder (Agentforce Vibes) environment. The default value is false. | | LastRevisionCounter | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Tracks the last revision or sync point for source control to determine changes. Lifecycle Center uses this value to ensure that it doesn't pull duplicate records. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the environment. | | NamedCredential | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique name of the named credential that Lifecycle Center uses to authenticate and connect to the org referenced by this environment. | | OrgIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The 18-character ID of the Salesforce org that this environment is connected to. Lifecycle Center connects to an org using a URL. When it connects, it compares its org ID with the value in this field. If the two IDs differ, Lifecycle Center determines that the connected org is a refreshed sandbox. | | OrgType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Classifies the connected Salesforce org. Possible values are: - PRODUCTION - SANDBOX The default value is PRODUCTION. | | OrgUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The login URL Lifecycle Center uses to connect to the org. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | RefreshDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that this sandbox was last refreshed from its parent org. Lifecycle Center uses this field with Refresh Source ID to determine post-refresh state. For example, work items that are missing from a recently swapped environment. | | RefreshSourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the environment that this sandbox was cloned from. Lifecycle Center uses this field and Refresh Date to determine which work items are missing from a recently swapped environment. This field is a relationship field. Relationship Name RefreshSource Refers To DevopsEnvironment | | ReplacesId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the environment that this one replaces during reconnection or sandbox swap. This field is a relationship field. Relationship Name Replaces Refers To DevopsEnvironment | ## Usage Use this object to manage and track the Salesforce orgs Lifecycle Center connects to for pipeline stages and work items. ## 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. [DevopsEnvironmentFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsEnvironmentHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [DevopsEnvironmentShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. <!-- document id=6837d4ce08f4de3cbe3bf25002fe45761ed65c1bd8e0142be93726a2d664680c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopspipeline.md --> # DevopsPipeline Represents a release pipeline in Lifecycle Center, which is the ordered path work items follow from development to production. Related DevopsPipelineStage records store the pipeline stages. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief text that explains the purpose of the pipeline or the team it supports. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the pipeline is active. When true, you can promote work items on this pipeline. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique name of the Lifecycle pipeline. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the pipeline. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | PackageDirectories | Type textarea Properties Create, Nillable, Update Description The file path to the package directories defined in the sfdx-project.json file. | | SourceCodeRepositoryId | Type reference Properties Create, Filter, Group, Sort, Update Description Identifies the source control repository associated with this pipeline. This field is a relationship field. Relationship Name SourceCodeRepository Refers To SourceCodeRepository | ## 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. [DevopsPipelineFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsPipelineHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [DevopsPipelineShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. <!-- document id=1450bc21df53d746da86c6b4fde2999786baa4a355b9d891d2596fdad55eeef1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopspipelineenvironment.md --> # DevopsPipelineEnvironment Represents the association between a DevopsPipeline and DevopsEnvironment objects. This object defines which orgs are part of the release pipeline. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsEnvironmentId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the DevopsEnvironment record associated with the pipeline. This field is a relationship field. Relationship Name DevopsEnvironment Refers To DevopsEnvironment | | DevopsPipelineId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent DevopsPipeline record that this environment belongs to. This field is a relationship field. Relationship Name DevopsPipeline Relationship Type Master-detail Refers To DevopsPipeline (the parent object) | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the environment is active for the specified pipeline. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique, auto-generated name for the pipeline environment association record. | ## 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. [DevopsPipelineEnvironmentFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsPipelineEnvironmentHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. #### See Also - [DevopsPipeline](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipeline.htm "Represents a release pipeline in Lifecycle Center, which is the ordered path work items follow from development to production. Related DevopsPipelineStage records store the pipeline stages. This object is available in API version 67.0 and later.") - [DevopsEnvironment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsenvironment.htm "Represents a connection from Lifecycle Center to an environment, which currently can be only a Salesforce org. Developers use development environments to do their work. Each pipeline stage has an associated environment. This object is available in API version 66.0 and later.") - [DevopsPipelineStage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelinestage.htm "Represents a connection between a pipeline, an environment, and the source control branch used for that stage. The collection of all pipeline stages in a project make up the Lifecycle Center pipeline. This object is available in API version 66.0 and later.") <!-- document id=4919a7412eabab94e8235bb71d78b436f7804984c03abf326ecaf3bba3b86c4e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopspipelinestage.md --> # DevopsPipelineStage Represents a connection between a pipeline, an environment, and the source control branch used for that stage. The collection of all pipeline stages in a project make up the Lifecycle Center pipeline. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevOpsEnvironmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the associated pipeline stage where these stage operations happen. Currently all environments are Salesforce orgs. This field is a relationship field. Relationship Name DevOpsEnvironment Refers To DevopsEnvironment | | DevopsPipelineId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent DevopsPipeline record that this stage belongs to. This field is a relationship field. Relationship Name DevopsPipeline Relationship Type Master-detail Refers To DevopsPipeline (the parent object) | | IsBundled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether work items in this stage are bundled together for promotion. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastSyncDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time the stage environment was last synced with the source control branch. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the pipeline stage. For example, Staging or UAT. | | NextStageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the next stage in the release pipeline. For a production stage, this value is NULL. This field is a relationship field. Relationship Name NextStage Refers To DevopsPipelineStage | | ReviewRemoteReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to a change request associated with this stage in the source control. | | SourceCodeRepositoryBranchId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the specific branch in the source control that corresponds to this pipeline stage. This field is a relationship field. Relationship Name SourceCodeRepositoryBranch Refers To SourceCodeRepositoryBranch | ## 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. [DevopsPipelineStageFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsPipelineStageHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. <!-- document id=60e4d5811cca79498050e94801ee8161215709f609a41046b8f1551c10a0c417 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopspipelinestagetrigger.md --> # DevopsPipelineStageTrigger Defines trigger points within a pipeline stage where automated validations, test suite executions, and quality gate evaluations can be initiated. It tracks execution history, trigger type, associated records, and the number of linked test suites and quality gates, enabling organizations to enforce testing and quality controls at specific stages of the deployment lifecycle. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastExecutionStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the status of the most recent trigger execution. Possible values are: - Error - Failed - InProgress - Passed The default value is Passed. | | LastExecutionTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Stores the date and time when the trigger was most recently executed. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related record or list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Stores the name of the pipeline stage trigger. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or queue that owns the pipeline stage trigger record. Relationship Name Owner Refers To Group, User | | QualityGateCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the number of quality gates associated with this trigger. | | RelatedRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the pipeline or pipeline stage associated with this trigger. Relationship Name RelatedRecord Refers To DevopsPipeline, DevopsPipelineStage | | TestSuiteCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the number of test suites associated with this trigger. | | TriggerType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies when the trigger is executed within the pipeline lifecycle. Possible values are: - Post-Promote - Pre-Promote - Review The default value is Pre-Promote. | <!-- document id=442c2550a56388925386bd4fafa19b80de6476ea6528b7b9896d74b994897997 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopspipelinetestprovider.md --> # DevopsPipelineTestProvider Establishes the association between a pipeline and an external test provider. It stores provider-specific configuration and project information required for integrating testing services into a pipeline. This object enables pipelines to connect with external testing platforms, manage provider settings, and facilitate the execution and synchronization of tests as part of the workflow. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsPipelineId | Type reference Properties Create, Filter, Group, Sort Description References the pipeline associated with this test provider configuration. Relationship Name DevopsPipeline Relationship Type Parent-detail Refers To DevopsPipeline (the parent object) | | DevopsTestProviderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the external test provider linked to the pipeline. Relationship Name DevopsTestProvider Refers To DevopsTestProvider | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related record or list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier for the pipeline test provider record. | | TestProviderProject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the project name or identifier used by the external test provider for this pipeline. | | TestProviderSpecificConfig | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Stores provider-specific configuration settings required for integrating and managing the external test provider within the pipeline. | <!-- document id=0b66acd03679ba3175b63dc631381c061bff65793fee992ea6e17b4c974e9c49 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopspipelnstgprom.md --> # DevopsPipelnStgProm Represents a stage promotion in Lifecycle Center. Stage promotion moves one or more work items to the next stage in the pipeline. This object is available in API version 66.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CompletionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the stage promotion operation was completed. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique name for the pipeline stage promotion record. | | PipelineStageId | Type reference Properties Create, Filter, Group, Sort Description The ID of the target pipeline stage to which the work items are promoted. This field is a relationship field. Relationship Name PipelineStage Relationship Type Master-detail Refers To DevopsPipelineStage (the parent object) | | RequestInfoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the associated DevopsRequestInfo record that tracks this event. This field is a relationship field. Relationship Name RequestInfo Refers To DevopsRequestInfo | | Status | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The current state of the promotion operation. Possible values are: - CANCELLED - ERROR - FINALIZING - INTERRUPTED - IN\_PROGRESS - NEW - SUCCESS The default value is NEW. | ## Usage Use this object to track the execution and outcome of a stage promotion. During promotion, work item branches merge into a target stage branch and deploys the associated metadata and configuration data to the environment linked to that stage. ## 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. [DevopsPipelnStgPromChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [DevopsPipelnStgPromFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsPipelnStgPromHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [DevopsPipelnStgPromOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [DevopsPipelnStgPromShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. #### See Also - [DevopsPipelineStage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelinestage.htm "Represents a connection between a pipeline, an environment, and the source control branch used for that stage. The collection of all pipeline stages in a project make up the Lifecycle Center pipeline. This object is available in API version 66.0 and later.") - [DevopsPipelnStgPromWkItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelnstgpromwkitem.htm "Represents the association between a work item and a pipeline stage promotion. The object tracks the merge status of the work item into the target stage branch in source control. This object is available in API version 66.0 and later.") - [DevopsRequestInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsrequestinfo.htm "Represents a specific request for a Lifecycle Center operation, such as a commit, deploy, promotion, rebase, or back sync, and tracks its overall status and outcome. This object is available in API version 66.0 and later.") <!-- document id=b6f25fe55117a5d11bc1e3ce355c405479861ea7068c5462aaf11e0cd0359cd9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopspipelnstgpromwkitem.md --> # DevopsPipelnStgPromWkItem Represents the association between a work item and a pipeline stage promotion. The object tracks the merge status of the work item into the target stage branch in source control. This object is available in API version 66.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsPipelnStgPromId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent pipeline stage promotion record. This field is a relationship field. Relationship Name DevopsPipelnStgProm Relationship Type Master-detail Refers To DevopsPipelnStgProm (the parent object) | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | MergeCompletionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the merge operation for this specific work item was completed in the source control system. | | MergeRemoteReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique reference identifier from the remote source control provider, such as a Pull Request ID, for the merge associated with this promotion. | | MergeSourceBranchId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the source branch in the repository from which changes were merged for this work item during this promotion. This field is a relationship field. Relationship Name MergeSourceBranch Refers To SourceCodeRepositoryBranch | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique identifier for the pipeline stage promotion work item record. | | WorkItemId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the work item that is promoted. This field is a relationship field. Relationship Name WorkItem Refers To WorkItem | ## Usage Use this object to track how individual work items move forward through the release lifecycle. When a work item is promoted, either individually as part of custom promotion or as part of a stage promotion, this record captures the source branch information and the completion status of the merge operation in the source control system. ## 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. [DevopsPipelnStgPromWkItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [DevopsPipelnStgPromWkItemFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsPipelnStgPromWkItemHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [DevopsPipelnStgPromWkItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [DevopsPipelnStgPromWkItemShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. #### See Also - [WorkItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workitem.htm "Represents a logical unit of work, such as a user story, task, or bug, used to track the progress of metadata and configuration data changes within a Lifecycle Center project. A work item moves through multiple development lifecycle stages until all development work is complete and the work item is part of the release pipeline. This object is available in API version 67.0 and later.") - [DevopsPipelineStage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelinestage.htm "Represents a connection between a pipeline, an environment, and the source control branch used for that stage. The collection of all pipeline stages in a project make up the Lifecycle Center pipeline. This object is available in API version 66.0 and later.") - [SourceCodeRepositoryBranch](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sourcecoderepositorybranch.htm "Represents a specific branch within a source control repository, such as a feature branch for a work item or a release branch for a pipeline stage. Work Item and Pipeline Stage records refer to this object. This object is available in API version 66.0 and later.") <!-- document id=8e3465cf422be72196a1dbcba7b0a74464e424548e3eabf0589afe913d937384 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsproject.md --> # DevopsProject Represents a Lifecycle Center project. A project is the primary workspace where teams collaborate to manage changes for an app or customization. This object is the parent for all other Lifecycle Center objects, including pipelines, environments, and work items. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A text description of the project's purpose or scope. Lifecycle Center uses this field only to display the description in the UI. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the project is currently active. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Lifecycle Center project. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the project. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | ## 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. [DevopsProjectFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsProjectHistory](https://https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm/docs/atlas.en-us.260.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [DevopsProjectShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. <!-- document id=f88606a0852fdc4f3cbf6106f1407a43871e52cf2a3992afa0269cf3a0a8704a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsprojectpipeline.md --> # DevopsProjectPipeline Represents an association between a Lifecycle Center project and a release pipeline. In Lifecycle Center, each project is associated with a pipeline to define the sequence of stages work items move through, from initial development to final release. This association is typically established during the pipeline setup. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsPipelineId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the associated DevopsPipeline record. This field is a relationship field. Relationship Name DevopsPipeline Refers To DevopsPipeline | | DevopsProjectId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent DevopsProject record. This field is a relationship field. Relationship Name DevopsProject Relationship Type Master-detail Refers To DevopsProject (the parent object) | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique identifier for the project-pipeline association. | ## 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. [DevopsProjectPipelineChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [DevopsProjectPipelineFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsProjectPipelineHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [DevopsProjectPipelineOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [DevopsProjectPipelineShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. <!-- document id=1c826d56e14e239ec5d76da2947393d4937d6fb648e8ebe615192f579de1d6ef url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsqualitygate.md --> # DevopsQualityGate Defines a set of quality requirements that must be satisfied before a deployment or pipeline stage can proceed. It acts as a container for quality gate rules, enabling organizations to enforce testing and quality standards by evaluating test execution results against predefined criteria. Quality gates help ensure that only changes meeting established quality thresholds advance through the DevOps lifecycle. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description Stores additional details, notes, or documentation about the quality gate. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related record or list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Stores the name of the quality gate. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or queue that owns the quality gate record. Relationship Name Owner Refers To Group, User | <!-- document id=6ccf154a0012231b61f4f6a7eb5cf75689976c7dfc077043f8e575e76e179384 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsqualitygateresult.md --> # DevopsQualityGateResult Stores the outcome of a quality gate evaluation performed during a test suite execution. It records the overall status of the quality gate and associates the result with both the quality gate definition and the corresponding test suite execution. This object enables tracking, reporting, and auditing of quality gate compliance before a deployment progresses through the DevOps pipeline. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsQualityGateId | Type reference Properties Create, Filter, Group, Sort Description References the quality gate evaluated for this result record. Relationship Name DevopsQualityGate Relationship Type Parent-detail Refers To DevopsQualityGate (the parent object) | | DevopsTestSuiteExecutionId | Type reference Properties Create, Filter, Group, Sort, Update Description References the test suite execution associated with this quality gate evaluation. Relationship Name DevopsTestSuiteExecution Refers To DevopsTestSuiteExecution | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related record or list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier for the quality gate result record. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the overall outcome of the quality gate evaluation. Possible values are: - Error - Failed - InProgress - Passed The default value is Passed. | <!-- document id=3989009f49b56a176fb7c64874bbd7813ce61176ffe7d2f9f3bcba6b99ece421 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsqualitygaterule.md --> # DevopsQualityGateRule Defines the criteria that must be evaluated as part of a quality gate assessment within the DevOps process. Each rule specifies a validation condition, such as severity, pass percentage, or essential test requirements, along with an optional threshold value. These rules are used to determine whether a quality gate passes or fails before allowing progression through the deployment pipeline. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsQualityGateId | Type reference Properties Create, Filter, Group, Sort Description References the quality gate to which this rule belongs. Relationship Name DevopsQualityGate Relationship Type Master-detail Refers To DevopsQualityGate (the parent object) | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related record or list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier for the quality gate rule record. | | Rule | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the rule used to evaluate the quality gate. Possible values are: - ESSENTIAL - PASS\_PERCENTAGE - SEVERITY The default value is SEVERITY. | | Threshold | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Defines the threshold value used when evaluating the quality gate rule. | <!-- document id=cd06598a444bcf37bcc01cffdad3a5e2085454054b84f4ca6abb5906febf6a65 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsqualitygateruleresult.md --> # DevopsQualityGateRuleResult Stores the outcome of an individual quality gate rule evaluation performed during a quality gate assessment. It records the execution status of a specific quality gate rule and associates the result with the overall quality gate evaluation, enabling detailed tracking, monitoring, and reporting of quality gate compliance within the DevOps process. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsQualityGateResultId | Type reference Properties Create, Filter, Group, Sort, Update Description References the quality gate result associated with this rule result record. Relationship Name DevopsQualityGateResult Refers To DevopsQualityGateResult | | DevopsQualityGateRuleId | Type reference Properties Create, Filter, Group, Sort Description References the quality gate rule evaluated for this result record. Relationship Name DevopsQualityGateRule Relationship Type Parent-detail Refers To DevopsQualityGateRule (the parent object) | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related record or list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier for the quality gate rule result record. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the outcome of the quality gate rule evaluation. Possible values are: - Error - Failed - InProgress - Passed The default value is Passed. | <!-- document id=80c7491fb033ecd250139fa53f0b7dbf613d618b695634dc0db82582d8d2ec42 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopsrequestinfo.md --> # DevopsRequestInfo Represents a specific request for a Lifecycle Center operation, such as a commit, deploy, promotion, rebase, or back sync, and tracks its overall status and outcome. This object is available in API version 66.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ErrorDetails | Type textarea Properties Create, Nillable, Update Description Provides detailed information if the requested operation encounters an error. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Message | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A status message or summary description regarding the current state of the request. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique identifier for the request info record. | | OperationType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the specific type of Lifecycle Center action performed. Possible values are: - BACK\_SYNC - COMMIT - DEPLOY - INSPECT - MIGRATE - PROMOTE - REBASE - REBASE\_AND\_COMBINE - SWAP - TEST\_ONLY - TEST\_RESUME The default value is PROMOTE. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ParentRequestInfoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of a parent request info record, used for tracking related or suboperations. This field is a relationship field. Relationship Name ParentRequestInfo Refers To DevopsRequestInfo | | RequestCompletionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the requested operation was completed. | | RequestToken | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique token used to correlate the request with external source control systems or event processing. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The current state of the DevOps request. Possible values are: - CANCELLED - ERROR - FINALIZING - INTERRUPTED - IN\_PROGRESS - NEW - SUCCESS The default value is NEW. | ## Usage Use this object to monitor the lifecycle of asynchronous Lifecycle Center operations. For example, when you promote a work item or run a back sync, Lifecycle Center creates a DevopsRequestInfo record to manage that specific operation. It acts as a central point for tracking whether an operation is still in progress, has succeeded, or requires troubleshooting due to an error. If a promotion or commit appears stalled, you can query this object to find the associated result and determine if the external services completed the task successfully. ## 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. [DevopsRequestInfoChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [DevopsRequestInfoFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DevopsRequestInfoHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [DevopsRequestInfoOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [DevopsRequestInfoShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. <!-- document id=c258a749212b686bf00c860ab923953f262654816cb621c55fa2445464d1c05b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopstest.md --> # DevopsTest Stores and manages individual test definitions within the Lifecycle testing framework. It maintains metadata about tests imported from external test providers, including test type, severity, execution status, configuration details, and associations with pipelines and environments. This object enables the organization, tracking, and execution of tests as part of automated quality assurance and deployment processes. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DefinitionInTestProvider | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the URL or reference to the test definition in the external test provider system. | | Description | Type textarea Properties Create, Nillable, Update Description Stores additional details or notes about the test. | | DevopsPipelineId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the DevOps pipeline associated with the test. Relationship Name DevopsPipeline Refers To DevopsPipeline | | DevopsTestProviderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the external test provider that manages the test. Relationship Name DevopsTestProvider Refers To DevopsTestProvider | | EnvironmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the DevOps environment in which the test is applicable. Relationship Name Environment Refers To DevopsEnvironment | | ExternalId | Type string Properties Create, Filter, Group, Sort, Update Description Stores the identifier used by the external test provider to uniquely identify the test. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the test is currently active and available for execution. | | IsEssential | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the test is considered essential for validation or deployment. The default value is false. | | LastExecutionStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the result of the most recent test execution. Possible values are: - Error - Failed - InProgress - Passed The default value is Passed. | | LastExecutionTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Stores the date and time of the most recent test execution. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related record or list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Stores the name of the test. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or queue that owns the test record. Relationship Name Owner Refers To Group, User | | Severity | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the severity level assigned to the test. Possible values range from 1 (lowest) to 5 (highest). The default value is 1. | | Subtype | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores a more specific classification of the test within its test type. | | SyncLogId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the synchronization log associated with the test provider sync operation. Relationship Name SyncLog Refers To DevopsTestProviderSyncLog | | TestClass | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the class name or identifier associated with the test implementation. | | TestProviderSpecificConfig | Type textarea Properties Create, Nillable, Update Description Stores provider-specific configuration settings required for the test. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the category of the test. Possible values are: - End-to-End Test - Integration Test - Linting - Profiling - Scanning - Unit Test The default value is Linting. | | UniqueKey | Type textarea Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Stores a unique identifier for the test within the organization to prevent duplicate records. | <!-- document id=90952c7e6d32194dc9f925b585ba942af1434b7597a33dcd90256af4d9226cb7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopstestexecution.md --> # DevopsTestExecution Tracks the execution of individual tests within a test suite execution. It records execution timing, status, results, severity, error messages, and related reporting information, enabling teams to monitor, analyze, and troubleshoot test outcomes as part of the Lifecycle testing process. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsTestId | Type reference Properties Create, Filter, Group, Sort, Update Description References the test definition associated with this execution record. Relationship Name DevopsTest Refers To DevopsTest | | DevopsTestSuiteExecutionId | Type reference Properties Create, Filter, Group, Sort, Update Description References the test suite execution that contains this test execution. Relationship Name DevopsTestSuiteExecution Refers To DevopsTestSuiteExecution | | ExecutionEndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Stores the date and time when the test execution completed. | | ExecutionStartTime | Type dateTime Properties Create, Filter, Sort, Update Description Stores the date and time when the test execution started. | | ExternalTestRef | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the identifier or reference of the test in an external testing system. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related record or list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | LearnMore | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Stores a URL that provides additional information or guidance related to the test result. | | Message | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores a summary message or outcome associated with the test execution. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier for the test execution record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or queue that owns the test execution record. Relationship Name Owner Refers To Group, User | | ReportUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Stores a URL linking to the detailed execution report. | | ResultDetails | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Stores detailed information about the execution results, including failures and outcomes. | | SampleCode | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Stores sample code, snippets, or examples related to the test execution result. | | Severity | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the severity level associated with the test result. Possible values range from 5 (lowest) to 1 (highest). The default value is 5. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the current execution status of the test. Possible values are: - Error - Failed - InProgress - Passed The default value is Passed. | <!-- document id=5fd1a4434e01a5aff77566ebfda99020314a6f266e41c3269e05964225cd9735 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopstestprovider.md --> # DevopsTestProvider Stores the configuration and metadata of both internal and external testing providers integrated with the DevOps framework. It serves as a central registry of supported test providers, maintaining provider-specific information such as implementation identifiers, language settings, URLs, and integration details required to connect and manage external testing systems within DevOps processes. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ApexClassIdentifier | Type textarea Properties Create, Nillable, Update Description Stores the identifier of the Apex class used to implement the test provider integration. | | Description | Type textarea Properties Create, Nillable, Update Description Stores additional details or notes about the test provider. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Stores the unique developer name used to identify the test provider. | | Icon | Type textarea Properties Create, Nillable, Update Description Stores icon information or metadata associated with the test provider. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the localized language and regional locale code used for the test execution context or report generation. This ensures that any logs, system-generated error messages, or feedback from the DevOps pipeline stage are parsed and presented in the correct linguistic format. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | LearnMoreUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Stores a URL that provides additional information or documentation about the test provider. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Stores the display label of the test provider. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Stores the namespace prefix associated with the test provider package, if applicable. | | TestProviderUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the URL used to access or integrate with the external test provider. | <!-- document id=de5f1d12cdb5a5ae3b6dbd2d3fd456c52184e800e18676905200c7a0e9542f87 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopstestprovidersynclog.md --> # DevopsTestProviderSyncLog Tracks synchronization activities between the DevOps framework and external test providers. It records the lifecycle of synchronization operations, including execution start and end times, status, error details, and the associated DevOps pipeline and test provider. This object enables monitoring, troubleshooting, and auditing of test provider synchronization processes. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsPipelineId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the DevOps pipeline associated with this record. Relationship Name DevopsPipeline Refers To DevopsPipeline | | DevopsTestProviderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the external test provider associated with this record. Relationship Name DevopsTestProvider Refers To DevopsTestProvider | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Stores the date and time when the operation or execution completed. | | ErrorDetails | Type textarea Properties Create, Nillable, Update Description Stores details about errors encountered during the operation or execution. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related record or list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record directly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier for the record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or queue that owns the record. Relationship Name Owner Refers To Group, User | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Stores the date and time when the operation or execution started. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the current status of the operation or execution. Possible values are: - Error - Failed - InProgress - Passed The default value is Passed. | <!-- document id=c0b3ef55e30afb15e3444af90712ee0cd5776610a74ea9bf065f1e6fee60ee96 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopstestsuite.md --> # DevopsTestSuite Stores and manages collections of related test definitions that can be executed together as part of a DevOps pipeline. It serves as a logical grouping mechanism for tests sourced from external test providers, enabling teams to organize, configure, and execute sets of tests within specific pipelines and environments. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DefinitionInTestProvider | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the URL or reference to the test definition in the external test provider system. | | Description | Type textarea Properties Create, Nillable, Update Description Stores additional details or notes about the test definition. | | DevopsPipelineId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the DevOps pipeline associated with the test definition. Relationship Name DevopsPipeline Refers To DevopsPipeline | | DevopsTestProviderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the external test provider that manages the test definition. Relationship Name DevopsTestProvider Refers To DevopsTestProvider | | EnvironmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the DevOps environment in which the test definition is applicable. Relationship Name Environment Refers To DevopsEnvironment | | ExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores the identifier used by the external test provider to uniquely identify the test definition. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the test definition is currently active and available for use. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Stores the timestamp when the current user last viewed the record directly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Stores the name of the test definition. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or queue that owns the test definition record. Relationship Name Owner Refers To Group, User | | SyncLogId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the synchronization log associated with the test provider sync operation. Relationship Name SyncLog Refers To DevopsTestProviderSyncLog | | TestProviderSpecificConfig | Type textarea Properties Create, Nillable, Update Description Stores test-provider-specific configuration settings required for the test definition. | | UniqueKey | Type textarea Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Stores a unique identifier for the test definition within the organization to prevent duplicate records. | <!-- document id=98d77de9c65cc5f8d4b8927bdae44abe5ffe350811f536aa07778d37b52f09b4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopstestsuiteexecution.md --> # DevopsTestSuiteExecution Records the individual execution lifecycle, results, and metrics of a specific test suite within a DevOps pipeline stage. It tracks granular outcomes like code coverage, pass/fail rates, and links directly back to the overarching test suite group. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Coverage | Type percent Properties Create, Filter, Nillable, Sort, Update Description The automated code coverage percentage for example, Apex test coverage, achieved during this specific test suite execution. | | DevopsTestSuiteGroupExecId | Type reference Properties Create, Filter, Group, Sort, Update Description References the parent DevopsTestSuiteGroupExec record that coordinates this and other related test suite executions within the pipeline stage. Relationship Name DevopsTestSuiteGroupExec Refers To DevopsTestSuiteGroupExec | | DevopsTestSuiteId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the definition of the DevopsTestSuite being executed. This field is a relationship field. Relationship Name DevopsTestSuite Refers To DevopsTestSuite | | DevopsTestSuiteStageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the specific stage configuration or environment step (DevopsTestSuiteStage) where this execution takes place. This field is a relationship field. Relationship Name DevopsTestSuiteStage Refers To DevopsTestSuiteStage | | ExecutionEndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the test suite finished executing. This field remains null while the execution is actively InProgress. | | ExecutionStartTime | Type dateTime Properties Create, Filter, Sort, Update Description The precise date and time when the execution of this test suite commenced. | | ExternalIdRef | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique identifier used to map or reference this test run to an external CI/CD engine, testing framework, or third-party tool execution ID. | | FailureCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of individual test cases or assertions that failed during this test suite run. | | FailureRate | Type percent Properties Create, Filter, Nillable, Sort, Update Description The calculated percentage of failed tests relative to the total number of tests run in this suite. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, such as through a related list or lookup context. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last explicitly viewed this record's detail page or list view. | | LearnMore | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description A URL pointing to supplemental documentation, internal run logs, or troubleshooting guides relevant to this test suite execution. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A system-generated unique auto-number identifier assigned to the test suite execution record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or queue that owns this specific test suite execution record. Relationship Name Owner Refers To Group, User | | QualityGateStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents the final evaluation outcome of any automated quality policies or compliance criteria established for this test suite. Possible values are: - Error - Failed - InProgress - Passed The default value is Passed. | | ReportUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The web link to the complete, detailed test execution report or artifacts (e.g., JUnit XML, HTML dashboard) generated by the runner. | | ResultDetails | Type textarea Properties Create, Nillable, Update Description A raw block of summary text, error logs, stack traces, or console output detailing why a test failed or stalled. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The operational state of the test suite run execution process itself. Possible values are: - Error - Failed - InProgress - Passed The default value is Passed. | | SuccessCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of individual test cases or assertions that completed successfully without errors. | | SuccessRate | Type percent Properties Create, Filter, Nillable, Sort, Update Description The calculated percentage of passing tests relative to the total number of tests run in this suite. | <!-- document id=8d60f385aac151be564000f0758bd200dfa9c4420b6fdaf5ab577eae3b913276 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopstestsuitegroupexec.md --> # DevopsTestSuiteGroupExec Records the execution lifecycle of a test suite group within a DevOps pipeline stage, including execution status, quality gate outcomes, timing information, and deployment request details. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsPipelineStageTriggerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the pipeline stage trigger with which this test suite stage is associated. Relationship Name DevopsPipelineStageTrigger Refers To DevopsPipelineStageTrigger | | ExecutionEndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the test suite group finished executing. This field remains null (nillable) while the execution is actively In Progress or Pending and is populated immediately upon the completion, failure, or error termination of the run. | | ExecutionStartTime | Type dateTime Properties Create, Filter, Sort, Update Description The precise date and time when the execution of the test suite group officially commenced within the DevOps pipeline stage. It is used alongside the end time to calculate the total duration of the test execution lifecycle. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier (auto-number) for the DevOps Test Suite Stage record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or queue that owns the test suite group execution record. Relationship Name Owner Refers To Group, User | | PendingExecutionCount | Type int Properties Filter, Group, Nillable, Sort Description Indicates the number of test executions that are still pending within the execution group. | | QualityGateStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents the outcome of quality gate validation for the execution group. Possible values are: - Error - Failed - InProgress - Passed | | RequestInfoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the DevOps request or deployment request associated with this execution. Relationship Name RequestInfo Refers To DevopsRequestInfo | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Represents the overall execution status of the test suite group. Possible values are: - Error - Failed - InProgress - Passed | <!-- document id=1ac4d76d02b7d40ec33684ec0a653c53e4875150f2bedc5b85767b496660f01c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopstestsuitestage.md --> # DevopsTestSuiteStage Represents the association between a Test Suite and a Pipeline Stage within the DevOps process. It is used to configure which test suites are executed at specific pipeline stages and optionally link quality gates that must be evaluated before progressing through the deployment pipeline. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsPipelineStageTriggerId | Type reference Properties Create, Filter, Group, Sort, Update Description References the pipeline stage trigger with which this test suite stage is associated. Relationship Name DevopsPipelineStageTrigger Refers To DevopsPipelineStageTrigger | | DevopsQualityGateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the quality gate that can be applied to validate deployment criteria for this stage. Relationship Name DevopsQualityGate Refers To DevopsQualityGate | | IsQualityGateEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the associated quality gate is enabled and enforced for this test suite stage. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier (auto-number) for the Lifecycle centre Test Suite Stage record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or queue that owns this Lifecycle centre Test Suite Stage record. Relationship Name Owner Refers To Group, User | | TestSuiteId | Type reference Properties Create, Filter, Group, Sort, Update Description References the Lifecycle centre Test Suite that is linked to this pipeline stage. Relationship Name TestSuite Refers To DevopsTestSuite | <!-- document id=cfe674af1ac6fb2c1d2ef1aefc6de2d0c92b6e1a6f50352a59dae43f5a664b29 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopstestsuitetest.md --> # DevopsTestSuiteTest Represents the association between a Lifecycle centre Test Suite and an individual DevOps Test, enabling tests to be organized, managed, and synchronized within a test suite. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsTestId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the DevOps Test associated with this test suite entry. Relationship Name DevopsTest Refers To DevopsTest | | DevopsTestSuiteId | Type reference Properties Create, Filter, Group, Sort Description References the parent Lifecycle centre Test Suite that contains this test. Relationship Name DevopsTestSuite Relationship Type Master-detail Refers To DevopsTestSuite (the master object) | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the test is currently active within the test suite. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The system-generated unique identifier for the record. | | SyncLogId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the synchronization log associated with this test suite entry. Relationship Name SyncLog Refers To DevopsTestProviderSyncLog | | UniqueKey | Type textarea Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Stores a unique identifier used to uniquely distinguish this record within the organization. | <!-- document id=004fc3c6fae45ce35e3a646aa2426a1c55c4f9ced5cd7a7d68f9b5bc4116407f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_devopswkitmtststegrpexec.md --> # DevopsWkItmTstSteGrpExec Represents the association between a DevOpsWork Item and a DevOpsTestSuiteGroupExecution. This object is used to track which work items are linked to specific test suite group execution records, enabling traceability between development work and test execution activities within the DevOps lifecycle. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DevopsTestSuiteGroupExecId | Type reference Properties Create, Filter, Group, Sort, Update Description References the Lifecycle centre Test Suite Group Execution associated with this record. This field is a relationship field. Relationship Name DevopsTestSuiteGroupExec Refers To DevopsTestSuiteGroupExec | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The system-generated unique identifier for the record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description References the user or queue that owns this record. Relationship Name Owner Refers To Group, User | | WorkItemId | Type reference Properties Create, Filter, Group, Sort, Update Description References the work item linked to this test suite group execution record. Relationship Name WorkItem Refers To WorkItem | <!-- document id=f679f374c57a37c787c96dd527e4166f260641fef9ce405c5f1d2a8dcfbca37b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_digitalsignature.md --> # DigitalSignature Represents a signature captured on a service report in field service. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | DigitalSignatureNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the signature. | | DocumentBody | Type base64 Properties Create Description The captured signature image. | | DocumentContentType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The data type of the captured signature. Possible values are: - audio/acc - audio/amr - audio/ogg - video/3gpp2 - video/3gpp - image/avif - text/calendar - audio/x-caf - image/webp | | DocumentLength | Type int Properties Filter, Group, Nillable, Sort Description The length of the captured signature. | | DocumentName | Type string Properties Create, Filter, Group, Sort Description The name of the captured signature image. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the service appointment, work order, or work order line item that the service report is generated for. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To AuthorizationFormConsent, Order, ServiceAppointment, WorkOrder, WorkOrderLineItem | | Place | Type string Properties Create, Filter, Group, Nillable, Sort Description The place where the report was signed. | | SignatureType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The role of the person signing the service report. Your org comes with one signature type, Default. A service report template can only contain one signature per type. If you plan to collect multiple signatures on service reports, create additional values for the Signature Type field. Create at least one value for every role that might need to sign a service report. For example, Technician, Customer, Supervisor, or Supplier. If some service reports will be signed by multiple people in one role—for example, all technicians present at an appointment—create numbered types: Technician 1, Technician 2, and so forth. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can create up to 1,000 signature types. You can’t delete signature types, but you can deactivate them so they can’t be used in service report templates. When you deactivate a type, it still appears on service report templates that used it, but you can’t use it on new service report templates. | | SignedBy | Type string Properties Create, Filter, Group, Nillable, Sort Description The name of the person signing. | | SignedDate | Type dateTime Properties Create, Filter, Nillable, Sort Description The date and time of the signing. | ## Usage Add signature blocks to service report templates to determine which signatures need to be gathered on reports that use the template. Service report templates can contain up to 20 signatures, and each signature must use a different Signature Type. For example, create a standard service report template that contains a customer signature and a technician signature. To learn more about digital signatures, see [Guidelines for Using Signatures on Service Reports](https://help.salesforce.com/articleView?id=fs_signature_guidelines.htm&language=en_US). ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [DigitalSignatureChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (Available in API version 57.0) Change events are available for the object. <!-- document id=9cdfecd4fd10bde67edb439e36c8632883e8270f6c4fbe0433f866bd4d252f2b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_digitalwallet.md --> # DigitalWallet Represents a customer’s digital wallet service. Salesforce Payments can use a digital wallet as a payment source when processing payments through a payment gateway. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account of the customer owns the digital wallet. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | AuditEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the digital wallet owner where audit information about payments gets sent. This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own. | | BillingName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing name linked to customer's digital wallet. Available in API version 64.0 and later. | | Comments | Type textarea Properties Create, Nillable, Update Description Users can provide additional details about the digital wallet. Supports a maximum of 1000 characters. | | CompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Company of the digital wallet owner. | | Customer | Type string Properties Create, Filter, Group, Nillable, Sort Description Customer name of the digital wallet owner. | | DigitalWalletNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated reference number for the digital wallet. | | Email | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email of the digital wallet owner. | | ExtendedPaymentMethodType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Other digital payment methods used for the transaction. This field value is required when the value of the PaymentMethodType field is extd\_altrn\_payment\_method\_type or extd\_wallet. This field is available in API version 66.0 and later. | | GatewayToken | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unencrypted unique token ID generated by the payment gateway to represent the digital wallet during transactions. This field is available for backward compatibility. To secure the token, use the GatewayTokenEncrypted field. If you try to record a GatewayToken for a digital wallet that already has a GatewayToken or GatewayTokenEncrypted value, Salesforce throws an error. | | GatewayTokenDetails | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Unique ID generated by the payment gateway for the card for future transactions. | | GatewayTokenEncrypted | Type encryptedstring Properties Create, Nillable, Update Description Encrypted unique token ID generated by the payment gateway to represent the digital wallet during transactions. Encrypted using Salesforce Classic Encryption for custom fields. Available in API v52.0 and later. | | IpAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The IP address of the digital wallet owner. This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own. | | IsAutoPayEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Indicates whether the payment method can be used for recurring payments (True) or not (False). The default value is False. This field is available in API v55.0 and later. For orgs that upgraded from v54.0, you must add this field to the Digital Wallet page layout in the UI. It isn't automatically added. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it's possible the user only referenced this record (LastReferencedDate) but not viewed it. | | MacAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The MAC address of the digital wallet owner. This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own. | | NickName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description User-defined nickname for the digital wallet. | | PaymentGatewayId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Gateway used with transactions for the digital wallet. This field is a relationship field. Relationship Name PaymentGateway Relationship Type Lookup Refers To PaymentGateway | | PaymentMethodAddress | Type address Properties Filter, Nillable Description Full address associated with the digital wallet payment method. For more information about address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") | | PaymentMethodCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodDetails | Type string Properties Create, Filter, Group, Nillable, Sort Description Optional information about the payment method type. This field is available in API version 57.0 and later. | | PaymentMethodGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the payment method address. An accuracy level contains information about the location of a latitude and longitude. For more information about geolocation fields, see [Geolocation Compound Field](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_geolocation.htm "Geolocation fields are accessible in the SOAP and REST APIs as a Location—a structured compound data type—or as individual latitude and longitude elements."). Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | PaymentMethodLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Latitude of the payment method address. Used with the PaymentMethodLongitude to specify the precise geolocation of the address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | PaymentMethodLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Latitude of the payment method address. Used with the PaymentMethodLatitude to specify the precise geolocation of the address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | PaymentMethodPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodSubType | Type string Properties Create, Filter, Group, Nillable, Sort Description More information about the payment method. For example, if the PaymentMethodType is Visa, this field can be digital wallet. This field is available in API version 57.0 and later. | | PaymentMethodType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Payment method used for the transaction. Possible values include credit cards such as Visa and American Express, digital wallets like Apple Pay and PayPal, direct debits such as ACH, BECS, Bacs, non-card payments methods such as EPS, SEPA, and iDEAL, extended alternate payments methods, and extended wallets. This field is available in API version 57.0 and later. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the digital wallet owner. This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Defines whether the digital wallet is used for transactions made inside or outside the payment platform. Possible values are: - External—Transactions happened outside of the Salesforce payments platform. - Salesforce—Salesforce made and recorded an external call to the payment platform. This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important ProcessingMode is required to create a DigitalWallet entity. | | SavedPaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the saved payment method record. Relationship Name SavedPaymentMethod Relationship Type Lookup Refers To SavedPaymentMethod | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines the state of the digital wallet as a payment source. Possible values are: - Active—Customers can make payments with the digital wallet. - Canceled—The digital wallet can no longer be used for payments. This status can’t be changed. - InActive—The digital wallet can’t be used for payments until a user changes its status to Active. | <!-- document id=4dd047282e327a301b985cf6c80750f7847fd0e3df10adc427fb198e096e694c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_directmessage.md --> # DirectMessage Represents a direct message conversation between multiple users in Chatter. This object is available in API version 38.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), update() ## Special Access Rules You must have the Manage Chatter Messages and Direct Messages permission enabled to access the DirectMessage object. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description A default value that isn’t visible to users. | | Subject | Type string Properties Filter, Group, Nillable, Sort, Update Description Subject of the overall direct message conversation. | ## Usage DirectMessage is an object used by Salesforce to control DirectMessage conversations. It represents a record of a direct message conversation, but doesn’t include conversation data, such as posts or comments. It is most frequently used to moderate direct message data in order to meet data compliance regulations. <!-- document id=ed3b0eb605b3ced4ee4c6ac3b55b68ab6f33f65eab6a9c645b74eede4d89e536 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_division.md --> # Division A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - Divisions must be enabled for your organization to access this object. To discover whether divisions have been enabled for an organization, inspect the User or Group object for the DefaultDivision field—if it is present, then divisions have been enabled, and this field (the field is named Division in objects other than User and Group) will be available in all relevant objects. - Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Update Description Indicates whether the division is active (true) or not (false). Label is **Active**. | | IsGlobalDivision | Type boolean Properties Defaulted on createFilter Description Indicates whether the division is your organization’s global default division (true) or not (false). Label is **Global Division**. | | Name | Type string Properties Create, Filter, Update Description A descriptive name for the division. Limit: 80 characters. | | SortOrder | Type int Properties Create, Filter, Nillable, Update Description The order in which this division name appears in the Division picklist field when creating or editing users in the Salesforce user interface. | ## Usage The values available for that field are the global division ID for the organization, created when divisions are first enabled, and any other division IDs that have been created. The division ID associated with a user is populated in the objects owned or created by the user. You can use the division ID to make searches, reports, and list views run more quickly and return more relevant results if an organization has very large data sets. For more information, see the Salesforce online help, in the Fields description for the object. You can use WITH in SOSL to pre-filter results based on division. This is faster than specifying the division in a WHERE clause. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The User object has a Division field that is unrelated to this object. The Division field is a standard text field similar to Company or Department that has no special properties. Do not confuse it with the DefaultDivision field, which does relate to this object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=65a2af2753ee2bbc4bd7eade65d1e082fd43eba818c597720b07f182e66a3916 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_divisionlocalization.md --> # DivisionLocalization When the Translation Workbench is enabled for your organization, the DivisionLocalization object provides the translation of the label for a division. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - Your organization must be using Professional, Enterprise, Developer, Unlimited, or Performance Edition and be enabled for the Translation Workbench. - To view this object, you must have the “View Setup and Configuration” permission. ## Fields | Field | Details | | --- | --- | | Language | Type string Properties Create, Filter, Nillable, Restricted picklist Description The language for this translated label. | | NamespacePrefix | Type string Properties Filter, Nillable Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Nillable Description The ID of the Division associated with the label that is being translated. | | Value | Type string Properties Create, Filter, Nillable, Update Description The actual translated label for the division. Label is **Translation**. | ## Usage Use this object to translate the labels of your divisions into the different languages supported by Salesforce. <!-- document id=9e2c7d9669267338117678fb3f3f1d4b9198d772244eef8d2e25a7200a5843d0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_docatchdownloadeventlog.md --> # DocAtchDownloadEventLog Document Attachment Downloads events contain details of document and attachment downloads. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | FileType | Type string Properties Filter, Group, Nillable, Sort Description The type of the file or attachment. | | ObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the object that’s associated with the document or attachment. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID.. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | <!-- document id=04d31e86c86dd70e2035b3689ef81875130aeadb37ad7e42786843417d22cca1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_docprocreview.md --> # DocProcReview Represents a document processing review task that manages human verification and correction of data extracted by the Intelligent Document Processing (IDP). This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access the DocProcReview object, your organization must have the flowDocumentProcessingAddon license enabled. This object is available only to users with appropriate permissions in organizations that have purchased the Intelligent Document Processing add-on. ## Fields | Field Name | Details | | --- | --- | | AssignedToId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user or queue assigned to review this document. This field is a polymorphic relationship field. Relationship Name AssignedTo Refers To Group, User | | ContentDocumentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The uploaded file under review. This field is a relationship field. Relationship Name ContentDocument Refers To ContentDocument | | CorrelationIdentifier | Type string Properties Create, Filter, Group, Sort, Update Description Unique correlation ID used by InvocableIdpAsyncAction. Joins this review to the originating extraction and is carried in the post-review platform event so the paused Flow can resume. | | CreatedDate | Type datetime Properties Filter, Group, Nillable, Sort Description The date and time when this review was created. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the review task. | | ErrorMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Error message if the review encounters a failure. | | ExtractedData | Type textarea Properties Create, Update Description Extracted document payload (JSON) captured at extraction completion. Surfaced to the reviewer in the Review UI and carried in the post-review platform event payload. | | FlowElement | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The developer name of the flow element that triggered the review. | | FlowVersion | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The current running flow version that triggered this review. This field is a relationship field. Relationship Name FlowVersion Refers To InteractionDefinitionVersion | | IdpConfigurationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The IDP configuration associated with this review. This field is a relationship field. Relationship Name IdpConfiguration Refers To IdpConfiguration | | LastModifiedDate | Type datetime Properties Filter, Group, Nillable, Sort Description The date and time when this review's status, reviewer, modified data, or error message was last updated. | | MasterFlowVersion | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The master flow version that triggered this review. This field is a relationship field. Relationship Name MasterFlowVersion Refers To InteractionDefinitionVersion | | ModifiedData | Type textarea Properties Create, Nillable, Update Description Reviewer-modified document payload (JSON) captured after review. Reflects the corrections the reviewer made to the originally extracted data, and is carried in the post-review platform event payload. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the review task. This is an auto-generated number of format HR-{000000000}. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of this review record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ReviewerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user currently working on this review. This field is a relationship field. Relationship Name Reviewer Refers To User | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the review task. Possible values are: - Completed - InProgress—In Progress - New - Rejected - TimedOut—Timed Out | ## 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. [DocProcReviewChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [DocProcReviewFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [DocProcReviewHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [DocProcReviewOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_docprocreviewownersharingrule.htm) Sharing rules are available for the object. [DocProcReviewShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_docprocreviewshare.htm) Sharing is available for the object. <!-- document id=38ad073f7ca2ed4a7f2f9de2ac8202754af466ae66c1e47df0144c26318619c1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_document.md --> # Document Represents a file that a user has uploaded. Unlike Attachment records, documents are not attached to a parent object. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules You must have the “Edit” permission on documents and the appropriate access to the Folder that contains a document in order to create or update a document in that Folder. ## Fields | Field | Details | | --- | --- | | AuthorId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who is responsible for the Document. This is a relationship field. Relationship Name Author Relationship Type Lookup Refers To User | | Body | Type base64 Properties Create, Nillable, Update Description Required. Encoded file data. If specified, then do not specify a URL. | | BodyLength | Type int Properties Filter, Group, Sort Description Size of the file (in bytes). | | ContentType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Type of content. Label is **Mime Type**. Limit: 120 characters. If the Don't allow HTML uploads as attachments or document records security setting is enabled for your organization, you cannot upload files with the following file extensions: .htm, .html, .htt, .htx, .mhtm, .mhtml, .shtm, .shtml, .acgi, .svg. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the Document. Limit: 255 characters. | | 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 org. 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 **Document Unique Name**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | FolderId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the Folder that contains the document. This is a relationship field. Relationship Name Folder Relationship Type Lookup Refers To Folder, User | | IsBodySearchable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the contents of the object can be searched using a SOSL FIND call. The ALL FIELDS search group includes the content as a searchable field. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsInternalUseOnly | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the object is only available for internal use (true) or not (false). Label is **Internal Use Only**. | | IsPublic | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the object is available for external use (true) or not (false). Label is **Externally Available**. | | Keywords | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Keywords. Limit: 255 characters. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the document. Label is **Document Name**. | | NamespacePrefix | Type string Properties Filter, Group, Sort, Nillable Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Type | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description File type of the Document. In general, the values match the file extension for the type of Document (such as pdf or jpg). Label is **File Extension**. | | Url | Type string Properties Create, Filter, Nillable, Group, Sort, Update Description URL reference to the file (instead of storing it in the database). If specified, do not specify the Body or BodyLength. | ## Usage When creating or updating a document, you can specify a value in either the Body or Url fields, but not both. ## Encoded Data The API sends and receives the binary file data encoded as a base64 data type. Prior to creating a record, clients must encode the binary file data as base64. Upon receiving an API response, clients must decode the base64 data to binary (this conversion is usually handled for you by the SOAP client). ## Maximum Document Size You can only create or update documents to a maximum size of 5 MB. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=184b33d805153125efa8f64c4ed88bc827f29d0819e2030be82555b4cbeefdaa url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_documentattach.md --> # Document Attachment Downloads Event Type Document Attachment Downloads events contain details of document and attachment downloads. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">ENTITY_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the entity that’s associated with the document or attachment.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="event-type-desc"><a name="event-type-desc"></a>The type of event.</span> The value is always <samp class="codeph nolang">DocumentAttachmentDownoads</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">FILE_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The type of the file or attachment.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the organization.</dd><dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd><dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. Timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00530000009M943</samp></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00590000000I1SNIA0</samp>.</dd></dl></td></tr></tbody></table> #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=d6cb4405d39b077d50e3954a8a6f2fb457cfda8c0fcaa426f69b04e52ceb8aa1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_documentattachmentmap.md --> # DocumentAttachmentMap Maps the relationship between an EmailTemplate and its attachment, which is stored as a Document. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | DocumentId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the document that this object tracks. | | DocumentSequence | Type int Properties Create, Filter, Group, Sort, Update Description Represents the order that the attachments will be included in the email defined by the EmailTemplate specified by the DocumentId. Label is **Attachment Sequence**. The first attachment is given a value of 0, and each subsequent attachment is given a value incremented by 1. | | ParentId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the EmailTemplate parent. The attachment identified by DocumentId is attached to the EmailTemplate specified in this field. | ## Usage Use this object to map the relationship of an EmailTemplate to its attachments, and to specify the order of the attachments. #### See Also - [EmailTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailtemplate.htm "Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only.") <!-- document id=61f999e2f3f0ab0436681d9cf6f165189b35bb498a20124b8b2856e92e3e66a0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_documentrecipient.md --> # DocumentRecipient Connects a Service Report to a Digital Signature. 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() ## Fields | Field | Details | | --- | --- | | DigitalSignatureId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Digital Signature to be used on the Service Report. This field is a relationship field. Relationship Name DigitalSignature Relationship Type Lookup Refers To DigitalSignature | | DigitalSignatureUrl | Type textarea Properties Create, Nillable, Update Description Link to request signature from Experience Cloud site. | | DocumentId | Type reference Properties Create, Filter, Group, Sort, Update Description The document sent to the recipient. This field is a polymorphic relationship field. Relationship Name Document Relationship Type Lookup Refers To ServiceReport | | DocumentRecipient | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Number automatically assigned to a new record. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. ID of the creator of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | QuoteDocumentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The quote document sent to the recipient. This field is a relationship field. Relationship Name QuoteDocument Refers To QuoteDocument | | RecipientId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The recipient to sign the document. This field is a polymorphic relationship field. Relationship Name Recipient Relationship Type Lookup Refers To Contact, User | | SignatureIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique identifier that associates DocumentRecipient with a signature Lightning web component (LWC) on the report page layout, telling you where on the report the signature goes. | | SignatureStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the signature. The default value is Completed. Possible values are: - Completed - Skipped | | SignatureStatusReason | Type textarea Properties Create, Filter, Nillable, Sort, Update Description An explanation for the signature status. For example, a reason why the signature was skipped. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the document recipient record. Possible values are: - Completed - Declined - Delivered - None - Sent The default value is None. | | StatusReason | Type textarea Properties Create, Nillable, Update Description The final status reason. | ## 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. [DocumentRecipientFeed](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. [DocumentRecipientOwnerSharingRule](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. [DocumentRecipientShare](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. <!-- document id=db606a4d43302b4db6a7b4241821d2fff7b86e1b7b0934d9eeabadd590b25103 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_documenttag.md --> # DocumentTag Associates a word or short phrase with a Document. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage DocumentTag stores the relationship between its parent TagDefinition and the Document being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. <!-- document id=93a06bc5c37f1c202be4871b1af1ae0787c84db687b11609f202fa6fe9bf558b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_domain.md --> # Domain Read-only object that represents a custom Web address assigned to a site in your organization. This object is available in API version 26.0 and later. To access this object, Salesforce Sites, Digital Experiences, or Site.com must be enabled for your organization. DomainSite contains records for domains that serve your Experience Cloud sites only when enhanced domains are deployed. The system-managed site hostnames for those Experience Cloud sites end in .my.site.com. This object doesn’t contain records for legacy domains that serve Experience Cloud sites with hostnames that end in .force.com. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules - Customer Portal users can’t access this object. - To view this object, you must have either the View Setup and Configuration or Manage Custom Domains permission. - Site.com Publisher users have read-only API access to the Domain and [DomainSite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domainsite.htm "Read-only junction object that joins the Site and Domain objects. This object is available in API version 26.0 and later.") objects. ## Fields | Field | Description | | --- | --- | | CnameTarget | Type string Properties Filter, Nillable, Sort Description The canonical name (CNAME) of the external host or server. If you use a custom domain with a non-Salesforce provider, such as your own external server or CDN provider, to serve your domain, this field points to the CNAME of the external provider. This field is available in API version 43.0 and later. | | Domain | Type string Properties Filter, idLookup, Sort Description The branded custom Web address within the global namespace identified by this domain's type. In the Domain Name System (DNS) global namespace, this field is the custom Web address that you registered with a third-party domain name registrar. The custom Web address can be used to access the site of this domain. | | DomainType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The global namespace that this custom Web address belongs to. This value is set to DNS for custom Web addresses in the global DNS. DomainType can have the following value: - DNS—Domain Name System (DNS) | | HttpsOption | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Current HTTPS option. Values include: - CdnPartner—Salesforce serves the custom domain, such as https://www.example.com, with the Salesforce Content Delivery Network (CDN) partner. - Community—The system-managed Experience Cloud sites domain that ends in .force.com. This option applies only to orgs without enhanced domains. - CommunityAlt—The system-managed Experience Cloud sites domain that ends in .my.site.com. This option applies only to orgs with enhanced domains. - ExternalHttps—An external service or CDN serves the custom domain, such as https://www.example.com. - LegacyDomain—A previous system-managed domain for this org. This option is rarely used. - NoHttps—Salesforce serves the custom domain, such as http://www.example.com, via HTTP. Used to configure your custom domain before selecting a permanent HTTPS option. - OrgDomain—The system-managed My Domain login URL for this org. - Sites—The system-managed Salesforce Sites domain that ends in .force.com. This option applies only to orgs without enhanced domains. - SitesAlt—The system-managed Salesforce Sites domain that ends in .my.salesforce-sites.com. This option applies only to orgs with enhanced domains. - SitesRuntime—Salesforce serves the custom domain, such as https://www.example.com, using your HTTPS certificate on Salesforce servers. This field is available in API version 47.0 and higher. To get the current system-managed domains for your org, use the [Domain](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_class_System_Domain.htm) Apex class. | | OptionsHstsPreload | Type boolean Properties Filter Description Indicates whether the preload directive is added to the HSTS header so that the domain is eligible for HSTS preloading registration (true) or not (false). This field is available in API version 52.0 and later. After this field is set to true, to ensure that HTTPS connections are always used in browsers that support HSTS, you must also register the domain at [https://hstspreload.org](https://hstspreload.org). We only modify the HSTS headers of domains that are eligible for registration. Domain names can consist of a public suffix plus one additional label. For more information, see [Add a Domain](https://help.salesforce.com/articleView?id=platform.domain_mgmt.htm&type=5&language=en_US) in Salesforce Help. | ## Usage Use this read-only object to query the domains that are associated with each site in your organization. <!-- document id=672cf6a9e2ad719b80dd32f2e35af1d38f597d5ed27c288490e8c8e7d037e4ed url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_domainsite.md --> # DomainSite Read-only junction object that joins the Site and Domain objects. This object is available in API version 26.0 and later. To access this object, Salesforce Sites, Digital Experiences, or Site.com must be enabled. DomainSite contains records for domains that serve your Experience Cloud sites only when enhanced domains are deployed. The system-managed site hostnames for those Experience Cloud sites end in .my.site.com. This object doesn’t contain records for legacy domains that serve Experience Cloud sites with hostnames that end in .force.com. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules - Customer Portal users can’t access this object. - To view this object, you must have either the View Setup and Configuration or Manage Custom Domains permission. - Site.com Publisher users have read-only API access to the [Domain](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domain.htm "Read-only object that represents a custom Web address assigned to a site in your organization. This object is available in API version 26.0 and later.") and DomainSite objects. ## Fields | Field | Description | | --- | --- | | DomainId | Type reference Properties Filter, Group, Sort Description The ID of the associated Domain. This is a relationship field. Relationship Name Domain Relationship Type Lookup Refers To Domain | | PathPrefix | Type string Properties Filter, Group, Sort Description Shows where a site’s root exists on a domain. Can only be set for custom Web addresses. Always begins with a /. | | SiteId | Type reference Properties Filter, Group, Sort Description The ID of the associated Site. This is a relationship field. Relationship Name Site Relationship Type Lookup Refers To Site | ## Usage Use this read-only object to query or retrieve information about your sites. <!-- document id=5f7653d857f808132d6b92b9c96dded92eb5528989016a688f14290f65074f4b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dsarpolicy.md --> # DsarPolicy Represents a Data Subject Access Request (DSAR) policy created in the Privacy Center managed package. DSAR policies anonymize or transfer personal data from your org at your customer’s request. This object is available in API version 50.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules This object is for Privacy Center customers with the ReadAllData or PrivacyDataAccess permissions. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Filter, Group, Nillable, Sort Description Description of the policy. The description is limited to 255 characters. | | DeveloperName | Type string Properties Filter, Group, Sort Description Developer name of the policy. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this policy can be used (true) or not (false) for data subject (customer) requests. The default value is false. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the MasterLabel. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, Sort Description Label of the policy. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as the object. [DsarPolicyLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dsarpolicylog.htm "Represents the history of Data Subject Access Request (DSAR) policy execution requests. This log records the status and results of executed DSAR policies for a customer. This object is available in API version 50.0 and later.") Sharing is available for the object. <!-- document id=e9b66732b779920db3bb02aea6f688f90590541ab1de547cbb1feadd8e543666 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dsarpolicylog.md --> # DsarPolicyLog Represents the history of Data Subject Access Request (DSAR) policy execution requests. This log records the status and results of executed DSAR policies for a customer. This object is available in API version 50.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules This object is for Privacy Center customers with the ReadAllData or PrivacyDataAccess permissions. ## Fields | Field | Details | | --- | --- | | CompletionDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the data subject access request was completed. Available in API version 51.0 and later. | | DataSubjectId | Type reference Properties Filter, Group, Nillable, Sort Description The 15–18 character ID of the data subject making the request. Available in API version 51.0 and later. | | DeletedDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the file generated for the data subject’s request is deleted. Available in API version 51.0 and later. | | DeveloperName | Type string Properties Filter, Group, Sort Description Developer name of the policy. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | DownloadedDateTime | Type dateTime Properties Filter, Nillable, Sort Description The most recent date and time when the data subject downloaded the file generated at their request. Available in API version 51.0 and later. | | DsarError | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Represents an error in generating the file for the data subject access request. Available in API version 51.0 and later. | | DsarPolicyId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the DSAR policy. | | FileURL | Type string Properties Filter, Group, Nillable, Sort Description The result of the DSAR policy execution. The URL links to a downloadable file that contains the customer data. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the MasterLabel. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, Sort Description Label of the policy. | | RequestDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when a data subject requested access to their data in the org. Available in API version 51.0 and later. | | RequestStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the policy execution. Possible values are: - Complete - Deleted - Downloaded - Expired - Failed - In Progress | | RequestUserId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the org employee or admin making the request on behalf of the data subject. Available in API version 51.0 and later. | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as the object. [DsarPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dsarpolicy.htm "Represents a Data Subject Access Request (DSAR) policy created in the Privacy Center managed package. DSAR policies anonymize or transfer personal data from your org at your customer’s request. This object is available in API version 50.0 and later.") Sharing is available for the object. <!-- document id=981a76f9018b8c900ed62dde075d305eebe151ff3a77b3f2dba11bc40dc4016a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_duplicatejob.md --> # DuplicateJob Represents an instance of a job that identifies duplicates among existing records in the system. This object is available in API versions 42.0 and later. A duplicate job is the parent of the DuplicateRecordSet instances that it generates. The duplicate record items in a set generated by a duplicate job are of one object type. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules As of Summer ’20 and later, only users with the View Setup and Configuration permission can access this object. ## Fields | Field Name | Details | | --- | --- | | DuplicateJobDefinitionId | Type reference Properties Filter, Group, Sort, Update Description The ID of the corresponding duplicate job definition. | | DuplicateJobStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The current status of a duplicate job. Valid values are Not Started, In Progress, Completed, Canceled, Failed, Results Deleted. | | EndDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when a duplicate job was completed. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when a duplicate job was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when a duplicate job was last viewed. | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description The name of a duplicate job. | | NumDuplicateRecordItems | Type int Properties Filter, Group, Sort Description The total number of duplicate records identified as a result of invoking a duplicate job. | | NumDuplicateRecordSets | Type int Properties Filter, Group, Sort Description The number of duplicate record sets identified as a result of invoking a duplicate job. | | NumRecordsScanned | Type int Properties Filter, Group, Sort Description The number of records scanned as a result of invoking a duplicate job. | | ResultListViewId | Type reference Properties Filter, Group, Nillable, Sort, Update Description List view metadata for displaying the duplicate record sets identified as result of invoking a duplicate job. | | StartDateTime | Type dateTime Properties Filter, Sort Description The date and time when a duplicate job was invoked. | <!-- document id=818fac4140583344a44b3918a3b527b13335a4c811c4d7bfa3413d2ff0cdd3c3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_duplicatejobdefinition.md --> # DuplicateJobDefinition Setup object defining a job that identifies duplicate record items globally. This object is available in API versions 42.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only users with the View Setup and Configuration permission can access this object. ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The name of the user who created a duplicate job. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language in the user’s personal settings. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label of the duplicate job. | | SobjectSubtype | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The object subtype. Valid values are Person Account or None. | | SobjectType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The object type: account, contact, or lead. | <!-- document id=28d3cea4fea05a857be91cfe6b3ef946c5c547312bc0a50553833fa06e141793 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_duplicatejobmatchingrule.md --> # DuplicateJobMatchingRule Represents a MatchingRule to be used with a DuplicateJob sharing the corresponding DuplicateJobMatchingRuleDefinition. This object is available in API versions 42.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only users with the View Setup and Configuration permission can access this object. ## Fields | Field Name | Details | | --- | --- | | DuplicateJobId | Type reference Properties Filter, Group, Sort Description The ID of the corresponding DuplicateJob. | | DuplicateJobMatchRuleDefId | Type reference Properties Filter, Group, Sort Description The ID of the matching rule defined for the corresponding DuplicateJobMatchingRuleDefinition. | | MatchingRuleBooleanFilter | Type textarea Properties Filter, Sort Description Boolean logic of the MatchingRule for this DuplicateJobMatchingRule. | | MatchingRuleDescription | Type textarea Properties Filter, Group, Nillable, Sort Description Description of the matching rule for this DuplicateJobMatchingRule. | | MatchingRuleName | Type string Properties Filter, Group, Sort Description The name of the matching rule defined for this particular DuplicateJob invocation. | <!-- document id=6478799844faf664c181fa0a39972846f14a8c3f7ae584bf555a9b1368ad5671 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_duplicatejobmatchingruledefinition.md --> # DuplicateJobMatchingRuleDefinition Setup object specifying a MatchingRule to use with DuplicateJob instances that share a DuplicateJobDefinition. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. This object is available in API versions 42.0 and later. ## Supported Calls describeSObjects(), query(), search() ## Special Access Rules As of Summer ’20 and later, only users with the View Setup and Configuration permission can access this object. ## Fields | Field Name | Details | | --- | --- | | DuplicateJobDefinitionId | Type reference Properties Filter, Group, Sort Description ID of DuplicateJobDefinition (master) for this DuplicateJobMatchingRuleDefinition (detail). | | MatchingRuleId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the MatchingRule to be used with this DuplicateJobMatchingRuleDefinition. | <!-- document id=80c200f180d23b68fdf275d91ca656981d34e2b38d08ddb370c63875723b82a5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_duplicaterecorditem.md --> # DuplicateRecordItem Represents a record that’s been identified as a duplicate. DuplicateRecordItems are included in a DuplicateRecordSet, which are processed in duplicate jobs. Use this object to create custom report types for duplicates. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, enable Duplicate Management. A Salesforce admin can grant access to any user with a Sales Cloud or CRM user license. ## Fields | Field Name | Details | | --- | --- | | DuplicateRecordSetId | Type reference Properties Create, Filter, Group, Sort Description The duplicate record set that the duplicate record item is assigned to. This is a relationship field. Relationship Name DuplicateRecordSet Relationship Type Lookup Refers To DuplicateRecordSet | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The autogenerated name that’s given to the Duplicate Record Item. Label is Duplicate Record Item Name. | | RecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The name of the record as it appears on the record’s detail page. This is a polymorphic relationship field. Relationship Name Record Relationship Type Lookup Refers To Account, Contact, Individual, Lead | <!-- document id=7499853430859e2fc458ca3a7723f468fbbc2e5de1f0715edaf9767b0bd1b3ca url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_duplicaterecordset.md --> # DuplicateRecordSet Represents a group of records that have been identified as duplicates. Each duplicate record set contains one or more duplicate record items. Use this object to create custom report types and view the results of duplicate jobs. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, activate duplicate rules. A Salesforce admin must give users read and write access. ## Fields | Field Name | Details | | --- | --- | | DuplicateRuleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The duplicate rule used to identify this list of duplicate records. Label Duplicate Rule ID This is a relationship field. Relationship Name DuplicateRule Relationship Type Lookup Refers To DuplicateRule | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The autogenerated name that’s given to the duplicate record set. Label is Duplicate Record Set Name. | | RecordCount | Type int Properties Filter, Group, Nillable, Sort Description The number of record items in the set. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ParentId represents the parent of a duplicate rule or duplicate job. A ParentId is polymorphic. The label is Parent. This field is available in API versions 42.0 and later. | <!-- document id=700d45eff4cfb0fc9d38d2c935451d9381ba46e50757fe23dd1f010e83d0f7a2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_duplicaterule.md --> # DuplicateRule Represents a duplicate rule for detecting duplicate records. ## Supported Calls describeSObjects(), describeLayout(), query(), retrieve(), search() ## Special Access Rules As of Summer ’20 and later, only users with the View Setup and Configuration permission can access this object. ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The developer name for the duplicate rule. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a duplicate rule is active (true) or not (false). This field is read only. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language for the duplicate rule. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. This field is available in API version 41.0 or later. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label for the duplicate rule. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | SobjectSubtype | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The subtype of object the duplicate rule is defined for. This field is available in API version 39.0 or later. Possible values are: - None - PersonAccount The default value is None. | | sObjectType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of object the duplicate rule is defined for. Possible values are: - Account - Contact - Individual - Lead | ## Usage You can use the API to view a duplicate rule’s details. To create, edit, or delete duplicate rules, use the UI. Use DuplicateRule to get the sObject type. DuplicateRule is unavailable in some orgs. <!-- document id=087765dd95437d27f59e43fdd26ea1f800f70815c309a225784ee63656cada26 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_dynamicdatacapture.md --> # DynamicDataCapture DynamicDataCapture is a junction object that adds a Form tab to Work Order Overview, and to the related list of a work order, work order line item, or service appointment in the Field Service mobile app. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActionDefinition | Type string Properties Create, Filter, Group, Sort, Update Description The associated Data Capture Flow to execute. | | ActionType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of platform action that the form is associated with. Possible values are: Possible values are: - Flow The default value is Flow. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the form. | | ExecutionOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The order in which the Data Capture flow is executed. Positive integer values or null are supported. | | IsRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Boolean value that specifies if this form needs to be completed before moving on to the next form. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The order in which the Data Capture flow is executed. Positive integer values or null are supported. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the form. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID that refers to user who owns the Dynamic Data Capture object. This field is a polymorphic relationship field. Relationship Name Owner Refers To ServiceAppointment, WorkOrder, WorkOrderLineItem (the parent object), Timesheet | | ParentRecordId | Type reference Properties Create, Filter, Group, Sort Description The ID that refers to a work order, work order line item, or service appointment that serves as the parent record for junction object. This field is a polymorphic relationship field. Relationship Name ParentRecord Relationship Type Parent-child Refers To ServiceAppointment, WorkOrder, WorkOrderLineItem (the parent object) | | ParentRecordType | Type string Properties Filter, Group, Nillable, Sort Description The type of parent object associated with the junction object. Possible values are: - Work Order - Work Order Line Item - Service Appointment | | PausedFlowInterviewId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the flow interview that has been paused by a user. This field is a relationship field. Relationship Name PausedFlowInterview Refers To FlowInterview | | ProcessType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The flow process type for the form. Possible values are: - DataCaptureFlow—Data Capture Flow The default value is DataCaptureFlow. | | ServiceDocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | ServiceReportLanguage | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description | | StatusCategory | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The category that each status value belongs to. Possible values are: - Completed - InProgress—In Progress - New - NotApplicable—Not Applicable - Paused The default value is New. | ## 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. [DynamicDataCaptureChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.")(API Version 64.0) Change events are available for the object. [DynamicDataCaptureOwnerSharingRule](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.") (API Version 64.0) Sharing rules are available for the object. [DynamicDataCaptureShare](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.") (API Version 64.0) Sharing is available for the object. <!-- document id=9e1b16fc9fdfe3fddc8eb20dacf95bcc992040cfb40d9d2ea9a39a1ae076aea0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_electronicmediagroup.md --> # ElectronicMediaGroup Represents the type of media that you can associate with a product or category.This object is available in API version 49.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access a web store. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The default value is USD. | | Description | Type string Properties Filter, Group, Nillable, Sort Description Description of the store. | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. 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. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Name of the media group. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the owner of the ElectronicMediaGroup object. For external routing, allows the object to be used in the Streaming API to listen to events whenever a ElectronicMediaGroup record is created, modified, or deleted. | | UsageType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Possible values are: - Attachment - Banner - Listing - Standard - Tile | <!-- document id=9991586df1133831183f1ff447b943dd06dc3a7a7e5571c26f6bc14f2573060c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_electronicmediause.md --> # ElectronicMediaUse Represents the usage of media. This object is available in API version 49.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access a web store. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The default value is USD. Possible values are: - USD—U.S. Dollar | | ElectronicMediaGroupId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the electronic media group. | | ElectronicMediaId | Type reference Properties Filter, Group, Sort Description The ID of the electronic media. | | ImplementorType | Type string Properties Filter, Group, Nillable, Sort Description The type of implementor. Available implementors of ElectronicMediaUse include: - ProductMedia - ProductCategoryMedia | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description The order that electronic media is displayed in. | <!-- document id=24ba37a170ed3788b62fdf52371f3107efef0f1a21a39f4ad0952b37d423852d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailcontent.md --> # EmailContent Represents a marketing email asset for use with Account Engagement. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules EmailContent is only available for orgs that use Account Engagement. The Manage Email Content user permission is required. Users also need the CRM User, Sales, or Service User permission set. EmailContent isn’t available for custom portal or guest users. ## Fields | Field | Details | | --- | --- | | ClickThroughRate | Type percent Properties Filter, Nillable, Sort Description The percentage of visitors who click links contained in emails delivered (sent minus bounces) to them. Multiple clicks for a same link are counted. | | ClickToOpenRatio | Type percent Properties Filter, Nillable, Sort Description The number of unique clicks divided by unique HTML opens. | | DeliveryRate | Type percent Properties Filter, Nillable, Sort Description The percentage of the emails that were delivered compared to the number that bounced (soft and hard). Note: this data includes emails that were delivered to the recipient's spam folder. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the email content, for example, Promotion Mass Mailing. | | HtmlBody | Type textarea Properties Nillable Description The body of the email in HTML format. The field is read-only. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when the current user last viewed the record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, the record could have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the email asset. | | OpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of unique HTML opens compared to the total number of emails delivered (sent minus bounces). | | OptOutRate | Type percent Properties Filter, Nillable, Sort Description The percentage of users that have opted out compared to the total number of emails sent. | | SpamComplaintRate | Type percent Properties Filter, Nillable, Sort Description The percentage of spam complaints compared to the total number emails sent. | | Subject | Type textarea Properties Create, Filter, Nillable, Update Description Content of the subject line. | | TemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The Email Template field is mostly read-only. You can populate the Email Template field only during record create to prevent overwriting data on the email content record. | | TextBody | Type textarea Properties Create, Nillable, Update Description The body of the email in plain text format. The character limit is 384, 000. | | TotalDelivered | Type int Properties Filter, Group, Nillable, Sort Description The total number of emails minus hard and soft bounces. Note: this data includes emails that were delivered to the recipient's spam folder. | | TotalHardBounced | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of emails that permanently returned to the sender because the address is invalid. A hard bounce can occur because the domain name doesn't exist or because the recipient is unknown. | | TotalOpens | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of times a prospect’s email client loaded the images in the HTML version of the email. We also record an open if the prospect clicks a link within the HTML or text email without downloading images. A click indicates that they viewed the message. Some email clients (Outlook, Apple Mail, Thunderbird) do not display images by default. Account Engagement counts an open each time the images load. | | TotalSent | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only field. The total number of list emails sent, including bounced, opted-out, and invalid To: addresses. | | TotalSoftBounced | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only field. The total number of times a recipient’s mail server acknowledged the email, but returned it to the sender. Sometimes it is because the recipient's mailbox is full or the mail server is temporarily unavailable. After 5 soft bounces, Account Engagement opts the prospect out of emails. | | TotalSpamComplaints | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only field. The total number of prospects that reported the email as spam. | | TotalTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only field. The number of times prospects clicked a link in the email. | | UniqueClickThroughRate | Type percent Properties Filter, Nillable, Sort Description Read-only field. The percentage of visitors who clicked a link contained in an email | | UniqueOpens | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only field. The number of prospects who loaded the images in the HTML version of the email. The Unique Opens category counts each recipient only one time, even if the prospect loaded images more than once. | | UniqueOptOuts | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only field. The total number of prospects that have clicked the link to unsubscribe or opted out of all emails in the Email Preference Center. They are removed from future email sends. | | UniqueTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only field. The number of times a prospect clicked a link in the email. This metric doesn’t include multiple clicks of the same link. | <!-- document id=65e6a9921f1355e82b01de8cb70f2344c2df654ca36f6ce0de395a50304949a1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emaildomainfilter.md --> # EmailDomainFilter Represents a filter that determines whether an email relay is restricted to a specific list of domains. This object is available in API version 43.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules You must have the “Email Administration,” “Customize Application,” and “View Setup” user permissions to use this object. You must create an email relay in Setup or through the [EmailRelay](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailrelay.htm "Represents the configuration for sending an email relay. An email relay routes email sent from Salesforce through your company’s email servers. This object is available in API version 43.0 and later.") object before you can use the EmailDomainFilter object. ## Fields | Field Name | Details | | --- | --- | | EmailRelayId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the [EmailRelay](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailrelay.htm "Represents the configuration for sending an email relay. An email relay routes email sent from Salesforce through your company’s email servers. This object is available in API version 43.0 and later.") record. This is a relationship field. Relationship Name EmailRelay Relationship Type Lookup Refers To EmailRelay | | FromDomain | Type textarea Properties Create, Nillable, Update Description Restricts the email relay to send emails based on the sender domains (FromDomain) listed in this field. This field is optional, accepts a list of comma-separated values, and supports the wildcard character. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the email domain filter is active (true) or not (false). Use this field to enable or disable the email domain filter. | | PriorityNumber | Type int Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Indicates the order in which the email domain filter is processed. Filters are evaluated in ascending order. The priority number must be unique. If this field is left blank, it is assigned the next available number and is processed last. Processing stops after the first matching filter is applied. | | ToDomain | Type textarea Properties Create, Nillable, Update Description Restricts the email relay to send emails based on the recipient domains (ToDomain) listed in this field. This field is optional, accepts a list of comma-separated values, and supports the wildcard character. | ## Usage ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip If you also plan to activate Bounce Management and Email Compliance Management, confirm with your email admin that your company allows relaying email sent from Salesforce. For more information on bounce management, see [Configure Deliverability Settings for Emails Sent from Salesforce](https://help.salesforce.com/articleView?id=emailadmin_send_through_salesforce_configure_deliverability.htm&language=en_US "HTML (New Window)"). <!-- document id=c7fdd9d416f512a0c116fc9d7a13d1fb653a5acbb75acbca51f3bae7027d8066 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emaildomainkey.md --> # EmailDomainKey Represents a domain key for an organization’s domain, used to authenticate outbound email that Salesforce sends on the organization’s behalf. This object is available in API version 28.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. We’ve upgraded and replaced the original DKIM (DomainKeys Identified Mail) key feature, so that you can create a DKIM key with increased email security. For more information, see [Setting Up More Secure DKIM Keys](https://help.salesforce.com/articleView?id=emailadmin_setup_dkim_key.htm&type=0&language=en_US). ## Fields | Field Name | Details | | --- | --- | | AlternatePublicKey | Type textarea Properties Nillable Description Read-only. Alternate public keys are used by Salesforce to auto-rotate domain keys. This field is available in API version 44.0 and later after activating the Critical Update. | | AlternateSelector | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The text used to distinguish the DKIM key from any other DKIM keys your organization uses for the specified domain. This field is available in API version 44.0 and later after activating the Critical Update. | | AlternateTxtRecordName | Type string Properties Filter, Group, Nillable, Sort Description The alternate TXT record name is used to create the CNAME record. Refer to the Usage section for more information. This field is available in API version 44.0 and later after activating the Critical Update. | | Domain | Type string Properties Create, Filter, Group, Sort, Update Description The organization’s domain name that the DKIM key is generated for. | | DomainMatch | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The specificity of match required on the sending domain name before signing with this DKIM key. Valid values are: - DomainOnly—Sign if sending domain matches at the domain level only (example.com but not mail.example.com) - SubdomainsOnly—Sign if sending domain matches at the subdomain level only (mail.example.com but not example.com) - DomainAndSubdomains—Sign if sending domain matches at the domain and subdomain levels (example.com and mail.example.com) | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this DKIM key is active (true) or not (false). | | KeySize | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description Indicates the RSA key size, in bits. The possible values are: - 1024 - 2048 This field is available in API version 45.0 and later. | | PrivateKey | Type textarea Properties Create, Nillable, Update Description Once you activate the Critical Update, this field is no longer visible. The private portion of the DKIM key pair used to encrypt mail headers from your domain. Salesforce generates an encrypted PrivateKey if you don’t specify a value when creating the DKIM key. If you do specify a value, it must be an existing valid PrivateKey from another EmailDomainKey object. This field doesn’t contain the actual private key, but a value that represents the key in our system. Therefore: - The actual private key can’t be leaked. - You can’t use the value to do your own email signing. | | PublicKey | Type textarea Properties Create, Nillable, Update Description Part of the domain key pair that mail recipients retrieve to decrypt the DKIM header and verify your domain. Add the PublicKey value to your domain’s DNS records before you start signing with this domain key. | | Selector | Type string Properties Create, Filter, Group, Sort, Update Description Text used to distinguish the DKIM key from any other DKIM keys your organization uses for the specified domain. | | TxtRecordName | Type string Properties Filter, Group, Nillable, Sort Description Read-only. The TXT record name is used to create the CNAME record. Refer to the Usage section for more information. This field is available in API version 44.0 and later after activating the Critical Update. | | TxtRecordsPublishState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The possible values are: - Published - Publishing in progress - Publishing failed This field is available in API version 44.0 and later after activating the Critical Update. | ## Usage **Create DKIM Keys with Increased Security** 1. If your Salesforce org was created before Winter ’19, enable the Critical Update. From Setup, enter Critical Updates in the Quick Find box, and then select **Critical Updates**. For Enable Redesigned DomainKeys Identified Mail (DKIM) Key Feature with Increased Email Security, click **Activate**. 2. Insert Domain, DomainMatch, Selector, and AlternateSelector. Salesforce publishes your TXT record to DNS. 3. Retrieve the TxtRecordName and AlternateTxtRecordName and use them to create and publish the CNAME and Alternate CNAME record to your domain’s DNS. 1. Create CNAME record using: <selector>.\_domainkey.<domain> IN CNAME txtRecordName. 2. Create Alternate CNAME record using: <alternateSelector>.\_domainkey.<domain> IN CNAME alternateTxtRecordName. 4. Set the IsActive field to true. **Create DKIM Keys (pre-Winter ‘19 Version)** ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The critical update activates for everyone on October 15, 2019. After that date, this approach to creating DKIM keys will no longer be available. When you create a DKIM key, Salesforce generates a public and private key pair. Publish the public key in the DNS. For each domain key you create, we recommend this sequence: 1. Insert the Domain, DomainMatch, and Selector. 2. Update your domain’s DNS records. 1. Locate the DNS record at selector.\_domainkey.domain. For example, mail.\_domainkey.mail.example.com. 2. Add the PublicKey value, like this: V=DKIM1; p=public\_key. DKIM Signing Outbound Email 1. In addition, you can optionally put the record in testing mode, which instructs recipients to not make decisions based on the email signature. Add parameter t=y to the DNS entry: V=DKIM1; t=y; p=public\_key. 3. Update the key via the API or UI to be active. #### See Also - [_Salesforce Help_: Considerations for Creating DKIM Keys](https://help.salesforce.com/articleView?id=emailadmin_considerations_dkim.htm&type=0&language=en_US " Salesforce Help: Considerations for Creating DKIM Keys - HTML (New Window)") - [_Salesforce Help_: Setting Up More Secure DKIM Keys](https://help.salesforce.com/articleView?id=emailadmin_setup_dkim_key.htm&type=0&language=en_US " Salesforce Help: Setting Up More Secure DKIM Keys - HTML (New Window)") <!-- document id=d5d5bfdca8565006fe496c4eca12d8f2db7d62dbbc3a75277539b156136d7eba url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailinsight.md --> # EmailInsight Represents an insight generated from an email interaction. EmailInsights acts as a central place to store various types of insights related to email messages. The insights stored include status, type, and time of generation. Only certain types of insights can be created based on a pre-configured list of insight types. This object is available in API version 63.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules EmailStream permission must be enabled. EmailStreamPref and SyncEmailToCoreActivity Org prefs must be enabled. To be able to see SyncEmailToCoreActivity preference, EACLegacyEmailSyncAWS Org permission, AnalyticsActivity, UnifiedActivities, and ActivityMetrics must be disabled. In addition, license to Standard Einstein Activity Capture and turning on Einstein Activity Capture and EmailInsights provisions the required permissions and preferences. ## Fields | Field | Details | | --- | --- | | EmailMessageId | Type reference Properties Filter, Group, Sort Description Required. The ID of the email message the insight is generated for. This field is a relationship field. Relationship Name EmailMessage Refers To EmailMessage | | GeneratedDate | Type dateTime Properties Filter, Sort Description Required. The date and time when the insight was generated in the legacy system. | | InsightTypeDescription | Type textarea Properties None Description Required. Description of the insight type. | | InsightTypeIdentifier | Type string Properties Filter, Group, Sort Description Required. The ID of the insight type based on which the insight is generated. | | InsightTypeLabel | Type string Properties Filter, Group, Sort Description Required. The display name of the insight type. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the email insight record is locked or not. The default value is false. | | LegacyInsightIdentifier | Type string Properties Filter, Group, idLookup, Sort Description Required. The unique ID of the insight that was generated and stored in the legacy system. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the email insight record can be edited or not. The default value is false. | | RowVersion | Type string Properties Defaulted on create, Filter, Group, Sort Description A system-generated, read-only field that tracks the version of a record. Each time a record is created or updated, the RowVersion value increments, providing a mechanism to detect changes and manage concurrency. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. The status of the insight record. Possible values are: - Active - Completed - Deprecated - Dismissed The default value is Active. | <!-- document id=9e9e3cb6e190cffdf5556fdf2ebbaf983de397660a049abc2bba84780b5210ec url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailinsightaction.md --> # EmailInsightAction Represents the actions that have been taken, or could be taken, in relation to email insights. It logs different types of actions and associated metadata, helping to track and manage the activities and decisions made based on email insights. This object is available in API version 63.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules EmailStream permission must be enabled. EmailStreamPref and SyncEmailToCoreActivity Org prefs must be enabled. To be able to see SyncEmailToCoreActivity preference, EACLegacyEmailSyncAWS Org permission, AnalyticsActivity, UnifiedActivities, and ActivityMetrics must be disabled. In addition, license to Standard Einstein Activity Capture and turning on Einstein Activity Capture and EmailInsights provisions the required permissions and preferences. ## Fields | Field | Details | | --- | --- | | ActionMetadata | Type textarea Properties Nillable Description The metadata for the action. | | EmailInsightId | Type reference Properties Filter, Group, Sort Description Required. The ID of the email insight where the action is applied. This field is a relationship field. Relationship Name EmailInsight Refers To EmailInsight | | InsightAction | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. The action that's taken on the email insight. Possible values are: - CreateCalendarEvent - CreateTaskWithDate - EciCreateEmail - EciScheduleMeetings - EciSendEmail - EmailReply - EmailReplyLater - EmailReplyWithTemplate - InsertFreeTime - PostOnChatter - ViewCalendar - ViewContactProfile The default value is EmailReply. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the email insight action record is locked or not. The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the email insight action record can be edited or not. The default value is false. | | RowVersion | Type string Properties Defaulted on create, Filter, Group, Sort Description A system-generated, read-only field that tracks the version of a record. Each time a record is created or updated, the RowVersion value increments, providing a mechanism to detect changes and manage concurrency. | <!-- document id=ca934cbea7e5e68dd63a00f33d4ee77c71c47b0343a7a39f8fb698bace3b0b34 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailmessage.md --> # EmailMessage Represents an email in Salesforce. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules EmailMessage is only available for orgs that use Email-to-Case or Enhanced Email, which is automatically enabled for most customers. To use reply and forward functionality, FromAddress must specify an email address that exists in EmailMessageRelation, with a RelationType of FromAddress. The Status field is mostly read-only. You can change the status only from New to Read. The HtmlBody and RelatedToId fields are supported in Classic list views but not in Lightning list views. In related lists and search results in Lightning Experience, these fields either don’t appear, show blank values, or result in an error. update() is supported when an email record is in Draft status, and IsPrivateDraft is false. It’s also supported if the email status is Draft, IsPrivateDraft is true, and CreatedBy is associated with the current user. When the email record isn’t in Draft status, the IsExternallyVisible field and custom fields only can be updated. Set the Update Email Messages user permission for users, such as an Automated Case User, who run automated processes that modify email message-related records. With the Update Email Message permission set, users’ processes can modify EmailMessageRelation and ContentDocumentLink records that are related to an email message that isn’t in Draft status. Don’t set this user permission for other users. Access to an email message depends on the associated object. The user who created the email is specified in CreatedById and always has access, unless that user is a guest user. Guest users have read access if the message is marked as IsExternallyVisible. The object that’s used to determine access differs for Email-to-Case and Enhanced Email. - Email-to-Case—When Email-to-Case is enabled and the email is Case-based (the ParentId field is Case), access depends on the user’s access to the related Case record. If the email message is a draft, only the user in the CreatedById field or users with the Modify All Data permission can access it. - Enhanced Email—Access is activity-based. The ActivityId field specifies an associated Task record. You can control access to activity-based objects with the [Access Activities permission](https://help.salesforce.com/s/articleView?id=sales.activity_access_user_perm.htm&type=5&language=en_US "HTML (New Window)"). Users with the Modify All Data permission can also access the message. When you use the API to insert EmailMessage records in bulk, the same access rules apply: access is based on cases in ParentId fields or by tasks in ActivityId fields. When inserting a single record, set the CreatedById field to the user performing the operation or leave it blank. ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d679029e210">Field</th> <th class="featureTableHeader " id="d679029e213">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">ActivityId</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">ID of the activity that is associated with the email. Usually represents an open task that is created for the case owner when a new unread email message is received. <span class="keyword parmname">ActivityId</span> can only be specified for emails on cases. It’s auto-created for other entities. </dd> <dd class="dd">If an EmailMessage has a related task, and fields on the email record are updated, we may delete the related task and create a new related task.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">AttachmentIds</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Nillable, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A comma-separated list of email attachments. This is used by the Send Email quick action when you use Salesforce Classic email templates. Maximum length is 32, 768 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">AutomationType</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A picklist value that determines if an outgoing email was manually created or AI-generated.</dd> <dd class="dd">Possible values are: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">AiAssisted</samp>–Email is AI-generated, but sent by human. </li> <li class="li"> <samp class="codeph nolang">AiAutomated</samp>–Email is generated and sent by AI. </li> <li class="li"> <samp class="codeph nolang">Null</samp>–Email is created and sent by human. </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">BccAddress</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A string array of email addresses for recipients who were sent a visually impaired carbon copy of the email message. Include only email addresses that aren’t associated with Contact, Lead, or User records in Salesforce. If the recipient is a contact, lead, or user, add their ID to the <span class="keyword parmname">BccIds</span> field instead of adding their email address to the <span class="keyword parmname">BccAddress</span> field. When adding their ID, the email message is automatically associated with the contact, lead, or user. For an Experience Cloud site user who isn’t the sender of the email, this field returns null. </dd> <dd class="dd">You can’t send emails unless there’s at least one recipient.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">BccIds</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">JunctionIdList</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="EmailMessage_bcc_id_desc_ph"><a name="EmailMessage_bcc_id_desc_ph"><!-- --></a>A string array of IDs for contacts, leads, and users who were sent a visually impaired carbon copy of the email message. Each ID is linked to an <span class="keyword parmname">EmailMessageRelation</span> record, which represents the relationship between an email message and a Contact, Lead, or User record. For an Experience Cloud site user who isn’t the sender of the email, this list is empty.</span> <p class="p">Adding a <span class="keyword parmname">JunctionIdList</span> field name to the <span class="keyword parmname">fieldsToNull</span> property deletes all related junction records. This action can’t be undone. </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"> <span class="keyword parmname">CcAddress</span> </td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A string array of email addresses for recipients who were sent a carbon copy of the email message. Include only email addresses that aren’t associated with Contact, Lead, or User records in Salesforce. If the recipient is a contact, lead, or user, add their ID to the <span class="keyword parmname">CcIds</span> field instead of adding their email address to the <span class="keyword parmname">CcAddress</span> field. Then the email message is automatically associated with the contact, lead, or user. </dd> <dd class="dd">You can’t send emails unless there’s at least one recipient.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">CcIds</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">JunctionIdList</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="EmailMessage_cc_id_desc_ph"><a name="EmailMessage_cc_id_desc_ph"><!-- --></a>A string array of IDs for contacts, leads, and users who were sent a carbon copy of the email message. Each ID is linked to an <span class="keyword parmname">EmailMessageRelation</span> record, which represents the relationship between an email message and a Contact, Lead, or User record. </span> <p class="p">Adding a <span class="keyword parmname">JunctionIdList</span> field name to the <span class="keyword parmname">fieldsToNull</span> property deletes all related junction records. This action can’t be undone.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">ClientThreadIdentifier</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A value used by third-party email clients to identify which thread an email belongs to. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=service.support_email_to_case_threading.htm&type=5&language=en_US" target="_blank" title="html (New Window)">Email-to-Case Threading</a> for more information.<p class="p">Available in API versions 56.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname" id="contentdocumentids"><a name="contentdocumentids"><!-- --></a>ContentDocumentIds</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">JunctionIdList</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="contentdoc_desc"><a name="contentdoc_desc"><!-- --></a>A string array of IDs for content documents such as files and attachments that are associated with an email. Each ID is linked to a <span class="keyword parmname">ContentDocumentLink</span> record, which represents the relationship between an email message and a content document record.</span> <p class="p">Adding a <span class="keyword parmname">JunctionIdList</span> field name to the <span class="keyword parmname">fieldsToNull</span> property deletes all related junction records. This action can’t be undone.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">Division</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">EmailRoutingAddressId</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Stores the ID of the email routing address used to create the email. This value is set when the email is processed by Email-to-Case service. When this field is set, EmailMessage.Incoming cannot be <samp class="codeph nolang">false</samp>.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">EmailRoutingAddress</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">EmailRoutingAddress</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">EmailTemplateId</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The email template, if any, that was chosen for the email. This field is populated in Lightning Experience only.</dd> <dd class="dd">This is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">EmailTemplate</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">EmailTemplate</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">FirstLinkClickedDate</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The timestamp for when a link in the email was first clicked. </dd> <dd class="dd">Available in API version 67.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">FirstOpenedDate</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date the email was first opened.</dd> </dl> <p class="p">To see this field, enable email tracking in your org.</p> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">FromAddress</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">email</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The address that originated the email. When using this field, specify an email address that exists in EmailMessageRelation, with a <span class="keyword parmname">RelationType</span> of <samp class="ph systemoutput">FromAddress</samp>. </dd> <dd class="dd">EmailMessages in Draft status with <span class="keyword parmname">IsPrivateDraft </span>set to <samp class="codeph nolang">true</samp> must use the user's address, a verified org-wide email address, or a verified Email-to-Case routing address in the <span class="keyword parmname">FromAddress</span> field. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">FromId</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The contact, lead, or user who sent the email. Maximum length is 18 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">FromName</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The sender’s name. When using this field, specify an email address that exists in EmailMessageRelation, with a <span class="keyword parmname">RelationType</span> of <samp class="ph systemoutput">FromAddress</samp>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">HasAttachment</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the email was sent with an attachment (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">HasReply</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the email has a reply (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. </dd> <dd class="dd">Available in API version 67.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">Headers</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Nillable, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The Internet message headers of the incoming email. Used for debugging and tracing purposes. Doesn’t apply to outgoing emails.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">HtmlBody</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Nillable, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The body of the email in HTML format. </dd> <dd class="dd">You can’t send emails unless at least one of these fields has content. <ul class="ul bulletList"> <li class="li">Subject field</li> <li class="li">HTML Body or Text Body field</li> </ul> As the sender, you can provide the content, or it can be automatically inserted using predefined values. An email template can also include the content for these fields.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">Incoming</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the email was received (<samp class="codeph nolang">true</samp>) or sent (<samp class="codeph nolang">false</samp>).</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">IsBounced</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Defaulted on create, Filter, Group, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the email bounced.<p class="p">This field is set to True for bounced emails in orgs using Lightning Threading. It’s not set to True for orgs using Ref ID threading.</p> </dd> </dl> <p class="p">To see this field, enable bounce management in your org.</p> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">IsClientManaged</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">If EmailMessage is created with <span class="keyword parmname">IsClientManaged</span> set to <samp class="codeph nolang">true</samp>, users can modify <span class="keyword parmname">EmailMessage.ContentDocumentIds</span> to link file attachments even when the <span class="keyword parmname">Status</span> of the EmailMessage isn’t set to <samp class="codeph nolang">Draft</samp>. When this field is set to <samp class="codeph nolang">true</samp> and Enhanced Email is enabled, a Task record is created for the EmailMessage regardless of Email-to-Case settings. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">IsDeleted</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the object has been moved to the Recycle Bin (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Label is <strong class="ph b">Deleted</strong>.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">IsExternallyVisible</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">If the Experience Cloud site case feed is enabled, <span class="keyword parmname">IsExternallyVisible</span> controls the external visibility of emails in sites. When <span class="keyword parmname">IsExternallyVisible</span> is set to <samp class="codeph nolang">true</samp>—its default value—external users see the email message in the case feed. <ul class="ul bulletList"> <li class="li">Emails remain visible in the Emails related list whether or not this field is set to true. For security reasons, we recommend that you remove this related list from your case page layout for external community users.</li> <li class="li">Only emails with a value in the <span class="keyword parmname">ParentId</span> field can be made externally visible in sites. </li> <li class="li">This field can’t be updated if the email’s <span class="keyword parmname">Status</span> is set to <samp class="codeph nolang">Draft</samp>. </li> <li class="li"> <p class="p">The <span class="keyword parmname">Enable Case Feeds in Experience Cloud Sites</span> organization preference in Setup makes case-related emails, comments, and updates visible to site members.</p> When this preference is off, <span class="keyword parmname">IsExternallyVisible</span> is True by default for the EmailMessage. When this preference is on, <span class="keyword parmname">IsExternallyVisible</span> defaults to True only if the case contact email is the sender or the recipient of the <span class="keyword parmname">EmailMessage.</span> Otherwise, <span class="keyword parmname">IsExternallyVisible</span> defaults to False. </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">IsLinkClicked</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether a link in the email has been clicked (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 67.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">IsLinkTracked</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Defaulted on create, Filter, Group, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether there are any URLs in the email that can be tracked (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. </dd> <dd class="dd">Available in API version 67.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">IsOpened</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the email has been opened.</dd> </dl> <p class="p">To see this field, enable email tracking in your org.</p> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">IsPrivateDraft</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">If <span class="keyword parmname">IsPrivateDraft</span> is set to <span class="keyword parmname">true</span>, then only the<span class="keyword parmname"> CreatedById</span> user can view, update, and send this email draft. If<span class="keyword parmname"> IsPrivateDraft</span> is set to <span class="keyword parmname">false</span>, then any user with permissions to work on the case can see these drafts. After the email is sent, then this field is updated to be <span class="keyword parmname">false</span>. Public drafts are loaded and visible in Salesforce Classic while Private Drafts are only used in Lightning Experience. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">IsTracked</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Defaulted on create, Filter, Group, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the email is being tracked.</dd> </dl> <p class="p">To see this field, enable email tracking in your org.</p> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">LastLinkClickedDate</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The timestamp for when a link in the email was last clicked. </dd> <dd class="dd">Available in API version 67.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">LastOpenedDate</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date the email was last opened.</dd> </dl> <p class="p">To see this field, enable email tracking in your org.</p> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">MessageDate</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date the email was created. </dd> <dd class="dd">For inbound emails, Email-to-Case sets this field using the Date header. The Date header is set by the email client and is subject to the sender's time preferences.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">MessageIdentifier</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, idLookup, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the email message.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">Name</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, idLookup, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A name for the email message that's derived from the first 255 characters of the Subject field. If the Subject field is empty, a localized string of <samp class="codeph nolang">[No Subject]</samp> is used. This field is read-only and can’t be created or updated. Available in API versions 56.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">ParentId</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">ID of the case that’s associated with the email.</dd> <dd class="dd">This is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">Parent</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Case</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">RelatedToId</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">The <span class="keyword parmname">RelatedToId</span> represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. RelatedToIds are polymorphic. Polymorphic means a RelatedToId is equivalent to the ID of a related object.</p> <p class="p">You must have access to at least one entity listed under Refers To to access RelatedToId.</p> <p class="p">You can update <span class="keyword parmname">RelatedToId</span> when <span class="keyword parmname">IsClientManaged</span> is set to <span class="keyword parmname">true</span>. </p> <p class="p"><span class="keyword parmname">RelatedtoId</span> and <span class="keyword parmname">ParentId</span> should have the same value when <span class="keyword parmname">ParentId</span> is set. You might see unexpected results otherwise. </p> </dd> <dd class="dd">This is a polymorphic relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">RelatedTo</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CommSubscriptionConsent, ContactEncounter, ContactEncounterParticipant, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem, CreditMemo, DelegatedAccount, DocumentChecklistItem, EnrollmentEligibilityCriteria, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, ListEmail, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PartyConsent, PersonLifeEvent, PlanBenefit, PlanBenefitItem, ProcessException, Product2, ProductItem, ProductRequest, ProductRequestLineItem, ProductTransfer, PurchaserPlan, ReceivedDocument, ResourceAbsence, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, Shift, Shipment, ShipmentItem, Solution, Visit, VisitedParty, VolunteerProject, WorkOrder, WorkOrderLineItem</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">ReplyToEmailMessageId</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">ID of the inbound or outbound email message the current email message is a reply to. It’s not possible to reply to a message whose <span class="keyword parmname">Status</span> is <samp class="codeph nolang">Draft</samp>. </dd> <dd class="dd">This is a relationship field.</dd> <dd class="dd">This is only set for Case related Email replies at setup.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">ReplyToEmailMessage</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">EmailMessage</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">Source</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">When Sync Email as Salesforce Activity is enabled, this value reflects from where the email was captured automatically. Available in API version 64.0 and later.</dd> <dd class="dd">Possible values are: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">Einstein Activity Capture</samp>–Captured as an entire email message by Einstein Activity Capture. </li> <li class="li"> <samp class="codeph nolang">Einstein Activity Capture Limited</samp>–Captured as a header-only email by Einstein Activity Capture. The sender, recipients, date, and time of the message were captured, not the subject or body. </li> <li class="li"> <samp class="codeph nolang">Email Integration App Manual</samp>-Captured to track the email message records created or edited from the mailapp. </li> <li class="li"> <samp class="codeph nolang">Migrated Captured Email</samp>-An email that was captured in Einstein Activity Capture and migrated to an updated version of Einstein Activity Capture in which Sync Email as Activity is turned on. Available in API version 65.0 and later. </li> <li class="li"> <samp class="codeph nolang">Migrated Captured Email Header Only</samp>-An email that was captured in Einstein Activity Capture and migrated as header-only data to an updated version of Einstein Activity Capture in which Sync Email as Activity is turned on. Available in API version 65.0 and later. </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">Status</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Restricted picklist, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The status of the email. <p class="p">The <span class="keyword parmname">Status</span> field is mostly read-only. You can change the status only from <var class="keyword varname">New</var> to <var class="keyword varname">Read</var>. </p> Possible values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">0</samp> (New) </li> <li class="li"> <samp class="codeph nolang">1</samp> (Read) </li> <li class="li"> <samp class="codeph nolang">2</samp> (Replied) </li> <li class="li"> <samp class="codeph nolang">3</samp> (Sent) </li> <li class="li"> <samp class="codeph nolang">4</samp> (Forwarded) </li> <li class="li"> <samp class="codeph nolang">5</samp> (Draft) </li> </ul> </dd> <dd class="dd">For emails not sent as part of a case, only the status <samp class="codeph nolang">3</samp> (Sent) is valid. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">Subject</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The subject line of the email. </dd> <dd class="dd">You can’t send emails unless at least one of these fields has content. <ul class="ul bulletList"> <li class="li">Subject field</li> <li class="li">HTML Body or Text Body field</li> </ul> As the sender, you can provide the content, or it can be automatically inserted using predefined values. An email template can also include the content for these fields. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">TextBody</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Nillable, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The body of the email, in plain text format. If <span class="keyword parmname">TextBody</span> isn’t set, then it’s extracted from <span class="keyword parmname">HtmlBody</span>. </dd> <dd class="dd">You can’t send emails unless at least one of these fields has content. <ul class="ul bulletList"> <li class="li">Subject field</li> <li class="li">HTML Body or Text Body field</li> </ul> As the sender, you can provide the content, or it can be automatically inserted using predefined values. An email template can also include the content for these fields </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">ThreadIdentifier</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, idLookup, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the email thread the email message belongs to. This field is used by features that sync emails directly from an inbox into Salesforce. This field is not used by On-Demand Email-to-Case.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">ToAddress</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">A string array of email addresses for recipients who were sent the email message. Include only email addresses that aren’t associated with Contact, Lead, or User records in Salesforce. If the recipient is a contact, lead, or user, add their ID to the <span class="keyword parmname">ToIds</span> field instead of adding their email address to the <span class="keyword parmname">ToAddress</span> field. Then the email message is automatically associated with the contact, lead, or user. </dd> <dd class="dd">You can’t send emails unless there’s at least one recipient.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">ToIds</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">JunctionIdList</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="EmailMessage_to_id_desc_ph"><a name="EmailMessage_to_id_desc_ph"><!-- --></a>A string array of IDs for contacts, leads, and users who were sent a carbon copy of the email message. Each ID is linked to an <span class="keyword parmname">EmailMessageRelation</span> record, which represents the relationship between an email message and a Contact, Lead, or User record. </span> <p class="p">Adding a <span class="keyword parmname">JunctionIdList</span> field name to the <span class="keyword parmname">fieldsToNull</span> property deletes all related junction records. This action can’t be undone.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d679029e210" data-title="Field"><span class="keyword parmname">ValidatedFromAddress</span></td> <td class="entry" headers="d679029e213" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Restricted picklist, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">A picklist value with either the sender's address, org-wide email addresses, or Email-to-Case routing address. The email address must be verified. If the sender’s email address is used, the sender must be the current user.</p> <p class="p"><span class="keyword parmname">ValidatedFromAddress</span> isn’t suitable for use in Group By or Sort By statements. Use <span class="keyword parmname">FromAddress</span> instead.</p> </dd> </dl> </td> </tr> </tbody> </table> ## Usage EmailMessage is limited to 50 custom fields. If your org uses Email-to-Case, a case is created when an email is sent to one of your company’s addresses. The email, which is related to the case by the ParentID field, is stored as an EmailMessage record. When users view the email, they see the EmailMessage record. If your org uses Enhanced Email, each email is stored as an EmailMessage record and a Task record. When users view an email, they see the EmailMessage record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note In an org with Email-to-Case enabled, an inbound (Incoming = true) email with case as the parent record won’t create a task automatically. This functionality respects the Create Task from Email setting for each Email-to-Case routing address. If you would like to change the recipients or contents of an outbound email, don’t use automation tools, like Flows or Apex triggers, to update EmailMessage records. Unless they are for a draft, updates to EmailMessage records will not be reflected in the actual sent email. To update an email’s data before it’s sent, use Quick Action predefined values or a [QuickActionDefaultsHandler](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_interface_QuickAction_QuickActionDefaultsHandler.htm). When a Flow creates an EmailMessage with set values in the audit fields (like CreatedBy and CreatedDate), any FeedItem automatically created for that EmailMessage will not share the same audit field values. ## Sample Code—Apex This sample logs email activity in Salesforce. // if EnhancedEmail Perm is not enabled, continue logging the email as a task // if EnhancedEmail Perm is enabled, create an EmailMessage object EmailMessage emailMessage = new EmailMessage(); emailMessage.status = '3'; // email was sent emailMessage.relatedToId = '006B0000003weZGIAY'; // related to record e.g. an opportunity emailMessage.fromAddress = 'sender@example.com'; // from address emailMessage.fromName = 'Dan Perkins'; // from name emailMessage.subject = 'This is the Subject!'; // email subject emailMessage.htmlBody = '<html><body><b>Hello</b></body></html>'; // email body // Contact, Lead or User Ids of recipients String\[\] toIds = new String\[\]{'003B000000AxcEjIAJ'}; emailMessage.toIds = toIds; // additional recipients who don’t have a corresponding contact, lead or user id in the Salesforce org (optional) emailMessage.toAddress = 'emailnotinsalesforce@toexample.com, anotherone@toexample.com'; insert emailMessage; // insert // Add Email Message Relation for id of the sender EmailMessageRelation emr = new EmailMessageRelation(); emr.emailMessageId = emailMessage.id; emr.relationId = '005B0000003qHvOIAU'; // user id of the sender emr.relationType = 'FromAddress'; insert emr; ## 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. [EmailMessageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. #### See Also - [Case](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm "Represents a case, which is a customer issue or problem.") - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=75b9c1b35356503a5f57e5d3e61a71769fb5d00bbcaa75b2691edcb8f8b227ff url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailmessagemigration.md --> # EmailMessageMigration For internal use only. <!-- document id=02eab65dcc7d9f5ddf3ae2972995d6efe23db01f03578786992c6368b154f245 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailmessagerelation.md --> # EmailMessageRelation Represents the relationship between an email and contacts, leads, and users. This object is available in API version 37.0 and later. ## Special Access Rules EmailMessageRelation is only available for organizations that use Email-to-Case or Enhanced Email, which is automatically enabled for most customers. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | EmailMessageId | Type reference Properties Create, Filter, Group, Sort Description The ID of the EmailMessage record. This is a relationship field. Relationship Name EmailMessage Relationship Type Lookup Refers To EmailMessage | | DeliveryResponse | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The delivery response from the email recipient. Possible values are: - SoftBounce - HardBounce - OutOfOffice Available in API version 67.0 and later. | | RelationAddress | Type string Properties Create, Filter, Group, Nillable, Sort Description The email address of the sender or recipient. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If a record relates an email to an existing contact, lead, or user record in Salesforce, the value of RelationAddress is the current value of the email address. If the value is not set, it is auto-populated from RelationId. | | RelationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The RecordId of the sender or recipient. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If a record relates an email to an email address that’s not associated with an existing contact, lead, or user record in Salesforce, the value of RelationId is null. This is a polymorphic relationship field. Relationship Name Relation Relationship Type Lookup Refers To Contact, Lead, User | | RelationObjectType | Type string Properties Filter, Group, Nillable, Sort Description The API name of the object type of the RecordId in the RelationId field. It can be a contact, lead, or user. | | RelationType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of relationship the contact, lead, or user has with the email message. Possible values include: - ToAddress - CcAddress - BccAddress - FromAddress - OtherAddress For an Experience Cloud site user who is not the sender of the email, no BccAddress relations are returned. | ## Usage EmailMessageRelation allows an email to be related to contacts, leads, and users. <!-- document id=ef93b8affac720166aa1d34ea00d9f09cba8d4d0889f04e3e3dedf9c979dea79 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailrelay.md --> # EmailRelay Represents the configuration for sending an email relay. An email relay routes email sent from Salesforce through your company’s email servers. This object is available in API version 43.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules You must have the Email Administration, Customize Application, and View Setup user permissions to use this object. ## Fields | Field Name | Details | | --- | --- | | AuthType | Type picklist Properties Create, Filter, Group, Restricted Picklist, Sort, Update Description Specifies which SASL mechanism Salesforce uses for SMTP authentication. This field is available when Enable SMTP Auth is selected. Select an option: - PLAIN- Salesforce uses PLAIN SASL mechanism for SMTP authentication. Default. - LOGIN- Salesforce uses LOGIN SASL mechanism for SMTP authentication This field is available in API version 52.0 and later. | | Host | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Indicates the host name or IP address of your company's SMTP server. | | IsRequireAuth | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether (true) or not (false) authentication is required. When setting this field to true, the TlsSetting must be set to **RequiredVerify**. This field is available in API version 44.0 and later. | | Password | Type encryptedstring Properties Create, Nillable, Update Description Specifies the password for relay host STMP authentication. When IsRequireAuth is set to true, this field is required. This field is available in API version 44.0 and later. | | Port | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the port number of your company's SMTP server. - 25 - 587 - 10025 - 11025 | | TlsSetting | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Specifies whether Salesforce uses TLS for SMTP sessions. - Off: TLS is turned off. SMTP session continues through an insecure connection. - Preferred: If the remote server supports TLS, Salesforce upgrades the current SMTP session to use TLS. If TLS is unavailable, Salesforce continues the session without TLS. - Required: Salesforce continues the session only if the remote server supports TLS. If TLS is unavailable, Salesforce terminates the session without delivering the email. - PreferredVerify: If the remote server supports TLS, Salesforce upgrades the current SMTP session to use TLS. Before the session begins, Salesforce verifies that the certificate is signed by a valid certificate authority, and that the common name presented in the certificate matches the domain or mail exchange of the current connection. If TLS is available but the certificate is not signed or the common name does not match, Salesforce disconnects the session and does not deliver the email. If TLS is unavailable, Salesforce continues the session without TLS. - RequiredVerify: Salesforce continues the session only if the remote server supports TLS, the certificate is signed by a valid certificate authority, and the common name presented in the certificate matches the domain or mail exchange to which Salesforce is connected. If any of these criteria are not met, Salesforce terminates the session without delivering the email. | | Username | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the username for relay host STMP authentication. When IsRequireAuth is set to true, this field is required. This field is available in API version 44.0 and later. | ## Usage An email relay must be associated with an active email domain filter to take effect. If you set up multiple email relays in one org, they are processed in the priority order of their email domain filters. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip If you also plan to activate Bounce Management and Email Compliance Management, confirm with your email admin that your company allows relaying email sent from Salesforce. For more information on bounce management, see [Configure Deliverability Settings for Emails Sent from Salesforce](https://help.salesforce.com/articleView?id=emailadmin_send_through_salesforce_configure_deliverability.htm&language=en_US "HTML (New Window)"). #### See Also - [EmailServicesFunction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailservicesfunction.htm "An email service.") - [EmailDomainFilter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emaildomainfilter.htm "Represents a filter that determines whether an email relay is restricted to a specific list of domains. This object is available in API version 43.0 and later.") <!-- document id=1bb4a938ffb03a649bd2f149bb2b0de97ebaf81b1ce578ca64b75549ce8a1595 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailroutingaddress.md --> # EmailRoutingAddress An email address used for Email-to-Case. Email routing addresses store a unique email services address provided by Salesforce and configuration options for emails received by this address. ## Supported Calls create(), describeSObjects(), delete(), update(), query(), retrieve(), upsert() ## Special Access Rules To access this object, Email-to-Case must be enabled. Only admin users can access this object. ## Fields | Field | Details | | --- | --- | | PersonalName | Type string Properties Create, Filter, Sort, Update Description The display name of the EmailRoutingAddress. Maximum size is 300 characters. | | Address | Type email Properties Create, Filter, Sort, Update Description The email address to which your customers direct their questions. Emails are forwarded from this address. | | EmailServicesAddress | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A unique, Salesforce-generated email address. This field value is read-only and can't be modified. Emails are forwarded to this address. | #### See Also - [EmailServicesAddress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailservicesaddress.htm "An email service address.") <!-- document id=226c364d4e0062afa4c8725380dd1d4538a2c2d2f4620cded5e7ac9d4cb61ef9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailservicesaddress.md --> # EmailServicesAddress An email service address. Each email service has one or more email addresses to which users can send messages for processing. An email service only processes messages it receives at one of its addresses. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | AuthorizedSenders | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Configures the email service address to only accept messages from the email addresses or domains listed in this field. If the email service address receives a message from an unlisted email address or domain, the email service performs the action specified in the AuthorizationFailureAction field of its associated email service. Leave this field blank if you want the email service address to receive email from any email address. | | DeveloperName | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The name of the object in the API. This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This 25-character field must be unique among other EmailServicesAddress records under the same EmailServiceFunction parent. In managed packages, this field prevents naming conflicts on package installations. This field is automatically generated, but you can supply your own value if you create the record using the API. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance might be slow while Salesforce generates one for each record. | | EmailDomainName | Type string Properties Filter, Group, Nillable, Sort Description A read only field you can query that contains the system-generated domain part of this email service address. The system generates a unique domain-part for each email service address to ensure that no two email service addresses are identical. | | FunctionId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the email service for which the email service address receives messages. This is a relationship field. Relationship Name Function Relationship Type Lookup Refers To EmailServicesFunction | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this object is active (true) or not (false). | | LocalPart | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The local-part of the email service address. The local-part of the address is the string that comes before the @ symbol. For the local-part of a Salesforce email address, all alphanumeric characters are valid, plus the following special characters: ! # $ % & amp; ' \* / = ? ^ \_ + - \` { | } ~ , The dot character (.) is also valid as long as it's not the first or last character. Email addresses aren’t case-sensitive. | | RunAsUserId | Type reference Properties Create, Filter, Group, Sort, Update Description The username of the user whose permissions the email service assumes when processing messages sent to this address. | ## Usage This object supports the email services feature, which allows you to create automated processes that use Apex classes to process the contents, headers, and attachments of inbound email. For example, you can create an email service that automatically creates contact records based on contact information in messages. #### See Also - [EmailServicesFunction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailservicesfunction.htm "An email service.") <!-- document id=349d8b95badfcdfc42b24808a7b4ab6fb4fcb032eef763614b85d50098afdbb5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailservicesfunction.md --> # EmailServicesFunction An email service. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | AddressInactiveAction | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates what the email service does with messages received at an email address that is inactive. One of the following values: - UseSystemDefault—The system default is used. (In API version 41.0 and earlier, the value specified for this choice is 0.) - Bounce—The email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 1.) - Discard—The email service deletes the message without notifying the sender. (In API version 41.0 and earlier, the value specified for this choice is 2.) - Requeue—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 3.) | | ApexClassId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The ID of the Apex class that the email service uses to process inbound messages. This field is required for API version 12.0 and later. | | AttachmentOption | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the types of attachments the email service accepts. One of the following values: - None—The email service accepts the message but discards any attachment. (In API version 41.0 and earlier, the value specified for this choice is 0.) - NoContent—The attachment metadata (filename, MIME type, and so on) is provided to the Apex class, but the body is set to null. There was no previous numeric value for this choice. - TextOnly—The email service only accepts the following types of attachments: - Attachments with a Multipurpose Internet Mail Extension (MIME) type of text. - Attachments with a MIME type of application/octet-stream and a file name that ends with either a .vcf or .vcs extension. These are saved as text/x-vcard and text/calendar MIME types, respectively. (In API version 41.0 and earlier, the value specified for this choice is 1.) - BinaryOnly—The email service only accepts binary attachments, such as image, audio, application, and video files. (In API version 41.0 and earlier, the value specified for this choice is 2.) - All—The email service accepts any type of attachment. (In API version 41.0 and earlier, the value specified for this choice is 3.) | | AuthenticationFailureAction | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates what the email service does with messages that fail or do not support any of the authentication protocols if the IsAuthenticationRequired field is true. One of the following values: - UseSystemDefault—The system default is used. (In API version 41.0 and earlier, the value specified for this choice is 0.) - Bounce—The email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 1.) - Discard—The email service deletes the message without notifying the sender. (In API version 41.0 and earlier, the value specified for this choice is 2.) - Requeue—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 3.) | | AuthorizationFailureAction | Type picklist Properties Defaulted on create, Group, Sort, Create, Filter, Nillable, Restricted picklist, Update Description Indicates what the email service does with messages received from senders who are not listed in the AuthorizedSenders field on either the email service or email service address. One of the following values: - UseSystemDefault—The system default is used. (In API version 41.0 and earlier, the value specified for this choice is 0.) - Bounce—The email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 1.) - Discard—The email service deletes the message without notifying the sender. (In API version 41.0 and earlier, the value specified for this choice is 2.) - Requeue—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 3.) | | AuthorizedSenders | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Configures the email service to only accept messages from the email addresses or domains listed in this field. If the email service receives a message from an unlisted email address or domain, the email service performs the action specified in the AuthorizationFailureAction field. Leave this field blank if you want the email service to receive email from any email address. | | ErrorRoutingAddress | Type email Properties Create, Filter, Nillable, Sort, Update Description The destination email address for error notification email messages when IsErrorRoutingEnabled is true. | | FunctionInactiveAction | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates what the email service does with messages it receives when the email service itself is inactive. One of the following values: - UseSystemDefault—The system default is used. (In API version 41.0 and earlier, the value specified for this choice is 0.) - Bounce—The email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 1.) - Discard—The email service deletes the message without notifying the sender. (In API version 41.0 and earlier, the value specified for this choice is 2.) - Requeue—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 3.) | | FunctionName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the email service. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this object is active (true) or not (false). | | IsAuthenticationRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Configures the email service to verify the legitimacy of the sending server before processing a message. The email service uses the SPF, SenderId, and DomainKeys protocols to verify the sender's legitimacy: If the sending server passes at least one of these protocols and does not fail any, the email service accepts the email. If the server fails a protocol or does not support any of the protocols, the email service performs the action specified in the AuthenticationFailureAction field. | | IsErrorRoutingEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description When incoming email messages can’t be processed, indicates whether error notification email messages are routed to a chosen address or to the senders. | | IsTextAttachmentsAsBinary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, text attachments are supplied to the Apex code as a Messaging.BinaryAttachment instead of as a Messaging.TextAttachment. This means that the body is supplied as an Apex Blob instead of as an Apex String. | | IsTextTruncated | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description This field is deprecated. It is not available as of API version 23.0 and is deprecated and hidden in versions 17.0 through 22.0. In all API versions, the email service now accepts inbound email messages up to the 10 MB size limit, without truncating the text. Previously, it indicated whether the email service truncated and accepted email messages with HTML body text, plain body text, and text attachments over approximately 100,000 characters (true) or rejected these email messages and notified the sender (false). | | IsTlsRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Not currently in use. | | OverLimitAction | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates what the email service does with messages if the total number of messages processed by all email services combined has reached the daily limit for your organization. One of the following values: - UseSystemDefault—The system default is used. (In API version 41.0 and earlier, the value specified for this choice is 0.) - Bounce—The email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 1.) - Discard—The email service deletes the message without notifying the sender. (In API version 41.0 and earlier, the value specified for this choice is 2.) - Requeue—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected. (In API version 41.0 and earlier, the value specified for this choice is 3.) The system calculates the limit by multiplying the number of user licenses by 1,000. | ## Usage This object supports the email services feature, which allows you to create automated processes that use Apex classes to process the contents, headers, and attachments of inbound email. For example, you can create an email service that automatically creates contact records based on contact information in messages. #### See Also - [EmailServicesAddress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailservicesaddress.htm "An email service address.") <!-- document id=d69c0992b358bfe98930147450a05e94b5736271801cea21f1ad8d3d3655982a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailstatus.md --> # EmailStatus Represents the status of email sent. ## Supported Calls describeSObjects() ## Special Access Rules Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | EmailTemplateName | Type string Properties Filter, Group, Nillable, Sort Description The name of the EmailTemplate. | | FirstOpenDate | Type dateTime Properties Filter, Nillable, Sort Description Date when the email was first opened by recipient. Label is **Date Opened**. | | LastOpenDate | Type dateTime Properties Filter, Nillable, Sort Description Date when the email was last opened by recipient. | | TaskId | Type reference Properties Filter, Group, Sort Description The activity (task or event) associated with the email. Label is **Activity ID**. This is a relationship field. Relationship Name Task Relationship Type Lookup Refers To Task | | TimesOpened | Type int Properties Filter, Group, Sort Description Number of times the recipient opened the email. | | WhoId | Type reference Properties Filter, Group, Nillable, Sort Description The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is Name ID. This is a polymorphic relationship field. Relationship Name Who Relationship Type Lookup Refers To Contact, Lead | #### See Also - [EmailTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailtemplate.htm "Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only.") <!-- document id=30d729575bc89b72ff5793fb740f3588eb1e4849f98fe4151b96901aed366b15 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailtemplate.md --> # EmailTemplate Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t send a mass email using a Visualforce email template. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | ApiVersion | Type double Properties Create, Filter, Nillable, Sort, Update Description The API version for this class. Every class has an API version specified at creation. | | Body | Type textarea Properties Create, Nillable, Update Description Content of the email. Limit: 384 KB. | | BrandTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. ID of the BrandTemplate associated with this email template. The brand template supplies letterhead information for the email template. | | DeliveryRate | Type percent Properties Filter, Nillable, Sort Description Read-only. The percentage of the emails that were delivered compared to the number that bounced (soft and hard). Note: this data includes emails that were delivered to the recipient's spam folder. This field is available in API version 46.0 and later. To access this field, your org must use Sales Engagement and users need the Sales Engagement User or Sales Engagement Cadence Creator permission set. This field value includes emails sent via the ListEmail object or Sales Engagement cadences. | | Description | Type string Properties Create, Filter, Nillable, Sort, Update Description Description of the template, for example, Promotion Mass Mailing. | | 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 org. 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 **Template Unique Name**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | Encoding | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Character set encoding for the template. | | EnhancedLetterheadId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the enhanced letterhead associated with the email template. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To use an enhanced letterhead, associate it with a Lightning email template that uses the HML merge language. This is a relationship field. Relationship Name EnhancedLetterhead Relationship Type Lookup Refers To EnhancedLetterhead | | EntityType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Description When UIType is 2 (Lightning Experience) or 3 (Lightning ExperienceSample), EntityType indicates which entities this template can be used with (for example, account or lead). Valid values are standard object ID prefixes: 001 for account, 003 for contact, 006 for opportunity, and 00Q for lead, 500 for case, and 701 for campaign. This field has been removed in API version 39.0. Use RelatedEntityType instead. | | FolderId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the folder that contains the template. This is a relationship field. Relationship Name Folder Relationship Type Lookup Refers To Folder, Organization, User | | FolderName | Type string Properties Filter, Nillable, Sort Description The name of the folder that contains the template. | | HasSalesforceFiles | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If the email template has attachments from Salesforce Files. The default value is false. | | HtmlValue | Type textarea Properties Create, Nillable, Update Description This field contains the content of the email message, including HTML coding to render the email message. Limit: 384 KB. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that this template is active if true, or inactive if false. | | IsBuilderContent | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If the email template was made in Email Template Builder. The default value is false. | | LastUsedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when this email template was last used. Used with Salesforce Classic templates. Not typically used with Lightning Experience templates. | | Markup | Type textarea Properties Create, Nillable, Update Description The Visualforce markup, HTML, JavaScript, or any other Web-enabled code that defines the content of the template. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the template. Label is **Email Template Name**. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. This field can’t be accessed unless the logged-in user has the Customize Application permission. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the template. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | RelatedEntityType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description When UIType is 2 (Lightning Experience) or 3 (Lightning ExperienceSample), RelatedEntityType indicates which entities this template can be used with. Valid values are the entity API name: "Account" for account, "Contact" for contact, "Opportunity" for opportunity, "Lead" for lead, and so on. The value can be any entity the user has read access to (including custom entities) but not virtual entities, setup entities, or platform entities. No restrictions exist at the schema level. | | Subject | Type string Properties Create, Nillable, Sort, Update Description Content of the subject line. The limit is 1,000 characters for Lightning email templates and 230 characters for Classic email templates. | | TemplateStyle | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Style of the template. Possible values are: - formalLetter—Formal Letter - freeForm—Free Form Letter - newsletter—Newsletter - none—No Email Layout - products—Products - promotionLeft—Promotion (Left) - promotionRight—Promotion (Right) | | TemplateType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Type of template. Possible values are: - custom—Custom - html—HTML - text—Text - visualforce—Visualforce | | TimesUsed | Type int Properties Filter, Group, Nillable, Sort Description Number of times this email template has been used. Used with Salesforce Classic templates. Not typically used with Lightning Experience templates. | | TotalDelivered | Type int Properties Filter, Group, Nillable, Sort Description Read-only. The total number of emails sent minus hard and soft bounces. Note: this data includes emails that were delivered to the recipient's spam folder. This field is available in API version 46.0 and later. To access this field, your org must use Sales Engagement and users need the Sales Engagement User or Sales Engagement Cadence Creator permission set. This field value includes emails sent via the ListEmail object or Sales Engagement cadences. | | TotalHardBounced | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only. The total number of emails that permanently bounced back to the sender because the address is invalid. A hard bounce can occur because the domain name doesn't exist or because the recipient is unknown. This field is available in API version 46.0 and later. To access this field, your org must use Sales Engagement and users need the Sales Engagement User or Sales Engagement Cadence Creator permission set. This field value includes emails sent via the ListEmail object or Sales Engagement cadences. | | TotalOpens | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only. The total number of times a prospect’s email client loaded the images in the HTML version of the email. We also record an open if the prospect clicks a link within the HTML or text email without downloading images. A click indicates that they viewed the message. Some email clients (Outlook, Apple Mail, Thunderbird) don’t display images by default. Pardot counts an open each time the images load. This field is available in API version 46.0 and later. To access this field, your org must use Sales Engagement and users need the Sales Engagement User or Sales Engagement Cadence Creator permission set. This field value includes emails sent via the ListEmail object or Sales Engagement cadences. | | TotalSent | Type int Properties Filter, Group, Nillable, Sort Description Read-only. The total number of emails sent, including bounced, opted-out, and invalid To: addresses. This field is available in API version 46.0 and later. To access this field, your org must use Sales Engagement and users need the Sales Engagement User or Sales Engagement Cadence Creator permission set. This field value includes emails sent via the ListEmail object or Sales Engagement cadences. | | TotalSoftBounced | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only. The total number of times a recipient’s mail server acknowledged the email, but returned it to the sender. Sometimes it is because the recipient's mailbox is full or the mail server is temporarily unavailable. A soft bounce message can sometimes be delivered at another time. After 5 soft bounces, Pardot opts the prospect out of emails. This field is available in API version 46.0 and later. To access this field, your org must use Sales Engagement and users need the Sales Engagement User or Sales Engagement Cadence Creator permission set. This field value includes emails sent via the ListEmail object or Sales Engagement cadences. | | UIType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the user interface where this template is usable. Possible values are: - Aloha - SFX - SFX\_Sample—SFXSample | ## Usage To retrieve this object, issue a describe call on an object, which returns a query result for each activity since the object was created. You can't query these records. ## 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. [EmailTemplateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. #### See Also - [Attachment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attachment.htm#sforce_api_objects_attachment "Represents a file that a User has uploaded and attached to a parent object.") - [EmailStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailstatus.htm "Represents the status of email sent.") - [DocumentAttachmentMap](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_documentattachmentmap.htm#sforce_api_objects_documentattachmentmap "Maps the relationship between an EmailTemplate and its attachment, which is stored as a Document.") <!-- document id=423203ad877b442f17ef74e49ece54168076d6eaf3b8b10b0cf987c4d7221685 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_emailtemplatemonthlymetric.md --> # EmailTemplateMonthlyMetric Represents the monthly engagement metrics for an email template. This object is available in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Sales Engagement must be enabled. ## Fields | Field | Details | | --- | --- | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total of hard and soft bounced emails for this email template in the month. This is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of successfully delivered emails for this email template in the month. This is a calculated field. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of hard bounced emails for this email template in the month. | | AllEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails containing a link clicked by the recipient for this email template in the month. | | AllEmailsNotDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails not delivered for this email template in the month. This field is available in API version 54.0 and later. | | AllEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails opened by the recipient for this email template in the month. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that triggered an out-of-office reply for this email template in the month. | | AllEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails replied to for this email template in the month. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent for this email template in the month. This is a calculated field. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails soft bounced for this email template in the month. | | AllEmailsTrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with engagement tracking enabled for this email template in the month. | | AllEmailsUntrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent without engagement tracking for this email template in the month. | | DeliveredRecipientCount | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were successfully delivered an email for this email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | DeliveredRecipientRate | Type percent Properties Filter, Nillable, Sort Description The percentage of unique recipients that received an email you sent. This field is available in API version 54.0 and later. This is a calculated field. | | EmailTemplateId | Type reference Properties Filter, Group, Sort Description The ID of the related email template. This is a relationship field. Relationship Name EmailTemplate Relationship Type Lookup Refers To EmailTemplate | | HardBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with hard bounce tracking. This field is available in API version 54.0 and later. | | HrdBncTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with hard bounce tracking. This field is available in API version 54.0 and later. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the monthly metric record is locked or not. The default value is 'false'. | | LinkClickTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with link click tracking for the email template in the month. This field is available in API version 54.0 and later. | | LinkClkTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with link tracking for the email template in the month. This field is available in API version 54.0 and later. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the monthly metric record can be edited or not. The default value is 'false'. | | Month | Type date Properties Filter, Group, Sort Description The month in which the engagement occurred. | | MonthInt | Type int Properties Filter, Group, idLookup, Sort Description The month in which the engagement occurred, in yyyymm format. | | OooTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with out-of-office tracking for the email template in the month. Out-of-office tracking requires Inbox. This field is available in API version 54.0 and later. | | OpenTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with open tracking for the email template in the month. This field is available in API version 54.0 and later. | | OpenTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with open tracking for the email template in the month. This field is available in API version 54.0 and later. | | OutOfOfficeTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with out-of-office tracking for the email template in the month. This field is available in API version 54.0 and later. | | RecipientReplies | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who replied to an email for this email template in the month. This field is available in API version 54.0 and later. | | RecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of unique email recipients for this email template in the month. This field is available in API version 54.0 and later. | | RecipientsHardBounced | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients that hard-bounced an email for this email template in the month. Hard bounces can mean that the recipient's email address doesn't exist or is misspelled. This field is available in API version 54.0 and later. | | RecipientsOutOfOffice | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients that responded with an out-of-office reply for the email template in the month. This field is available in API version 54.0 and later. | | RecipientsSoftBounced | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients that soft-bounced an email for the email template in the month. A soft bounce often indicates a temporary issue with the recipient's email server, such as a full inbox. This field is available in API version 54.0 and later. | | ReplyTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with reply tracking for this email template in the month. This field is available in API version 54.0 and later. | | ReplyTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with reply tracking for the email template in the month. This field is available in API version 54.0 and later. | | SftBncTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who received an email with soft bounce tracking for the email template in the month. This field is available in API version 54.0 and later. | | SoftBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with soft bounce tracking for the email template in the month. This field is available in API version 54.0 and later. | | SomeEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of sent emails that were successfully delivered to at least one of its recipients for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | SomeEmailsDeliveredRate | Type percent Properties Filter, Nillable, Sort Description The percentage of sent and tracked emails that were successfully delivered to at least one of their recipients for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableRecipientSendHrdBncRt | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to unique recipients with hard bounce tracking that hard bounced for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableRecipientSendOooRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with out-of-office tracking that received out-of-office replies from unique recipients for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableRecipientSendReplyRt | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with reply tracking that received replies from unique recipients for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableRecipientSendSftBncRt | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to unique recipients with soft bounce tracking that soft-bounced for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableSendHardBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with hard bounce tracking that hard bounced for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableSendLinkClickRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with link tracking that had link clicks for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableSendOpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with open tracking that were opened by the recipient for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableSendOutOfOfficeRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with out-of-office tracking that received out-of-office replies for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableSendReplyRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with reply tracking that received replies for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | TrackableSendSoftBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with soft bounce tracking that soft bounced for the email template in the month. This field is available in API version 54.0 and later. This is a calculated field. | | UniqueEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of link clicks by unique recipients for the email template in the month. | | UniqueEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times an email you sent was opened by a unique recipient for the email template in the month. When you send a list email, this field increments each time a recipient opens the received email. | | UniqueEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of replies from unique recipients for the email template in the month. | <!-- document id=780df6e575d60530c58084c478bb344dfaab6bcc1b050c86a684102461f4298b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_embeddedservicedetail.md --> # EmbeddedServiceDetail Represents a metadata catalog object that exposes fields from the underlying Embedded Service setup objects defined in each EmbeddedServiceConfig deployment for guest users. Guest users don’t have direct access to the Embedded Service setup objects. Available in API version 39.0 and later. ## Supported SOAP Calls describeSObjects(), query() ## Supported REST HTTP Methods GET ## Fields | Field | Details | | --- | --- | | AvatarImg | Type string Properties Filter, Group, Nillable, Sort Description URL of the image used as the agent avatar image. | | ContrastInvertedColor | Type string Properties Filter, Group, Nillable, Sort Description Accent branding color used in the embedded component, displayed as a hexadecimal value. Changes made to this field in the API aren’t reflected in the embedded component. | | ContrastPrimaryColor | Type string Properties Filter, Group, Nillable, Sort Description Value of the ContrastPrimaryColor field in the EmbeddedServiceBranding setup object. | | CustomMinimizedComponent | Type string Properties Filter, Group, Nillable, Sort Description The custom Aura component that’s used for the minimized state for this Embedded Chat deployment. | | CustomPrechatComponent | Type string Properties Filter, Group, Nillable, Sort Description The custom Aura component that’s used for the pre-chat page for this Embedded Chat deployment. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description Developer name for the EmbeddedServiceConfig. | | FieldServiceConfirmCardImg | Type string Properties Filter, Group, Nillable, Sort Description URL of the image used for the confirmation card in embedded Appointment Management (beta). | | FieldServiceHomeImg | Type string Properties Filter, Group, Nillable, Sort Description URL of the image used for the home screen in embedded Appointment Management (beta). | | FieldServiceLogoImg | Type string Properties Filter, Group, Nillable, Sort Description URL of the logo used for the home screen in embedded Appointment Management (beta). | | Font | Type string Properties Filter, Group, Nillable, Sort Description Font used in the chat text of the Embedded Chat window. | | FontSize | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Font size for the embedded component. Possible values are: - Small - Medium - Large | | HeaderBackgroundImg | Type string Properties Filter, Group, Nillable, Sort Description URL of the image used for the header background in Embedded Chat. This field is removed in API version 49.0 and later. The header background image is no longer supported. | | Height | Type int Properties Filter, Group, Nillable, Sort Description Height of the embedded component. | | IsFieldServiceEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether Field Service is enabled for this Embedded Service deployment (true) or not (false). Embedded Appointment Management is currently beta. | | IsLiveAgentEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether Chat is enabled for this Embedded Service deployment (true) or not (false). | | IsOfflineCaseEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether offline support is enabled for this Embedded Chat deployment (true) or not (false). | | IsPrechatEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Value of the PrechatEnabled field in the EmbeddedServiceLiveAgent setup object. | | IsQueuePositionEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether queue position (displaying the customer’s place in line while they wait for an agent) is enabled for this Embedded Chat deployment (true) or not (false). | | NavBarColor | Type string Properties Filter, Group, Nillable, Sort Description Value of the NavBarColor field in the EmbeddedServiceBranding setup object. | | NavBarTextColor | Type string Properties Filter, Group, Nillable, Sort Description This field is used to set the text color for the header. | | OfflineCaseBackgroundImg | Type string Properties Filter, Group, Nillable, Sort Description URL of the image used for the background for the offline support case form in Embedded Chat. | | PrechatBackgroundImg | Type string Properties Filter, Group, Nillable, Sort Description URL of the image used for the background for the pre-chat form in Embedded Chat. | | PrimaryColor | Type string Properties Filter, Group, Nillable, Sort Description Value of the PrimaryColor field in the EmbeddedServiceBranding setup object. | | SecondaryColor | Type string Properties Filter, Group, Nillable Sort Description Value of the SecondaryColor field in the EmbeddedServiceBranding setup object. | | SecondaryNavBarColor | Type string Properties Filter, Group, Nillable Sort Description This field is used to set the color of a secondary header. | | ShouldHideAuthDialog | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the prompt that the customer log in again during a flow should be hidden (true) or not (false). When it’s hidden, the customer is taken directly to your login page. | | ShouldShowExistingAppointment | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether to display a button on the home screen for customers to access their existing appointments (true) or not (false) for embedded Appointment Management (beta). | | ShouldShowNewAppointment | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether to display a button on the home screen for customers to create a new appointment (true) or not (false) for embedded Appointment Management (beta). | | Site | Type string Properties Filter, Group, Nillable Sort Description Value of the Site field in the EmbeddedServiceConfig setup object. | | SmallCompanyLogoImg | Type string Properties Filter, Group, Nillable, Sort Description URL of the logo image used with Embedded Chat. | | WaitingStateBackgroundImg | Type string Properties Filter, Group, Nillable, Sort Description URL of the image used for the background image in Embedded Chat while the customer waits to be connected with a support agent. | | Width | Type int Properties Filter, Group, Nillable, Sort Description Width of the embedded component. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Any changes you make to the image fields override what you’ve entered in Setup. We recommend setting your image URLs in Setup. <!-- document id=b383a0826978c612bf215804560f32fad07bfaf540bcf01f00951a10f83fad46 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_embeddedservicelabel.md --> # EmbeddedServiceLabel Represents a customized label in Embedded Chat or embedded Appointment Management.This object is available in API version 44.0 and later. ## Supported SOAP Calls describeSObjects(), query() ## Supported REST HTTP Methods GET ## Fields | Field | Details | | --- | --- | | CustomLabelName | Type string Properties Filter, Group, Nillable, Sort Description The developer name for the custom label. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description The unique name containing EmbeddedServiceConfig.labelKey. | | EmbeddedServiceConfigDeveloperName | Type string Properties Filter, Group, Nillable, Sort Description Developer name for the EmbeddedServiceConfig. | | LabelKey | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of label for this embedded component. The value corresponds to the label within a label group (substate of chat state or page type). | <!-- document id=786bb2c77a3e3a95cf69d8e4833f20dc38948a369c243714a6274a70dff11b47 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_employee.md --> # Employee Represents an employee within a company or organization. This object is available in API version 48.0 and later. In API version 49.0 and later, this object supports reports, criteria-based sharing rules, and history tracking, plus you can exclude individual fields from custom page layouts. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() undelete(), update(), upsert() ## Special Access Rules To access this object, you must have a Workplace Command Center permission set license and the Provides access to Workplace Command Center features system permission or have the Employee Management and Employee User add-on licenses. ## Fields | Field | Details | | --- | --- | | AboutMe | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Information about the employee, such as areas of interest or skills. Values can be provided on Employee’s profile page. This field is available even if Chatter is disabled. | | AlternateEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s alternate email address. | | Availability | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s availability status. Possible values are: - In The Office - Out Of Office - Out Sick - PTO - Volunteering Time Off - Working Remotely | | AvailabilityEndDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The end date of the Employee’s availability, inclusive of the date. | | AvailabilityStartDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The start date of the Employee’s availability, inclusive of the date. | | BannerPhotoUrl | Type url Properties Filter, Nillable, Sort Description Read only. The URL for the employee's banner photo. Available in API v51.0 and later. | | CurrentWellnessStatus | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s current wellness status. Possible values are: - Available To Work - Remote Work Only - Unavailable - Unknown | | DateOfBirth | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s date of birth. | | Email | Type email Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The employee’s email address. This field is unique within your organization. | | EmployeeNumber | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The employee's employment ID for the organization they were hired into. This field is unique within your organization. | | EmployeeStatus | Type picklist Properties Create, Filter, Group, Sort, Update Description Required. The employee's current work status. Possible values are: - Active - Inactive - Leave - Terminated | | EmploymentType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee's full-time or part-time status. Possible values are: - Full-Time - Part-Time | | FirstName | Type string Properties Create, Filter, Group, Sort, Update Description Required. The employee’s first name. | | FullPhotoUrl | Type url Properties Filter, Nillable, Sort Description Read only. The URL for the employee's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo has been uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. Available in API v51.0 and later. | | Gender | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s gender. Possible values are: - Female - Male - Non-Binary / Non-Conforming - Other - Prefer Not to State - Transgender Female - Transgender Male | | HomeAddress | Type address Properties Filter, Nillable Description The employee’s home address. | | HomeCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city for the employee’s home address. | | HomeCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The county for the employee’s home address. | | HomeGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of an employee’s home address geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | HomeLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with HomeLongitude to specify the precise geolocation of the employee’s home address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | HomeLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with HomeLatitude to specify the precise geolocation of the employee’s home address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | HomePhone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s home phone number. | | HomePostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code for the employee’s home address. | | HomeState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state for the employee’s home address. | | HomeStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street for the employee’s home address. | | IndividualId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the Individual record that this employee is assigned to. | | InternalOrganizationUnitId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the InternalOrganizationUnit this employee is assigned to. | | JobProfile | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s job profile at the company. | | LastName | Type string Properties Create, Filter, Group, Sort, Update Description Required. The employee’s last name. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | LocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the Location that this employee is assigned to. | | ManagerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the Employee record of the employee's manager. | | MediumPhotoUrl | Type url Properties Filter, Nillable, Sort Description Read only. The URL for the medium-sized employee's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo has been uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. Available in API v51.0 and later. | | MiddleName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s middle name. | | Name | Type string Properties Filter, Group, idLookup, Nillable, Sort Description A compound field of Employee.FirstName, Employee.MiddleName, and Employee.LastName. | | NameSuffix | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s suffix. | | OutOfOfficeMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The message portion of the employee availability. This message can provide reasons or details about the change in availability. The maximum length of this string is 40 characters. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this record. Default value is the user logged in to the API to perform the create operation. | | PreferredFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name the employee prefers to be called. | | PreferredPronoun | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee's preferred pronoun. Possible values are: - He/Him/His - Other/Ask Me - She/Her/Hers - They/Them/Theirs | | RelatedPersonId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Links an employee to a person account with a unique value. Reserved for future use. Don’t edit it. | | SmallPhotoUrl | Type url Properties Filter, Nillable, Sort Description Read only. The URL for the small-sized employee's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo has been uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. Available in API v51.0 and later. | | StatusAsOf | Type dateTime Properties Create, Filter, Sort, Update Description Required. Start date of the employee’s current status. | | StatusEndDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Planned end date for the employee’s status. | | TimeZone | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time zone which the employee’s work hours fall within. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field to associate an Employee record with a user in the org. The field is optional and unique. | | WorkPhone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The employee's formatted work phone number including country code and extension. | | WorkerType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The type of worker for the employee. Possible values are: - Alumnus - Contractor - Employee - Intern - Temporary | | WorkingHoursEnd | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The end time of the employee’s working hours. | | WorkingHoursStart | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The start time of the employee’s working hours. | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [EmployeeHistory](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.") (API version 49.0) History is available for tracked fields of the object. [EmployeeOwnerSharingRule](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. [EmployeesShare](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.") (API version 49.0) Sharing is available for the object. #### See Also - [_Workplace Command Center for Work.com Developer Guide_: Extend Work.com with Custom Solutions](https://developer.salesforce.com/docs/atlas.en-us.264.0.workdotcom_dev_guide.meta/workdotcom_dev_guide/wdc_cc_dev_workplace_cc_solution.htm " Workplace Command Center for Work.com Developer Guide: Extend Work.com with Custom Solutions - HTML (New Window)") <!-- document id=5c9beb2427958ffd20b4bd7369916f4f30407872686de2532e76e0aef2da3e29 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_employee2.md --> # Employee2 Represents an employee within a company or an organization. This object is available in API version 62.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available if Talent Recruitment Management is enabled in your org. It’s also available to customers who purchase the Unified Employee license.To access the object, you need one of these permission sets. <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d703169e115">User Type</th> <th class="featureTableHeader " id="d703169e118">Permission Set</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d703169e115" data-title="User Type">Internal Users</td> <td class="entry" headers="d703169e118" data-title="Permission Set">HR Service Workspace Personnel</td> </tr> <tr> <td class="entry" headers="d703169e115" data-title="User Type">Salesforce Platform Users</td> <td class="entry" headers="d703169e118" data-title="Permission Set"> <p class="p">Employee Hub Community User</p> <p class="p">OR</p> <p class="p">Unified Employee Permission Set</p> <p class="p">OR</p> <p class="p">Work.com License</p> </td> </tr> <tr> <td class="entry" headers="d703169e115" data-title="User Type">Unified Employee Users</td> <td class="entry" headers="d703169e118" data-title="Permission Set">Unified Employee Permission Set</td> </tr> </tbody> </table> ## Fields | Field | Details | | --- | --- | | AlternateEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s alternate email address. | | ContactId | Type reference Properties Create, Filter, Group, Sort Description The contact associated with the employee. Relationship Name Contact Relationship Type Master-detail Refers To Contact (the master object) | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO currency code for the post-authorization request. Valid value is: - USD—U.S. Dollar The default value is USD. | | EmployeeNumber | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The employee's unique ID for their organization. | | EmployeeStatus | Type picklist Properties Create, Filter, Group, Sort, Update Description The employee's current work status. Valid values are: - Active - Inactive - Leave - Terminated | | EmployeeType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The employee's full-time or part-time status. Valid values are: - Alumnus - Contractor - Permanent - Intern - Temporary | | EmploymentType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee's full-time or part-time status. Valid values are: - Full-Time - Part-Time | | InternalOrganizationUnitId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The internal organization unit associated with the employee. Relationship Name InternalOrganizationUnit Refers To InternalOrganizationUnit | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that the user only accessed the record or a related list view (LastReferencedDate), but not viewed the record itself. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the employee record. | | StatusEndDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The planned end date for the employee’s status. | | StatusStartDate | Type dateTime Properties Create, Filter, Sort, Update Description The start date of the employee’s current status. | | User | Type reference Properties Create, Filter, Nillable, Sort, Update Description The user associated with the employee. After this field is set to a non-null value, you can’t update it. Relationship Name User Description User | <!-- document id=834c8e9f45e4ba53250ce12cb01e327bcc2e30456c56f8d9840882d269be9461 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_employeecrisisassessment.md --> # EmployeeCrisisAssessment Represents a crisis assessment of an Employee. This object is available in API version 48.0 and later. In API version 49.0 and later, this object supports reports, criteria-based sharing rules, and history tracking, plus you can exclude individual fields from custom page layouts. For Work.com, when an employee responds to a wellness survey, an EmployeeCrisisAssessment record is created based on an employee's answers. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, you must be assigned a Workplace Command Center permission set license and the Provides access to Workplace Command Center features system permission. ## Fields | Field | Details | | --- | --- | | Assessment | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s COVID-19 status at the time of the assessment. Possible values are: - COVID-19 Immune or Recovered - COVID-19 No Symptoms - COVID-19 Symptoms or Exposed - COVID-19 Test Negative - COVID-19 Test Positive - Declined | | AssessmentDate | Type dateTime Properties Create, Filter, Sort, Update Description The date of the assessment. Required | | AssessmentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The assessment record number. | | CrisisId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Crisis that this assessment is associated with. | | EmployeeId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The Employee that this assessment is associated with. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this record. Default value is the user logged in to the API to perform the create operation. | | SourceAssessment | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The record in the source system that drove this assessment. | | SourceSystem | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The source system that drove this assessment. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [EmployeeCrisisAssessmentHistory](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.") (API version 49.0) History is available for tracked fields of the object. [EmployeeCrisisAssessmentOwnerSharingRule](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. [EmployeeCrisisAssessmentShare](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.") (API version 49.0) Sharing is available for the object. #### See Also - [_Workplace Command Center for Work.com Developer Guide_: Extend Work.com with Custom Solutions](https://developer.salesforce.com/docs/atlas.en-us.264.0.ajax.meta/workdotcom_dev_guide/wdc_cc_overview.htm " Workplace Command Center for Work.com Developer Guide: Extend Work.com with Custom Solutions - HTML (New Window)") <!-- document id=9bd7298875830f3c5a422561f9b0dfb8d247143ab6e718cc35b85743f7496f1c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_empuserprovisioningprocess.md --> # EmpUserProvisioningProcess Represents an employee-user provisioning process. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object requires a Workplace Command Center add-on license, or an Employee Experience add-on license. ## Fields | Field | Details | | --- | --- | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that the user provisioning process ended. | | ErrorRecordCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of records that encountered an error during the user provisioning process. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the user provisioning process was last referenced, with a precision of one second. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the user provisioning process was last viewed, with a precision of one second. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the user provisioning process. | | ProcessStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the user provisioning process. Possible values are: - Aborted - Cancelled - Failed - Finished - Initializing - Processing - Queued | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that the user provisioning process started. | | SuccessRecordCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of records that were successfully provisioned during the user provisioning process. | | TotalRecordCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of records in the user provisioning process. | ## Usage Use the EmpUserProvisioningProcess to view the status of an employee-user provisioning process. <!-- document id=6a8f40314604a073c9310d875dbc03ef2cb66c44d53ba50b0ce8e5f0e26a7feb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_empuserprovisionprocesserr.md --> # EmpUserProvisionProcessErr Represents an employee-user provisioning process error. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object requires a Workplace Command Center add-on license, or an Employee Experience add-on license. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Person Account linked to the employee record associated with the error. This is a relationship field. Relationship Name Account Refers To Account | | EmployeeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the employee record associated with the error. This is a relationship field. Relationship Name Employee Relationship Type Lookup Refers To Employee | | ErrorCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The error code if the provisioning isn’t successful. | | ErrorMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If an error occurred, this field contains the error message. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the error was last referenced, with a precision of one second. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the error was last viewed, with a precision of one second. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the error. | | ProvisioningProcessId | Type reference Properties Create, Filter, Group, Sort Description The ID of the associated user provisioning process. This is a relationship field. Relationship Name ProvisioningProcess Relationship Type Lookup Refers To EmpUserProvisioningProcess | ## Usage Use the EmpUserProvisionProcessErr to view the errors for an employee-user provisioning process. <!-- document id=b678cceb524ff1bd9cfc6a405d045e9905df575b08a7c9bdb95658e3fc64b0cc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enablementmeasuredefinition.md --> # EnablementMeasureDefinition Represents an Enablement measure, which specifies the job-related activity that a user performs to complete a milestone or outcome in an Enablement program. A measure identifies a source object and optional related objects, with optional field filters and filter logic, for tracking the activity. This object also represents Enablement measure information in Metadata API. This object is available in API version 56.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. ## Fields | Field | Details | | --- | --- | | AggregateFieldApiName | Type string Properties Create, Filter, Group, Nillable, Sort Description The unique name in the API for the field that the AggregateFunction uses for calculating. For example, if you’re measuring how much revenue a sales rep has won, the value of aggregateFunction is Sum and the value of aggregateFieldApiName is Amount, which is the API name of the Amount field on the Opportunity object. | | AggregateFunction | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The method for calculating progress towards the milestone or outcome from records that qualify for the measure’s criteria. Possible values are: - Average - Count - Sum For example, if you’re measuring the number of deals won, the function is Count. If the function is Average or Sum, then AggregateFieldApiName specifies the API name of the field to use for calculating progress. | | Description | Type string Properties Create, Filter, Sort, Update Description An internal description for the measure to help Enablement admins understand the activity that’s tracked. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | DisplayFieldApiName | Type string Properties Create, Filter, Group, Sort Description The unique name in the API for the field that primarily identifies records that qualify for the activity you’re measuring. For example, if you’re measuring the number of deals won, you’re tracking the Opportunity object, and maybe you want to identify opportunities by their name. In this case, this field can be Name, the API name of the Opportunity Name field on the Opportunity object. | | IsValid | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the measure is valid. A measure becomes invalid and stops tracking progress under these circumstances: - An object or field is removed. - An object label or API name is renamed. - A field’s API name is renamed. Default is false. A measure only becomes invalid after a breaking change is saved the corresponding outcome or milestone progress is calculated. See [Considerations for Creating and Editing Measures](https://help.salesforce.com/s/articleView?id=sales.enablement_measures_considerations.htm&type=5&language=en_US "HTML (New Window)"). | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reserved for future use. Don’t edit this field. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label for this EnablementMeasureDefinition value. This display value is the internal label that doesn't get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. Available in API version 62.0 and later. | | PublishedDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the measure was activated for use in Enablement programs. | | SourceMeasureObjectId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the EnblMeasureObjectDefinition that specifies the criteria for the source object that tracks the activity you're measuring. This field is a relationship field. Relationship Name SourceMeasureObject Relationship Type Lookup Refers To EnblMeasureObjectDefinition | | SourceObjectApiName | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The unique name in the API for the source object that tracks the activity you're measuring. This value is a derived value. For example, if you're measuring the number of deals won, this value is Opportunity, the API name for the Opportunity object. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The availability of the measure for use in Enablement programs. Possible values are: - Archived—Available in API versions 56.0 to 60.0. - Draft—The measure is saved, but not activated for use in programs. - Published—The measure is activated for use in programs. In Lightning Experience, this value is Active. | ## Usage An EnablementMeasureDefinition can have multiple EnblMeasureObjectDefinition references, depending on the number of related objects in the measure. Consider an example measure that tracks activity on the Opportunity source object and the Account related object. - The EnablementMeasureDefinition identifies the Opportunity source object. - An EnblMeasureObjectDefinition specifies the criteria on the Opportunity source object. - An EnblMeasureObjectDefinition specifies the criteria on the Account related object. <!-- document id=1c643110c0b456d3b8f0f927479186345c6286699279c231b41ba9c034a2db93 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enablementprogram.md --> # EnablementProgram Represents an Enablement program, which includes exercises and measurable milestones to help users such as sales reps achieve specific outcomes related to your company’s revenue goals. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - For partner users who take Partner Enablement programs, the Take Partner Enablement Programs permission is required. This permission is enabled by default as part of the Use Partner Enablement Programs permission set, which comes with the Enablement add-on license. Partner Enablement also requires a [supported Partner Relationship Management (PRM) add-on license](https://help.salesforce.com/s/articleView?id=slack.prm_support_license_template.htm&type=5&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Update Description A summary of the program’s goals and content that’s visible to users. | | DoesAllowSelfEnrollment | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether users can self-enroll in programs that are shared with them (true) or take only assigned programs (false). The default value is false. | | EnablementProgramDefinitionId | Type reference Properties Filter, Group, Nillable, Sort Description The representation for the program in Metadata API. This field is a relationship field. Available in API version 61.0 and later. Relationship Name EnablementProgramDefinition Relationship Type Lookup Refers To EnablementProgramDefinition | | IsOutcomeBased | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the program includes a final, measurable outcome (true) or not (false). The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record. If this value is null, maybe the user accessed this record (LastReferencedDate) but not viewed it yet. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the program that’s visible to users. For example, AE Onboarding, Event Prep, or New Product Launch. | | NetworkId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the supported Experience Cloud site where a partner program is available. For site requirements, see [Considerations for Partner Enablement Programs](https://help.salesforce.com/s/articleView?id=sales.enablement_partner_considerations.htm&type=5&language=en_US "HTML (New Window)"). Available in API version 60.0 and later. Relationship Name Network Relationship Type Lookup Refers To Network | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the program. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PublishedDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date that the program is published. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The status of the program. Only a published program is available for an Enablement admin to assign to users or share with users so they can self-enroll. Possible values are: - Archived - Draft - Published | | TotalAssigned | Type int Properties Nillable Description The number of assignments in this program. For example, if the program is assigned to 3 users, then TotalAssigned=3. | | TotalBehind | Type int Properties Nillable Description The number of assignments that are behind in this program. For example, if the program is assigned to 3 users, and 2 users are behind on their assignments, then TotalBehind=2 | | TotalCompleted | Type int Properties Nillable Description The number of completed assignments in this program. For example, if the program is assigned to 3 users, and 1 user has completed the program, then TotalCompleted=1. | | TotalDays | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Total days of the program. This value is derived from the latest day of all items in the program, including exercises, milestones, and the outcome. This field is a calculated field. For example, a program has Task A on day 1 and Task B on day 2. Since Task B has the latest days of all tasks, then TotalDays=2. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of the program. Possible values are: - Enablement—A sales program in Lightning Experience. - PtnrEnablement—A partner program in a supported Experience Cloud site. Available in API version 60.0 and later. - EmployeeServiceEnablement—An employee enablement program in Employee Portal. Available in API version 63.0 and later. | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [EnablementProgramOwnerSharingRule](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.") (API version 60.0) Sharing rules are available for the object. [EnablementProgramShare](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.") (API version 60.0) Sharing is available for the object. <!-- document id=ac78da2d1e4db38ce20d49d895077d04dede2140eca644905638c24f228163a0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enablementprogramdefinition.md --> # EnablementProgramDefinition Represents Enablement program information in Metadata API. This object is available in API version 61.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | EnablementProgramId | Type reference Properties Filter, Group, Nillable, Sort Description The Enablement program to reference in Metadata API. This field is a relationship field. Relationship Name EnablementProgram Relationship Type Lookup Refers To EnablementProgram | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reserved for future use. Don’t edit this field. | | MasterLabel | Type string Properties Filter, Group, Sort Description Label for this EnablementProgramDefinition value. This display value is the internal label that doesn't get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. Available in API version 62.0 and later. | <!-- document id=cca46b14f3bdcef0ea9168ad04396c202b2de6176eeb12409ba9d195fda726ea url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enblmeasureobjectdefinition.md --> # EnblMeasureObjectDefinition Represents the criteria for an object that tracks the job-related activity for an Enablement measure in an Enablement program. A separate EnblMeasureObjectDefinition is used for a measure's source object and each optional related object. This object is available in API version 56.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | EnablementMeasureDefinitionId | Type reference Properties Create, Filter, Group, Sort Description The measure that the EnblMeasureObjectDefinition applies to. This field is a relationship field. Relationship Name EnablementMeasureDefinition Relationship Type Lookup Refers To EnablementMeasureDefinition | | FilterLogic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An expression that determines how to evaluate the optional field filters for the object. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reserved for future use. Don’t edit this field. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for the EnblMeasureObjectDefinition value. This display value is the internal label that doesn't get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. Available in API version 62.0 and later. | | ObjectApiName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unique name in the API for the measure's source object or optional related object that the EnblMeasureObjectDefinition describes. For example, if you're measuring the number of deals won for a specific product, this field on one EnblMeasureObjectDefinition references the API name of the Opportunity source object and this field on another EnblMeasureObjectDefinition references the API name of the Opportunity Product related object. | | SequenceNumber | Type int Properties Create, Filter, Group, Sort, Update Description A number that specifies the order of the EnblMeasureObjectDefinition, relative to other EnblMeasureObjectDefinition records under the same EnablementMeasureDefinition, starting at 1. | ## Usage An EnablementMeasureDefinition can have multiple EnblMeasureObjectDefinition references, depending on the number of related objects in the measure. Consider an example measure that tracks activity on the Opportunity source object and the Account related object. - The EnablementMeasureDefinition identifies the Opportunity source object. - An EnblMeasureObjectDefinition specifies the criteria on the Opportunity source object. - An EnblMeasureObjectDefinition specifies the criteria on the Account related object. <!-- document id=7e5b5081872320e8f306a4ca1f0b13a580074a01972f545e372152a5465df2a3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enblpgmtaskmeasureprogress.md --> # EnblPgmTaskMeasureProgress Represents a user’s progress through the object and field requirements that an Enablement measure defines for an outcome or milestone in an Enablement program. This object is available in API version 61.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - For partner users who take Partner Enablement programs, the Take Partner Enablement Programs permission is required. This permission is enabled by default as part of the Use Partner Enablement Programs permission set, which comes with the Enablement add-on license. Partner Enablement also requires a [supported Partner Relationship Management (PRM) add-on license](https://help.salesforce.com/s/articleView?id=slack.prm_support_license_template.htm&type=5&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ContributingRecordCount | Type int Properties Filter, Group, Nillable, Sort Description The number of records that qualify for a user’s progress towards completing an outcome or milestone. To qualify, the activity must meet the criteria that the corresponding Enablement measure defines for specific objects, fields, and field values. | | EnblProgramTaskMeasureId | Type reference Properties Filter, Group, Sort Description ID of the record that represents the connection between a specific Enablement measure and a specific milestone or outcome in an Enablement program. This field is a relationship field. Relationship Name EnblProgramTaskMeasure Relationship Type Lookup Refers To EnblProgramTaskMeasure | | EnblProgramTaskProgressId | Type reference Properties Filter, Group, Sort Description ID of the record that represents the progress through the milestone or outcome. This field is a relationship field. Relationship Name EnblProgramTaskProgress Relationship Type Master-detail Refers To EnblProgramTaskProgress (the master object) | | MeasureComputationResult | Type double Properties Filter, Sort Description The calculated progress through the measure’s requirements for a milestone or outcome. For example, if the measure is the dollar amount of all closed opportunities, then the field value is measured in dollars. For a composite milestone or a composite outcome, this value represents the progress through only one measure associated with the milestone or outcome. | <!-- document id=b8b0d955c88509ea5c81d9939f18f216cc528adef0ede2bb7940cc5e99bef216 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enblprogramsection.md --> # EnblProgramSection Represents an optional section in an Enablement program. A section can include other program items, such as milestones and exercises. This object is available in API version 60.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - For partner users who take Partner Enablement programs, the Take Partner Enablement Programs permission is required. This permission is enabled by default as part of the Use Partner Enablement Programs permission set, which comes with the Enablement add-on license. Partner Enablement also requires a [supported Partner Relationship Management (PRM) add-on license](https://help.salesforce.com/s/articleView?id=slack.prm_support_license_template.htm&type=5&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. Available in API version 61.0 and later. | | EnablementProgramId | Type reference Properties Filter, Group, Sort Description The Enablement program that contains the section. This field is a relationship field. Relationship Name EnablementProgram Relationship Type Lookup Refers To EnablementProgram | | Name | Type string Properties Filter, Group, idLookup, Sort Description The title of the section that’s visible to users when they take the program. | | SequenceNumber | Type int Properties Filter, Group, Sort Description A number that specifies the order of the section, relative to other sections, starting at 0. | <!-- document id=437d60d32958a3480357531ca884e17c9024269942b49b99b69cef74fdef2462 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enblprogramtaskdefinition.md --> # EnblProgramTaskDefinition Represents an outcome, a milestone, or an exercise in an Enablement program. A program task is also known as a program item. This object is available in API version 60.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - For partner users who take Partner Enablement programs, the Take Partner Enablement Programs permission is required. This permission is enabled by default as part of the Use Partner Enablement Programs permission set, which comes with the Enablement add-on license. Partner Enablement also requires a [supported Partner Relationship Management (PRM) add-on license](https://help.salesforce.com/s/articleView?id=slack.prm_support_license_template.htm&type=5&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | CompositeMilestoneType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of logic to use for evaluating the activity from two Enablement measures in a composite milestone. Possible values are: - Addition - Division - Percentage Available in API version 61.0 and later. | | CustomEnblPgmTaskSubCategoryId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the EnblProgramTaskSubCategory record associated with a custom exercise type. This field is required when the TaskSubCategory field’s value is CustomExercise. This field is a relationship field. Available in API version 62.0 and later. Relationship Name CustomEnblPgmTaskSubCategory Relationship Type Lookup Refers To EnblProgramTaskSubCategory | | Day | Type int Properties Filter, Group, Sort Description The day of the program when the item is due, relative to the program's start date. For example, if a user is expected to complete an exercise where they watch a product demo by day 2, this field’s value is 2. For an outcome, this field specifies the number of days the full program takes. For example, if your program lasts 60 days, the value of this field is 60 for the outcome. This field’s value contributes to the program’s due date that users see when they take the program. | | Description | Type textarea Properties Create Description A summary of the outcome, milestone, or exercise that’s visible to users when they take the program. | | EnablementProgramId | Type reference Properties Filter, Group, Sort Description The ID of the Enablement program that contains the outcome, milestone, or exercise. This field is a relationship field. Relationship Name EnablementProgram Relationship Type Lookup Refers To EnablementProgram | | EnblProgramSectionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of an optional program section that contains the milestone or exercise. This field is a relationship field. Relationship Name EnblProgramSection Relationship Type Lookup Refers To EnblProgramSection | | IsMilestoneAnOutcome | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the program item is the program’s final outcome (true) or an incremental milestone (false). The default value is false. | | LearningItemId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the learning item record for the outcome, milestone, or exercise. This field is a relationship field. Relationship Name LearningItem Relationship Type Lookup Refers To LearningItem | | MilestoneTarget | Type double Properties Filter, Nillable, Sort Description The target value for a user to achieve to get credit for completing the outcome or milestone. The unit depends on the specific measure used with the outcome or milestone. For example, if the measure is the dollar amount of all closed opportunities, then the field value is measured in dollars. | | MinimumSampleSize | Type int Properties Filter, Group, Nillable, Sort Description The number of records to evaluate when calculating progress for an outcome or milestone that uses an average-based measure. Use this field with MilestoneTarget. For example, if you want users to achieve an average deal size of $50,000 after closing 4 deals, then this field’s value is 4 and MilestoneTarget is 50000. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The title of the outcome, milestone, or exercise that’s visible to users when they take the program. | | SequenceNumber | Type int Properties Filter, Group, Sort Description A number that specifies the order of the milestone or exercise, relative to other milestones or exercises that have the same due date in the program or in the same section, starting at 0. This number determines the order of items that users see for that day in the program. | | StandardCustomExerciseType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Reserved for future use. | | TaskCategory | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of program item. Possible values are: - Exercise - Milestone Milestone is used for both the program’s final outcome and incremental milestones. | | TaskSubCategory | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of exercise. This value determines the content associated with the exercise. For example, if the field value is Video, the exercise must reference video content from the Enablement workspace in the Digital Experiences app. The LearningItemId field specifies the reference to that video content. Possible values are: - ActionItem - AudioRecording - CustomExercise—Available in API version 62.0 and later. - Document - FeedbackRequest - Other - OtherExercise - ScheduledEvent - StandardCustomExercise—Reserved for future use. - TextLesson - Trailhead - Video | <!-- document id=8e631ce565e229cc2ad156d0babf140848ac72d9f9f95ce7a3c43a78ce161c11 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enblprogramtaskmeasure.md --> # EnblProgramTaskMeasure Represents the connection between an Enablement measure and a specific milestone or outcome in an Enablement program. This object is available in API version 61.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To access this object, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. ## Fields | Field | Details | | --- | --- | | EnablementMeasureDefinitionId | Type reference Properties Filter, Group, Sort Description The ID of the Enablement measure to use with a milestone or outcome. This field is a relationship field. Relationship Name EnablementMeasureDefinition Relationship Type Lookup Refers To EnablementMeasureDefinition | | EnblProgramTaskDefinitionId | Type reference Properties Filter, Group, Sort Description The ID of the outcome or milestone that uses the Enablement measure. This field is a relationship field. Relationship Name EnblProgramTaskDefinition Relationship Type Master-detail Refers To EnblProgramTaskDefinition (the master object) | | SequenceNumber | Type int Properties Filter, Group, Nillable, Sort Description A number that specifies the order of the Enablement measure when multiple measures are used with one outcome or milestone, starting at 0. For example, in a composite milestone that uses the Percentage function, the measure that provides the numerator value is sequence 0 and the measure that provides the denominator value is sequence 1. | <!-- document id=39b3cbd191e987117e67d8cc0ac3a4dcb8e85d0c786ba5e18aa800bae36b0fbb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enblprogramtaskprogress.md --> # EnblProgramTaskProgress Represents a user’s progress towards completing an outcome, a milestone, or an exercise in an Enablement program. This object is available in API version 60.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - For partner users who take Partner Enablement programs, the Take Partner Enablement Programs permission is required. This permission is enabled by default as part of the Use Partner Enablement Programs permission set, which comes with the Enablement add-on license. Partner Enablement also requires a [supported Partner Relationship Management (PRM) add-on license](https://help.salesforce.com/s/articleView?id=slack.prm_support_license_template.htm&type=5&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | CompletedDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date that the user completed the outcome, milestone, or exercise. | | CompletedOnDay | Type int Properties Filter, Group, Nillable, Sort Description Number of days that the user took to complete the outcome, milestone, or exercise. | | CompletedPercent | Type percent Properties Filter, Nillable, Sort Description Percentage of the outcome, milestone, or exercise that’s complete. | | ContributingRecordCount | Type int Properties Filter, Group, Nillable, Sort Description The number of records that qualify for a user’s progress towards completing an outcome or milestone. To qualify, the activity must meet the criteria that the corresponding Enablement measure defines for specific objects, fields, and field values. Available in API version 61.0 and later. | | DueDate | Type date Properties Filter, Group, Sort Description The date the outcome, milestone, or exercise is due. | | EnblProgramTaskDefinitionId | Type reference Properties Filter, Group, Sort Description ID of the outcome, milestone, or exercise definition. This field is a relationship field. Relationship Name EnblProgramTaskDefinition Relationship Type Lookup Refers To EnblProgramTaskDefinition | | IsCompleted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the outcome, milestone, or exercise is complete (true) or not (false). The default value is false. | | IsNoLongerTracking | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If the user hasn’t completed the outcome or milestone and 30 days have elapsed since the program’s due date, the value is true. Otherwise, the value is false. The default value is false. For details, see [Completion Statuses in Enablement Analytics](https://help.salesforce.com/s/articleView?id=sales.enablement_analytics_completion_statuses.htm&type=5&language=en_US "HTML (New Window)"). | | LearningItemProgressId | Type reference Properties Filter, Group, Sort Description ID of the record that tracks the user's progress through the program that includes this outcome, milestone, or exercise. This field is a relationship field. Relationship Name LearningItemProgress Relationship Type Lookup Refers To LearningItemProgress | | MilestoneComputationResult | Type double Properties Filter, Nillable, Sort Description Derived from the associated EnblProgramTaskDefinition record. For example, if a milestone has a single measure A with a result of 5, this field’s value is 5. | | ProgressStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of the outcome, milestone, or exercise progress. Possible values are: - Behind - Completed Late - Completed On Time - No Longer Tracking - Not Completed - Overdue For details, see [Completion Statuses in Enablement Analytics](https://help.salesforce.com/s/articleView?id=sales.enablement_analytics_completion_statuses.htm&type=5&language=en_US "HTML (New Window)"). | <!-- document id=5dc2378c71b9872cebd1bf6e8dc183e9bd228adc4ccea690218aec4e46b82369 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enblprogramtasksubcategory.md --> # EnblProgramTaskSubCategory Represents a custom exercise type that an Enablement admin adds to an Enablement program in Program Builder. A custom exercise type also requires a corresponding EnblProgramTaskDefinition record for Program Builder and corresponding LearningItem and LearningItemType records for when users take the exercise in the Guidance Center. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Custom exercises aren’t compatible with Partner Enablement programs. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | Icon | Type textarea Properties Create, Update Description The icon to use for the custom exercise type in Program Builder. Use the format iconType:iconName, where the values correspond to icon categories and names from the [Salesforce Lightning Design System](https://www.lightningdesignsystem.com/icons/ "HTML (New Window)"). - iconType is the type of icon, such as standard or doctype. - iconName is the icon name, such as flow or slide. For example, to use the Standard type Flow icon, this value is standard:flow. For details, see [Implement Custom Exercise Types for Enablement Programs](https://developer.salesforce.com/docs/sales/enablement/guide/enablement-custom-exercises-intro.html "HTML (New Window)") in the _Sales Programs and Partner Tracks with Enablement Developer Guide_. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reserved for future use. Don’t edit this field. | | LearningItemTypeId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the learning item type record that represents this custom exercise type in the Guidance Center when users take a program. This field is a relationship field. Relationship Name LearningItemType Refers To LearningItemType | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for this EnblProgramTaskSubCategory value. This display value is the internal label that doesn't get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | <!-- document id=e7e2cfefc4af2e7bbd8182de59a1200bfe18f41b577a14b062b2766aaabdac33 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_engagementchanneltype.md --> # EngagementChannelType Represents a channel through which a customer can be reached for communication. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ContactPointType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The contact point type of the channel. Possible values are: - Email - InPerson—In Person - MailingAddress—Mailing Address - Phone - Social - Video - Web | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the communication subscription consent record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account owner associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [EngagementChannelTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. [EngagementChannelTypeFeed](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. [EngagementChannelTypeHistory](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. [EngagementChannelTypeOwnerSharingRule](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. [EngagementChannelTypeShare](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. <!-- document id=4b7e4a60e612980d55b860f28eb5e0f7045362ff49e44b084db6bdc06b96101d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_engagementsignal.md --> # EngagementSignal Represents data about an individual’s engagement action, such as a web click, an email response, or a PDF download. This object is available in API version 62.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | DataSpaceId | Type reference Properties Filter, Group, Sort Description Required. Unique identifier that refers to the data space where the engagement signal originates. This field is a relationship field. Relationship Name DataSpace Refers To DataSpace | | Description | Type string Properties Filter, Group, Nillable, Sort Description An optional text description of the engagement signal. | | DeveloperName | Type string Properties Filter, Group, Sort Description Required. API name for the engagement signal that's system-or user-generated. | | IsRemote | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the engagement signal object is owned by a different org in Data 360. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the engagement signal was referenced by the current user. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the current user viewed the engagement signal record. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. Text label that identifies the engagement signal. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Picklist value that indicates the current status of the engagement signal. Possible values are: - Active - CreateError—Error - DeleteError—Error - Deleting - EditError—Error - Preparing - Processing The default value is Processing. | ## Usage Use this object to define foundational data for your business objectives and recommendations in Salesforce Personalization. Use mapped data model object (DMO) fields to identify and track an individual’s engagement actions. For example, use data about a web click, an email response, or a PDF download to help achieve your personalization goals. <!-- document id=d0b03d270f5626abe68d0361f42a20445991c83110393fff2f1dfe4c767c837d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_engagementsignalcmpndmetric.md --> # EngagementSignalCmpndMetric Represents a rate metric that measures the ratio between two engagement signal metrics, such as product orders and product views to calculate a conversion rate, or email clicks and email opens to determine a click-through rate. Use this object to create complex measurements for A/B testing and web experimentation. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CompoundMetricFormula | Type string Properties Filter, Group, idLookup, Nillable, Sort Description A read-only formula field that concatenates the three core components of a Compound Metric—the primary metric, the operator, and the secondary metric—into a single string. This field is unique within your Salesforce org. This field is a calculated field. | | DenomEngmtSignalMetricId | Type reference Properties Create, Filter, Group, Sort, Update Description Points to the EngagementSignalMetric record that serves as the denominator of the compound metric. This field is a relationship field. Relationship Name DenomEngmtSignalMetric Refers To EngagementSignalMetric | | IsRemote | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the engagement signal compound metric object is owned by a different org in Data 360. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the engagement signal compound metric was referenced by the current user. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the current user viewed the engagement signal compound metric record. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. Text label that identifies the engagement signal compound metric. | | NumerEngmtSignalMetricId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Points to the EngagementSignalMetric record that serves as the numerator of the compound metric. This field is a relationship field. Relationship Name NumerEngmtSignalMetric Refers To EngagementSignalMetric | | Operator | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents the mathematical operation that combines the numerator and denominator metrics in the compound metric formula. Possible values are: - Ratio The default value is Ratio. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents the ID of the user or group that owns the engagement signal compound metric. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | ## Usage Use this object to create rate metrics for A/B testing and web experimentation. To measure the effectiveness of personalization experiences, divide the numerator metric by the denominator metric. These metrics help you make data-driven decisions to compare content performance. This object is used for measurement and isn’t used for machine learning model training. ## 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. [EngagementSignalCmpndMetricShare](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. <!-- document id=52bb1bdb7c8bcca0d6f7650eeb3495f9974ab2b7f8250cdcd0eedcdfc0c7f7cc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_engagementsignalmetric.md --> # EngagementSignalMetric Represents a measurable quantity that’s derived from an engagement signal, such as the sum of revenue or a count of clicks. Use this object to track user engagement for A/B tests, machine learning model training, and attribution configurations. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AggregateFunction | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Defines the type of calculation used on the metric field. Possible values are: - Avg - Count - Distinct - Select - Sum The default value is Count. | | EngagementSignalId | Type reference Properties Create, Filter, Group, Sort Description Required. Represents the ID of the engagement signal that’s associated with the metric. This field is a relationship field. Relationship Name EngagementSignal Relationship Type Master-detail Refers To EngagementSignal (the master object) | | IsRemote | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the engagement signal metric object is owned by a different org in Data 360. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the engagement signal metric was referenced by the current user. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the current user viewed the engagement signal metric record. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. Text label that identifies the engagement signal metric. | ## Usage These derived metrics serve as the core unit of measurement across the personalization platform. Use them to train machine learning models, measure performance in A/B tests, track outcomes in attribution models, and define custom objectives or compound metrics. <!-- document id=6df1a9cadc26e8474ca1103b9707a86b8040f3eda9a7eff1268ea00784c86776 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_enhancedletterhead.md --> # EnhancedLetterhead Represents an enhanced letterhead that can be associated with a Lightning email template that doesn’t use the Salesforce Merge Language (SML). This object is available in API version 46.0 and later. ## Supported Calls create(), delete(), describeSObjects(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the contents of the header and footer. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when this enhanced letterhead was last used. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when this enhanced letterhead was last viewed. | | LetterheadFooter | Type textarea Properties Create, Nillable, Update Description The contents of the enhanced letterhead’s footer. | | LetterheadHeader | Type textarea Properties Create, Nillable, Update Description The contents of the enhanced letterhead’s header. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the enhanced letterhead, such as Standard Company Letterhead. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [EnhancedLetterheadFeed](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. <!-- document id=a5758c4f2b589f461ff902ebb8b9d624fff554cf818c3b294ceaa23548dd77f3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_entitlement.md --> # Entitlement Represents the customer support an account or contact is eligible to receive. This object is available in API version 18.0 and later. Entitlements may be based on an asset, product, or service contract. ## Supported Calls create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Sort Description ID of the Account associated with the entitlement. | | AssetId | Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the Asset associated with the entitlement. | | AssetWarrantyID | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier of the asset warranty record. Must be a valid asset warranty ID. AssetWarranty is available only with Field Service. | | BusinessHoursId | Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the BusinessHours associated with the entitlement. | | CasesPerEntitlement | Type int Properties Filter, Group, Nillable, Sort Description The total number of cases the entitlement supports. This field is only available if IsPerIncident is true. | | ContractLineItemId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the ContractLineItem associated with the entitlement. | | EndDate | Type date Properties Create, Filter, Nillable, Update Description The last day the entitlement is in effect. | | IsPerIncident | Type boolean Properties Defaulted on create, Filter, Update Description Indicates whether the entitlement is limited to supporting a specific number of cases (true) or not (false). | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | LastViewedDate | Type date Properties Filter, Nillable, Sort, Update Description The 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. | | LocationID | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Location associated with the entitlement. | | Name | Type string Properties Create, Filter, Update Description Required. Name of the entitlement. | | SvcApptBookingWindowsId | Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description The operating hours that the entitlement’s work orders should respect. The label in the user interface is Operating Hours. Available only if Field Service is enabled. | | RemainingCases | Type int Properties Create, Filter, Nillable, Update Description The number of cases the entitlement can support. This field decreases in value by one each time a case is created with the entitlement. This field is only available if IsPerIncident is selected. | | RemainingWorkOrders | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of agreed work orders remaining to be created. | | ServiceContractId | Type reference Properties Create, Filter, Nillable, Update Description Required. ID of the ServiceContract associated with the entitlement. | | SlaProcessId | Type reference Properties Create, Filter, Nillable, Update Description ID of the SlaProcess associated with the entitlement. This field is available in version 19.0 and later. | | StartDate | Type date Properties Create, Filter, Nillable, Update Description The first date the entitlement is in effect. | | Status | Type picklist Properties Filter, Nillable Description Status of the entitlement, such as Expired. | | SvcApptBookingWindows | Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description The operating hours of the entitlement. This field is visible only if Field Service is enabled. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Nillable, Update Description The type of entitlement, such as Web or phone support. | | | | | WorkOrdersPerEntitlement | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Total number of work orders available for this entitlement. | ## 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. [EntitlementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [EntitlementFeed](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.") (API version 23.0) Feed tracking is available for the object. [EntitlementHistory](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. #### See Also - [EntitlementContact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entitlementcontact.htm "Represents a Contact eligible to receive customer support via an Entitlement. This object is available in API version 18.0 and later.") - [SlaProcess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_slaprocess.htm "Represents an entitlement process associated with an Entitlement. This object is available in API version 19.0 and later.") <!-- document id=c633bc874dd39a7c7f7e1873ecb2426796d83cfa9d29255ff9e2d95e2853ee3a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_entitlementcontact.md --> # EntitlementContact Represents a Contact eligible to receive customer support via an Entitlement. This object is available in API version 18.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Fields | Field | Details | | --- | --- | | ContactId | Type reference (master-detail to Contact) Properties Create, Filter, Group, Sort Description Required. ID of the Contact associated with the entitlement. | | EntitlementId | Type reference (master-detail to Entitlement) Properties Create, Filter Description Required. ID of the Entitlement associated with the entitlement contact. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup Description Required. Autonumber identifier for the Entitlement Contact junction record. | ## Usage Use to query and manage entitlement contacts. #### See Also - [Entitlement](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entitlement.htm "Represents the customer support an account or contact is eligible to receive. This object is available in API version 18.0 and later. Entitlements may be based on an asset, product, or service contract.") <!-- document id=806a8a0b17ee5ed017375d8a2457535b6dd406b5694105bbe0c279af446ad5b9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_entitlementtemplate.md --> # EntitlementTemplate Represents predefined terms of customer support for a product (Product2). This object is available in API version 18.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only Salesforce admins, users with access to the Case, Entitlement, or Work Order objects, and users with the View Setup and Configuration permission can access this object. ## Fields | Field | Details | | --- | --- | | BusinessHoursId | Type reference Properties Create, Filter, Nillable, Update Description ID of the BusinessHours associated with the entitlement template. Must be a valid business hours ID. | | CasesPerEntitlement | Type int Properties Create, Filter, Nillable, Update Description The total number of cases the entitlement template supports. This field is only available if IsPerIncident is true. | | IsPerIncident | Type boolean Properties Create, Defaulted on create, Filter, Update Description Indicates whether the entitlement template is limited to supporting a specific number of cases (true) or not (false). | | Name | Type string Properties Create, Filter, idLookup, Update Description Required. Name of the entitlement template. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. Available in version 34.0 and later. | | SlaProcessId | Type reference Properties Create, Filter, Nillable, Update Description ID of the SlaProcess associated with the entitlement template. This field is available in API version 19.0 and later. | | Term | Type int Properties Create, Defaulted on create, Filter, Nillable, Update Description Number of days that the entitlement template is valid. | | Type | Type picklist Properties Create, Filter, Nillable, Update Description The type of entitlement template, such as Web or phone support. | ## Usage Use this object to manage entitlement templates. <!-- document id=f9ec60b43143512081e5088d1b2f21cbf8eb18344140645bad3c8c5b9d212010 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_entityhistory.md --> # EntityHistory Represents historical information about an object’s changed field values. This object is only available to users with the “View All Data” permission. This object is unavailable beginning with API version 8.0. Use the object-specific [History](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.xml "HTML (New Window)")objects instead. ## Supported Calls describeSObjects(), getUpdated(), getDeleted(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | FieldName | Type picklist Properties Filter, Restricted picklist Description ID of the standard or custom field. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | NewValue | Type anyType Properties Nillable Description New value of the modified field. | | OldValue | Type anyType Properties Nillable Description Previous value of the modified field. | | ParentId | Type reference Properties Filter Description ID of the object that contains the field. | | ParentSobjectType | Type picklist Properties Filter, Restricted picklist Description The kind of object that contains the field. | ## Usage In API version 7.0 and later, this object works with Case, Contract, and Solution objects: - This object is always read-only in the online application. - When a field is modified, this object records both the old and new field values. There are exceptions to this behavior for certain fields such as long text areas and multi-select picklists. These fields appear in this object to indicate that the field was changed, but the old and new values are not recorded. - Two rows are added to this object when foreign key fields change. One row contains the foreign key object names that display in the online application. For example, “Jane Doe” is recorded as the name of a contact. The other row contains the actual foreign key ID that is only returned to and visible from the API. - Up to a total of twenty fields (standard or custom) can be tracked for a given object. - In the online application, you can specify which fields are tracked or not tracked at any time. - As soon as tracking is turned on for a field, all changes to its value are recorded in the database. - Turning off tracking for a field stops further changes from being recorded, but the history data is not deleted. - Be advised that deleting a custom field also permanently deletes the history data for that custom field. <!-- document id=679e2e672c73cbbcbf5ff8c7799b3c9cc61675bcf4dafe0cb345f35f9b4b72bc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_entitymilestone.md --> # EntityMilestone Represents a required step in a customer support process on a work order. The Salesforce user interface uses the term “object milestone. This object is available in API version 37.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Milestones on cases use the [CaseMilestone](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casemilestone.htm "Represents a milestone (required step in a customer support process) on a Case. This object is available in API version 18.0 and later.") object type. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() ## Special Access Rules - As of Summer ’20 and later, only Salesforce admins, users with access to the Case, Entitlement, or Work Order objects, and users with the View Setup and Configuration permission can access this object. - Entitlement management must be enabled. - Work orders or Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | ActualElapsedTimeInDays | Type double Properties Filter, Nillable, Sort Description The number of days that it took to complete a milestone. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time) ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To display this field, select **Enable stopped time and actual elapsed time** on the Entitlement Settings page and add the field to the object milestone page layout. | | ActualElapsedTimeInHrs | Type double Properties Filter, Nillable, Sort Description The number of hours that it took to complete a milestone. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time) ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To display this field, select **Enable stopped time and actual elapsed time** on the Entitlement Settings page and add the field to the object milestone page layout. | | ActualElapsedTimeInMins | Type int Properties Filter, Group, Nillable, Sort Description The number of minutes that it took to complete a milestone. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time) ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To display this field, select **Enable stopped time and actual elapsed time** on the Entitlement Settings page and add the field to the object milestone page layout. | | BusinessHoursId | Type reference Properties Filter, Group, Nillable, Sort Description The business hours on the milestone. If business hours aren’t specified, the entitlement process business hours are used. If business hours are also not specified on the entitlement process, the business hours on the record are used. | | CompletionDate | Type dateTime Properties Filter, Nillable, Sort, Update Description The date and time the milestone was completed. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | ElapsedTimeInDays | Type double Properties Filter, Nillable, Sort Description The number of days it took to complete a milestone, including time during which the milestone was stopped. Automatically calculated to include the business hours on the record. Elapsed time is calculated only after the Completion Date field is populated. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time). | | ElapsedTimeInHrs | Type double Properties Filter, Nillable, Sort Description The number of hours it took to complete a milestone, including time during which the milestone was stopped. Automatically calculated to include the business hours on the record. Elapsed time is calculated only after the Completion Date field is populated. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time). | | ElapsedTimeInMins | Type int Properties Filter, Group, Nillable, Sort Description The number of minutes it took to complete a milestone, including time during which the milestone was stopped. Automatically calculated to include the business hours on the record. Elapsed time is calculated only after the Completion Date field is populated. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time). | | IsCompleted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Green checkmark icon that indicates a milestone completion. | | IsViolated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Red exclamation point icon that indicates a milestone violation. | | MilestoneTypeId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the milestone (for instance, First Response). | | Name | Type string Properties Filter, Group, Sort, Update Description The name of the milestone. | | ParentEntityId | Type reference Properties Filter, Group, Sort Description The ID of the record—for example, a work order—that contains the milestone. | | SlaProcessId | Type reference Properties Filter, Group, Nillable, Sort Description The entitlement process associated with the milestone. | | StartDate | Type dateTime Properties Filter, Nillable, Sort, Update Description The date and time that milestone tracking started. | | StoppedTimeInDays | Type double Properties Filter, Nillable, Sort Description The number of days that an agent has been blocked from completing a milestone. For example, an agent may be waiting for a customer to reply with more information. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To display this field, select **Enable stopped time and actual elapsed time** on the Entitlement Settings page and add the field to the object milestone page layout. | | StoppedTimeInHrs | Type double Properties Filter, Nillable, Sort Description The number of hours that an agent has been blocked from completing a milestone. For example, an agent may be waiting for a customer to reply with more information. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To display this field, select **Enable stopped time and actual elapsed time** on the Entitlement Settings page and add the field to the object milestone page layout. | | StoppedTimeInMins | Type int Properties Filter, Group, Nillable, Sort Description The number of minutes that an agent has been blocked from completing a milestone. For example, an agent may be waiting for a customer to reply with more information. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To display this field, select **Enable stopped time and actual elapsed time** on the Entitlement Settings page and add the field to the object milestone page layout. | | TargetDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time to complete the milestone. | | TargetResponseInDays | Type double Properties Filter, Nillable, Sort Description The number of days to complete the milestone. Automatically calculated to include the business hours on the record. | | TargetResponseInHrs | Type double Properties Filter, Nillable, Sort Description The number of hours to complete the milestone. Automatically calculated to include the business hours on the record. | | TargetResponseInMins | Type int Properties Filter, Group, Nillable, Sort Description The number of minutes to complete the milestone. Automatically calculated to include the business hours on the record. | | TimeRemainingInDays | Type string Properties Filter, Nillable, Sort Description The days that remain before a milestone violation. Automatically calculated to include the business hours on the record. | | TimeRemainingInHrs | Type string Properties Filter, Group, Nillable, Sort Description The hours that remain before a milestone violation. Automatically calculated to include the business hours on the record. | | TimeRemainingInMins | Type string Properties Group, Nillable, Sort Description The minutes that remain before a milestone violation. Automatically calculated to include the business hours on the record. | | TimeSinceTargetInDays | Type string Properties Filter, Nillable, Sort Description The days that have elapsed since a milestone violation. Automatically calculated to include the business hours on the record. | | TimeSinceTargetInHrs | Type string Properties Filter, Nillable, Sort Description The hours that have elapsed since a milestone violation. Automatically calculated to include the business hours on the record. | | TimeSinceTargetInMins | Type string Properties Group, Nillable, Sort Description The minutes that have elapsed since a milestone violation. Automatically calculated to include the business hours on the record. | ## Usage When you create an entitlement process, you select its type based on the type of record that you want the process to run on: Case or Work Order. Processes created before Summer ’16 use the Case type. When a Work Order entitlement process runs on a work order, the resulting milestones on the work order are object milestones. Conversely, when a Case entitlement process runs on a case, the resulting milestones are case milestones, a separate standard object. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip If an entitlement has an entitlement process associated with it, don’t use the entitlement for multiple types of support records. An entitlement process works only on records that match the process’s type. For example, when a Case entitlement process is applied to an entitlement, the process runs only on cases associated with that entitlement. If a work order is also associated with the entitlement, the process doesn’t run on the work order. To ensure that the milestones you set up work as expected, associate a customer’s work orders and cases with different entitlements. Customize page layouts, validation rules, and more for object milestones from the Object Milestones node in Setup under Entitlement Management. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [EntityMilestoneFeed](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. [EntityMilestoneHistory](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. <!-- document id=b3ddf26edb7bf5a2f05b9c0d75f4bb3b1449e4f22bc1342d25d176d5072eb4e6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_entitysubscription.md --> # EntitySubscription Represents a subscription for a user following a record or another user. This object is available in API version 34.0 and later. A user can subscribe to a record or to another user. Changes to the record and updates from the users are displayed in the Chatter feed on the user's home page, which is a useful way to stay up-to-date with other users and with changes made to records in Salesforce. Feeds are available in API version 18.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Experience Cloud site where the user is following the record or user. This field is available in API version 26.0 and later, if digital experiences is enabled for your org. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the record or user which the user is following. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account, Accreditation, ActivationTarget, ActivationTrgtIntOrgAccess, ApiAnomalyEventStore, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CollaborationGroup, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContentDocument, Contract, CoverageBenefit, CoverageBenefitItem, CredentialStuffingEventStore, CreditMemo, CreditMemoLine, Dashboard, DashboardComponent, DataStream, DelegatedAccount, DocumentChecklistItem, EngagementChannelType, EnhancedLetterhead, EnrollmentEligibilityCriteria, Event, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Identifier, Image, IndividualApplication, Invoice, InvoiceLine, Lead, Location, MarketSegment, MarketSegmentActivation, MemberPlan, MessagingSession, MktCalculatedInsight, OperatingHours, Opportunity, Order, OrderItem, OtherComponentTask, PartyConsent, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, Product2, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, ProviderSearchSyncLog, PurchaserPlan, PurchaserPlanAssn, ReceivedDocument, Report, ReportAnomalyEventStore, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SessionHijackingEventStore, Shift, Shipment, ShipmentItem, Site, SkillRequirement, SocialPost, Solution, Task, ThreatDetectionFeedback, Topic, User, Visit, VisitedParty, Visitor, VoiceCall, VolunteerProject, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup, WorkTypeGroupMember | | SubscriberId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the user who is following the record or user. This is a relationship field. Relationship Name Subscriber Relationship Type Lookup Refers To User | ## Usage Consider this when following records and users: - Users can only follow records that they can see. - Users can see which records other users are following, unless they don’t have access to the records. - Administrators and users with the “Modify All Data” permission can configure a user to follow records that the user has read access to. - Administrators and users with the “Modify All Data” permission can configure users to stop following records. - Following topics is available in API version 29.0 and later. For this reason, a topic ID is now a supported value for the ParentId field. - If you deactivate a user, any EntitySubscription where the user is associated with the ParentId or SubscriberId field, meaning all subscriptions both to and from the user, are soft deleted. If the user is reactivated, the subscriptions are restored. However, if you deactivate multiple users at once and these users follow each other, their subscriptions are hard deleted. In this case, the user-to-user EntitySubscription is deleted twice (double deleted). Such subscriptions can’t be restored upon user reactivation. When using query() with EntitySubscription, - Note the following SOQL restriction. No SOQL limit if logged-in user has “View All Data” permission. If not, specify a LIMIT clause of 1,000 records or fewer. - A query using a WHERE clause can only filter by fields on the EntitySubscription object. - If user sharing is enabled and the querying user is not an administrator, a SOQL query must be constrained either by the ParentId or SubscriberId. Otherwise, the query behavior at run time is undefined, meaning the result set can be incomplete or inconsistent from invocation to invocation. For an unconstrained query, the sharing check limits imposed on a non-adminstrative user are likely to be exceeded before the query completes, because access checks are run against both parent and subject, for each row of the result set. We recommend using the Connect REST API to query EntitySubscription data instead of running a SOQL query. - Users without the “View All Data” permission - Need read access on the object associated with the ParentId field to see which users are following records for the object. - Can use an ORDER BY clause in a query only to order by fields on the EntitySubscription object. For example, if the subscription relates to an Account record, the query can ORDER BY ParentId, but it can’t ORDER BY Account.Name. - Don’t always get all matching subscriptions when running a query. For these users, a query evaluates visibility criteria on a maximum of 500 records to reduce the prospect of long-running queries. If a user runs a query to see the CEO's subscriptions, it might scan a large number of records. The query only returns matches within the first 500 records scanned. It is possible that there are more subscriptions that are visible to the user, but they are not returned. To mitigate this, we recommend using a WHERE clause, if possible, to reduce the scope of the query. ## Sample—SOQL The following SOQL query returns subscriptions for all the accounts that a subscriber is following that have more than 10 employees: SELECT Id FROM EntitySubscription WHERE SubscriberId = '005U0000000Rg2CIAS' AND ParentId IN ( SELECT Id FROM Account WHERE NumberOfEmployees > 10 ) LIMIT 200 #### See Also - [Custom Object\_\_Feed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customobject__feed.htm "Represents the feed, specifically posts and feed-tracked changes, on a custom object.") <!-- document id=7918fad019f1956ff8960647825b14da4f0c06990bb8742bb0dfd054a61b1c83 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_environmenthubmember.md --> # EnvironmentHubMember Represents a member organization in the Environment Hub. This object is available in API version 29.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can create only 20 member orgs per day. If you need to create additional orgs, log a support case in the [Salesforce Partner Community](https://partners.salesforce.com "HTML (New Window)"). For product, specify **Platform**. For topic, specify **AppExchange & Managed Packages**. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Nillable, Update Description A brief description of this org. | | DisplayName | Type string Properties Filter, Group, Nillable,Sort, Update Description The name that the user has specified for this member org. | | EnvironmentHubId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The Org ID of this member’s Environment Hub org. | | Instance | Type String Properties Filter, Group, Nillable, Sort Description Name of the instance where the Environment Hub member org resides. | | IsFedIdSsoMatchAllowed | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates if single sign-on (SSO) has been enabled based on matching the Federation ID. The default is false. | | IsSandbox | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates if the member org is a sandbox (true) or not (false). This field is available in API version 36.0 and later. | | MemberEntity | Type string Properties Filter, Group, idLookup, Sort Description The unique Org ID of the member org for this record. | | MemberType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of member org for this record. Possible values include Branch Org, Patch Org, Release Org, Sandbox Org, Trialforce Management Org, and Trialforce Source Org. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only one member type at a time is stored. Member type is determined according to this hierarchy: (1) Sandbox, (2) Release, (3) Trialforce Source Org (TSO), (4) Patch, (5) Branch, and (6) Trialforce Management Org (TMO). For example, if an org is both a sandbox and a TMO, the value of MemberType is Sandbox Org. | | Name | Type string Properties Defaulted on create, Filter, idLookup, Sort Description The name of the member org for this record. | | OrgEdition | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The org’s edition, for example, Enterprise Edition or Unlimited Edition. | | OrgStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The licensing or creation status of this org. Possible values include Active, Demo, Deleted, Free, Inactive, and Trial. | | Origin | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The method by which this org was added to the Environment Hub. Possible values are autoDiscovered, userAdded, and provisioned. | | SSOMappedUsers | Type int Properties Filter, Group, Nillable, Sort Description The total number of mapped users in this member org. This field is available in API version 36.0 and later. | | ServiceProviderId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The ID of the service provider for this member org. This field is available in API version 36.0 and later. | | ShouldAddRelatedOrgs | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description Status of the connection of related orgs to the hub. Possible values are done, notRequested, pending, and requested. | | ShouldEnableSSO | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description If SSO should be enabled when this member org is added. The default is false. | | SsoStatus | Type picklist Properties Defaulted on create, Filter, Group, Sort, Update Description If SSO has been enabled for this org. Possible values are: - Enabled—Single sign-on is enabled. - Disabled—Single sign-on is disabled. - Pending—Single sign-on is in the process of being enabled. - Failed—Single sign-on enablement failed. Contact Salesforce support for assistance. | | SsoUsernameFormula | Type string Properties Filter, Group, Nillable, Sort, Update Description The custom formula for matching users in the hub and member orgs. | ## Usage Use this object to access and modify settings of member orgs in the Environment Hub. <!-- document id=84d42e5ed9a4bbed700545222c36e1f66124aa2d3789481b8ad88cd60cc243e7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_event.md --> # Event Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - An EventRelation object can’t be related to a child event, and child events don’t include the invitee related list. - query(), delete(), and update() aren’t allowed with events related to more than one contact in API versions 25.0 and earlier. - create() and update() aren’t available for read-only fields on Lightning Experience event series. - upsert() and undelete() aren’t supported for syncing changes made to events through the API using the feature Lightning Sync. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AcceptedEventInviteeIds | Type JunctionIdList Properties Create, Update Description A string array of contact or lead IDs who accepted this event. This JunctionIdList is linked to the AcceptedEventRelation child relationship. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning Adding a JunctionIdList field name to the fieldsToNull property deletes all related junction records. This action can’t be undone. | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description Represents the ID of the related account. The AccountId is determined as follows. If the value of WhatId is any of the following objects, then Salesforce uses that object’s AccountId. - Account - Opportunity - Contract - Custom object that’s a child of Account If the value of the WhatId field is any other object, and the value of the WhoId field is a contact object, then Salesforce uses that contact’s AccountId. If your org uses Shared Activities, Salesforce uses the AccountId of the primary contact. Otherwise, Salesforce sets the value of the AccountId field to null. For information on IDs, see [ID Field Type.](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm#i1435616) This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | ActivityDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Contains the event’s due date if the IsAllDayEvent flag is set to true. Doesn’t contain the event’s latest due date if the IsAllDayEvent flag is set to false. When IsAllDayEvent flag is set to true, use ActivityDateTime or StartDateTime. This field is a date field with a timestamp that’s always set to midnight in the Coordinated Universal Time (UTC) time zone. Don’t attempt to alter the timestamp to account for time zone differences. Label is **Due Date Only**. This field is required in API versions 12.0 and earlier if the IsAllDayEvent flag is set to true. The value for this field and StartDateTime must match, or one of them must be null. | | ActivityDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Contains the event’s due date if the IsAllDayEvent flag is set to false. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate. Label is **Due Date Time**. This field is required in API versions 12.0 and earlier if the IsAllDayEvent flag is set to false. The value for this field and StartDateTime must match, or one of them must be null. | | ClientGuid | Type string Properties Filter, Group, Nillable, Sort Description The client globally unique identifier identifies the external API client used to create the event. Label is **Client GUID**. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | DeclinedEventInviteeIds | Type JunctionIdLIst Properties Create, Update Description A string array of contact, lead, or user IDs who declined this event. This JunctionIdList is linked to the DeclinedEventRelation child relationship. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning Adding a JunctionIdList field name to the fieldsToNull property deletes all related junction records. This action can’t be undone. | | Description | Type textarea Properties Create, Nillable, Update Description Contains a text description of the event. Limit: 32,000 characters. | | Division | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled. | | DurationInMinutes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Contains the event length, in minutes. Even though this field represents a temporal value, it’s an integer type—not a Date/Time type. Required in API versions 12.0 and earlier if IsAllDayEvent is false. In API versions 13.0 and later, this field is optional, depending on the following: - If IsAllDayEvent is true, you can supply a value for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time. If both fields are null, the duration defaults to one day. - If IsAllDayEvent is false, a value must be supplied for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time. If the multiday event feature is enabled, then API versions 13.0 and later support values greater than 1440 for the DurationInMinutes field. API versions 12.0 and earlier can’t access event objects whose DurationInMinutes is greater than 1440. For more information, see [**Multiday Events**](# "Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities."). Depending on your API version, errors with the DurationInMinutes and EndDateTime fields may appear in different places. - Versions 38.0 and before—Errors always appear in the DurationInMinutes field. - Versions 39.0 and later—If there’s no value for the DurationInMinutes field, errors appear in the EndDateTime field. Otherwise, they appear in the DurationInMinutes field. | | EndDate | Type date Properties Filter, Group, Nillable, Sort Description Read-only. Available in API versions 46.0 and later. This field supplies the date value that appears in the EndDateTime field. This field is a date field with a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. | | EndDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Available in API versions 13.0 and later. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate. This field is optional, depending on the following: - If IsAllDayEvent is true, you can supply a value for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time. If both fields are null, the duration defaults to one day. - If IsAllDayEvent is false, a value must be supplied for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time. Depending on your API version, errors with the DurationInMinutes and EndDateTime fields may appear in different places. - Versions 38.0 and before—Errors always appear in the DurationInMinutes field. - Versions 39.0 and later—If there’s no value for the DurationInMinutes field, errors appear in the EndDateTime field. Otherwise, they appear in the DurationInMinutes field. | | EventSubtype | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Provides standard subtypes to facilitate creating and searching for events. This field isn’t updateable. | | EventWhoIds | Type JunctionIdList Properties Create, Update Description A string array of contact or lead IDs used to create many-to-many relationships with a shared event. EventWhoIds is available when the shared activities setting is enabled. The first contact or lead ID in the list becomes the primary WhoId if you don’t specify a primary WhoId. If you set the EventWhoIds field to null, all entries in the list are deleted and the value of WhoId is added as the first entry. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning Adding a JunctionIdList field name to the fieldsToNull property deletes all related junction records. This action can’t be undone. | | GroupEventType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Read-only. Available in API versions 19.0 and later. The possible values are: - 0 (Non–group event)—An event with no invitees. - 1 (Group event)—An event with invitees. - 2 (Proposed event)—An event created when a user requests a meeting with a contact, lead, or person account using the Salesforce user interface. When the user confirms the meeting, the proposed event becomes a group event. You can’t create, edit, or delete proposed events in the API. This value is no longer used in API version 41.0 and later. - 3 (IsRecurrence2 Series Pattern)—An event representing a template for a series recurrence pattern in Lightning Experience. You can't view, create, edit, or delete these events in the API. | | IsAllDayEvent | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the ActivityDate field (true) or the ActivityDateTime field (false) is used to define the date or time of the event. Label is **All-Day Event**. See also [DurationInMinutes](# "Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities.") and [EndDateTime](# "Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities."). | | IsArchived | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event has been archived. | | IsChild | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event is a child of another event (true) or not (false). For a child event, you can update IsReminderSet and ReminderDateTime only. You can query and delete a child event. If the objects related to the child event are different from those objects related to the parent event (this difference is possible if you use API version 25.0 or earlier) and one of the objects related to the child event is deleted, the objects related to the parent event are updated to ensure data integrity. | | IsClientManaged | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event is managed by an external client. If the value of this field is false, the event isn’t owned or managed by an external client, and Salesforce can be used to update it. If the value is true, Salesforce can be used to change only noncritical fields on the event. Label is **Is Client Managed**. | | IsGroupEvent | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event is a group event—that is, whether it has invitees (true) or not (false). | | IsPrivate | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether users other than the creator of the event can (false) or can’t (true) see the event details when viewing the event user’s calendar. However, users with the View All Data or Modify All Data permission can see private events in reports and searches, or when viewing other users’ calendars. Private events can’t be associated with opportunities, accounts, cases, campaigns, contracts, leads, or contacts. Label is **Private**. | | IsRecurrence | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether a Salesforce Classic event is scheduled to repeat itself (true) or only occurs one time (false). This field is read-only when updating records, but not when creating them. If this field value is true, then RecurrenceEndDateOnly, RecurrenceStartDateTime, RecurrenceType, and any recurrence fields associated with the given recurrence type must be populated. Label is **Create recurring series of events**. | | IsRecurrence2 | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. This field is available in API version 44.0 and later. Indicates whether a Lightning Experience event is scheduled to repeat (true) or only occurs one time (false). If this field value is true, then Recurrence2PatternText and Recurrence2PatternVersion must be populated. Label is **Repeat**. | | IsRecurrence2Exception | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether an individual event in a series is different from the other events in the series, making it an exception. Changes made to the series aren’t made to an event that is an exception. Available in API version 44.0 and later. Read-only in API version 66 and earlier. | | IsRecurrence2Exclusion | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. This field is available in API version 44.0 and later. Indicates when updates to a Lightning Experience event series recurrence pattern have been made, but affect future event occurrences only. For past event occurrences, IsRecurrence2Exclusion is set to true, excluding past occurrences from the series recurrence pattern. | | IsReminderSet | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the activity is a reminder (true) or not (false). To set IsReminderSet to true, the ReminderDateTime field must contain a valid date and time to trigger the reminder. | | IsVisibleInSelfService | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether an event associated with an object can be viewed in the Customer Portal (true) or not (false). If your org has enabled digital experiences, events marked IsVisibleInSelfService are visible to any external user in the Experience Cloud site, as long as the user has access to the record the event was created on. This field is available when - Customer Portal or partner portal is enabled OR - Digital experiences is enabled and you have Customer Portal or partner portal licenses | | Location | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Contains the location of the event. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Contains the ID of the user or public calendar who owns the event. Label is **Assigned to ID**. This is a polymorphic relationship field. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important By default, the event is assigned to the user who created it. If the event is created by the Automated Process user, add a different value for OwnerId. The Automated Process user isn’t a valid value for the OwnerId field. Relationship Name Owner Relationship Type Lookup Refers To Calendar, User | | Recurrence2PatternStartDate | Type dateTime Properties Filter, Nillable, Sort Description Read-only. This field is available in API version 44.0 and later. Indicates the date and time when the Lightning Experience event series begins. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate. | | Recurrence2PatternText | Type textarea Properties Create, Nillable Description The RRULE that describes the recurrence pattern for Lightning Experience event series. Supports a subset of the RFC 5545 standard for internet calendaring and scheduling. See the Event Series section in this topic for usage examples. This field has a maximum length of 512 characters. This field is available in API version 44.0 and later, and has the Create property in API version 52.0 and later. | | Recurrence2PatternTimeZone | Type string Properties Filter, Group, Nillable, Sort Description This field is available in API version 44.0 and later. Indicates the time zone in which the Lightning Experience event series was created or updated. This field uses standard Java TimeZone IDs. For example, America/Los\_Angeles. | | Recurrence2PatternVersion | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Description For internal use only. This field is available in API version 44.0 and later. | | RecurrenceActivityId | Type reference Properties Filter, Group, Nillable, Sort Description Read-only. Not required on create. Contains the ID of the main record of the Salesforce Classic recurring event. Subsequent occurrences have the same value in this field. | | RecurrenceDayOfMonth | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the day of the month on which the event repeats. | | RecurrenceDayOfWeekMask | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the day or days of the week on which the Salesforce Classic recurring event repeats. This field contains a bitmask. The values are as follows: - Sunday = 1 - Monday = 2 - Tuesday = 4 - Wednesday = 8 - Thursday = 16 - Friday = 32 - Saturday = 64 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20. | | RecurrenceEndDateOnly | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the last date on which the event repeats. For multiday Salesforce Classic recurring events, this date is the day on which the last occurrence starts. This field is a date field with a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. Don’t attempt to alter the timestamp to account for time zone differences. | | RecurrenceInstance | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the frequency of the Salesforce Classic event’s recurrence. For example, 2nd or 3rd. | | RecurrenceInterval | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the interval between Salesforce Classic recurring events. | | RecurrenceMonthOfYear | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the month in which the Salesforce Classic recurring event repeats. | | RecurrenceStartDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date and time when the Salesforce Classic recurring event begins. The value must precede the RecurrenceEndDateOnly. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate. | | RecurrenceTimeZoneSidKey | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the time zone associated with a Salesforce Classic recurring event. For example, “UTC-8:00” for Pacific Standard Time. | | RecurrenceType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how often the Salesforce Classic event repeats. For example, daily, weekly, or every nth month (where “nth” is defined in RecurrenceInstance). | | ReminderDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Represents the time when the reminder is scheduled to fire, if IsReminderSet is set to true. If IsReminderSet is set to false, then the user may have deselected the reminder checkbox in the Salesforce user interface, or the reminder has already fired at the time indicated by the value. | | ShowAs | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how this event appears when another user views the calendar: Busy, Out of Office, or Free. Label is **Show Time As**. | | StartDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the start date and time of the event. Available in versions 13.0 and later. If the Event IsAllDayEvent flag is set to true (indicating that it’s an all-day Event), then the event start date information is contained in the StartDateTime field. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate. If the Event IsAllDayEvent flag is set to false (indicating that it isn’t an all-day event), then the event start date information is contained in the StartDateTime field. The time portion is always transferred in the Coordinated Universal Time (UTC) time zone. You need to translate the time portion to or from a local time zone for the user or the application, as appropriate. If this field has a value, then ActivityDate and ActivityDateTime must either be null or match the value of this field. | | Subject | Type combobox Properties Create, Filter, Nillable, Sort, Update Description The subject line of the event, such as Call, Email, or Meeting. Limit: 255 characters. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the event type, such as Call, Email, or Meeting. | | UndecidedEventInviteeIds | Type JunctionIdList Properties Create, Update Description A string array of contact, lead, or user IDs who are undecided about this event. This JunctionIdList is linked to the UndecidedEventRelation child relationship. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning Adding a JunctionIdList field name to the fieldsToNull property deletes all related junction records. This action can’t be undone. | | WhatCount | Type int Properties Filter, Group, Nillable, Sort Description Available if your organization has enabled Shared Activities. Represents the count of related EventRelations pertaining to the WhatId. The count of the WhatId must be 1 or less. | | WhatId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The WhatId represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. WhatIds are polymorphic. Polymorphic means a WhatId is equivalent to the ID of a related object. The label is Related To ID. This is a polymorphic relationship field. Relationship Name What Relationship Type Lookup Refers To Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CommSubscriptionConsent, ContactEncounter, ContactEncounterParticipant, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem, CreditMemo, DelegatedAccount, DocumentChecklistItem, EnrollmentEligibilityCriteria, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, ListEmail, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PartyConsent, PersonLifeEvent, PlanBenefit, PlanBenefitItem, ProcessException, Product2, ProductItem, ProductRequest, ProductRequestLineItem, ProductTransfer, PurchaserPlan, ReceivedDocument, ResourceAbsence, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, Shift, Shipment, ShipmentItem, Solution, Visit, VisitedParty, VolunteerProject, WorkOrder, WorkOrderLineItem | | WhoCount | Type int Properties Filter, Group, Nillable, Sort Description Available to organizations that have Shared Activities enabled. Represents the count of related EventRelations pertaining to the WhoId. | | WhoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is Name ID. If Shared Activities is enabled, the value of this field is the ID of the related lead or primary contact. If you add, update, or remove the WhoId field, you might encounter problems with triggers, workflows, and data validation rules that are associated with the record. The label is Name ID. If the JunctionIdList field is used, all WhoIds are included in the relationship list. Beginning in API version 37.0, if the contact or lead ID in the WhoId field isn't in the EventWhoIds list, no error occurs and the ID is added to the EventWhoIds as the primary WhoId. If WhoId is set to null, an arbitrary ID from the existing EventWhoIds list is promoted to the primary position. This is a polymorphic relationship field. Relationship Name Who Relationship Type Lookup Refers To Contact, Lead | ## Usage Use Event to manage calendar appointments. **Querying and Filtering Events** Queries on events are denied before they time out if they involve amounts of data that are deemed too large. In such cases, the exception code OPERATION\_TOO\_LARGE is returned. If you receive OPERATION\_TOO\_LARGE, refactor your query to return or scan a smaller amount of data. When querying for events with a specific due date, you must filter on both the ActivityDateTimeand and ActivityDate fields. For example to find all events with a due date of February 14, 2003, you need two filters: - One filter with the ActivityDate field equal to the Coordinated Universal Time (UTC) time zone on February 14, 2003. - One filter with the ActivityDate field greater than or equal to midnight on February 14, 2003 in the user’s local time zone AND less than or equal to midnight on February 15, 2003 in the user’s local time zone. Alternatively, in API version 13.0 and later, you can find events with a specific due date by filtering on StartDateTime. For example, to find all events with a due date of February 14, 2003, filter with the StartDateTime greater than or equal to midnight on February 14, 2003 in the user's local time zone AND less than or equal to midnight on February 15, 2003 in the user's local time zone. The EventId field of an EventRelation object always points to the master record. An invitee on a group event can query the EventRelation object to view the master record. **Multiday Events** - Multiday events are available in API version 13.0 and later. Also, in earlier versions SOQL queries don’t return multiday events. - Multiday events are enabled through the user interface from Setup by entering Activity Settings in the Quick Find box, then selecting **Activity Settings**. - If the multiday event feature is enabled, then API versions 13.0 and later support values greater than 1440 for the DurationInMinutes field. API versions 12.0 and earlier can’t access event objects whose DurationInMinutes is greater than 1440. - Multiday events can’t exceed 14 days. **Event Series and Recurring Events** In Lightning Experience, events with multiple occurrences are called event series, and are indicated when the IsRecurrence2 field is set to true. In Salesforce Classic, events with multiple occurrences are called recurring events, and are indicated when the IsRecurrence field is set to true. Both fields can’t be set to true for the same event. - Lightning Experience event series are available in API version 44.0 and later as read-only fields. Recurrence patterns, specified by the Recurrence2PatternText field, are creatable in API version 52.0 and later. Salesforce Classic recurring events are available in API version 7.0 and later. In earlier versions, SOQL queries don’t return any Lightning Experience event series. - After an event is created, you can’t change the values of IsRecurrence2 or IsRecurrence from true to false or vice versa. - You can’t set fields associated with IsRecurrence2 for events where IsRecurrence is set to true, or vice versa. - For Lightning Experience event series where IsRecurrence2 is true, if you’d like to delete a single or all remaining events, use the REST API call. For Salesforce Classic recurring events where IsRecurrence is true, all past and future events in the series are removed when you delete the recurring event series through the API. However, when you delete the recurring event series through the user interface, only future occurrences are removed. - For Lightning Experience event series in API version 58.0 and later, when you change a future event, events in the entire series also change. When you change a past event, IsRecurrence2Exception is set to true and only that past event changes. - When creating a Salesforce Classic recurring event series, the duration of the event must be 24 hours or less. When the Salesforce Classic recurring event series is created, you can extend the length of individual occurrences beyond 24 hours if Multiday events are enabled; see **Multiday Events**. - For Salesforce Classic recurring events, RecurrenceStartDateTime, RecurrenceEndDateOnly, RecurrenceType, and any properties associated with the given recurrence type (see the Recurrence Field Usage for Salesforce Classic Recurring Events table) must be populated. - When updating a Salesforce Classic recurring event series, it’s not possible to update the EventRelation for the event series object and the EventRelation for the series object occurrences at the same time. - Lightning Experience event series have no series ID, so it’s not possible to locate other occurrences in the series. In Salesforce Classic recurring events, you can use RecurrenceActivityId to locate other occurrences. - For both Lightning Experience event series and Salesforce Classic recurring events, when a series repeats every day, month, or year, you can only schedule occurrences one time per day, month, or year. The week option lets you schedule occurrences multiple days per week. [Limits for Lightning Experience event series](https://help.salesforce.com/s/articleView?id=sales.creating_events_lex.htm&type=5&language=en_US "HTML (New Window)") and [limits for Salesforce Classic recurring events](https://help.salesforce.com/s/articleView?id=sales.creating_events_cex.htm&type=5&language=en_US "HTML (New Window)") also apply. **Lightning Experience Event Series and Recurring Events** Use the Recurrence2PatternText field to specify the recurrence pattern for Lightning Experience event series. These recurrence patterns, called reference rules or RRULES, support a subset of the RFC 5545 standards. This table includes common RRULE examples. | Recurrence Pattern | RRULE Example | | --- | --- | | Every day for five days | RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5 | | Every Monday, Tuesday, Wednesday, Thursday, and Friday with no end date | RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR | | Every two weeks on Monday and Friday for 10 occurrences | RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,FR;COUNT=10 | | Monthly on the first day of the month until January 1, 2020 | RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=1;UNTIL=20200101T100000Z | | Yearly on July 4th for three years (in this example, specify the date using StartDateTime) | RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=7;BYMONTHDAY=4;COUNT=3 | | Daily until January 1, 2022 with no end date | RRULE:FREQ=DAILY;UNTIL=20220101T000000Z | | Every third Friday of the month with no end date | RRULE:FREQ=MONTHLY;BYSETPOS=3;BYDAY=FR | The RRULE defined by Recurrence2PatternText supports a subset of the RFC 5545 standard for internet calendaring and scheduling. Supported RRULE parts include FREQ, BYMONTH, BYMONTHDAY, BYDAY, WKST, BYSETPOS, INTERVAL, UNTIL, and COUNT. When the event record is saved, the RRULE might be modified to follow the required format: - The RRULE parts are placed in the following order: FREQ, BYMONTH, BYMONTHDAY, BYDAY, WKST, BYSETPOS, INTERVAL, UNTIL, and COUNT. - Any missing default values are inserted. For example, if the RRULE doesn't include INTERVAL, then INTERVAL=1 is added. - The RRULE is prefaced with RRULE: if that preface is missing. <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d729324e3457">RRULE Part</th> <th class="featureTableHeader " id="d729324e3460">Supported RFC 5545 Implementation</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">FREQ</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">Required. Indicates the type of recurrence rule. Allowed values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">DAILY</samp>—supported parts include FREQ, INTERVAL, UNTIL, and COUNT. </li> <li class="li"> <samp class="codeph nolang">WEEKLY</samp>—supported parts include INTERVAL, UNTIL, COUNT, BYDAY, and WKST. BYDAY is required, but can't be preceded by a number.<p class="p">For example, to indicate weekly on Tuesday and Thursday until September 1, 2023, use <samp class="codeph nolang">RRULE:FREQ=WEEKLY;UNTIL=20230901T000000Z;BYDAY=TU,TH</samp></p> </li> <li class="li"> <samp class="codeph nolang">MONTHLY</samp>—supported patterns include:<ul class="ul bulletList"> <li class="li">BYMONTHDAY<p class="p">For example, to indicate monthly on the third day of the month use: <samp class="codeph nolang">RRULE:FREQ=MONTHLY;BYMONTHDAY=3</samp></p> </li> <li class="li">BYDAY and BYSETPOS<p class="p">For example, to indicate the last weekday of the month, use <samp class="codeph nolang">RRULE:FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1</samp></p> </li> <li class="li">BYDAY, where the BYDAY values are specified with a numeric value<p class="p">For example, to indicate monthly on the first Friday for 10 occurrences, use <samp class="codeph nolang">RRULE:FREQ=MONTHLY;COUNT=10;BYDAY=1FR</samp> </p> </li> </ul> </li> <li class="li"> <samp class="codeph nolang">YEARLY</samp>—supported patterns include:<ul class="ul bulletList"> <li class="li">BYMONTH, BYDAY, and BYSETPOS<p class="p">For example, to indicate every year on the second Friday of January, use <samp class="codeph nolang">RRULE:FREQ=YEARLY;BYMONTH=1;BYDAY=FR;BYSETPOS=2</samp></p> </li> <li class="li">BYMONTH and BYMONTHDAY<p class="p">For example, to indicate every year on October 31, use <samp class="codeph nolang">RRULE:FREQ=YEARLY;BYMONTH=10;BYMONTHDAY=31</samp></p> <p class="p">For example, to create a maintenance pattern such as twice in May, and September on 7th and 15th; and one time in June/July/August on the 1st, use two RRULEs: <samp class="codeph nolang">RRULE: FREQ=MONTHLY; BYMONTH=5,9; BYMONTHDAY=7, 15</samp> <samp class="codeph nolang">RRULE:FREQ=MONTHLY; BYMONTH=6,7,8; BYMONTHDAY=1</samp> </p> </li> </ul> </li> </ul> </td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">BYMONTH</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">The month. Valid values are <samp class="codeph nolang">1</samp> to <samp class="codeph nolang">12</samp>. </td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">BYMONTHDAY</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">The day of the month. Valid values are <samp class="codeph nolang">1</samp> to <samp class="codeph nolang">31</samp>. If BYMONTHDAY is <samp class="codeph nolang">31</samp> and the month has fewer than 31 days, the event is created on the last day of the month.</td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">BYDAY</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">A comma-separated list of days of the week. Valid values are <samp class="codeph nolang">SU</samp>, <samp class="codeph nolang">MO</samp>, <samp class="codeph nolang">TU</samp>, <samp class="codeph nolang">WE</samp>, <samp class="codeph nolang">TH</samp>, <samp class="codeph nolang">FR</samp>, <samp class="codeph nolang">SA</samp>. For RRULES with yearly or monthly frequency, BYDAY must be one of:<ul class="ul bulletList"> <li class="li">a single day</li> <li class="li">weekend days</li> <li class="li">weekdays</li> <li class="li">every day of the week</li> </ul> <p class="p">Each BYDAY value can be preceded by an integer that indicates the nth occurrence of a specific day within the monthly or yearly RRULE. Allowed values are <samp class="codeph nolang">-1</samp>, <samp class="codeph nolang">1</samp>, <samp class="codeph nolang">2</samp>, <samp class="codeph nolang">3</samp>, and <samp class="codeph nolang">4</samp>. You can't use different numbers in the BYDAY values. For example, this RRULE isn’t supported: <samp class="codeph nolang">RRULE:FREQ=MONTHLY;INTERVAL=2;COUNT=10;BYDAY=1SU,-1SU </samp> If BYDAY values are prefaced with a number, the RRULE can't include BYSETPOS. </p> </td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">WKST</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">Specifies the day on which the workweek starts. Valid values are <samp class="codeph nolang">MO</samp>, <samp class="codeph nolang">TU</samp>, <samp class="codeph nolang">WE</samp>, <samp class="codeph nolang">TH</samp>, <samp class="codeph nolang">FR</samp>, <samp class="codeph nolang">SA</samp>, and <samp class="codeph nolang">SU</samp>. Default value is based on the user's locale. </td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">BYSETPOS</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">A comma-separated list of values that correspond to the nth occurrence within the set of recurrence instances specified by the rule. Valid values are <samp class="codeph nolang">-1</samp>, <samp class="codeph nolang">1</samp>, <samp class="codeph nolang">2</samp>, <samp class="codeph nolang">3</samp>, or <samp class="codeph nolang">4</samp>. Default value is <samp class="codeph nolang">1</samp>.<p class="p">For example, to indicate the last weekday of the month, use: <samp class="codeph nolang">RRULE:FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1</samp></p> </td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">INTERVAL</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">The repetition interval. Valid values are:<ul class="ul bulletList"> <li class="li">an integer between <samp class="codeph nolang">1</samp> and <samp class="codeph nolang">999</samp> if FREQ=DAILY</li> <li class="li">an integer between <samp class="codeph nolang">1</samp> and <samp class="codeph nolang">99</samp> if FREQ=WEEKLY or FREQ=MONTHLY</li> <li class="li"> <samp class="codeph nolang">1</samp> if FREQ=YEARLY </li> </ul> Default value is <samp class="codeph nolang">1</samp>.</td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">UNTIL</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">Specifies the datetime in UTC format when the recurrence rule stops. The supported format is yyyyMMddTHHmmssZ, for example: 20210419T083000Z. <p class="p">An RRULE can't contain both UNTIL and COUNT. A recurring event without either UNTIL or COUNT repeats indefinitely.</p> </td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">COUNT</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">The number of occurrences. Allowed values are 1 to 999. <p class="p">An RRULE can't contain both UNTIL and COUNT. A recurring event without either UNTIL or COUNT repeats indefinitely.</p> </td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">BYWEEKNO</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">Specifies a comma-separated list of values that specify weeks of the year. Valid values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">1</samp> to <samp class="codeph nolang">53</samp> </li> <li class="li"> <samp class="codeph nolang">-53</samp> to <samp class="codeph nolang">-1</samp> </li> </ul> <p class="p">For example, to indicate specific weeks in a year, use: <samp class="codeph nolang">RRULE: BYWEEKNO=20, -20</samp>. </p> <p class="p">This rule part can’t be used when the FREQ rule part is set to anything other than YEARLY. For example, 3 represents the third week of the year. </p> <p class="p">Note: Assuming a Monday week start, week 53 can only occur when Thursday is January 1 or if it’s a leap year and Wednesday is January 1.</p> </td> </tr> <tr> <td class="entry" headers="d729324e3457" data-title="RRULE Part">BYYEARDAY</td> <td class="entry" headers="d729324e3460" data-title="Supported RFC 5545 Implementation">Specifies a comma-separated list of values that specify days of the year. Valid values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">1</samp> to <samp class="codeph nolang">366</samp> </li> <li class="li"> <samp class="codeph nolang">-366</samp> to <samp class="codeph nolang">-1</samp> </li> </ul> <p class="p">For example, to indicate specific days in a year, use: <samp class="codeph nolang">RRULE:BYYEARDAY=1,100,200</samp>; or, <samp class="codeph nolang">RRULE:BYYEARDAY=1,-2</samp>. </p> </td> </tr> </tbody> </table> **Salesforce Classic Event Series and Recurring Events** This table describes the usage of recurrence fields for Salesforce Classic recurring events. Each recurrence type must have all of its properties set. All unused properties must be set to null. | RecurrenceType Value | Properties | Example Pattern | | --- | --- | --- | | RecursDaily | RecurrenceInterval | Every second day | | RecursEveryWeekday | RecurrenceDayOfWeekMask | Every weekday - can’t be Saturday or Sunday | | RecursMonthly | RecurrenceDayOfMonth RecurrenceInterval | Every second month, on the third day of the month | | RecursMonthlyNth | RecurrenceInterval RecurrenceInstance RecurrenceDayOfWeekMask | Every second month, on the last Friday of the month | | RecursWeekly | RecurrenceInterval RecurrenceDayOfWeekMask | Every three weeks on Wednesday and Friday | | RecursYearly | RecurrenceDayOfMonth RecurrenceMonthOfYear | Every March on the 26th day of the month | | RecursYearlyNth | RecurrenceDayOfWeekMask RecurrenceInstanceRecurrenceMonthOfYear | The first Saturday in every October | **Attendees, Invitees, and Resources** The field GroupEventType indicates that event participants are included on an event. You can add a resource to an event only when the resource is available. The only attendance status that can be assigned to resources is Accepted. Events can’t be saved when resources you’ve added aren’t available. Child attendee events aren’t supported in Apex Triggers. When a recurring event has attendees, Salesforce creates child event records for each attendee for each recurrence. However, these child attendee event records don’t appear in Trigger.new or other trigger context variables. Only the host’s event records are accessible in the trigger context. **JunctionIdList** To create an event using JunctionIdList, IDs are pulled from the related contacts and both the event and the EventRelation records are created in one API call. If the EventRelation fails, the event is rolled back because it’s all done in a single API call. public void createEventNew(Contact\[\] contacts) { String\[\] contactIds = new String\[contacts.size()\]; for (int i = 0; i < contacts.size(); i++) { contactIds\[i\] = contacts\[i\].getID(); } Event event = new Event(); event.setSubject("New Event"); event.setEventWhoIds(contactIds); SaveResult\[\] results = null; try { results = connection.create(new Event\[\] { task }); } catch (ConnectionException ce) { ce.printStackTrace(); } } **Syncing Events with Lightning Sync** Attendee statuses (Accepted or Maybe, Declined, or No Response) sync from Microsoft® Exchange or Google to Salesforce, but not from Salesforce to Exchange or Google. Be wary of creating API flows that update attendee status in Salesforce for users set up to sync both ways. Eventually the original Exchange or Google status overrides the update made in Salesforce. **Shared Field-Level Security for Event and Task Objects** Metadata deployments for the Event object must include the field-level security for the Task object. Shared field-level security prevents each object from changing the field-level security of the associated object. Metadata deployments that include field-level security for only one of either the Event or Task objects can cause field-level security changes to the other object that aren't reflected in the metadata. - If field-level security is enabled for one object, then field-level security is enabled for both objects. - If field-level security is disabled for one object, then it's disabled for both objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note A missing entry in the metadata is treated as field-level security being disabled. ## 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. [EventChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [EventFeed](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.") (API version 20.0) Feed tracking is available for the object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=1ac0b41bf6db4d57d6b3ddc0d0c562aba0eb988b04d4399fb47f80e3183e42de url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventbussubscriber.md --> # EventBusSubscriber Represents a trigger, process, or flow that’s subscribed to a platform event or a change data capture event. Doesn’t include CometD or Pub/Sub API subscribers. ## Supported Calls describeSObjects(), query() ## Special Access Rules EventBusSubscriber is read only and can only be queried. As of Summer ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field | Details | | --- | --- | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description The ID of the subscriber. For example, the trigger ID. | | IsPartitioned | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the platform event Apex trigger is configured with parallel subscriptions (true) or not (false). The default value is false. See [Platform Event Processing at Scale with Parallel Subscriptions for Apex Triggers](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_ps.htm) in the Platform Events Developer Guide. This field is available in API version 62.0 and later. | | LastError | Type string Properties Filter, Group, Nillable, Sort Description The error message that the last thrown EventBus.RetryableException contains. This field applies to Apex triggers only. Available in API version 43.0 and later. | | LastProcessed | Type string Properties Filter, Group, Nillable, Sort Description The replay ID of the last event that the subscriber processed. This field replaces Position as of API level 66.0. | | LastPublished | Type string Properties Filter, Group, Nillable, Sort Description The replay ID of the last published event. This field replaces Tip as of API level 66.0. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For high-volume platform events and change events, the value for Tip isn’t available and is always -1. | | Name | Type string Properties Filter, Group, Nillable, Sort Description The name of the subscribed item, such as the trigger or process name. If the subscribed item’s name is “Process”, at least one flow Pause element is subscribed to the event. | | Position | Type int Properties Filter, Group, Nillable, Sort Description The replay ID of the last event that the subscriber processed. This field has been deprecated as of API level 66.0 and should no longer be used. Use LastProcessed instead. This field may not be properly represented if the value exceeds the maximum integer size. | | Retries | Type int Properties Filter, Group, Nillable, Sort Description The number of times the trigger was retried due to throwing the EventBus.RetryableException. This field applies to Apex triggers only. Available in API version 43.0 and later. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the status of the subscriber. Can be one of these values: - Error— The subscriber was disconnected and stopped receiving published events. A trigger reaches this state when it exceeds the number of maximum retries with the EventBus.RetryableException. Trigger assertion failures and unhandled exceptions don’t cause the error state. We recommend limiting the retries to fewer than nine times to avoid reaching this state. When you fix and save the trigger, or for a managed package trigger, if you redeploy the package, the trigger resumes automatically from the tip, starting from new events. Also, you can resume a trigger subscription in the subscription detail page that you access from the platform event page. - Repartitioning—The system is in the process of modifying the trigger's parallel subscription configuration. - Running—The subscriber is actively listening to events. If you modify the subscriber, the subscription continues to process events. - Suspended—The subscriber is disconnected and can’t receive events because a Salesforce admin suspended it or due to an internal error. You can resume a trigger subscription in the subscription detail page that you access from the platform event page. To resume a process, deactivate it and then reactivate it. If you modify the subscriber, the subscription resumes automatically from the tip, starting from new events. For more information, see [View and Manage an Event’s Subscribers on the Platform Event’s Detail Page](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_get_subscribers_apex.htm "HTML (New Window)") in the Platform Events Developer Guide. | | Tip | Type int Properties Filter, Group, Nillable, Sort Description The replay ID of the last published event. This field has been deprecated as of API level 66.0 and should no longer be used. Use LastPublished instead. This field may not be properly represented if the value exceeds the maximum integer size. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For high-volume platform events and change events, the value for Tip isn’t available and is always -1. | | Topic | Type string Properties Filter, Group, Nillable, Sort Description The name of the subscription channel that corresponds to a platform event or change event. For a platform event, the topic name is the event name appended with \_\_e, such as MyEvent\_\_e. For a change event, the topic is the name of the change event, such as AccountChangeEvent. | | Type | Type string Properties Filter, Group, Nillable, Sort Description The subscriber type (ApexTrigger). If the subscriber is a process or flow Pause element, the type is blank. | ## Usage Use EventBusSubscriber to query details about subscribers to a platform event. You can get all subscribers for a particular event by filtering on the Topic field, as follows. SELECT ExternalId, Name, Position, Status, Tip, Type FROM EventBusSubscriber WHERE Topic='Low\_Ink\_\_e' <!-- document id=2c6dea091f75c7afab047d89a28f4b6d00fa2c5518fd42c6751282b3386581e7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile.md --> # EventLogFile Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later. You can interact with event monitoring data by querying fields on the EventLogFile object (like EventType and LogDate). CreatedDate tracks when the log file was generated. To view the underlying event data, query the LogFile field. The EventType determines the schema of this field. Log files don’t count towards your org’s data or file storage allocations. For more information, see [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary."). Composite requests that include multiple API requests in a single call aren’t supported. In the event of a composite request, EventLogFile captures only the parent request. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Log data schema for each EventType can change. With each new release, use the LogFileFieldNames and LogFileFieldTypes fields to validate the schema changes. In the unlikely case in which no log files are generated for 24 hours, contact Salesforce Customer Support. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip Debug and troubleshoot performance issues by correlating logs using the customizable Request Identifier field, available in all Event Monitoring logs. To correlate logs pertaining to an API request call, set the X-SFDC-REQUEST-ID header with a 32 character OTEL compatible TraceId or a 22 -character alphanumeric Id. Using SOQL, search for the Event Monitoring logs with this RequestId to correlate the logs and see the unit of work performed as a part of the API transaction. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)"). ## Special Access Rules Accessing this object requires View Event Log Files and API Enabled user permissions. Users with View All Data permission can view event log files. ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can only delete event log file data if you enable the **Delete event monitoring data** setting in Setup. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note All Shield and Event Monitoring customers have 1 year of Event Log File storage enabled by default. ## Fields | Field | Details | | --- | --- | | ApiVersion | Type double Properties Filter, Sort Description The specific API version for this log file. This field is available in API version 30.0 and later. | | EventType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The event type—API, Login, Report, URI, and so forth. Use to determine which files were generated for your org. For the corresponding LogFile schema, see [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary."). | | LogDate | Type dateTime Properties Filter, Sort Description The date and time of the log file’s creation. For daily event log files, tracks usage activity for a 24-hour period, from 12:00 a.m. to 11:59 p.m. UTC time. For hourly event log files, indicates the hour in which the log file was generated. For example, for events that occur between 11:00 AM and 12:00 PM on 3/7/2016, this field’s value is 2016-03-07T11:00:00.000Z. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For hourly event log files, we recommend using CreatedDate to query the date and time that an EventLogFile object was created. | | LogFile | Type base64 Description Encoded file data in .csv format. The EventType field defines the schema for this data. | | LogFileContentType | Type string Properties Filter, Group, Sort Description The content type of the log file; always .csv. | | LogFileFieldNames | Type string Properties Nillable Description The ordered list of fields in the log file data. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note LogFileFieldNames and LogFileFieldTypes are specific to each EventType. For example, LogFileFieldNames has a different value for an API EventType and a Login EventType. | | LogFileFieldTypes | Type string Properties Nillable Description The ordered list of field types in the log file data (String, Id, and so forth). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note LogFileFieldNames and LogFileFieldTypes are specific to each EventType. For example, LogFileFieldTypes has a different value for an API EventType and a Login EventType. | | LogFileLength | Type double Properties Filter, Sort Description The log file length in bytes. You can use this field to plan storage needs for your log files. | - **[EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm)** The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU\_TIME and RUN\_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary. <!-- document id=e91de5f7802b771019b925eb925a4e5935c73fc45833b3fd3d639595617185d5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.md --> # EventLogFile Supported Event Types The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU\_TIME and RUN\_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary. We generate some text messages in quotes, as in "example message". To preserve the original value, we add two more quotes and the final value looks like """example message""" in the CSV file. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The Apex Unexpected Exception, API Total Usage, CORS Violation Record, CSP Violation, Hostname Redirects, Insecure External Assets, Login, and Logout events are available in supported Salesforce editions at no additional cost. To purchase the remaining event types, contact Salesforce. - **[Apex Callout Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apexcallout.htm)** Apex Callout events contain details about callouts (external requests) during Apex code execution. - **[Apex Execution Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apexexecution.htm)** Apex Execution events contain details about Apex classes that are used. - **[Apex Inline Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apexinline.htm)** This event type is reserved for future use. This object is available in API version 66.0 and later. - **[Apex REST API Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apexrestapi.htm)** Apex REST API events capture information about every Apex REST API request. - **[Apex SOAP Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apexsoap.htm)** Apex SOAP events contain details about custom SOAP web service calls. - **[Apex Trigger Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apextrigger.htm)** Apex Trigger events contain details about triggers that fire in an organization. - **[Apex Unexpected Exception Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apexunexpectedexception.htm)** The Apex Unexpected Exception event type captures information about unexpected exceptions in Apex code execution. This event type is available in the EventLogFile object in API version 45.0 and later. Unexpected exception information is not captured in the EventLogFile object with @IsTest and anonymous Apex. - **[API Total Usage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apitotalusage.htm)** API Total usage events contain details about Platform SOAP API, Platform REST API, and Bulk API requests. - **[Asynchronous Report Run Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_asyncreportrun.htm)** Asynchronous Report Run events are created for reporting requests that are scheduled. This category includes dashboard refreshes, asynchronous reports, schedule reports, and analytics snapshots. - **[Aura Request Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_lightning_component.htm)** Aura Request events contain details of requests to Apex methods from Aura and Lightning web components. For example, you can benchmark request time or identify the URI of an unsuccessful request. - **[Blocked Redirect Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_blockedredirect.htm)** Blocked redirect events capture information about blocked redirections from Salesforce to untrusted and malformed URLs. The Blocked Redirect event type is available in the EventLogFile object in API version 63.0 and later. - **[Bulk API Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_bulkapi.htm)** Bulk API events contain details about Bulk API requests. - **[Bulk API Request Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_bulkapi_request.htm)** The Bulk API request event captures when Bulk API requests are received to create a job, update a job, create a batch, update a batch, and when a job completes. - **[Bulk API 2.0 Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_bulkapi2.htm)** BulkApi2 events contain details about Bulk API 2.0 requests. - **[Change Set Operation Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_changesetoperation.htm)** Change Set Operation events contain information from change set migrations. - **[Composite API Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_composite_api.htm)** Composite API events contain details about composite API requests. One composite API event is generated for each composite API and composite graph API call. This event type is available in API version 64.0 and later. - **[Composite API Subrequest Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_composite_api_subrequest.htm)** Composite API subrequest events contain details about composite API subrequests. One composite API subrequest event is generated for each subrequest or collated set of subrequests. For example, if a composite API request contains five subrequests and four of the subrequests are collated, then two composite API subrequest events are generated. This example also applies to composite graph API. This event type is available in API version 64.0 and later. - **[Concurrent Long-Running Apex Limit Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_concurrentlongrunningapexlimit.htm)** Concurrent Long-Running Apex Limit events contain information about long-running concurrent Apex requests in your org that Salesforce terminated after reaching your org’s concurrency limit. Requests with an established Apex context that execute for 5 seconds are counted towards your org’s limit of concurrent long-running requests. (Asynchronous requests don’t count towards the limit.) When the long-running requests exceed the org default limit, all new Apex invocation requests are denied. This event type is available in the EventLogFile object in API version 45.0 and later. - **[Console Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_console.htm)** Console events contain information about the performance and use of Salesforce Consoles. The Console events are logged whenever a Console tab is opened with a sidebar component. Outside of that, when Console tabs are opened, a regular view record detail event is served just like in Salesforce Classic. - **[Content Distribution Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_contentdistribution.htm)** Content Distribution events contain information about content distributions and deliveries to users. - **[Content Document Link Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_contentdocument.htm)** Content Document Link events contain sharing information for content documents. - **[Content Transfer Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_contenttransfer.htm)** Content Transfer events contain information about content transfer events, such as downloads, uploads, and previews. This information includes events performed on files and attachments to records. - **[Continuation Callout Summary Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_continuationcalloutsummary.htm)** Continuation Callout Summary events contain information about all of the asynchronous callouts performed during a transaction, their response status codes, execution times, and URL endpoint destinations. This event type is available in the EventLogFile object in API version 43.0 and later. - **[CORS Violation Record Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_cors_violation.htm)** CORS Violation Record events capture information about Cross-Origin Resource Sharing (CORS) violations. Cross-origin requests to Lightning apps are blocked unless the request comes from a URL listed in your CORS allowlist. - **[CSP Violation Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_cspviolation.htm)** CSP violation events capture details about blocked resource requests from Lightning Experience pages based on your content security policy (CSP). The CSP Violation event type is available in the EventLogFile object in API version 63.0 and later. - **[Dashboard Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_dashboard.htm)** Dashboard events contain details about report requests from dashboards. These requests are triggered by dashboard refreshes, subscriptions, and filter changes. - **[Database Save Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_databasesaveevent.htm)** Database Save events track when records are created, updated, or deleted. This object is available in API version 63.0 and later. - **[Document Attachment Downloads Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_documentattach.htm)** Document Attachment Downloads events contain details of document and attachment downloads. - **[External Cross-Org Callout Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_externalcrossorgcallout.htm)** External Cross-Org Callout events represent external data callouts via the cross-org adapter for Salesforce Connect. This event type is available in the EventLogFile object in API version 40.0 and later. - **[External Custom Apex Callout Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_externalcustomapexcallout.htm)** External Custom Apex Callout events represent external data callouts via custom adapters for Salesforce Connect. This event type is available in the EventLogFile object in API version 40.0 and later. - **[External Data Source Callout Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_externaldatasourcecallout.htm)** External Data Source Callout events represent external data callouts via the Salesforce Connect adapters for Amazon DynamoDB and Amazon Athena. This event type is available in the EventLogFile object in API version 56.0 and later. - **[External OData Callout Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_externalodatacallout.htm)** External OData Callout events represent external data callouts via the OData 2.0 and OData 4.0 adapters for Salesforce Connect. This event type is available in the EventLogFile object in API version 40.0 and later. - **[Flow Execution Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_flowexecution.htm)** Flow Execution events contain information about flows that were executed including details such as total execution time, number of interviews, and number of errors. - **[GraphQL Query Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_graphql_query.htm)** GraphQL Query events contain information about executed queries, including total execution time, the number of invocations, and any reported errors. - **[Group Membership Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_groupmembership.htm)** Group Membership events capture details about changes to public group and queue membership, such as when members are added to or removed from the public group or queue. - **[Hostname Redirects Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_hostnameredirects.htm)** Hostname Redirect events contain details about blocked and successful redirections for your previous My Domain hostnames. The Hostname Redirects event type is available in the EventLogFile object in API version 56.0 and later. - **[Insecure External Assets Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_insecureexternalassets.htm)** Insecure External Assets events contain information about external assets. External assets include images or videos accessed by users over an insecure HTTP protocol. The event lists all your Salesforce pages that contain assets hosted insecurely on third-party sites that users loaded with a Chrome, Firefox, Microsoft Edge, or Safari browser. The INSECURE\_URI field contains the URI being used to load the asset insecurely. The Insecure External Assets event type is available in the EventLogFile object in API version 42.0 and later. - **[Insufficient Access Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_insufficientaccess.htm)** Insufficient Access events contain details about errors relating to insufficient account, case, contact, and opportunity record access, so that you can troubleshoot and resolve access issues for your users. - **[Invocable Action Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_invocableaction.htm)** Invocable Action events capture the calls to Salesforce Invocable Actions. This is particularly useful to monitor actions invoked during Agentforce flows. This event type is available in API versions 64.0 and later. - **[Knowledge Article View Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_knowledgearticleview.htm)** Knowledge Article View events contain user activity with your knowledge base. - **[Lightning Error Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_lightningerror.htm)** Lightning Error events represent errors that occurred during user interactions with Lightning Experience and the Salesforce mobile app. This event type is available in the EventLogFile object in API version 39.0 and later. - **[Lightning Interaction Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_lightninginteraction.htm)** Lightning Interaction events track user actions in Lightning Experience and the Salesforce mobile app, such as the user clicking, tapping, or scrolling on a page. This event type is available in the EventLogFile object in API version 39.0 and later. - **[Lightning Logger Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_lightninglogger.htm)** Lightning Logger events contain information from observed Lightning component logs. This event type is available in the EventLogFile object in API version 58.0 and later. - **[Lightning Page View Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_lightningpageview.htm)** Lightning Page View events represent information about the page on which the event occurred in Lightning Experience and the Salesforce mobile app, such as the page's load time. This event type is available in the EventLogFile object in API version 39.0 and later. - **[Lightning Performance Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_lightningperformance.htm)** Lightning Performance events track trends in Lightning Experience and Salesforce mobile app performance. This event type is available in the EventLogFile object in API version 39.0 and later. - **[Login Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_login.htm)** Login events contain details about your org’s user login history. - **[Login As Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_loginas.htm)** Login As events contain details about what a Salesforce admin did while logged in as another user. - **[Logout Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_logout.htm)** Contains details of user sessions ending or being revoked. - **[Metadata API Operation Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_metadataapi.htm)** Metadata API Operation events contain details of Metadata API retrieval and deployment requests. - **[Multiblock Report Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_multiblock.htm)** Multiblock Report events contain details about Joined Report reports. - **[Named Credential Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_namedcredential.htm)** The Named Credential event type captures information about Apex callouts that use named credentials as their endpoints. Use this event type to audit the installed managed packages that use named credentials. If you don’t recognize the package namespace in the named credential event log file, then you can investigate whether a security breach has occurred. This event type is available in the EventLogFile object in API version 53.0 and later. - **[One Commerce Usage Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_onecommerceusage.htm)** One Commerce Usage events capture information about your Commerce instance. This event type is available in the EventLogFile object in API version 51.0 and later. - **[Package Install Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_packageinstall.htm)** Package Install events contain details about package installation in the organization. - **[Permission Update Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_permissionupdate.htm)** Permission update events represent changes to object, field, and user permissions and setup entity access that occur in profiles and permission sets. The event type also tracks if you clone profiles or change whether session activation is required in permission sets or permission set groups. - **[Platform Encryption Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_platformencryption.htm)** Platform Encryption event contains information about tenant secret and derived encryption key usage. This event type is available in API versions 41.0 and later. - **[Pricing Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_pricing.htm)** Pricing events contain information about pricing procedures that were executed, including details such as pricing procedures used, the pricing APIs, and pricing details and status. - **[Queued Execution Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_queuedexec.htm)** Queued Execution events contain details about queued executions—for example, batch Apex. - **[Report Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_report.htm)** Report events contain information about what happened when a user ran a report. This event type includes all activity that's in the Report Export event type, plus more. For example, it has user activity for reports exported as both Formatted Report and Details Only output. - **[Report Export Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_reportexport.htm)** Report Export events contain details about reports that a user exported. For example, this event type captures when a user exports a report as Details Only output. But it doesn’t capture reports that users export as Formatted Report or XLSX Detail output. For that data, see the Report event type. - **[REST API Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_restapi.htm)** REST API events contain details about REST-specific requests. - **[Sandbox Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_sandbox.htm)** Sandbox events contain details about sandbox copies. - **[Search Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_search.htm)** Search events contain details about the user’s search query. All searches within the app, including Experience Cloud sites, are included. However, unauthenticated users won’t have a unique Salesforce user ID. - **[Search Click Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_searchclick.htm)** Search Click events contain details about the user’s interaction with the search results in the search results page. Interactions with search results in the instant result dialog are not recorded by this event. All searches within the app, including Experience Cloud sites, are included. However, unauthenticated users won’t have a unique Salesforce user ID. - **[Sites Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_sites.htm)** Sites events contain details of Site.com requests. Requests can originate from the browser (UI). - **[SOAP API Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_api.htm)** SOAP API events contain details about your org's SOAP API request activity. - **[Time-Based Workflow Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_timebasedworkflow.htm)** Time-Based Workflow events contain details about queue activity monitoring. - **[Transaction Security Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_transaction.htm)** Transaction Security events contain details about policy execution. This event type is supported in API version 55.0 and later. - **[UI Telemetry Navigation Timing Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_uitelemetrynavigationtiming.htm)** UI Telemetry Navigation Timing events capture network performance metrics related to page navigation. The event extends from the UI Telemetry Resource Timing Event and includes requests initiated with either the [Fetch API](https://fetch.spec.whatwg.org/) or the [XMLHttpRequest API](https://xhr.spec.whatwg.org/). This object is available in API version 61.0 and later. - **[UI Telemetry Resource Timing Event](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_uitelemetryresourcetiming.htm)** UI Telemetry Resource Timing events capture network performance metrics related to loading an application’s resources. The event includes requests initiated with either the [Fetch API](https://fetch.spec.whatwg.org/) or the [XMLHttpRequest API](https://xhr.spec.whatwg.org/). This object is available in API version 61.0 and later. - **[Unique Query Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_unique_query_event_elf.htm)** Unique Query events capture specific search queries (SOQL), filter IDs, and report IDs that are processed, along with the underlying database queries (SQL). This event type is available in API versions 64.0 and later. - **[URI Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_uri.htm)** URI events contain details about user interaction with the web browser UI. - **[Visualforce Request Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_visualforce.htm)** Visualforce Request events contain details of Visualforce requests. Requests can originate from the browser (UI). - **[Wave Change Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_wavechange.htm)** Wave Change events represent route or page changes made in the CRM Analytics user interface. A Wave Change event type is captured every time the user opens a new CRM Analytics asset or tab, switches between tabs, or changes dashboard pages. Wave Change events are logged when opening new tabs and switching back to previously opened tabs. - **[Wave Download Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_wavedownload.htm)** Wave Download events represent downloads made from lens explorations and dashboard widgets in the CRM Analytics user interface. A Wave Download event type is captured when a user downloads images ( .png ), Microsoft® Excel® data ( .xls ), or comma-separated values ( .csv ) files. - **[Wave Interaction Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_waveinteraction.htm)** Wave Interaction events represent route or page changes made in the CRM Analytics user interface. A Wave Interaction event type is captured when a tab is closed. It also collates the interaction statistics over the life of the tab, including total open time, read time, and so on. These statistics are aggregated as you go to other tabs and return, and logged only once when the tab is closed. - **[Wave Performance Event Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_waveperformance.htm)** Wave Performance events help you track trends in your Analytics performance. #### See Also - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=5a0325890eabefd4019e7c0c61106163dc2340f59f377962e4451786b6500f37 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventattendee.md --> # EventRelation Represents a person (a user, lead, or contact) or a resource (such as a conference room) invited to an event. This object lets you add or remove invitees from an event and use the API to manage invitees’ responses to invitations. If Shared Activities is enabled, EventRelation can also represent other objects that are related to an event. EventRelation does not support triggers, workflow, or data validation rules. EventRelation allows a variable number of relationships and handles deleted events differently, depending on whether Shared Activities is enabled. A non-recurring event can have up to 1,000 invitees. A recurring event can have up to 100 invitees. If Shared Activities Isn’t Enabled - EventRelation records only represent invitees (contacts, users, and resources). - An event can be related to one contact or lead. If Shared Activities Is Enabled - EventRelation records can represent: - Invitees (IsInvitee= is set to true) OR - Related contacts or lead (IsParent is set to true) - An event can be related to up to 50 contacts or one lead. These people may or may not be invitees. The number of allowed invitees is not affected by the number of related contacts. If a contact or lead is also an invitee, there is one EventRelation record for that person with IsInvitee and IsParent are set to true. - An event can be related to a lead, contact, resource, account, or opportunity. - An event can be related to a custom object that has the HasActivities attribute set to true. - If you delete an event, then relations between the event and any specified contacts, leads, and other records are also deleted. - If you delete the EventRelation record representing a relation then the corresponding relation field may be cleared on the event. - If you delete the EventRelation record representing the WhoId on an event, then another Who, if any, from the event’s EventWhoIds field will be promoted to the WhoId. - If you restore a deleted event, relations between the event and any specified contacts, leads, and records are also restored. The WhoId, WhatId, and AccountId field values are recalculated using the field values on EventRelation. Whether or not Shared Activities is enabled, an event can be related to one other kind of record, such as an account, an opportunity, or a custom object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - With API versions 26.0 and later, the EventRelation object replaces the EventAttendee object, and the EventAttendee object is no longer visible. You can still query the EventAttendee object using packages that support API versions 25.0 and earlier, or by using Apex. - An EventRelation object can’t be created for a child event. - EventRelation includes deactivated users. - In API versions 25.0 and earlier, you can’t use query(), delete(), or update() with events related to more than one contact. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description Contains the Account ID of the relation. For information on IDs, see [ID Field Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm#i1435616). AccountId is visible when Shared Activities is enabled. | | EventId | Type reference Properties Create, Filter, Group, Sort Description Contains the ID of the event. This value can’t be changed after it’s been specified. This is a relationship field. Relationship Name Event Relationship Type Lookup Refers To Event | | IsDeleted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. | | IsInvitee | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the relation is an invitee. - IsInvitee is visible while Shared Activities is being enabled, after it has been enabled, and while it is being disabled. - IsInvitee defaults to true while Shared Activities is being enabled, after it has been enabled, and while it is being disabled if IsInvitee, IsParent, and IsWhat are not set. This configuration ensures compatibility when Shared Activities isn’t enabled and EventRelation represents event invitees only. - IsInvitee defaults to false when Shared Activities is enabled if IsParent is set to true. | | IsParent | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description IsParent is visible only when Shared Activities is enabled. When false, indicates that the relation is an invitee (a contact, lead, or user). When true, indicates that the relation is a Who or What, as determined by IsWhat field. | | IsWhat | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description IsWhat is visible only when Shared Activities is enabled. The value is relevant only if IsParent is true. When IsWhat is true, the relation specified by RelationId is a What (an account, opportunity, custom object, etc.). When IsWhat is false, the relation specified by RelationId is a Who (a contact, lead, or user). | | RelationId | Type reference Properties Create, Filter, Group, Sort Description Contains the ID of the person (User, Contact, or Lead) or the resource invited to an event. When Shared Activities is enabled, RelationId can also contain the ID of an account, opportunity, or other object related to an event. This value can’t be changed after it’s been specified. This is a polymorphic relationship field. Relationship Name Relation Relationship Type Lookup Refers To Calendar, Contact, Lead, User | | RespondedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the most recent date and time when the invitee responded to an invitation to an event. | | Response | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Contains optional text that the invitee can enter when responding to an invitation to an event. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the invitee status with one of the following values: - New: Invitee has received the invitation but hasn’t yet responded. This value is the default. - Declined: Invitee has declined the invitation. - Accepted: Invitee has accepted the invitation. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Uninvited and Maybe aren’t currently supported. | ## Usage - Invitee related lists display slightly different content. In the Salesforce mobile app, the invitee related list includes invitees only, whereas in the full site, it also includes the event owner. To reproduce the full site functionality in the Salesforce mobile app, use the following API queries. If you use Shared Activities in your Salesforce org, use this query: SELECT RelationId FROM EventRelation WHERE isInvitee = true AND eventId='\[Event\_Id\]' where Event\_Id is the child event’s ID. If you don’t use Shared Activities, use this query: SELECT RelationId FROM EventRelation WHERE eventId='\[Event\_Id\]' These queries get the main event’s relations and display them for the given child event. To further filter the results, add a WHERE clause. Assigning resource attendance status You can add a resource to an event only when the resource is available. The only attendance status that can be assigned to resources is Accepted. Events can’t be saved when resources you’ve added aren’t available. Create an invitee if Shared Activities is enabled (or during the process of enabling it or rolling back) If the invitee is already a contact or lead, update IsInvitee to true. If the invitee is not already a contact or lead, create an EventRelation object for the invitee with IsInvitee set to true. Create an invitee if Shared Activities is not enabled Create an EventRelation object for the invitee. Insert a contact or lead relation EventRelation er = new EventRelation(EventId = '00UD0000005zijH', RelationId = '003D000000Q8aeV', isParent = true, isInvitee = false); insert er; Determine what events a given invitee is attending To determine all the events that a particular person is attending during a given time period (for example, next week), you can have a client application query the Event object for a given date range, iterate through the results, and, for each event, query the EventRelation object to determine whether the particular person (RelationId) has accepted an invitation to that event. Insert an invitee relation If isParent, isWhat and IsInvitee are not set, and RelationId is a contact, lead, user, or calendar, IsInvitee defaults to true. This means if an EventRelation isn’t specifically inserted as a relation to a contact or lead, it’s treated as an Invitee relation by default. EventRelation er = new EventRelation(EventId = '00UD0000005zijH', RelationId = '003D000000Q8adV'); insert er; Query relations to a contact or a lead List<EventRelation> whoRelations = \[SELECT Id, Relation.Name FROM EventRelation WHERE EventId = '00UD0000005zijD' AND isParent = true AND isWhat = false\]; Query invitee relations List<EventRelation> inviteeRelations = \[SELECT Id, Relation.Name FROM EventRelation WHERE EventId = '00UD0000005zijD' AND isInvitee = true\]; Update an invitee relation to a contact or lead invitee relation EventRelation er = \[SELECT Id FROM EventRelation WHERE EventId = '00UD0000005zijD' AND isInvitee = true and isParent = false LIMIT 1\]; er.isParent = true; update er; Update a contact or lead relation to a contact or lead invitee relation EventRelation er = \[SELECT Id FROM EventRelation WHERE EventId = '00UD0000005zijD' AND isParent = true and isInvitee = false LIMIT 1\]; er.isInvitee = true; update er; Reproduce invitee related list functionality in the Salesforce mobile app Invitee related lists display slightly different content in the Salesforce mobile app and the full site. In the app, the invitee related list includes invitees only, whereas in the full site, it also includes the event owner. If you use Shared Activities in your Salesforce org, use the following query to reproduce the full site functionality in the Salesforce mobile app: SELECT RelationId FROM EventRelation WHERE isInvitee = true AND eventId='\[Event\_Id\]' where Event\_Id is the child event’s ID. If you don’t use Shared Activities, use this query: SELECT RelationId FROM EventRelation WHERE eventId='\[Event\_Id\]' These queries get the main event’s relations and display them for the given child event. To further filter the results, add a WHERE clause. Send email notifications To send email notifications for a given event, query EventRelation for the event, iterate through the list, examine the status, and send email notifications to every person who accepted the invitation. Syncing Events with Lightning Sync Attendee statuses (Accepted or Maybe, Declined, or No Response) sync from Microsoft® Exchange or Google to Salesforce, but not from Salesforce to Exchange or Google. Be wary of creating API flows that update attendee status in Salesforce for users set up to sync both ways. Eventually the original Exchange or Google status overrides the update made in Salesforce. ## 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. [EventRelationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. #### See Also - [Event](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_event.htm "Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities.") - [EventWhoRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventwhorelation.htm "Represents the relationship between an event and a lead or contacts. This derived object is a filtered version of the EventRelation object; that is, IsParent is true and IsWhat is false. It doesn’t represent relationships to invitees or to accounts, opportunities, or other objects. This object is available in API versions 29.0 and later.") - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=a5ff47b8e2066de7f7e370b32b89d73c00823ac673a795688f457cd9f56247bc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventrelayconfig.md --> # EventRelayConfig Represents the configuration of an event relay, which relays platform events and change data capture events from Salesforce to Amazon EventBridge. This object is available in API version 56.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules - To retrieve or query this object, you must have the View Setup and Configuration permission. - This object is read-only. To configure an event relay, use [EventRelayConfig](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_eventrelayconfig.htm) in Tooling API or [EventRelayConfig](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_eventrelayconfig.htm) in Metadata API. ## Fields | Field | Details | | --- | --- | | DestinationResourceName | Type string Properties Filter, Group, Sort Description The developer name of the named credential, which stores the AWS account information. The destinationResourceName value contains the callout: prefix. For example: callout:MyRelayNamedCredential | | DeveloperName | Type string Properties Filter, Group, Sort Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. 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 **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. | | EventChannel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The full name of the event channel used in the event relay. For example: MyRelayChannel\_\_chn | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the EventRelayConfig. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, Sort Description Label for the EventRelayConfig. In the UI, this field is Event Relay Config. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values: - In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. - In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects. | | RelayOption | Type textarea Properties Nillable Description A JSON-encoded string that contains an option for resuming an event relay after the system recovers from an error. This option is used if the event relay can't resume after the last relayed event. The options available are: - "{"ReplayRecovery":"LATEST"}"—(Default) Start relaying events from new events received in the event bus. Use this option if you aren’t interested in missed events while the relay was down. - "{"ReplayRecovery":"EARLIEST"}"—Resend all events stored in the event bus and relay new events thereafter. The event bus stores events for up to three days. Use this option if you want to reprocess all stored events and catch up on missed events. | | State | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The execution state of the event relay. Possible values are: - RUN—The event relay is running and actively relaying event messages from Salesforce to Amazon EventBridge. - PAUSE—An administrator paused the event relay. No events are relayed to Amazon EventBridge during this status. All current state information is saved. - STOP—(Default) The event relay is stopped and no events are relayed to Amazon EventBridge. All current state information is deleted. | | UsageType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Reserved for future use. | <!-- document id=68f29b517b3113f23f34e4144f83a09ba0ee37d9e724a332aaad5a0afaaee82d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventrelayfeedback.md --> # EventRelayFeedback Represents execution state information about an event relay from Salesforce to Amazon EventBridge for platform events and change data capture events. Query this object to get information such as the event relay status and any error message. This object is available in API version 56.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ErrorCode | Type string Properties Filter, Group, Nillable, Sort Description The error code of the last error that occurred during the relay of event messages. For a list of possible error codes and messages, see [Error Codes](#error-codes-section). | | ErrorIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The identifier of an unexpected system error that occurred during the relay of event messages. | | ErrorMessage | Type textarea Properties Nillable Description The error message of the last error that occurred during the relay of event messages. For a list of possible error codes and messages, see [Error Codes](#error-codes-section). | | ErrorTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time in the UTC time zone when the last error occurred during the relay of event messages. | | EventRelayConfigId | Type reference Properties Filter, Group, Sort Description The ID of the event relay configuration that this feedback record is collecting the execution information of. This field is a relationship field. Relationship Name EventRelayConfig Relationship Type Lookup Refers To EventRelayConfig | | EventRelayNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The number that identifies the EventRelayFeedback record. This field is of type Auto Number. | | LastRelayedEventTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time in the UTC time zone when the last event was relayed to Amazon EventBridge. | | RemoteResource | Type string Properties Filter, Group, Nillable, Sort Description The name of the partner event source associated with the event relay. It is in the format aws.partner/salesforce.com/orgID/channelID. For example: aws.partner/salesforce.com/00DRM000000Fxts2AC/0YLRM0000004Dfg4AE. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The status of the event relay. Possible values are: - ERROR— The event relay encountered an error while running or during a state change that the administrator initiates. During the ERROR state, no events are relayed to Amazon EventBridge. The system attempts periodically to recover from the error. If it succeeds, the Status field value changes to RUNNING or to the new state that the administrator selected. The event relay attempts to resume sending events from the event bus from where it left off. In rare occasions, if it can't resume after the last relayed event, it uses the error recovery option in the relayOption field of EventRelayConfig to determine where to resume from. - DELETED—Reserved for future use. - PAUSED— An administrator paused the event relay. No events are relayed to Amazon EventBridge during this status. When an administrator resumes the event relay, events are relayed from the last position in the event bus, as long as they're within the retention window. - RUNNING— The event relay is running and actively relaying events from Salesforce to Amazon EventBridge. - STOPPED—The event relay is stopped and no events are relayed to Amazon EventBridge. Some state information stored in EventRelayFeedback fields is deleted, such as LastRelayedEventTime and error fields. When the event relay is resumed, only new events are relayed. The default value is STOPPED. | | UsageType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Reserved for future use. | ## Error Codes This table contains the error codes and messages that a query on EventRelayFeedback can return in the ErrorCode and ErrorMessage fields. | Error Code | Error Description | | --- | --- | | sfdc.platform.eventbus.relay.aws.partner.eventsource.invalid | The configured event relay's AWS named credentials are invalid. | | sfdc.platform.eventbus.relay.aws.partner.eventsource.connect.error | The configured event relay encountered an error while connecting to Amazon EventBridge. | | sfdc.platform.eventbus.relay.feature.not.supported | The event relay is configured with an unsupported feature, such as event encryption and change data capture event enrichment. | | sfdc.platform.eventbus.relay.event.delivery.limit.error | You’ve exceeded the event delivery limit for your org. | | sfdc.platform.eventbus.relay.temporarily.unavailable | The event relay is temporarily unavailable due to an internal error. | <!-- document id=a68ed965e11d69618d24602b6be2ce18b3b259159392a3e81173e0898f9ddb23 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventstagedinviteeemail.md --> # EventStagedInviteeEmail Represents the relationship between an event and an email address invited to the event that doesn’t match to a user, contact, or lead record. Data about the unmatched email address is represented in StagedInviteeEmail. This object represents event-related details, such as the invitee's attendance response to the event. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() ## Special Access Rules This object is available with Einstein Activity Capture when Sync Email as Salesforce Activity is turned on. ## Fields | Field | Details | | --- | --- | | EventId | Type reference Properties Filter, Group, Sort Description The unique ID of the related event record. This field is a relationship field. Relationship Name Event Refers To Event | | IsArchived | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event is archived (true) or not (false). This value helps manage high volumes of archived events, improving query performance. The default value is false. | | IsOrganizer | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the invitee is the event organizer (true) or not (false). The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The invited email address. | | StagedInviteeEmailId | Type reference Properties Filter, Group, Sort Description The unique ID of the related invitee email address record. This field is a relationship field. Relationship Name StagedInviteeEmail Relationship Type Master-detail Refers To StagedInviteeEmail | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The attendance response to the event from the invitee. Possible values are: - Accepted - Declined - Maybe - New - Uninvited | <!-- document id=d7698c9ee7a5e12047609839ddc1f1936972cbc70f8775538b38c2aa65ce3b08 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventtag.md --> # EventTag Associates a word or short phrase with an Event. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage EventTag stores the relationship between its parent TagDefinition and the Event being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. <!-- document id=41f4354c820415fdbf5a0839b5e7ecf70eb18a1034c54ca679dcd7ff94f9fd22 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventwhorelation.md --> # EventWhoRelation Represents the relationship between an event and a lead or contacts. This derived object is a filtered version of the [EventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventattendee.htm "Represents a person (a user, lead, or contact) or a resource (such as a conference room) invited to an event. This object lets you add or remove invitees from an event and use the API to manage invitees’ responses to invitations. If Shared Activities is enabled, EventRelation can also represent other objects that are related to an event. EventRelation does not support triggers, workflow, or data validation rules.") object; that is, IsParent is true and IsWhat is false. It doesn’t represent relationships to invitees or to accounts, opportunities, or other objects. This object is available in API versions 29.0 and later. EventWhoRelation allows a variable number of relationships: one lead or up to 50 contacts. Available only if you’ve enabled Shared Activities for your organization. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note EventWhoRelation objects aren’t created for child events. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | EventId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the event. | | RelationId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the contacts or lead related to the event. | | Type | Type string Properties Filter, Group, Nillable, Sort Description Indicates whether the person related to the event is a contact or lead. | ## Usage Apex example that queries relations to a contact or lead List<EventWhoRelation> whoRelations = \[SELECT Id, Relation.Name FROM EventWhoRelation WHERE EventId = '00UD0000005zijD'\]; #### See Also - [Event](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_event.htm "Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities.") - [EventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventattendee.htm "Represents a person (a user, lead, or contact) or a resource (such as a conference room) invited to an event. This object lets you add or remove invitees from an event and use the API to manage invitees’ responses to invitations. If Shared Activities is enabled, EventRelation can also represent other objects that are related to an event. EventRelation does not support triggers, workflow, or data validation rules.") <!-- document id=bbb106024e8bc6f09f6cc948aec80c619fb1b04180f65c37b3f942242297a79a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_expense.md --> # Expense Represents an expense linked to a work order. Service resource technicians can log expenses, such as tools or travel costs. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the account associated with the linked work order. | | Amount | Type currency Properties Create, Filter, Sort, Update Description The amount of the expense. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. | | Description | Type textarea Properties Create, Nillable, Update Description A description for the expense. | | Discount | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage deducted from the Subtotal price. Available in version 51.0 and later. | | ExpenseEndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description If the expense was incurred over multiple days, the Expense End Date is the last day that the expense covers. | | ExpenseNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The number that uniquely identifies the expense. | | ExpenseStartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description If the expense was incurred over multiple days, the Expense Start Date is the first day that the expense covers. | | ExpenseType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of expense. Possible values are: - Billable - Non-Billable The default value is Billable. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the expense record. | | Quantity | Type double Properties Create, Filter, Nillable, Sort, Update Description The number of items purchased in this record. Available in version 51.0 and later. | | Subtotal | Type currency Properties Filter, Nillable, Sort Description The subtotal price calculated as the product of Quantity and UnitPrice. Available in version 51.0 and later. This is a calculated field. | | Title | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A title that identifies the expense. This field is available in API version 50.0 and later. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description The total price of the transaction which is equal to the discounted subtotal: Subtotal - (Discount \* Subtotal). Available in version 51.0 and later. This is a calculated field. | | TransactionDate | Type date Properties Create, Filter, Group, Sort, Update Description The day that the expense was incurred, or the payment date for the expense. | | UnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The price of one item on the record. Available in version 51.0 and later. | | WorkOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the work order associated with the expense. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ExpenseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. [ExpenseFeed](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. [ExpenseHistory](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. [ExpenseOwnerSharingRule](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. [ExpenseShare](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. <!-- document id=2c05a42060fe8b4ccd828c1c468c322dd4ee2206368387ba2d6dd30d0edcff3c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_expensereport.md --> # ExpenseReport Represents a report that summarizes expenses. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. | | Description | Type textarea Properties Create, Nillable, Update Description A description for the expense report. | | ExpenseReportNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the expense report. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the expense report record. | | Title | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A title that identifies the expense report. | | TotalExpenseAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all expense entries in the report. This is a calculated field. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ExpenseReportFeed](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. [ExpenseReportHistory](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. [ExpenseReportShare](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. <!-- document id=ab9cc8d65866dd22f9f4f42f689466628a33ad9c9a8d589a9da2a5a9062fe419 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_expensereportentry.md --> # ExpenseReportEntry Represents an entry in an expense report. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Filter, Nillable, Sort Description The amount of the expense. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. | | ExpenseId | Type reference Properties Create, Filter, Group, Sort, Update Description The expense that corresponds to the expense report entry. | | ExpenseReportEntryNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the expense report entry. | | ExpenseReportId | Type reference Properties Create, Filter, Group, Sort Description The expense report that’s associated with the expense report entry. | | ExpenseType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description The type of expense. Possible values are: - Billable - Non-Billable The default value is Billable. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Title | Type string Properties Filter, Group, Nillable, Sort Description A title that identifies the expense. | | TransactionDate | Type date Properties Filter, Group, Nillable, Sort Description The day that the expense was incurred, or the payment date for the expense. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ExpenseReportEntryFeed](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. [ExpenseReportEntryHistory](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. <!-- document id=84c4e8f547e22e83f6dea8a30dc2d4e6d1130340ad06f41909bd595c80307f70 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_expressionfilter.md --> # ExpressionFilter Represents a logical expression that’s used to control the execution of macro instructions. This object is available in API version 46.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ContextId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the MacroInstruction object that contains the expression. | | FilterConditionLogic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. The filter conditions to use and the order in which to apply them. For example, ‘1 AND 2’ evaluates condition 1 and then condition 2. | | FilterDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. A description of the filter expression that helps to explain the logic to users. For example, ‘Applies to New cases.’ | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Optional. A label for the expression. | ## Usage The ExpressionFilter object is used with the IF and ELSEIF operations in a [MacroInstruction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_macroinstruction.htm "Represents an instruction in a macro. An instruction can specify the object that the macro interacts with, the context or publisher that the macro works within, the operation or action that the macro performs, and the target of the macro’s actions."). It lets you specify a logical expression that determines whether macro instructions are executed. The object indicates whether any or all conditions must be true. To represent the conditions that are evaluated, this object uses one or more [ExpressionFilterCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expressionfiltercriteria.htm "Represents a condition in an expression that’s used to control the execution of macro instructions. This object is available in API version 46.0 and later.") child objects. The ExpressionFilter to be used with each criteria is specified in the ExpressionFilterCriteria’s ExpressionFilterId field. For example, to represent the following conditional statement, the ExpressionFilter object specifies the FilterConditionLogic field as 1 AND 2, where 1 and 2 are ExpressionFilterCriteria objects. In this example, condition 1 is Case.Status EQUALS New, and condition 2 is Case.Origin EQUALS Phone. IF (Case.Status EQUALS New) AND (Case.Origin EQUALS Phone) Select Email QuickAction Set Subject… Set To… Set Body… Submit ENDIF <!-- document id=a72472a2f14b5b559e2d882d3a8bf73c4cec693b9e906609c5cf06d1d6df6cdd url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_expressionfiltercriteria.md --> # ExpressionFilterCriteria Represents a condition in an expression that’s used to control the execution of macro instructions. This object is available in API version 46.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ExpressionFilterId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the ExpressionFilter object that references this condition. | | FilterTarget | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The target object or field used in the condition. For example, to create a condition that applies to new cases, use Case.Status as the FilterTarget. | | FilterTargetValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. The value that’s compared to the value of the FilterTarget. For example, to create a condition that applies to new cases, use New as the FilterTargetValue. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Optional. A label for the condition. | | Operation | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. Specifies the operator used to compare the target field and the target value. For example, to create a condition that applies to new cases, use EQUALS for the Operation field, as in Case.Status EQUALS New. - EQUALS - NOTEQUALS - CONTAINS - NOTCONTAIN | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The order in which the criteria are evaluated. | ## Usage ExpressionFilterCriteria is a child object of the [ExpressionFilter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expressionfilter.htm "Represents a logical expression that’s used to control the execution of macro instructions. This object is available in API version 46.0 and later.") object. Use these objects with the IF and ELSEIF operations in a [MacroInstruction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_macroinstruction.htm#sforce_api_objects_MacroInstruction "Represents an instruction in a macro. An instruction can specify the object that the macro interacts with, the context or publisher that the macro works within, the operation or action that the macro performs, and the target of the macro’s actions.") to control instruction execution. Each condition in a ExpressionFilterCriteria compares a target object or field to a value using a condition operator; for example, Case.Status EQUALS New. <!-- document id=91ac674d240932babf7887a471cd43cedef2f388e738ef1664e31e8c3a688e88 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_expressionsetconstraintobj.md --> # ExpressionSetConstraintObj Represents the association between a Product object and the constraint model tags defined in a given constraint model. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available in orgs where Revenue Cloud is enabled. ## Fields | Field | Details | | --- | --- | | ConstraintModelTag | Type string Properties Create, Filter, Group, Sort, Update Description The product tag that is defined in the constraint model, for example, Laptop. | | ConstraintModelTagType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of the product tag that is defined in the constraint model. Possible values are: - Port - Type The default value is Type. | | ExpressionSetId | Type reference Properties Create, Filter, Group, Sort, Update Description The expression set associated with the expression set constraint object. This field is a relationship field. Relationship Name ExpressionSet Refers To ExpressionSet | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, the user accessed this record or list view (LastReferencedDate) but didn’t view it. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the expression set constraint. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description For internal use only. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ReferenceObjectId | Type reference Properties Create, Filter, Group, Sort, Update Description The object associated with the expression set constraint object. This field is a polymorphic relationship field. Relationship Name ReferenceObject Refers To Product2, ProductClassification, ProductRelatedComponent | <!-- document id=840a8248014f01cc6bbe14b83a479d4180574408dec52bdf7466d440540d256c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extconvparticipantintegdef.md --> # ExtConvParticipantIntegDef Represents the integration configuration for external conversation participants, used for communication between Salesforce and external messaging platforms. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountKey | Type textarea Properties Create, Nillable, Update Description Encrypted JSON format key for secure storage of authentication credentials for external bot API calls. | | BotProvider | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Bot provider for integration of authentication and request and response logic. Possible value: - Custom | | ChannelMode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Possible values for the type of channel: - Messaging - Voice The default value is Messaging. | | ClientIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description API client ID of the bot provider. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Unique name of the object in the API. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Language of the master label. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for the ExtConvParticipantIntegDef object. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description If it's part of a managed package, the namespace of the package that contains integration definition for the external conversation participant. | | ProjectIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Identifier of the project in the provider framework to scope API calls and resource access. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Status of the integration. Possible values are: - Active - Deleted - Inactive The default value is Active. | <!-- document id=2b14470240f0356967412b8420ce2f74d9d607f35b34761df1fc45cf32df48cf url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extdatashare.md --> # ExtDataShare Represents a data share, which is a collection of Data Cloud objects that can be shared with other Data Cloud orgs or third-party partners. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DataShareType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of data share, indicating the direction of data flow. If Outbound, the data share was created on this Data Cloud org and is shared to third-party partners or with another Data Cloud org. If Inbound, the data share comes from another Data Cloud org and is shared to this Data Cloud org. Possible values are: - Inbound - Outbound The default value is Outbound. | | DataSpaceId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the data space under which the data share was created. This field is a relationship field. Relationship Name DataSpace Refers To DataSpace | | InboundDataShareName | Type string Properties Create, Filter, Group, Nillable, Sort Description The name of the data share in the source Data Cloud org. | | InboundDataShareOrgIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort Description The ID of the source Data Cloud org that shared a data share with the target org. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the data share. | | ObjectCount | Type int Properties Filter, Group, Nillable, Sort Description The number of Data Cloud objects added to this data share. | ## 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. [ExtDataShareChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ExtDataShareFeed](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. [ExtDataShareHistory](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. [ExtDataShareOwnerSharingRule](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. [ExtDataShareShare](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. #### See Also - [_Salesforce Help_: Create a Data Stream](https://help.salesforce.com/s/articleView?id=data.c360_a_create_data_shares.htm&language=en_US " Salesforce Help: Create a Data Stream - HTML (New Window)") <!-- document id=ed3fb234797cb69ba7f45614871ba2d2365368dd422d49d31ac6b66aba4be1e3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_externalcrossorgcallout.md --> # External Cross-Org Callout Event Type External Cross-Org Callout events represent external data callouts via the cross-org adapter for Salesforce Connect. This event type is available in the EventLogFile object in API version 40.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For the cross-org adapter for Salesforce Connect, event monitoring currently doesn’t track search callouts. ## Fields | Field | Details | | --- | --- | | ACTION | Type String Description Action performed by the callout. Possible Values - query - upsert - delete | | ENTITY | Type String Description Name of the external object being accessed. Example Order | | EVENT\_TYPE | Type String Description Type of event. Value is always ExternalCrossOrgCallout. | | EXECUTE\_MS | Type Number Description How long it took (in milliseconds) for Salesforce to prepare and execute the query. Available in API version 42.0 and later. Example 1 | | FETCH\_MS | Type Number Description How long it took (in milliseconds) to retrieve the query results from the external system. Available in API version 42.0 and later. Example 452 | | FILTER | Type Text Description Field expressions to filter which rows to return. Corresponds to WHERE in SOQL queries. Example WHERE CustomerId='123456' | | HAVING | Type Text Description Reserved for future use. | | LIMIT | Type Number Description Maximum number of rows to return for a query. Corresponds to LIMIT in SOQL queries. Example 200 | | MESSAGE | Type String Description Error or warning message associated with the failed query callout. Value is always empty for upsert and delete callouts. Example System.UnexpectedException: Query is either selecting too many fields or the filter conditions are too complicated | | OFFSET | Type Number Description Number of rows to skip when paging through a result set. Corresponds to OFFSET in SOQL queries. If a SOQL query doesn’t define an OFFSET, the value is -1. Example 0 (default) | | ORDERBY | Type String Description Field or column to use for sorting query results, and whether to sort the results in ascending (default) or descending order. Corresponds to ORDER BY in SOQL queries. Examples - ORDER BY ShipName - ORDER BY ShipName DESC | | ORGANIZATION\_ID | Type Id Description 15-character ID of the organization. Example 00D000000000123 | | REQUEST\_ID | Type String Description Unique ID of a transaction. A transaction can contain one or more events. All events in a transaction have the same REQUEST\_ID. Example 4A13-HSKv3CKs-0FKfceaV | | ROWS | Type Number Description Total number of records in the result set. Value is always 0 for upsert and delete callouts. Example 200 | | ROWS\_FETCHED | Type Number Description Reserved for future use. | | SELECT | Type String Description Comma-separated list of fields being queried. Corresponds to SELECT in SOQL queries. Example SELECT Id,Name,CustomerID,OrderDate | | STATUS | Type Boolean Description Whether the query was successful. Value is always empty for upsert and delete callouts. Possible Values - 1—Success - 0—Failed | | SUBQUERIES | Type Number Description The number of subqueries that the query is split into. | | THROUGHPUT | Type Number Description Reserved for future use. | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | TOTAL\_MS | Type Number Description How long it took (in milliseconds) to prepare and execute the query and to retrieve the query results. Example 453 | | USER\_ID | Type Id Description 15-character ID of the user accessing the external system. Example 00530000009M943 | | USING\_MRU | Type Boolean Description Reserved for future use. | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=b3bf3f44637050becb14c824f27bd6445aa0e384bed1c8760fd606481d5ea071 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_externalcustomapexcallout.md --> # External Custom Apex Callout Event Type External Custom Apex Callout events represent external data callouts via custom adapters for Salesforce Connect. This event type is available in the EventLogFile object in API version 40.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ACTION | Type String Description Action performed by the callout. Possible Values - query - upsert - delete | | ENTITY | Type String Description Name of the external object being accessed. Example Order | | EVENT\_TYPE | Type String Description Type of event. Value is always ExternalCustomApexCallout. | | EXECUTE\_MS | Type Number Description How long it took (in milliseconds) for Salesforce to prepare and execute the query. Available in API version 42.0 and later. Example 102 | | FETCH\_MS | Type Number Description How long it took (in milliseconds) to retrieve the query results from the external system. Available in API version 42.0 and later. Example 607 | | FILTER | Type Text Description Field expressions to filter which rows to return. Corresponds to WHERE in SOQL queries. Example Filter:\[columnName=CustomerID, columnValue=537, subfilters=null, tableName=Order, type=EQUALS\] | | LIMIT | Type Number Description Maximum number of rows to return for a query. Corresponds to LIMIT in SOQL queries. Example 200 | | MESSAGE | Type String Description Error or warning message associated with the failed call. Example System.UnexpectedException: Query is either selecting too many fields or the filter conditions are too complicated | | OFFSET | Type Number Description Number of rows to skip when paging through a result set. Corresponds to OFFSET in SOQL queries. Example 0 (default) | | ORDERBY | Type String Description Field or column to use for sorting query results, and whether to sort the results in ascending (default) or descending order. Corresponds to ORDER BY in SOQL queries. Examples (Order:\[columnName=OrderDate, direction=ASCENDING, tableName=Order\]) | | ORGANIZATION\_ID | Type Id Description 15-character ID of the organization. Example 00D000000000123 | | REQUEST\_ID | Type String Description Unique ID of a transaction. A transaction can contain one or more events. All events in a transaction have the same REQUEST\_ID. Example 4A13-HSKv3CKs-0FKfceaV | | ROWS | Type Number Description Total number of records in the result set. The value is always -1 if the custom adapter’s DataSource.Provider class doesn’t declare the QUERY\_TOTAL\_SIZE capability. Example 200 | | ROWS\_FETCHED | Type Number Description Number of rows fetched by the callout. Available in API version 42.0 and later. Example 200 | | SELECT | Type String Description Comma-separated list of fields being queried. Corresponds to SELECT in SOQL queries. Example (ColumnSelection:\[aggregation=NONE, columnName=Name, tableName=Order\], ColumnSelection:\[aggregation=NONE, columnName=CustomerID, tableName=Order\], ColumnSelection:\[aggregation=NONE, columnName=OrderDate, tableName=Order\]) | | STATUS | Type Boolean Description Whether the query was successful. Possible Values - 1—Success - 0—Failed - Empty—Failed with no logged status or message | | THROUGHPUT | Type Number Description Number of records retrieved in one second. Example 302.57 | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | SUBQUERIES | Type Number Description Reserved for future use. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | TOTAL\_MS | Type Number Description How long it took (in milliseconds) to prepare and execute the query and to retrieve the query results. Example 709 | | USER\_ID | Type Id Description 15-character ID of the user accessing the external system. Example 00530000009M943 | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=58c874cfd5a2ac57e81dd73fe3df24ba11d7f9f53da6cd6ded3d0dc61a8e17c1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_externaldatasourcecallout.md --> # External Data Source Callout Event Type External Data Source Callout events represent external data callouts via the Salesforce Connect adapters for Amazon DynamoDB and Amazon Athena. This event type is available in the EventLogFile object in API version 56.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ACTION | Type String Description Action performed by the callout. Possible Values For Amazon DynamoDB data source: - query - insert - delete - update - upsert For Amazon Athena data source: - query | | DATA\_SOURCE\_NAME | Type String Description Name of the external data source being accessed. | | EVENT\_TYPE | Type String Description Type of event. Value is always ExternalDataSourceCallout. | | EXTERNAL\_OBJECT | Type String Description Name of the external object being accessed. | | FETCH\_MS | Type Number Description How long it took (in milliseconds) to retrieve the query results from the external data source. Example 127 | | FILTER | Type Text Description Field expressions to filter which rows to return. Corresponds to WHERE in queries. | | LIMIT | Type Number Description Maximum number of rows to return for a query. Corresponds to [Limit parameter in ExecuteStatement operation](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ExecuteStatement.html) for an Amazon DynamoDB data source. | | MESSAGE | Type String Description Error or warning message associated with the failed call. | | NEXT\_LINK | Type String Description Next link that the callout used to request a subsequent page of rows. A next link is provided in a previous response when the response includes only part of the result set. For requests to AWS data sources, this field stores the nextToken parameter that contains a unique hash string. | | OFFSET | Type Number Description Number of rows to skip when paging through a result set. Corresponds to OFFSET in queries to Amazon Athena. This field is not supported by queries to Amazon DynamoDB. | | OPERATION | Type String Description The operation that’s being performed. | | ORDERBY | Type String Description Field or column to use for sorting query results, and whether to sort the results in ascending (default) or descending order. Corresponds to ORDER BY in queries. Example - Country ASC - CustomerName DESC | | ORGANIZATION\_ID | Type Id Description 15-character ID of the organization. Example 00D000000000123 | | PARENT\_CALLOUT | Type String Description If the callout requested a subsequent page of rows, this field identifies the initial callout whose request resulted in the multi-page result set. Example 4EoZtuBzzRIXSk-ysRdf1F-1 | | PROVIDER\_TYPE | Type String Description Whether the callout was made by Salesforce Connect adapter for Amazon DynamoDB or Amazon Athena. Possible Values - amazonDynamodb - amazonAthena | | REQUEST\_ID | Type String Description Unique ID of a transaction. A transaction can contain one or more events. All events in a transaction have the same REQUEST\_ID. Example 4A13-HSKv3CKs-0FKfceaV | | RESPONSE\_SIZE | Type Number Description The size of the callout response, in bytes. | | ROWS\_FETCHED | Type Number Description Number of records fetched by the callout. The records fetched by a callout can be a subset of a large result set. Example 200 | | SEARCH | Type String Description Search query string. | | SELECT | Type String Description Comma-separated list of fields being queried. Corresponds to SELECT in queries. To query, Salesforce Connect adapter uses PartiQL with Amazon DynamoDB and SQL with Amazon Athena. Example CustomerID,OrderDate,OrderID,ShipCity,ShipCountry | | STATUS | Type Boolean Description Whether the query was successful. Possible Values - 1—Success - 0—Failed | | STATUS\_CODE | Type Number Description The HTTP response status code for the request. | | TABLE\_NAME | Type String Description Name of the table being queried in the AWS data source. | | THROUGHPUT | Type Number Description Number of records retrieved in one second. Example 3025.67 | | TIMESTAMP | Type DateTime Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | TOTAL\_MS | Type Number Description How long it took (in milliseconds) to prepare and execute the query and to retrieve the query results. | | USER\_ID | Type Id Description 15-character ID of the user accessing the external data source. Example 00530000009M943 | <!-- document id=553361a7a2036ac19708205192f1093e4edd097af826899cd8e453993c2c7e30 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_external_objects.md --> # External Objects External objects are supported in API version 32.0 and later. External objects are similar to custom objects, but external object record data is stored outside your Salesforce organization. For example, perhaps you have data that’s stored on premises in an enterprise resource planning (ERP) system. Instead of copying the data into your org, you can use external objects to access the data in real time via web service callouts. External objects are available with Salesforce Connect and Files Connect. Each external object is associated with an external data source definition in your Salesforce organization. An external data source specifies how to access an external system. Salesforce Connect uses external data sources to access data that's stored outside your Salesforce organization. Files Connect uses external data sources to access third-party content systems. External data sources have associated external objects, which your users and the Lightning Platform use to interact with the external data and content. By accessing record data on demand, external objects always reflect the current state of the external data. You don't have to manage a copy of that data in Salesforce, so you're not wasting storage and resources keeping data in sync. External objects are best used when you have a large amount of data that you can’t or don’t want to store in your Salesforce organization, and you need to use only a small amount of data at any one time. See [Define External Objects](https://help.salesforce.com/s/articleView?id=platform.external_object_define.htm&language=en_US) in Salesforce Help for how to create and modify external objects. ## Naming Conventions for External Objects Object names must be unique across all standard, custom, and external objects in the org. In the API, the names of external objects are identified by a suffix of two underscores immediately followed by a lowercase “x” character. For example, an external object named “ExtraLogInfo” in the Salesforce user interface is seen as ExtraLogInfo\_\_x in that organization's WSDL. We recommend that you make object labels unique across all standard, custom, and external objects in the org. ## External Object Relationships External objects support standard lookup relationships, which use the 18-character Salesforce record IDs to associate related records with each other. However, data that’s stored outside your Salesforce org often doesn’t contain those record IDs. Therefore, two special types of lookup relationships are available for external objects: external lookups and indirect lookups. See [External Object Relationships](https://help.salesforce.com/s/articleView?id=platform.external_object_relationships.htm&language=en_US) in Salesforce Help for details. ## Feature Support for External Objects Most of the Salesforce features that support custom objects also support external objects. However, there are exceptions, and some features have special limitations and considerations for external objects. See the following topics in the Salesforce Help. - [External Objects in Salesforce Connect](https://help.salesforce.com/s/articleView?id=platform.platform_connect_considerations_compatibility.htm&language=en_US) - [Salesforce Platform Features Supported by Salesforce Connect](https://help.salesforce.com/s/articleView?id=platform.platform_connect_considerations.htm&language=en_US) ## Salesforce Connect Adapters Salesforce Connect uses a protocol-specific adapter to connect to an external system and access its data. This table describes the available adapters. <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader vertical-align-top " id="d890149e128">Salesforce Connect Adapter</th> <th class="featureTableHeader vertical-align-top " id="d890149e131">Description</th> <th class="featureTableHeader " id="d890149e134">When to Use </th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d890149e128" data-title="Salesforce Connect Adapter">Cross-org</td> <td class="entry" headers="d890149e131" data-title="Description">Uses the Lightning Platform REST API to access data that’s stored in other Salesforce orgs.</td> <td class="entry" headers="d890149e134" data-title="When to Use">To seamlessly connect data between your Salesforce orgs. For example, provide your service representatives a unified view of customer transactions by integrating data from different Salesforce orgs.</td> </tr> <tr> <td class="entry" headers="d890149e128" data-title="Salesforce Connect Adapter">OData 2.0<p class="p">OData 4.0</p> </td> <td class="entry" headers="d890149e131" data-title="Description">Uses Open Data Protocol to access data that’s stored outside Salesforce. The external data must be exposed via OData producers.</td> <td class="entry" headers="d890149e134" data-title="When to Use">To integrate external data sources into your org that support the ODATA protocol and publish an OData provider. For example, give your account executives a unified data view by pulling data from legacy systems such as SAP, Microsoft, and Oracle in real time.</td> </tr> <tr> <td class="entry" headers="d890149e128" data-title="Salesforce Connect Adapter">Custom adapter created via Apex</td> <td class="entry" headers="d890149e131" data-title="Description">You use the Apex Connector Framework to develop your own custom adapter when the other available adapters aren’t suitable for your needs.<p class="p">A custom adapter can obtain data from anywhere. For example, some data can be retrieved from anywhere in the Internet via callouts, while other data can be manipulated or even generated programmatically.</p> </td> <td class="entry" headers="d890149e134" data-title="When to Use">To develop your own adapter with the Apex Connector Framework when the other available adapters aren’t suitable for your needs. For example, when you want to retrieve data via callouts from a REST API. </td> </tr> </tbody> </table> ## Files Connect Adapters Several Files Connect adapters are also available: - Google Drive - Box - SharePoint Online - OneDrive for Business For more information about Salesforce Connect, see [Salesforce Connect](https://help.salesforce.com/s/articleView?id=platform.platform_connect_about.htm&language=en_US) in the Salesforce Help. For details on using the Apex Connector Framework, see “Salesforce Connect” and “DataSource Namespace” in the [Apex Code Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/). <!-- document id=f83098853248fc183b95bc84c0cab948771b050cdb5076cea97c56690191da83 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_externalodatacallout.md --> # External OData Callout Event Type External OData Callout events represent external data callouts via the OData 2.0 and OData 4.0 adapters for Salesforce Connect. This event type is available in the EventLogFile object in API version 40.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ACTION | Type String Description Action performed by the callout. Possible Values - query - upsert - delete | | BYTES | Type Number Description Size of the result set in bytes. | | ENTITY | Type String Description Name of the external object being accessed. Example Order | | EVENT\_TYPE | Type String Description Type of event. Value is always ExternalODataCallout. | | EXECUTE\_MS | Type Number Description How long it took (in milliseconds) for Salesforce to prepare and execute the query. Available in API version 42.0 and later. Example 21 | | EXPAND | Type String Description Reserved for future use. | | FETCH\_MS | Type Number Description How long it took (in milliseconds) to retrieve the query results from the external system. Available in API version 42.0 and later. Example 127 | | FILTER | Type Text Description Field expressions to filter which rows to return. Corresponds to WHERE in SOQL queries and $filter in OData queries. Example CustomerID eq 12345 | | LIBRARY | Type String Description Reserved for future use. | | LIMIT | Type Number Description Maximum number of rows to return for a query. Corresponds to LIMIT in SOQL queries and $top in OData queries. Example 200 | | MESSAGE | Type String Description Error or warning message associated with the failed call. Example The OData query result was too large, so the external data didn’t load. | | NEXT\_LINK | Type String Description OData next link that the callout used to request a subsequent page of rows. A next link is provided in a previous response from the OData producer when the response includes only part of the result set. Available in API version 42.0 and later. However, this field isn’t supported for the OData 2.0 adapter on orgs created before Spring ’18. Example http://services.example.org/Warehouse.svc/Orders?$count=true&​$select=CustomerID,OrderID,RequiredDate,ShippedDate&$top=301&​$skiptoken=10447 | | OFFSET | Type Number Description Number of rows to skip when paging through a result set. Corresponds to OFFSET in SOQL queries and $skip in OData queries. Example 10 | | ORDERBY | Type String Description Field or column to use for sorting query results, and whether to sort the results in ascending (default) or descending order. Corresponds to ORDER BY in SOQL queries and $orderby in OData queries. Examples - ShipName - ShipName desc | | ORGANIZATION\_ID | Type Id Description 15-character ID of the organization. Example 00D000000000123 | | PARENT\_CALLOUT | Type String Description If the callout requested a subsequent page of rows, this field identifies the initial callout whose request resulted in the multi-page result set. Available in API version 42.0 and later. However, this field isn’t supported for the OData 2.0 adapter on orgs created before Spring ’18. Example 4EoZtuBzzRIXSk-ysRdf1F-1 | | PROVIDER\_TYPE | Type String Description Whether the OData 2.0 or OData 4.0 adapter made the callout. Possible Values - OData—OData 2.0 adapter - OData4—OData 4.0 adapter | | RATE\_LIMIT\_USAGE\_PERCENT | Type Number Description Consumed percentage of the org’s limit of OData callouts per hour. Example 2.5—2.5% of the hourly callout limit has been consumed | | REQUEST\_ID | Type String Description Unique ID of a transaction. A transaction can contain one or more events. All events in a transaction have the same REQUEST\_ID. Example 4A13-HSKv3CKs-0FKfceaV | | REQUESTS | Type Number Description Reserved for future use. | | ROWS | Type Number Description Total number of records in the result set. Available in API version 42.0 and later. Example 830 | | ROWS\_FETCHED | Type Number Description Number of records fetched by the callout. The records fetched by a callout can be a subset of a large result set. Available in API version 42.0 and later. However, this field isn’t supported for the OData 2.0 adapter on orgs created before Spring ’18. Example 200 | | SEARCH | Type String Description Search query string. Corresponds to condition expressions in SOSL. Example contains(CustomerID,'10248') eq true or contains(ShipName,'10248') eq true | | SELECT | Type String Description Comma-separated list of fields being queried. Corresponds to SELECT in SOQL queries and $select in OData queries. Example CustomerID,OrderDate,OrderID,ShipCity,ShipCountry | | STATUS | Type Boolean Description Whether the query was successful. Possible Values - 1—Success - 0—Failed | | THROUGHPUT | Type Number Description Number of records retrieved in one second. Available in API version 42.0 and later. However, this field isn’t supported for the OData 2.0 adapter on orgs created before Spring ’18. Example 3025.67 | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | TOTAL\_MS | Type Number Description How long it took (in milliseconds) to prepare and execute the query and to retrieve the query results. | | USER\_ID | Type Id Description 15-character ID of the user accessing the external system. Example 00530000009M943 | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=1f5307ef9158567851f6f0939cede6bba6e5158afd540d0bf1730a162dbe49a1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_externalaccounthierarchy.md --> # ExternalAccountHierarchy Represents the external account hierarchy, which works like a role-based hierarchy. Use ExternalAccountHierarchy to allow partner and customer users to share data with other external accounts in their hierarchy.This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules You must have a Partner or Customer Community Plus license. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Sort Description The ID of the account in the external account hierarchy. | | CurrencyISOCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: - GBP— British Pound - USD— U.S. Dollar The default value is USD. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the external account hierarchy. | | HierarchyType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Possible values are: - CustomerPortal — Customer - Partner The default value is Partner. | | IsAccessibleToParent | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Allows data to be shared with parent account in the account hierarchy. The default value is true. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description When true, the hierarchy is turned on. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the external account hierarchy. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account owner. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent account. | <!-- document id=0125aff8be5f8cadecde6e5caa1d5ac2bd3460295fa51fcd3cd67aecf329e89f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_externalaccounthierarchyhistory.md --> # ExternalAccountHierarchyHistory Represents the history of changes to values in the fields of an external account hierarchy. This object is available in API version 50.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules You must have a Partner or Customer Community Plus license. ## Fields | Field | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Possible values are: - Address - AnyType - AutoNumber - Base64 - BitVector - Boolean - Content - Currency - DataCategoryGroupReference - DateOnly - DateTime - Division - Double - DynamicEnum - Email - EncryptedBase64 - EncryptedText - EntityId - EnumOrId - ExternalId - Fax - File - HtmlMultiLineText - HtmlStringPlusClob - InetAddress - Json - Location - MultiEnum - MultiLineText - Namespace - Percent - PersonName - Phone - Raw - RecordType - SfdcEncryptedText - SimpleNamespace - StringPlusClob - Switchable\_PersonName - Text - TimeOnly - Url - YearQuarter | | ExternalAccountHierarchyId | Type reference Properties Filter, Group, Sort Description The ID of the external account hierarchy. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Possible values are: - Account - HierarchyType - Hierarchy Type - IsAccessibleToParent - Is Accessible to Parent - IsActive - Is Hierarchy Active - Name - Owner - Parent - Created - Created. - FeedEvent - Feed Event - IndividualMerged - Individual Merged - Locked - Record Locked - OwnerAccepted - Owner (Accepted) - OwnerAssignment - Owner (Assignment) - Unlocked - Record unlocked | | NewValue | Type anyType Properties Nillable, Sort Description The updated value of the changed field. | | OldValue | Type anyType Properties Nillable, Sort Description The previous value of the changed field. | <!-- document id=924a5afcf6aa7cd7c42814299a86c905bf5855e365a88d6a8cab63d4de352bf0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_externalclientapplication.md --> # ExternalClientApplication For internal use only. <!-- document id=fd597b2b8594edc9a98698ae40bb3f7e6658b35a6b36c80ae9f397d38e3c26e8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_externaldatasource.md --> # ExternalDataSource Represents an external data source, which defines connection details for integration with data and content that are stored outside the Salesforce org. This object is available in API version 27.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note All credentials stored within this entity are encrypted under a framework that is consistent with other encryption frameworks on the platform. Salesforce encrypts your credentials by auto-creating org-specific keys. Credentials encrypted using the previous encryption scheme have been migrated to the new framework. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules From API version 48.0 onwards, only authenticated internal and external users can access this object. ## Fields | Field Name | Details | | --- | --- | | AuthProviderId | Type reference Properties Filter, Group, Nillable, Sort Description Salesforce ID of the authentication provider, which defines the service that provides the login process and approves access to the external system. Only users with the “Customize Application” and “Manage AuthProviders” permissions can view this field. This field is available in API version 39.0 and later. This is a relationship field. Relationship Name AuthProvider Relationship Type Lookup Refers To AuthProvider | | CustomConfiguration | Type textarea Properties Nillable Description A JSON-encoded configuration string that defines parameters specific to the type of external data source. | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | Endpoint | Type textarea Properties Nillable Description The URL of the external system, or if that URL is defined in a named credential, the named credential URL. A named credential URL contains the scheme callout:, the name of the named credential, and an optional path. For example: callout:My\_Named\_Credential/some\_path. You can append a query string to a named credential URL. Use a question mark (?) as the separator between the named credential URL and the query string. For example: callout:My\_Named\_Credential/some\_path?format=json. | | isWritable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Lets the Lightning Platform and users in this org create, update, and delete records for external objects associated with the external data source. The external object data is stored outside the org. By default, external objects are read only. Available only for Salesforce Connect external data sources. Available in API version 35.0 and later. However, with the cross-org adapter for Salesforce Connect, you can set this field to true only in API version 39.0 and later. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the MasterLabel. | | MasterLabel | Type string Properties Filter, Group, Sort Description Master label for the external data source. This internal label doesn’t get translated. | | NamedCredentialId | Type reference Properties Filter, Group, Nillable, Sort Description The Salesforce ID of the referenced named credential for an external data source. Required for Salesforce Connect adapters for Amazon DynamoDB, Amazon Athena, GraphQL, and OData 4.01. For connecting to other external data sources, the field must be null. This field is available in API version 58.0 and later. This is a relationship field. Relationship Name NamedCredential Relationship Type Lookup Refers To NamedCredential | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. | | PrincipalType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies whether the org uses one set (NamedUser), multiple sets (PerUser), or no (Anonymous) credentials to access the external system. Each set of credentials corresponds to a login account on the external system. Corresponds to Identity Type in the user interface. | | Protocol | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies whether to use OAuth, password authentication, or no authentication to access the external system. Some types of external data sources support only one value. - For cloud-based Files Connect external systems, select **Oauth 2.0**. - For on-premises systems, select **Password Authentication**. - For Simple URL data sources, select **No Authentication**. Additional authentication protocols are supported for the Amazon DynamoDB, Amazon Athena, Snowflake, GraphQL, and OData 4.01 external data sources. - AwsSv4 - Basic - Custom - Jwt - JwtExchange | | Repository | Type string Properties Filter, Group, Nillable, Sort Description Used for SharePoint Online. An optional name of the repository in the data source. Not applicable to all data source types. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies the adapter that connects to the external system. | ## Usage Define an external data source to connect to data or content that’s stored outside the Salesforce org. Then create external objects, which map to the external system’s data and behave similarly to custom objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Some external data source fields rely on per-user authentication to connect with an external system. If an admin edits one of these fields, then the previously authenticated credentials can get invalidated, requiring individual users to reauthenticate. #### See Also - [ExternalDataUserAuth](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externaldatauserauth.htm "Stores authentication settings for a Salesforce user to access an external system. The external system must be defined in an external data source or a named credential that’s configured to use per-user authentication. This object is available in API version 27.0 and later.") - [NamedCredential](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_namedcredential.htm "Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts. This object is available in API version 33.0 and later.") <!-- document id=bb4f4965d0a733dc4052829689b93a7e36e0e15a75a63275d00c3aa5786a750b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_externaldatauserauth.md --> # ExternalDataUserAuth Stores authentication settings for a Salesforce user to access an external system. The external system must be defined in an external data source or a named credential that’s configured to use per-user authentication. This object is available in API version 27.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note All credentials stored within this entity are encrypted under a framework that is consistent with other encryption frameworks on the platform. Salesforce encrypts your credentials by auto-creating org-specific keys. Credentials encrypted using the previous encryption scheme have been migrated to the new framework. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AuthProviderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce ID of the authentication provider, which defines the service that provides the login process and approves access to the external system. Only users with the “Customize Application” and “Manage AuthProviders” permissions can view this field. This field is available in API version 39.0 and later. This is a relationship field. Relationship Name AuthProvider Relationship Type Lookup Refers To AuthProvider | | ExternalDataSourceId | Type reference Properties Create, Filter, Group, Sort Description Salesforce ID of the external data source or named credential that defines the external system. This is a polymorphic relationship field. Relationship Name ExternalDataSource Relationship Type Lookup Refers To ExternalDataSource, NamedCredential | | Password | Type textarea Properties Create, Nillable, Update Description Password portion of the credentials for the Salesforce user to access the external system. | | Protocol | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether to use OAuth, password authentication, or no authentication when the user accesses the external system. Additional authentication protocols are supported for the Amazon DynamoDB, Amazon Athena, Snowflake, GraphQL, and OData 4.01 external data sources. - AwsSv4 - Basic - Custom - Jwt - JwtExchange | | UserId | Type reference Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description ID of the Salesforce user who’s accessing the external system. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | | Username | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Username portion of the credentials for the Salesforce user to access the external system. | ## Usage These authentication settings enable a Salesforce user to access an external system. The external system is defined in Salesforce as one of the following. - External data source—Provides access to external objects, whose data is stored outside the Salesforce organization. - Named credential—Enables the user’s actions to trigger authenticated callouts to the endpoint that’s specified in the named credential. If you grant users access to the external data source or named credential via permission sets or profiles, those users can manage their own authentication settings. See [Store Authentication Settings for External Systems](https://help.salesforce.com/s/articleView?id=platform.external_authentication.htm&type=5&language=en_US "HTML (New Window)") in the Salesforce Help. #### See Also - [ExternalDataSource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externaldatasource.htm "Represents an external data source, which defines connection details for integration with data and content that are stored outside the Salesforce org. This object is available in API version 27.0 and later.") - [NamedCredential](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_namedcredential.htm "Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts. This object is available in API version 33.0 and later.") <!-- document id=41ee72297e73c3eaab6fdcb5449ce349aca5f3c029355a5b6cc2ee9ec8a05d9f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_externalencryptionrootkey.md --> # ExternalEncryptionRootKey Represents metadata about root keys stored in third-party key stores that are used to generate and secure keys that encrypt Salesforce data. This object is available in API version 58.0 and later. Root keys are used to generate data encryption keys (DEKs) in Salesforce, which are in turn used to encrypt and decrypt data. Root keys are also used as wrapping keys to secure DEKs in the Salesforce database. ## Supported Calls describeSObjects(), query(), update() ## Special Access Rules This object is available as part of the Shield and Salesforce Platform Encryption add-on subscriptions. Access to this object also requires the Cache-Only Key Service add-on subscription. ## Fields | Field | Details | | --- | --- | | ActivatedDate | Type dateTime Properties Filter, Nillable, Sort, Update Description The date the key was activated in Salesforce. | | CreatedBy | Type string Properties Filter, Group, Nillable, Sort, Update Description The email address of the user who created the root key. For example, user@example.com. | | Description | Type string Properties Filter, Group, Nillable, Sort, Update Description The user-defined description of the root key. | | LastModifiedBy | Type string Properties Filter, Group, Nillable, Sort, Update Description The email address of the user who most recently modified the key. For example, user@example.com. | | Region | Type string Properties Filter, Group, Nillable, Sort, Update Description The region for the customer managed key. For example, if the RootKeyService is AWS, the region is an Amazon Web Services (AWS) region such as us-east1. | | RootKeyIdentifier | Type string Properties Filter, Nillable, Sort, Update Description The unique key identifier from the external KMS, such as an AWS Amazon Resource Name (ARN). For example, arn:aws:kms:us-west-2:123456789000:key/123ab456-7cd8-9012-3e4f-5gh678i901j2 | | RootKeyService | Type string Properties Filter, Group, Nillable, Sort, Update Description The external key management service connected to Salesforce. For example, AWS. | | Status | Type string Properties Filter, Group, Nillable, Sort, Update Description The status of the key. This is the only value that can be changed using update(). You can only change the status from Active to Inactive, or from Inactive to Active. Possible values are: - Activation Pending—Salesforce is waiting for confirmation of a valid key policy in the external key store. - Active—Can be used to encrypt new DEKs and decrypt existing DEKs. - Archived—Can’t encrypt new DEKs. Can be used to decrypt previously created DEKs. - Canceled—Root key activation canceled by a user. - Inactive—The root key, and the DEKs that it encrypts, are inaccessible. Inaccessible DEKs can’t be used to decrypt data, which renders that data also inaccessible. - Unavailable—The root key, and the DEKs that it encrypts, cannot be accessed. The root key has been removed or deactivated by the managing KMS. | ## Usage Three functions are available: describeSObjects(),query(), and update() Use your preferred developer environment to run the examples. Use the Salesforce developer [Introduction to REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/intro_rest.htm) for basic information on making REST calls into Salesforce. Also, [Introducing the Salesforce Shield Platform Encryption REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_encryption_rest_api_guide.meta/platform_encryption_rest_api_guide/api_rest_encryption.htm) gives you starter information on using REST to work with Shield Platform Encryption. Describe an external root key with describeSObjects() To get information about the ExternalEncryptionRootKey sObject, use describe. curl --location 'https://DOMAIN.my.salesforce.com/services/data/v62.0/sobjects/'\\ ExternalEncryptionRootKey/describe' --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer TOKEN' On success, the response is the full JSON description of the ExternalEncryptionRootKey sObject. Get info on an external root key with query() To get information about a specific root key, use query on the ExternalEncryptionRootKey sObject. Use the Identifier value as listed on the Key Management Page for the root key Id in the WHERE clause. curl --location 'https://DOMAIN.my.salesforce.com/services/data/v62.0/query?' \\ ?q=SELECT+FIELDS(ALL)+FROM+ExternalEncryptionRootKey+WHERE+Id='48q001t5ddzbucnAAA'+\\ --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer TOKEN' On success, the response is be similar to { "totalSize": 1, "done": true, "records": \[ { "attributes": { "type": "ExternalEncryptionRootKey", "url": "/services/data/v62.0/sobjects/ExternalEncryptionRootKey/48q001t5ddzbucnAAA" }, "Id": "48q001t5ddzbucnAAA", "RootKeyIdentifier": "97ee8238-c5ac-4320-a2d0-a728aaefd567", "CreatedDate": "2024-08-05T17:32:11.841+0000", "CreatedBy": "charley.t.pulasky@wise-raccoon-od1ly6.com", "LastModifiedDate": "2025-02-12T18:36:11.063+0000", "LastModifiedBy": "charley.t.pulasky@wise-raccoon-od1ly6.com", "RootKeyService": "SF", "Region": "KEY REGION", "Status": "Active", "Description": null, "ActivatedDate": null } \] } Update Status on an external root key with update() To update the status of an ExternalEncryptionRootKey from Active to Inactive, or from Inactive to Active, use PATCH on the specific key object. Use the vaule for Identifier as listed on the Key Management Page for the root key identifier. curl --location --request PATCH 'https://DOMAIN.my.salesforce.com/services/data/v62.0/sobjects/ExternalEncryptionRootKey/ROOTKEYIDENTIFIER' \\ --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer TOKEN'\\ --data '{ "Status": "Active" }' On success, the response is be similar to I SEE NO RESPONSE. <!-- document id=aff56fff249da5784b5ffee2be532e3ac149c392d1cfce0af98c0444a9fd7f9b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_externalevent.md --> # ExternalEvent Holds native iOS or Android calendar event details for the Salesforce Today feature in the Salesforce mobile app. This object is available in API version 35.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The Salesforce Today app is available in Salesforce for Android and Salesforce for iOS. It’s not available in the Salesforce desktop site. Access to Today is available only if you grant Calendar permission to the Salesforce mobile app. ## Fields | Field | Details | | --- | --- | | ExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the external event. | | Location | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The site where the external event takes place. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the external event’s organizer. | | Notes | Type textarea Properties Create, Nillable, Update Description Additional details about the external event. | | Time | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The time the external event is held. | | Title | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The title of the external event. | ## 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. [ExternalEventChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. <!-- document id=29e68ea9cf26922d3a5642a23ba0256bbb1aae1ba6664ea991156da9d7aa8311 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_externaleventmapping.md --> # ExternalEventMapping Holds native iOS or Android calendar event details for the Salesforce Today feature in the Salesforce mobile app. This object is available in API version 35.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The Salesforce Today app is available in Salesforce for Android and Salesforce for iOS. It’s not available in the Salesforce desktop site. Access to Today is available only if you grant Calendar permission to the Salesforce mobile app. ## Fields | Field | Details | | --- | --- | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the external event ends. | | EventId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Salesforce event created by the external event. This field is a relationship field. Relationship Name Event Refers To Event | | ExternalId | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The ID of the external event. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Returns true if the external event is locked, or false if it’s not. The default value is false. | | IsRecurring | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the external event is recurring (true) or not (false). The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Indicates whether the external event can be edited (true) or not (false). The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the external event’s organizer. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the creator of the external event. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the external event begins. | <!-- document id=90828df0a6188c57d2ea6f350fdec8225801d2b06d778d9b6409e36c2bae8e36 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_externalsocialaccount.md --> # ExternalSocialAccount Represents a managed social media account on a social network such as Facebook or Twitter. This object is available in API version 29.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | AuthorizedBy | Type string Properties Filter, Group, Nillable, Sort Description Name of the Radian6 user who added the social account to Radian6. | | DataSourceId | Type string Properties Filter, Group, Nillable, Sort Description ID of the Radian6 data source for the social account. | | DefaultResponseAccountId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the managed social account to use by default when responding. This is a relationship field. Relationship Name DefaultResponseAccount Relationship Type Lookup Refers To ExternalSocialAccount | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | ExternalAccountId | Type string Properties Filter, Group, Sort Description ID of the social account on the social network. | | ExternalPictureURL | Type url Properties Filter, Group, Nillable, Sort Description URL to the picture of the social account on the social network. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the social account is active or not. | | IsAuthenticated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the social account is authenticated or not. | | IsCaseCreationEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether case creation for the social account is enabled or not. | | IsDataSourceActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the data source is active or not. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies the language of the social account. | | MasterLabel | Type string Properties Filter, Group, Sort Description Master label for the social account. This display value is the internal label and does not get translated. | | ProfileUrl | Type url Properties Filter, Group, Nillable, Sort Description URL for the profile. | | Provider | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Social network, such as Facebook or Twitter, of the social account. | | ProviderUserId | Type string Properties Filter, Group, Sort Description User ID for the social network of the social account. | | RuleId | Type string Properties Filter, Group, Nillable, Sort Description ID of the Radian6 rule for the account. | | SocialPropertyId | Type string Properties Filter, Group, Nillable, Sort Description ID of the Radian6 social property for the account. | | TopicId | Type string Properties Filter, Group, Nillable, Sort Description ID of the topic for the social account. | | UniqueName | Type string Properties Filter, Group, Nillable, Sort Description Unique name for the social account. | | Username | Type string Properties Filter, Group, Nillable, Sort Description Username for the social account. | ## Usage Although available, many of the Radian6-related fields are no longer accurate or used. We recommend using [Social Engagement Resources](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_social_engagement_list.htm "HTML (New Window)") in Connect REST API Developer Guide. <!-- document id=fe7120076162c4445602064339de260400b9cd2d101314feab7bfbeb004e6b39 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extknowledgeconnector.md --> # ExtKnowledgeConnector Represents a connector to a third-party knowledge source for Unified Knowledge. This object is available in API version 60.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Knowledge must be enabled in your org. Salesforce Knowledge users, unlike customer and partner users, must also be granted the Knowledge User feature license. ## Fields | Field | Details | | --- | --- | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action condition record is locked or not. The default value is false. | | LastSyncDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates when the connector last synced with the third-party knowledge source to import articles into Salesforce. | | LastSyncStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the status of the connector’s last sync of articles from the third-party knowledge source into Salesforce. Possible values are: - articleLimitExceeded—Exceeded article or version limits - completed—Completed - completedWithErrors—Completed with errors - ended—Ended - failed—Failed - initiating—Started - invalidCredentials—Invalid credentials - polling—Polling for Zoomin sync to complete - queued—Queued - syncing—Syncing - timedOut—Timed Out - unavailable—Zoomin unavailable | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated import article condition record can be edited or not. The default value is false. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The connector’s label in Unified Knowledge setup. | | NamedCredentialId | Type reference Properties Filter, Group, Nillable, Sort Description Salesforce ID of the named credential that’s used for a request. The named credential identifies the third-party system and the third-party authentication settings. This field is a relationship field. Relationship Name NamedCredential Relationship Type Lookup Refers To NamedCredential | | OwnerId | Type reference Properties Filter, Group, Sort Description The user ID of the owner of the connector. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PartnerConnectorIdentifier | Type string Properties Filter, Group, Nillable, Sort Description | | ShouldOpenInSource | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether articles imported into Salesforce open in the third-party source from links in Salesforce. The default value is false. | ## 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. [ExtKnowledgeConnectorOwnerSharingRule](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. [ExtKnowledgeConnectorShare](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. <!-- document id=5e1a9728df342bc0b5362d8a5f2903ecbcdc4f04b5b48e5194af4768663ea00b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlclntappoauthplcycnfg.md --> # ExtlClntAppOauthPlcyCnfg For internal use only. <!-- document id=31802e8ebf93a5c9f5027bcf7e1b747c189812e374b60d9048a24a3e48352005 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlclntappoauthsettings.md --> # ExtlClntAppOauthSettings For internal use only. <!-- document id=a1f69006b8c7f4b5cdcd6f5544c4e4daf9162a742b6a4f0e17131343109f6e56 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlclntappplcycnfg.md --> # ExtlClntAppPlcyCnfg For internal use only. <!-- document id=bbc942667e4a12952bf5ea43f9219d88409208c3851fe2762c9a3de6dbeeeeb9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlintridmapping.md --> # ExtlIntrIdMapping Represents a mapping between a Salesforce record and its corresponding record in an external system, such as Workday. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules ## Fields | Field | Details | | --- | --- | | ExternalIdentifier | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The ID of the external event. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the external event’s organizer. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the creator of the external event. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | RecordIdentifier | Type string Properties Create, Filter, Group, Sort, Update Description The ID of the Salesforce record that is linked to a record in an external system. | | RelatedExternalIdentifier | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The ID of an associated record from the external system that provides additional context for the integration. | ## 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. [ExtlIntrIdMappingOwnerSharingRule](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. [ExtlIntrIdMappingShare](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. <!-- document id=d0c1b7ed8e2f23d8cc7c409f5fb4581cfe4f818a1a7ed6581f87ad81b361fbbb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshrcnct.md --> # ExtlRecShrCnct Represents authentication data to make outbound calls to and inbound calls from an external system to publish events for Partner Connect. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), update() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | CnctName | Type string Properties Filter, Group, Nillable, Sort, Update Description Name of the connection. | | CnctRole | Type picklist Properties Filter, Group, Restricted picklist, Sort Description System’s role in the connection. Possible values are: - Partner - Vendor | | CnctStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of the connection. Possible values are: - Disabled - Enabled - Error - Pending - Unknown | | ExternalClientApplicationId | Type reference Properties Filter, Group, Nillable, Sort Description ID of external client app representing your org’s connection to the external system. This field is a relationship field. Relationship Name ExternalClientApplication Refers To ExternalClientApplication | | ExtlSystem | Type string Properties Filter, Group, idLookup, Nillable, Sort Description ID of the external system. | | NamedCredentialId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the named credential. This field is a relationship field. Relationship Name NamedCredential Refers To NamedCredential | <!-- document id=977cd1b41ee83f86072ee85adbf2704bbdfb5ec4d31c1b2323855c2704e9ea6e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshrcnctaccnt.md --> # ExtlRecShrCnctAccnt Represents an association between an account and an external record share connection for Partner Connect. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Sort Description ID of the account. This field is a relationship field. Relationship Name Account Refers To Account | | ExtlRecShrCnctId | Type reference Properties Filter, Group, Sort Description ID of the ExtlRecShrCnct record. This field is a relationship field. Relationship Name ExtlRecShrCnct Refers To ExtlRecShrCnct | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. | <!-- document id=8a7417b5688d6363b457a1dd3933f02948c7458758a0233cbc4a0c328f3d6492 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshrfield.md --> # ExtlRecShrField Represents an imported, exported, or updated external record share field for Partner Connect. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | ExtlRecShrObjectId | Type reference Properties Create, Filter, Group, Sort Description ID of the ExtlRecShrObject record. This field is a relationship field. Relationship Name ExtlRecShrObject Refers To ExtlRecShrObject | | FieldDefaultValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Default value of the field. | | FieldSetType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Set of fields associated with this record. Possible values are: - ExportedFields - ImportedFields - InternalFields | | IsFieldNillable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this field can be set to null (true) or not (false). The default value is false. | | SendFieldUpdates | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether updates are tracked for this field, sent to the connected org, and stored in the ExtlRecShrLead or ExlRecShrOpportunity objects (true) or not (false). The default value is false. | | SharedFieldDevName | Type string Properties Create, Filter, Group, Sort Description Developer name of the field. | | SharedFieldLabel | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Label of the field. | | SharedFieldLength | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Maximum length of the field. | | SharedFieldType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Field type of the imported, exported, or updated field. Possible values are: - Address - Boolean - Currency - DateOnly - DateTime - Double - DynamicEnum - Email - EntityId - EnumOrId - Fax - Integer - MultiLineText - Percent - Phone - StaticEnum - Text - Url | <!-- document id=d3e8b5206b3aac2a07aca244c266bc8ee370dc8f43774e11aa2ac06ad0578b26 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshrfieldmap.md --> # ExtlRecShrFieldMap Represents the external record share field mapping between the sender and receiver for Partner Connect. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | ImportedFieldId | Type reference Properties Create, Filter, Group, Sort Description ID of the ExtlRecShrField record containing the field data sent from the external system. This field is a relationship field. Relationship Name ImportedField Refers To ExtlRecShrField | | InternalFieldId | Type reference Properties Create, Filter, Group, Sort Description ID of the ExtlRecShrField record containing the field data received on the internal system. This field is a relationship field. Relationship Name InternalField Refers To ExtlRecShrField | <!-- document id=c5d023fede32753210fec722a15f0e5eb51c78cf3860bba46ccb6ca3dfb0a7dd url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshrlead.md --> # ExtlRecShrLead Represents the Lead record of a vendor org if you’re a partner. If you’re a vendor for Partner Connect, this object represents a partner org. This object is available in API version 62.0 and later. In a related list, the label of this object is Connected External Leads. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | ExtlRecShrCnctId | Type reference Properties Filter, Group, Sort Description ID of the external record share connection. This field is a relationship field. Relationship Name ExtlRecShrCnct Refers To ExtlRecShrCnct | | LeadId | Type reference Properties Filter, Group, Sort Description ID of the partner lead. This field is a relationship field. Relationship Name Lead Relationship Type Master-detail Refers To Lead (the master object) | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. | <!-- document id=4d98f4d167b8ab17c5acc9ac8c22f2d9ad97c9eaec9d1f5f3a9050edd0d00daf url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshrobject.md --> # ExtlRecShrObject Represents a shared object for Partner Connect. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | DefaultRecordOwnerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the shared record owner. The owner can be a user or a queue, represented by a Group ID. This field is a polymorphic relationship field. Relationship Name DefaultRecordOwner Refers To Group, User | | ExtlObjectType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Object type in the external org or system that is part of the object field mapping. Possible values are: - ExtlRecShrLead - ExtlRecShrOpportunity - Lead - Opportunity | | ExtlRecShrCnctId | Type reference Properties Create, Filter, Group, Sort Description ID of the external record share connection. This field is a relationship field. Relationship Name ExtlRecShrCnct Refers To ExtlRecShrCnct | | FieldMapStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Exporter’s status of the field mapping. Possible values are: - ActiveMapping - Selected - SystemOverride | | InternalObjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Object type in your org or system used to group field selections and field mappings. Possible values are: - ExtlRecShrLead - ExtlRecShrOpportunity - Lead - Opportunity | <!-- document id=273aa6bc4e823eb5685565f8102f52b14ec3454397a0533d042d595411ccfae7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshropportunity.md --> # ExtlRecShrOpportunity Represents the opportunity for Partner Connect in the vendor org if you’re a partner and the partner org if you’re the vendor. This object is available in API version 62.0 and later. The label of this object in the related list is Connected External Leads. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | ExtlRecShrCnctId | Type reference Properties Filter, Group, Sort Description ID of the external record share connection. This field is a relationship field. Relationship Name ExtlRecShrCnct Refers To ExtlRecShrCnct | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. | | OpportunityId | Type reference Properties Filter, Group, Sort Description ID of the associated opportunity. This field is a relationship field. Relationship Name Opportunity Relationship Type Master-detail Refers To Opportunity (the master object) | <!-- document id=7e297ece857a9717cb901520908a1568ed01aed2819dcbc355f8b33e6c13d657 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshrpcklstoptn.md --> # ExtlRecShrPcklstOptn Represents a picklist option of an external record share picklist field shared between a partner and vendor for Partner Connect. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | ExtlRecShrFieldId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the associated external record share field of type picklist. This field is a relationship field. Relationship Name ExtlRecShrField Refers To ExtlRecShrField | | IsDefaultOption | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this picklist option is set as the default option (true) or not (false). The default value is false. | | SharedOptionLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label of the picklist option. | | SharedOptionValue | Type string Properties Create, Filter, Group, Sort, Update Description Value of the picklist option. | <!-- document id=206445c390584c21fa18cbd617f39ad1a731e91e553ab4c9ba153863ba34dd92 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshrpicklistmap.md --> # ExtlRecShrPicklistMap Represents the external record share picklist field mapping between the partner and vendor system for Partner Connect. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | ImportedPcklstOptionId | Type reference Properties Create, Filter, Group, Sort Description ID of the external record share picklist option of the external system. This field is a relationship field. Relationship Name ImportedPcklstOption Refers To ExtlRecShrPcklstOptn | | InternalPcklstOptionId | Type reference Properties Create, Filter, Group, Sort Description ID of the external record share picklist option of the internal system. This field is a relationship field. Relationship Name InternalPcklstOption Refers To ExtlRecShrPcklstOptn | <!-- document id=7f569911b1990467b70dd8612d3434b487503dce8c4996c2fe482aa0a6e87de7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_extlrecshrrecordmap.md --> # ExtlRecShrRecordMap Represents the lead or opportunity being mapped between a partner and vendor for Partner Connect. This object is available in API version 62.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To see this object, enable Partner Connect or Partner Connect for Vendors. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) and [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. ## Fields | Field | Details | | --- | --- | | ExtlRecShrCnctId | Type reference Properties Filter, Group, Sort Description ID of the external record share connection. This field is a relationship field. Relationship Name ExtlRecShrCnct Refers To ExtlRecShrCnct | | ExtlRecord | Type string Properties Filter, Group, Nillable, Sort Description ID of the lead or opportunity record on the external system. | | InboundStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of imports and updates received. Possible values are: - ImportSuccess - ImportConctExtlRecError - UpdateSuccess - UpdateFieldMapError - UpdateConctExtlRecError - UpdateUnknownError | | InternalRecordId | Type reference Properties Filter, Group, Sort Description ID of the lead or opportunity record on the internal system. This field is a polymorphic relationship field. Relationship Name InternalRecord Relationship Type Master-detail Refers To Lead, Opportunity (the master object) | | IsImported | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the record originated on the internal system (true) or external system (false). The default value is false. | | LastModifiedSent | Type dateTime Properties Filter, Nillable, Sort Description Timestamp of the last record update between the vendor and partner. This field doesn’t capture when the result is received. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. | | OutboundStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of exports, updates, and results received. Possible values are: - ExportSuccess - ExportInProgress - ExportSuccessSkipped - ExportSuccessPartial - ExportPublishFieldMapError - ExportSubscribeFieldMapError - ExportPublishEventError - ExportPublishUnknownError - ExportSubscribeUnknownError - ExportPublishConnectionError - UpdateInProgress - UpdateInProgressUpdateSuccess - UpdatePublishFieldMapErrorUpdateSubscribeRecordNotFound - UpdatePublishFieldMapError - UpdateSubscribeFieldMapError - UpdatePublishConnectionError - UpdatePublishEventError - UpdatePublishUnknownError - UpdateSubscribeUnknownError | | UniqueRecordKey | Type string Properties Filter, Group, Nillable, Sort Description Record key used internally for indexing. If IsImported is false, then this field contains the InternalRecordId value. If IsImported is true, this field contains the ExtlRecord value. This field is a calculated field. | <!-- document id=8b02e96580473cd9985a0a0c07672c9f62de09887599fe47858991f6662fbcfd url=/legacydeveloper/current/en-us/object_reference/obj_ref_data_access.md --> # Factors that Affect Data Access Some factors affect access to your organization's data. When using the API, the following factors affect access to your organization’s data: ## Access Your organization must be enabled for API access. Objects may not be available until you contact Salesforce and request access. For example, Territory2 is visible only if Enterprise Territory Management has been enabled in the application. Such requirements are in the “Usage” section for each object. Sometimes a feature must be used once before objects related to it can be accessed with the API. For example, the recordTypeIds is available only after at least one record type has been created for your organization in the user interface. To investigate data access issues, you can start by inspecting the WSDL: - **Enterprise WSDL**: The generated enterprise WSDL file contains all of the objects that are available to your organization. By using the API, a client application can access objects that are defined in your enterprise WSDL file. - **Partner WSDL**: When using the generated partner WSDL file, a client application can access objects that are returned in the describeGlobal() call. ## Object-Level and Field-Level Security The API respects object-level and field-level security configured in the user interface. You can access objects and fields only if the logged-in user's permissions and access settings allow such access. For example, fields that are not visible to a given user are not returned in a query() or describeSObjects() call. Similarly, read-only fields can't be updated. ## User Permissions A user attempting to access the API must have the permission “API Enabled” selected. It’s selected by default. Your client application logs in as a user called a logged-in user. The logged-in user's permissions grant or deny access to specific objects and fields in your organization: - **Read**—Users can only view objects of this type. - **Create**—Users can read and create objects of this type. - **Edit**—Users can read and update objects of this type. - **Delete**—Users can read, edit, and delete objects of this type. User permissions do not affect field-level security. If field-level security specifies that a field is hidden, users with “Read” on that object can view only those fields that are not hidden on the record. In addition, users with “Read” on an object can view only those records that sharing settings allow. The one exception is the “Edit Read Only Fields” permission, which gives users the ability to edit fields marked as read only via field-level security. ## Sharing For most API calls, data that is outside of the logged-in user’s sharing model is not returned. Users are granted the most permissive access that is available to them, either through organization-wide defaults or manual record sharing, just as in the application. ## User Permissions that Override Sharing - **View All Records**—Users can view all records associated with this object regardless of sharing settings. - **View All Data**—Users can view all records regardless of sharing settings. This permission is a user permission, not an object-level permission like View All Records. - **Modify All Records**—Users can read, edit, delete, transfer, and approve all records associated with this object, regardless of sharing settings. - **Modify All Data**—Users can read, edit, delete, transfer, and approve all records regardless of sharing settings. This permission is a user permission, not an object-level permission like Modify All Records. To protect the security of your data, give the logged-in user only the permissions needed to successfully execute all the calls made by the application. For large integration applications, “Modify All Data” may speed up call response times. If you are loading a large number of records, use [Bulk API 2.0](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_asynch.meta/api_asynch/bulk_api_2_0.htm) instead. ## Related Objects Some objects depend on other objects for permission. For example, AccountTeamMember follows sharing on the associated permission-assigned object such as the Account record. Ownership changes to a record do not automatically cascade to related records. For example, if ownership changes for a given Account, ownership does not then automatically change for any Contract associated with that Account—each ownership change must be made separately and explicitly by the client application. ## Object Properties To create an object with the create() call, the object's createable attribute must be set to true. To determine what operations are allowed on a given object, your client application can invoke the describeSObjects() call on the object and inspect the properties in the DescribeSObjectResult. replicatable allowsgetUpdated() and getDeleted() calls. ## Page Layouts and Record Types Requirements defined in the Salesforce user interface for page layouts and record types are not enforced by the API: - Page layouts can specify whether a given field is required, but the API does not enforce such layout-specific field restrictions or validations in create() and update() calls. It’s up to the client application to enforce any such constraints, if applicable. - Record types can control which picklist values can be chosen in a given record and which page layouts users with different profiles can see. However, such rules that are configured and enforced in the user interface are not enforced in the API. For example, the API does not validate whether the value in a picklist field is allowed per any record type restrictions associated with the profile of the logged-in user. Similarly, the API does not prevent a client application from adding data to a particular field simply because that field does not appear in a layout associated with the profile of the logged-in user. ## Referential Integrity To ensure referential integrity, the API forces or prevents certain behaviors: - [ID](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/field_types.htm#i1435616) values in [reference fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/field_types.htm#i1435823) are validated in create() and update() calls. - If a client application deletes a record, then its children are automatically deleted as part of the call if the cascadeDelete property on ChildRelationship for that child has a value of true. For example, if a client application deletes an Opportunity, then any associated OpportunityLineItem records are also deleted. However, if an OpportunityLineItem is not deletable or is currently being used, then deletion of the parent Opportunity fails. For example, if a client application deletes an Invoice\_Statement, then any associated Line\_Item records are also deleted. However, if a Line\_Item is not deletable or is currently being used, then deletion of the parent Invoice\_Statement fails. Use DescribeSObjectResult to view the ChildRelationship value if you want to be sure what will be deleted. There are certain exceptions that prevent the execution of a cascadeDelete. For example, you can't delete an account if it has associated cases, if it has related opportunities that are owned by other users, or if associated contacts are enabled for the Customer Portal. In addition, if you attempt to delete an account that has closed/won opportunities owned by you or has active contracts, then the delete request for that record will fail. <!-- document id=fea7f2026b6fa7e4f83737179a1e233e71e87a779d25af02b973f1eb34b26c33 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feedattachment.md --> # FeedAttachment Represents an attachment to a feed item, such as a file attachment or a link. Use FeedAttachment to add various attachments to one feed item. This object is available in API version 36.0 and later. ## Supported Calls create(), delete(), describeSObjects(), idEnabled(), query(), retrieve(), update(), upsert() ## Special Access Rules - You can read, create, update, or delete a FeedAttachment only if you have the corresponding access to the associated FeedItem. - Inline images aren’t creatable, updatable, or deletable through SOAP API. ## Fields | Field Name | Details | | --- | --- | | FeedEntityId | Type reference Properties Create, Filter, Group, Sort Description The ID of the associated feed entity that contains this attachment. | | RecordId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the record that this feed attachment contains. For inline images, RecordId is a ContentDocument ID. For content attachments, RecordId is a ContentVersion ID, For feed items, RecordId is a FeedItem ID. | | Title | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The title of this feed attachment. When Type is Link, Title value is the label for the attachment link. Otherwise, Title value isn’t used. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of this feed attachment. Valid values are: - 0 Content—A content attachment. - 1 InlineImage—An inline image. The system creates an inline image attachment when an image is added to the body of the associated FeedItem. You can’t add an inline image directly using FeedAttachment. - 2 Link—A link. - 3 FeedEntity—A feed entity, for example, a post that is shared. Available in API version 39 and later in Lightning Experience. - 4 ChatterExtension—a Rich Publisher App that’s integrated with the Chatter publisher. - 5 Record—A record. | | Value | Type string Properties Create, Filter, Nillable, Sort, Update Description The string value of this FeedAttachment. This field is optional. If the feed attachment is a Link FeedAttachment, the value is the link URL string. | ## Usage - This Apex example shows how to add an attachment to a Lead using API version 36.0 and later. First, post a feed item. //create and insert post FeedItem post = new FeedItem(); post.Body = 'HelloThere'; post.ParentId = 'ID\_OF\_LEAD\_ENTITY'; post.Title = 'FileName'; insert post; Then insert the attachment. //create and associate a content attachment to the post FeedAttachment feedAttachment = new FeedAttachment(); feedAttachment.FeedEntityId = post.Id; feedAttachment.RecordId = 'ID\_OF\_CONTENT\_VERSION'; feedAttachment.Title = 'FileName'; feedAttachment.Type = 'CONTENT'; insert feedAttachment; - You can create only one link attachment (FeedAttachment of type Link) per feed item. - If the feed item type is one of the following, you can add content or link feed attachments to a FeedItem. - AdvancedTextPost - TextPost - ContentPost - LinkPost - QuestionPost - When a FeedAttachment is added or removed from a feed item, Salesforce updates the type of the feed item to its most appropriate value, as follows. - If all content feed attachments are removed from a feed item of type ContentPost, the type of this feed item is updated to TextPost. - Conversely, if a content feed attachment is added to a feed item of type TextPost, the type of this feed item is updated to ContentPost. - If all link feed attachments are removed from a feed item of type LinkPost, the type of this feed item is updated to TextPost. - Conversely, if a link feed attachment is added to a feed item of type TextPost, the type of this feed item is updated to LinkPost. - The type of all other feed items, such as QuestionPost or AdvancedTextPost feed items, doesn’t change when any feed attachments are added or removed. - If a content feed attachment is added to a feed item of type LinkPost, the feed item type is updated to ContentPost. - If all content attachments are removed from a feed item of type ContentPost, but there's also a link attachment, the feed item type is updated to LinkPost. - Users without administrator privileges can’t retrieve a FeedAttachment by its ID in a SOQL query. They can retrieve attachments by specifying the associated FeedEntityId, as follows: SELECT Id FROM FeedAttachment WHERE FeedEntityId = 'some\_feedItem\_id' - Alternatively, retrieve attachments by using a SOQL query on FeedItem with a subquery on the FeedAttachments child relationship, as follows. SELECT Body, (SELECT RecordId, Title, Type, Value FROM FeedAttachments) FROM FeedItem WHERE Id = 'some\_feedItem\_id' - FeedAttachment is not a triggerable object. You can access feed attachments in FeedItem _update_ triggers by retrieving them through a SOQL query. For a trigger example, and to learn about trigger considerations for FeedAttachment, see [Triggers for Chatter Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_triggers_fields_not_updated_chatter.htm) in the Apex Developer Guide. <!-- document id=fc010a279e8ce8710ba5ebaf39ca8ded17d4061f296ee29cf883b3bedb25272e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feedcomment.md --> # FeedComment Represents a comment added to a feed by a user. This object is available in API version 18.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Note the following when working with feed comments. - You must have read access to the feed’s parent type to see a FeedComment record. - You must be able to access the feed to add a comment. - If the comment is related to a user record, the user can delete the comment. For example, if John Smith makes a comment on Sasha Jones’ profile feed, Sasha can delete the comment. - If the context user has the Insert System Field Values for Chatter Feeds user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the context user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration. You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: - Modify All Data - Modify All Records on the object associated with the feed and delete permission on the parent feed - Moderate Chatter ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Users with the Moderate Chatter permission can delete only the feed items and comments they can see. - Manage Unlisted Groups Only users with this permission can delete items in unlisted groups. ## Fields | Field | Details | | --- | --- | | CommentBody | Type textarea Properties Create, Filter, Sort, Update Description The text in the comment. | | CommentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of comment: - ContentComment—an uploaded file on a comment - TextComment—a direct text entry on a comment Before API version 24.0, a text entry was required on a comment. As of version 24.0, a text entry is optional if the CommentType is ContentComment. | | FeedItemId | Type reference Properties Create, Filter, Group, Sort Description ID of the feed item containing the comment. | | HasEntityLinks | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed CommentBody includes at least one link to a record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available starting in API version 43.0. | | InsertedById | Type reference Properties Filter, Group, Sort Description ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user. This is a relationship field. Relationship Name InsertedBy Relationship Type Lookup Refers To User | | IsRichText | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the feed CommentBody contains rich text. If you post a rich text feed comment using SOAP API, set IsRichText to true and escape HTML entities from the body. Otherwise, the comment is rendered as plain text. Rich text supports the following HTML tags: - <p> ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip Though the <br> tag isn’t supported, you can use <p> </p> to create lines. - <a> - <b> - <code> - <i> - <u> - <s> - <ul> - <ol> - <li> - <img> The <img> tag is accessible only through the API and must reference files in Salesforce similar to this example: <img src="sfdc://069B0000000omjh"></img> ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This attribute is available as of API version 38.0. In API version 38.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 37.0 and prior, all rich text appears as a plain-text representation. | | IsVerified | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Determines whether a comment on a question is marked as Company Verified. This field is available in API version 41.0 and later. | | LastEditById | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the user who last edited the feed comment. | | LastEditDate | Type datetime Properties Create, Filter, Nillable, Sort Description The date the feed comment was last edited. | | ParentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of a record associated with the feed comment. For example, if you are commenting on a change to a field on Account, ParentId is set to the account ID. | | RelatedRecordId | Type reference Properties Create, Group, Nillable, Sort Description ID of the ContentVersion record associated with a ContentComment. This field is null for all comments except ContentComment. For example, set this field to an existing ContentVersion ID and set the CommentType to ContentComment. | | Revision | Type int Properties Create, Filter, Group, Nillable, Sort Description The number of times the comment was revised. | | Status | Type picklist Properties Create, Defaulted on create, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether this feed comment is published and visible to all who can access the parent feed item. To change a comment’s status, the comment’s parent feed item must be in a published state. This field is available in API version 38.0 and later. Possible values are: - Published—The comment is visible to all who can access the parent feed item. - PendingReview—The comment is visible to its author. Users see the parent feed item and have View All Data or Can Approve Feed Post and Comment permission also see the comment. The author can delete the comment as can users who see the comment and have Can Approve Feed Post and Comment or Modify All Data permission. If the parent feed item is published, the author can edit the comment. Users who see the comment and have Can Approve Feed Post and Comment or Modify All Data permission can also edit the comment. Users with Can Approve Feed Post and Comment or Modify All Data permission can change comment status from Published to PendingReview and from PendingReview to Published. Some actions are blocked when a feed comment is pending review: - Select as Best—When a feed comment that is marked as best answer becomes unpublished, it’s removed as the best answer. If the comment is published, its best answer status is not restored. - Like and unlike - Isolated—The comment is visible only to admins. After an item is isolated, the author no longer has view or edit access. The admin user can edit, view, and delete isolated feed comments. | | SystemModstamp | Type datetime Properties Defaulted on create, Filter Description Date and time when a user or automated process (such as a trigger) last modified this record. In this context, "trigger" refers to Salesforce code that runs to implement standard functionality, and not an Apex trigger. SystemModstamp is a read-only [system field](http://www.salesforce.com/developer/docs/api/Content/system_fields.htm), available in FeedComment as of API version 37.0. | | ThreadChildrenCount | Type int Properties Create, Filter, Group, Nillable, Sort Description The count of comments associated with this parent feed object. The feed object can be either a Feed Item or a Feed Comment. The count shows how many comments are directly subordinate to the parent. This field is available on the object when **Allow discussion threads** is selected in the Administration Workspace. This field is available in API version 44.0 and later. | | ThreadLastUpdatedDate | Type dateTime Properties Create, Filter, Nillable, Sort Description The date and time the thread on this comment was last updated. This field is available on the object when **Allow discussion threads** is selected in the Administration Workspace. This field is available in API version 44.0 and later. | | ThreadLevel | Type int Properties Create, Filter, Group, Nillable, Sort Description The identifier that shows the level of this Feed Comment in a thread. By default, there are a maximum of three levels in a thread. The ThreadLevel value shows in which of the three levels this comment falls. This field is available on the object when **Allow discussion threads** is selected in the Administration Workspace. This field is available in API version 44.0 and later. | | ThreadParentId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The identifier of the feed item that is the parent of this comment. This field is available on the object when **Allow discussion threads** is selected in the Administration Workspace. This field is available in API version 44.0 and later. This is a relationship field. Relationship Name ThreadParent Relationship Type Lookup Refers To FeedComment | ## Usage - As of API version 23.0 and later, if you have View All Data permission, you can query FeedComment records directly without an ID filter. If you don’t have View All Data permission, you can’t query FeedComment records directly, with or without an ID filter. For example, the following query returns general information about a feed: SELECT ID, CreatedDate, CreatedById, CreatedBy.FirstName, CreatedBy.LastName, ParentId, Parent.Name, Body FROM FeedItem WHERE CreatedDate > LAST\_MONTH ORDER BY CreatedDate DESC, Id DESC - You can search for text in comments using SOSL. For example, the following Java class uses search() to find the string “foo” in any field of a record: public void searchSample() { try { SearchResult sr = connection.search("find {foo} in all fields " + "returning feedcomment(Id, FeedItemId, CommentBody)"); // Put the results into an array of SearchRecords SearchRecord\[\] records = sr.getSearchRecords(); // Check the length of the returned array of records to see // if the search found anything if (records != null && records.length > 0) { System.out.println("Found " + records.length + " comments: "); // Display each comment for (SearchRecord record : records) { FeedComment comment = (FeedComment) record.getRecord(); System.out.println(comment.getId() + ": " + comment.getCommentBody()); } } else { System.out.println("No records were found for the search."); } } catch (ConnectionException ce) { ce.printStackTrace(); } } - If you use an Apex trigger to modify the Body of a FeedComment object, all mentions hyperlinks are converted to plain text. The mentioned users don't get email notifications. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is hard deleted. It isn’t sent to the Recycle Bin. #### See Also - [Custom Object\_\_Feed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customobject__feed.htm "Represents the feed, specifically posts and feed-tracked changes, on a custom object.") <!-- document id=3d0c089a118988a6206b052bdd988ff04b3fe94ef9ebf8bc5527e151d67a1cd1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feeditem.md --> # FeedItem FeedItem represents an entry in the feed, such as changes in a record feed, including text posts, link posts, and content posts. This object is available in API version 21.0 and later. This object replaces FeedPost. ## Supported Calls create(), delete(), describeSObjects(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules - You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: - Modify All Data - Modify All Records on the feed item’s parent object, for example, Account for a feed item on an account feed - Moderate Chatter Note: Users with the Moderate Chatter permission can delete only the feed items and comments that they can see. Only users with this permission can delete items in unlisted groups. - Guest users can’t insert system field values for Chatter feeds. Even if you try to assign the CanInsertFeedSystemFields permission to a Guest User, the permission isn’t granted. Only users with the Modify All Data permission can delete a feed item of Type TrackedChange. If the context user has the Insert System Field Values for Chatter Feeds user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the context user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration. ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d909898e150">Field Name</th> <th class="featureTableHeader " id="d909898e153">Details</th> </tr> </thead> <tbody class="tbody"> <tr id="FeedBodyRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="FeedItem_BestCommentId"><a name="FeedItem_BestCommentId"><!-- --></a>BestCommentId</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="dd_BestCommentId"> <a name="dd_BestCommentId"><!-- --></a>The ID of the comment marked as best answer on a question post. </dd> <dd class="dd">This is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">BestComment</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FeedComment</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="FeedItem_Body"><a name="FeedItem_Body"><!-- --></a>Body</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="dd_Body"> <a name="dd_Body"><!-- --></a>The body of the feed item. <span class="ph" id="BodyDescReqWhenTextPost"><a name="BodyDescReqWhenTextPost"><!-- --></a>Required when <span class="keyword parmname">Type</span> is <samp class="codeph nolang">TextPost</samp> or <samp class="codeph nolang">AdvancedTextPost</samp>. Optional when <span class="keyword parmname">Type</span> is <samp class="codeph nolang">ContentPost</samp> or <samp class="codeph nolang">LinkPost</samp>.</span> </dd> <dd class="dd" id="dd_Body_2"> <a name="dd_Body_2"><!-- --></a>Although a value for <span class="keyword parmname">Body</span> isn’t required for the <samp class="codeph nolang">ContentPost</samp> type, an attachment is required. If an attachment isn’t present, the type changes to <samp class="codeph nolang">TextPost</samp> or <samp class="codeph nolang">AdvancedTextPost</samp>, depending on the API version. <samp class="codeph nolang">TextPost</samp> and <samp class="codeph nolang">AdvancedTextPost</samp> do require a value for <span class="keyword parmname">Body</span>.<p class="p">Tip: See the <a class="xref" href="#isRichTextDes"><span class="keyword parmname">IsRichText</span></a> field for a list of HTML tags supported in the body of rich text posts. </p> </dd> </dl> </td> </tr> <tr id="CommentCountRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname">CommentCount</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="dd_CommentCount"> <a name="dd_CommentCount"><!-- --></a><span class="ph" id="desc_CommentCount"><a name="desc_CommentCount"><!-- --></a>The number of comments associated with this feed item.</span> </dd> </dl> <div class="box message confirm" id="note_CommentCount"> <a name="note_CommentCount"><!-- --></a> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png" alt="Tip"> <div class="mediaBd"> <h4 class="mbs">Tip</h4> <p>In a feed that supports pre-moderation, <span class="keyword parmname">CommentCount</span> isn’t updated until a comment is published. For example, say that you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, comments aren’t counted until approved by an admin or someone with Can Approve Feed Post and Comment or Modify All Data. </p><p class="p">Feed moderation has implications on how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through <span class="keyword parmname">CommentCount</span>, go through pagination until the end of comments is returned.</p> <p></p> </div> </div> </div> </div> </div> </td> </tr> <tr id="ConnectionIdRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="sforce_api_object_feeditem_connectionId"><a name="sforce_api_object_feeditem_connectionId"><!-- --></a>ConnectionId</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="feeds_connectionid_def"><a name="feeds_connectionid_def"><!-- --></a>When a PartnerNetworkConnection modifies a record that is tracked, the <span class="keyword parmname">CreatedBy</span> field contains the ID of the system administrator. The <span class="keyword parmname">ConnectionId</span> contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your org.</span></dd> </dl> </td> </tr> <tr id="ContentDataRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="FeedItem_ContentData"><a name="FeedItem_ContentData"><!-- --></a>ContentData</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">base64</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. <span class="ph" id="RequiredforContentType"><a name="RequiredforContentType"><!-- --></a>This field is required if <span class="keyword parmname">Type</span> is <samp class="codeph nolang">ContentPost</samp>.</span> <span class="ph" id="ContentDataDesc"><a name="ContentDataDesc"><!-- --></a>Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets <span class="keyword parmname">Type</span> to <samp class="codeph nolang">ContentPost</samp>.</span> </dd> </dl> </td> </tr> <tr id="ContentDescriptionRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="FeedItem_ContentDescription"><a name="FeedItem_ContentDescription"><!-- --></a>ContentDescription</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. <span class="ph" id="ContentDescriptionDesc"><a name="ContentDescriptionDesc"><!-- --></a>The description of the file specified in <span class="keyword parmname">ContentData</span>.</span> </dd> </dl> </td> </tr> <tr id="ContentFileNameRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="FeedItem_ContentFileName"><a name="FeedItem_ContentFileName"><!-- --></a>ContentFileName</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. <span class="ph" id="ContentFileNameDesc"><a name="ContentFileNameDesc"><!-- --></a>The name of the file uploaded to the feed. Setting <span class="keyword parmname">ContentFileName</span> automatically sets <span class="keyword parmname">Type</span> to <samp class="codeph nolang">ContentPost</samp>.</span> </dd> </dl> </td> </tr> <tr id="ContentSizeRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="FeedItem_ContentSize"><a name="FeedItem_ContentSize"><!-- --></a>ContentSize</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. <span class="ph" id="ContentSizeDesc"><a name="ContentSizeDesc"><!-- --></a>This field is the size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.</span> </dd> </dl> </td> </tr> <tr id="ContentTypeRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="FeedItem_ContentType"><a name="FeedItem_ContentType"><!-- --></a>ContentType</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. <span class="ph" id="ContentTypeDesc"><a name="ContentTypeDesc"><!-- --></a>This field is the MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.</span> </dd> </dl> </td> </tr> <tr id="FeedPostIdRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="field_FeedPostId"><a name="field_FeedPostId"><!-- --></a>FeedPostId</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="do_not_use_FeedPostId"><a name="do_not_use_FeedPostId"><!-- --></a>This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only.</span> <p class="p">ID of the associated FeedPost. A FeedPost represents the following types of changes in a feed item: changes to tracked fields, text posts, link posts, and content posts.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname">HasContent</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the feed item has content.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="ph" id="HasFeedEntity"><a name="HasFeedEntity"><!-- --></a><span class="keyword parmname">HasFeedEntity</span></span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="HasFeedEntitydescription"><a name="HasFeedEntitydescription"><!-- --></a>Indicates whether the feed item has a feed entity, for example, a post, as an attachment. Available in API version 39 and later when sharing a feed entity in Lightning Experience.</span></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname">HasLink</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the feed item has a link attached.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="HasVerifiedComment"><a name="HasVerifiedComment"><!-- --></a>HasVerifiedComment</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Determines whether a question has an answer that is marked as Company Verified.<p class="p">This field is available in API version 41.0 and later.</p> </dd> </dl> </td> </tr> <tr id="InsertedByIdRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname">InsertedById</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="dd_InsertedById"> <a name="dd_InsertedById"><!-- --></a>ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the <span class="keyword parmname">InsertedBy</span> value is set to the ID of the context user. </dd> <dd class="dd">This is a polymorphic relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">InsertedBy</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">User</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname">IsClosed</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">As of API version 43, a read-only field that indicates whether the feed item is open or closed to new actions. A value of <samp class="codeph java">true</samp> places restrictions on the actions a user can take on a feed item and its comments. For more information, see the Usage section.</dd> </dl> </td> </tr> <tr id="IsDeletedRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname">IsDeleted</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Standard system field. Indicates whether the record has been moved to the Recycle Bin (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname">IsRichText</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Defaulted on create, Filter, Group, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="isRichTextDes"> <a name="isRichTextDes"><!-- --></a>Indicates whether the feed item <span class="keyword parmname">Body</span> contains rich text. If you post a rich text feed comment using SOAP API, set <span class="keyword parmname">IsRichText</span> to <samp class="codeph nolang">true</samp> and escape HTML entities from the body. Otherwise, the post is rendered as plain text.<p class="p">Rich text supports the following HTML tags:</p> <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang"><p></samp> <div class="box message confirm"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png" alt="Tip"> <div class="mediaBd"> <h4 class="mbs">Tip</h4> <p>Though the <samp class="codeph nolang"><br></samp> tag isn’t supported, you can use <samp class="codeph nolang"><p>&nbsp;</p></samp> to create lines. </p> </div> </div> </div> </div> </div> </li> <li class="li"><samp class="codeph nolang"><a></samp></li> <li class="li"><samp class="codeph nolang"><b></samp></li> <li class="li"><samp class="codeph nolang"><code></samp></li> <li class="li"><samp class="codeph nolang"><i></samp></li> <li class="li"><samp class="codeph nolang"><u></samp></li> <li class="li"><samp class="codeph nolang"><s></samp></li> <li class="li"><samp class="codeph nolang"><ul></samp></li> <li class="li"><samp class="codeph nolang"><ol></samp></li> <li class="li"><samp class="codeph nolang"><li></samp></li> <li class="li"> <samp class="codeph nolang"><img></samp> <p class="p">The <samp class="codeph nolang"><img></samp> tag is accessible only through the API and must reference files in Salesforce similar to this example: <span class="ph filepath"><img src="sfdc://069B0000000omjh"></img></span> </p> </li> </ul> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation.</p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="field_LastEditById"><a name="field_LastEditById"><!-- --></a>LastEditById</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">ID of the user who last edited the feed item.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="field_LastEditDate"><a name="field_LastEditDate"><!-- --></a>LastEditDate</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">datetime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date the feed item was last edited.</dd> </dl> </td> </tr> <tr id="LikeCountRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname">LikeCount</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="dd_LikeCount"> <a name="dd_LikeCount"><!-- --></a><span class="ph" id="desc_LikeCount"><a name="desc_LikeCount"><!-- --></a>The number of likes associated with this feed item.</span> </dd> </dl> </td> </tr> <tr id="LinkUrlRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="feedItem_LinkUrl"><a name="feedItem_LinkUrl"><!-- --></a>LinkUrl</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">url</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="dd_LinkUrl"> <a name="dd_LinkUrl"><!-- --></a><span class="ph" id="LinkUrl_Def"><a name="LinkUrl_Def"><!-- --></a>The URL of a <samp class="codeph nolang">LinkPost</samp>.</span> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="NetworkScopt"><a name="NetworkScopt"><!-- --></a>NetworkScope</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <a name="NetworkScopeDesc"><!-- --></a> <dl class="dl detailList" id="NetworkScopeDesc"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="NetworkScopeDesc1"><a name="NetworkScopeDesc1"><!-- --></a>Specifies whether this feed item is available in the default Experience Cloud site, a specific Experience Cloud site, or all sites. This field is available in API version 26.0 and later, if digital experiences is enabled for your org.</span> <div class="p" id="NetworkScopeValues"> <a name="NetworkScopeValues"><!-- --></a><span class="keyword parmname">NetworkScope</span> can have the following values: <ul class="ul bulletList"> <li class="li"> <span class="keyword parmname">NetworkId</span>—The ID of the Experience Cloud site in which the FeedItem is available. If left empty, the feed item is only available in the default Experience Cloud site. </li> <li class="li"> <samp class="codeph nolang">AllNetworks</samp>—The feed item is available in all Experience Cloud sites. </li> </ul> </div> <div class="p" id="NetworkScopeExceptions"> <a name="NetworkScopeExceptions"><!-- --></a>Note the following exceptions for <span class="keyword parmname">NetworkScope</span>:<ul class="ul bulletList"> <li class="li">Only feed items with a Group or User parent can set a <span class="keyword parmname">NetworkId</span> or a null value for <span class="keyword parmname">NetworkScope</span>.</li> <li class="li">For feed items with a record parent, users can set <span class="keyword parmname">NetworkScope</span> only to <samp class="codeph nolang">AllNetworks</samp>.</li> <li class="li">You can’t filter a feed item on the <span class="keyword parmname">NetworkScope</span> field. </li> </ul> </div> </dd> </dl> </td> </tr> <tr id="ParentId"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname">ParentId</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="parentid_desc"><a name="parentid_desc"><!-- --></a>ID of the object type to which the feed item is related. For example, set this field to a <span class="keyword parmname">UserId</span> to post to someone’s profile feed, or an <span class="keyword parmname">AccountId</span> to post to a specific account.</span></dd> <dd class="dd">This is a polymorphic relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">Parent</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Account, Accreditation, ActivationTarget, ActivationTrgtIntOrgAccess, ApiAnomalyEventStore, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CollaborationGroup, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContentDocument, Contract, CoverageBenefit, CoverageBenefitItem, CredentialStuffingEventStore, CreditMemo, CreditMemoLine, Dashboard, DashboardComponent, DataStream, DelegatedAccount, DocumentChecklistItem, EngagementChannelType, EnhancedLetterhead, EnrollmentEligibilityCriteria, Event, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Identifier, Image, IndividualApplication, Invoice, InvoiceLine, Lead, Location, MarketSegment, MarketSegmentActivation, MemberPlan, MessagingSession, MktCalculatedInsight, OperatingHours, Opportunity, Order, OrderItem, OtherComponentTask, PartyConsent, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, Product2, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, ProviderSearchSyncLog, PurchaserPlan, PurchaserPlanAssn, ReceivedDocument, Report, ReportAnomalyEventStore, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SessionHijackingEventStore, Shift, Shipment, ShipmentItem, Site, SkillRequirement, SocialPost, Solution, Task, ThreatDetectionFeedback, Topic, User, Visit, VisitedParty, Visitor, VoiceCall, VolunteerProject, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup, WorkTypeGroupMember</dd> </dl> </td> </tr> <tr id="RelatedRecordIdRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="Related_Record_Id"><a name="Related_Record_Id"><!-- --></a>RelatedRecordId</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="dd_RelatedRecord"> <a name="dd_RelatedRecord"><!-- --></a><span class="ph" id="relatedrecordid_descrip_short"><a name="relatedrecordid_descrip_short"><!-- --></a>ID of the ContentVersion record associated with a <samp class="codeph nolang">ContentPost</samp>. For WDC thanks posts, it’s the ID of the WorkThanks object associated with a <samp class="codeph nolang">RypplePost</samp>. This field is typically null for all posts except <samp class="codeph nolang">ContentPost</samp> and <samp class="codeph nolang">RypplePost</samp>.</span> <p class="p"><span class="ph" id="relatedrecordid_descrip2"><a name="relatedrecordid_descrip2"><!-- --></a>For example, set this field to an existing ContentVersion ID and post it to a feed with <span class="keyword parmname">Type</span> set to <samp class="codeph nolang">ContentPost</samp>.</span></p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="field_Revision"><a name="field_Revision"><!-- --></a>Revision</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The revision number of the feed item.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="field_Status"><a name="field_Status"><!-- --></a>Status</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Defaulted on create, Group, Nillable, Restricted picklist, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Specifies whether this feed item is published and visible to all who can access the feed. This field is available in API version 37.0 and later.</dd> <dd class="dd">Possible values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">Published</samp>—The item’s visible to all with access to the feed. </li> <li class="li"> <samp class="codeph nolang">PendingReview</samp>—The item’s visible to its author and users who see the item and have View All Data or Can Approve Feed Post and Comment permission. Some people can delete and edit the item. They include the author and users who see the item and have Can Approve Feed Post and Comment or Modify All Data permission. <div class="box message info" id="note_vtp_ppr_nsb"> <a name="note_vtp_ppr_nsb"><!-- --></a> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>These permissions don’t apply when you retrieve feed items using SOQL. To filter out Pending Review feed items you must add an explicit clause.</p> </div> </div> </div> </div> </div> <div class="p">Some actions are blocked when a feed item is pending review:<ul class="ul bulletList"> <li class="li">Comment</li> <li class="li">Like and unlike</li> <li class="li">Bookmark</li> <li class="li">Share</li> </ul> </div> </li> <li class="li"> <samp class="codeph nolang">Isolated</samp>—The item is visible only to admins. After an item is isolated, the author no longer has view or edit access. The admin user can edit, view, and delete isolated feed items. </li> </ul> </dd> </dl> </td> </tr> <tr id="TitleRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="FeedItem_Title"><a name="FeedItem_Title"><!-- --></a>Title</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="dd_Title"> <a name="dd_Title"><!-- --></a><span class="ph" id="title_desc"><a name="title_desc"><!-- --></a>The title of the feed item. <span class="ph" id="title_desc_linkpost"><a name="title_desc_linkpost"><!-- --></a>When the <span class="keyword parmname">Type</span> is <samp class="codeph nolang">LinkPost</samp>, the <span class="keyword parmname">LinkUrl</span> is the URL and this field is the link name.</span></span> The <span class="keyword parmname">Title</span> field can be updated on posts of <span class="keyword parmname">Type</span> <samp class="codeph nolang">QuestionPost</samp>. </dd> </dl> </td> </tr> <tr id="TypeRow"> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="FeedItem_Type"><a name="FeedItem_Type"><!-- --></a>Type</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd" id="dd_Type"> <a name="dd_Type"><!-- --></a>The type of feed item. Except for <samp class="codeph nolang">ContentPost</samp>, <samp class="codeph nolang">LinkPost</samp>, <samp class="codeph nolang">QuestionPost</samp>, and <samp class="codeph nolang">TextPost</samp>, all the FeedItem types listed here are system-generated. In most situations, we recommend that you don't create system-generated fields using Apex or our APIs. One exception is during Chatter data migrations, which can require admins to migrate system-generated post types.<a name="TypePicklist"><!-- --></a> <ul class="ul bulletList" id="TypePicklist"> <li class="li"> <p class="p"><samp class="codeph nolang">ActivityEvent</samp>—indirectly generated event when a user or the API adds a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm#sforce_api_objects_task" title="Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities.">Task</a> associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_event.htm#sforce_api_objects_event" title="Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities.">Event</a> associated with a case record (excluding email and call logging).</p> <p class="p">For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence.</p> </li> <li class="li"> <samp class="codeph nolang" id="advancedTextPost"><a name="advancedTextPost"><!-- --></a>AdvancedTextPost</samp>—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. </li> <li class="li"> <samp class="codeph nolang">AnnouncementPost</samp>—Not used. </li> <li class="li"> <samp class="codeph nolang">ApprovalPost</samp>—generated when a user submits an approval. </li> <li class="li"> <samp class="codeph nolang">BasicTemplateFeedItem</samp>—Not used. </li> <li class="li"> <samp class="codeph nolang">CanvasPost</samp>—a post made by a canvas app posted on a feed. </li> <li class="li"> <samp class="codeph nolang">CollaborationGroupCreated</samp>—generated when a user creates a public group. </li> <li class="li"> <samp class="codeph nolang">CollaborationGroupUnarchived</samp>—Not used. </li> <li class="li"> <samp class="codeph nolang" id="contentPost"><a name="contentPost"><!-- --></a>ContentPost</samp>—a post with an attached file. </li> <li class="li"> <samp class="codeph nolang">CreatedRecordEvent</samp>—generated when a user creates a record from the publisher. </li> <li class="li"> <samp class="codeph nolang">DashboardComponentAlert</samp>—generated when a dashboard metric or gauge exceeds a user-defined threshold. </li> <li class="li"> <samp class="codeph nolang">DashboardComponentSnapshot</samp>—created when a user posts a dashboard snapshot on a feed. </li> <li class="li"> <samp class="codeph nolang" id="linkPost"><a name="linkPost"><!-- --></a>LinkPost</samp>—a post with an attached URL. </li> <li class="li"> <samp class="codeph nolang">PollPost</samp>—a poll posted on a feed. </li> <li class="li"> <samp class="codeph nolang">ProfileSkillPost</samp>—generated when a skill is added to a user’s Chatter profile. </li> <li class="li"> <samp class="codeph nolang" id="questionPost"><a name="questionPost"><!-- --></a>QuestionPost</samp>—generated when a user posts a question. </li> <li class="li"> <samp class="codeph nolang">ReplyPost</samp>—generated when Chatter Answers posts a reply. </li> <li class="li"> <samp class="codeph nolang">RypplePost</samp>—generated when a user creates a Thanks badge in WDC. </li> <li class="li"> <samp class="codeph nolang" id="textPost"><a name="textPost"><!-- --></a>TextPost</samp>—a direct text entry on a feed. </li> <li class="li"> <samp class="codeph nolang" id="type_trackedchange"><a name="type_trackedchange"><!-- --></a>TrackedChange</samp>—a change or group of changes to a tracked field. </li> <li class="li"> <samp class="codeph nolang">UserStatus</samp>—automatically generated when a user adds a post. Deprecated. </li> </ul> <div class="p" id="case_feed_type_values"> <a name="case_feed_type_values"><!-- --></a>The following values appear in the <span class="keyword parmname">Type</span> picklist for all feed objects but apply only to CaseFeed: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">AttachArticleEvent</samp>—generated event when a user attaches an article to a case. </li> <li class="li"> <samp class="codeph nolang">CallLogPost</samp>—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. </li> <li class="li"> <samp class="codeph nolang">CaseCommentPost</samp>—generated event when a user adds a case comment for a case object. </li> <li class="li"> <samp class="codeph nolang">ChangeStatusPost</samp>—generated event when a user changes the status of a case. </li> <li class="li"> <samp class="codeph nolang">ChatTranscriptPost</samp>—generated event when Chat transcript is saved to a case. </li> <li class="li"> <samp class="codeph nolang">EmailMessageEvent</samp>—generated event when an email related to a case object is sent or received. </li> <li class="li"> <samp class="codeph nolang">FacebookPost</samp>—generated when a Facebook post is created from a case. Deprecated. </li> <li class="li"> <samp class="codeph nolang">MilestoneEvent</samp>—generated when a case milestone is completed or reaches violation status. </li> <li class="li"> <samp class="codeph nolang">SocialPost</samp>—generated when a social post is created from a case. </li> </ul> </div> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>If you set <span class="keyword parmname">Type</span> to <samp class="codeph nolang">ContentPost</samp>, also specify <span class="keyword parmname">ContentData</span> and <span class="keyword parmname">ContentFileName</span>. </p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d909898e150" data-title="Field Name"><span class="keyword parmname" id="Visibility"><a name="Visibility"><!-- --></a>Visibility</span></td> <td class="entry" headers="d909898e153" data-title="Details"> <a name="VisibilityDesc"><!-- --></a> <dl class="dl detailList" id="VisibilityDesc"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Create, Filter, Group, Nillable, Restricted picklist, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if digital experiences is enabled for your org.<div class="p"> <span class="keyword parmname">Visibility</span> can have the following values: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">AllUsers</samp>—The feed item is available to all users who have permission to see the feed item. </li> <li class="li"> <samp class="codeph nolang" id="InternalUsers-4D1EB2B9"><a name="InternalUsers-4D1EB2B9"><!-- --></a>InternalUsers</samp>—The feed item is available to internal users only. </li> </ul> </div> <div class="p">Note the following exceptions for <span class="keyword parmname">Visibility</span>: <ul class="ul bulletList"> <li class="li">For record posts, <span class="keyword parmname">Visibility</span> is set to <samp class="codeph nolang">InternalUsers</samp> for all internal users by default. </li> <li class="li">External users can set <span class="keyword parmname">Visibility</span> only to <samp class="codeph nolang">AllUsers</samp>.</li> <li class="li"> <span class="keyword parmname">Visibility</span> can be updated on record posts. </li> <li class="li">The <samp class="codeph nolang">Update</samp> property is supported only for feed items posted on records.</li> </ul> </div> </dd> </dl> </td> </tr> </tbody> </table> ## Usage - When a feed item’s IsClosed field is set to true, some actions are blocked and others are blocked to most users. This table sets out the actions that are blocked when a feed item is closed. <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d909898e2102">Action</th> <th class="featureTableHeader " id="d909898e2105">Availability on a Closed Conversation</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Add a comment</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Blocked</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Answer a question</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Blocked</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Vote on a poll</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Blocked</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Edit a feed item or its comments or answers</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Blocked to author; available to admins, moderators, and people with the Close Conversation Threads in Feeds permission<p class="p">Editing is blocked specifically for the feed item title, feed item body, and feed content body fields.</p> </td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Edit a topic</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Available</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Delete a feed item or its comments or answers</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Blocked to author; available to admins, moderators, and people with the Close Conversation Threads in Feeds permission</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Publish a pending review comment (moderation)</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Available to admins and moderators</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Like or unlike; upvote or downvote</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Available</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Select or remove a best answer</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Blocked to author; available to admins, moderators, and people with the Close Conversation Threads in Feeds permission</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Company verify; remove verification</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Available only to people with the Verify Answers to Chatter Questions permission</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Flag</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Available</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Share</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Available</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Bookmark</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Available</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Mute and unmute</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Available</td> </tr> <tr> <td class="entry" headers="d909898e2102" data-title="Action">Escalate to case</td> <td class="entry" headers="d909898e2105" data-title="Availability on a Closed Conversation">Available only to people permitted to escalate a feed item to a case</td> </tr> </tbody> </table> - This Apex example shows how to add a feed item with an attachment to a lead using API version 36.0 and later. First, post a feed item. //create and insert post FeedItem post = new FeedItem(); post.Body = 'HelloThere'; post.ParentId = 'ID\_OF\_LEAD\_ENTITY'; post.Title = 'FileName'; insert post; Then insert the attachment. //create and associate a content attachment to the post FeedAttachment feedAttachment = new FeedAttachment(); feedAttachment.FeedEntityId = post.Id; feedAttachment.RecordId = 'ID\_OF\_CONTENT\_VERSION'; feedAttachment.Title = 'FileName'; feedAttachment.Type = 'CONTENT'; insert feedAttachment; - If you’re using API version 23.0 or later and have View All Data permission, you can directly query for a FeedItem. The following example returns the 20 most recent feed items. SELECT ID, CreatedDate, CreatedById, CreatedBy.FirstName, CreatedBy.LastName, ParentId, Parent.Name, Body, (SELECT ID, FieldName, OldValue, NewValue FROM FeedTrackedChanges ORDER BY ID DESC) FROM FeedItem WHERE CreatedDate > LAST\_MONTH ORDER BY CreatedDate DESC - If you’re using an earlier API version than version 23.0, query FeedItem objects through a feed (such as AccountFeed or OpportunityFeed). The following example returns all feed items for a given account, ordered by date descending: SELECT Id, Type, FeedItem.Body FROM AccountFeed WHERE ParentId = AccountId ORDER BY CreatedDate DESC ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Provide the ParentId for API version 22.0 and earlier. - A feed item of type UserStatus is automatically created when a user adds a post to update the status. You can’t explicitly create a feed item of type UserStatus. - The FeedItem object doesn’t support aggregate functions in queries. - If the context user has the Insert System Field Values for Chatter Feeds user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the context user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration. - The size limit for an attachment on a feed is 2 GB. - You can’t use the content fields to update or delete the content. - You can’t filter or update the content fields. - Deleting a feed item via the API also deletes the associated content. Likewise, undeleting a feed item restores associated content. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is hard deleted. It isn’t sent to the Recycle Bin. - After uploading to a feed, it’s possible for an attachment or document to be deleted, marked private, or hidden by sharing rules. In this case, all content fields in a FeedItem object appear as null in a SOQL query. - You can’t explicitly create or delete a [FeedTrackedChange](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedtrackedchange.htm "Represents an individual field change or set of field changes. A FeedTrackedChange is a child object of a record feed, such as AccountFeed. This object is available in API version 18.0 and later.") record. - Imagine that you insert a feed item or feed comment of Type ContentPost on a [User](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_user.htm#sforce_api_objects_user "Represents a user in your organization.") or [Group](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_group.htm#sforce_api_objects_group "A set of User records.") to create a file. Then the NetworkScope field value of the feed item is passed to the file. - If you use an Apex trigger to modify the Body of a FeedItem object, all mentions hyperlinks are converted to plain text. The mentioned users don’t get email notifications. - If you insert rich text into the feed item body, make sure that the case of the opening and closing HTML tags matches. For example, <b>This is bold text</B> generates an error. - To check file sharing with Apex triggers, write triggers on ContentDocumentLink instead of FeedItem. For an example, see [ContentDocumentLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm "Represents the link between a Salesforce CRM Content document, Salesforce file, or ContentNote and where it's shared. A file can be shared with other users, groups, records, and Salesforce CRM Content libraries. This object is available in versions 21.0 and later for Salesforce CRM Content documents and Salesforce Files."). - In API version 36.0 and later, use [FeedAttachment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedattachment.htm "Represents an attachment to a feed item, such as a file attachment or a link. Use FeedAttachment to add various attachments to one feed item. This object is available in API version 36.0 and later.") to attach one or more content items to a feed item. As a result of support for multiple attachments through FeedAttachment, all fields related to content attachments have been removed. These fields are: ContentData, ContentDescription, ContentFileName, ContentSize, and ContentType. - For all API versions of FeedItem, you can’t query a FeedItem object using the System Modstamp filter. - When you use the FeedItem object to create a record-triggered flow, and the flow tries to update a field on the parent record, the field may not update in the UI until the page is refreshed. <!-- document id=69e1b4028bbdc9437d97cb92879d19d3b4d861a551fcb7ad677bcaccb8c728ef url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feedlike.md --> # FeedLike Indicates that a user has liked a feed item. This object is available in API version 21.0 and later. FeedLike records represent likes on posts and not likes on comments. Likes on comments can’t be queried via the API. A FeedLike is a child object of an associated FeedItem, FeedTrackedChange, or object feed, such as AccountFeed. ## Supported Calls create(), delete(), describeSObjects() ## Special Access Rules If the context user has the Insert System Field Values for Chatter Feeds user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the context user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration. ## Fields | Field Name | Details | | --- | --- | | FeedItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the feed item that the user liked. | | FeedEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of a feed item or feed comment the user liked. If the user liked a comment, FeedEntityId is set to the ID of the comment. If the user liked a feed item, FeedEntityId is set to the ID of the feed item. This field is optional. The default value is the ID of the feed item. | | InsertedById | Type reference Properties Filter, Group, Sort Description ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user. This is a relationship field. Relationship Name InsertedBy Relationship Type Lookup Refers To User | ## Usage You can't query FeedLike records directly. They can only be queried via the entity feed, such as AccountFeed. FeedLike records represent likes on posts and not likes on comments. Likes on comments can’t be queried via the API. <!-- document id=7de8d7e929ef78b154497d1c6015b0f32cfefda8cbba83af0710fbb8d0b3b3a0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feedpollchoice.md --> # FeedPollChoice Shows the choices for a poll posted in the feed. This object is available in API version 29.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To delete feed items they didn’t create, users must have one of these permissions: - Modify All Data - Modify All Records on the parent object, for example on Account for a poll on an AccountFeed - Moderate Chatter ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Users with the Moderate Chatter permission can delete only the feed items and comments they can see. Only users with this permission can delete items in unlisted groups. ## Fields | Field Name | Details | | --- | --- | | ChoiceBody | Type textarea Properties Group Description A choice in the poll. | | FeedItemId | Type reference Properties Filter, Group, Sort Description ID of the feed item for the poll. | | Position | Type int Properties Group, Sort Description Shows the position of the poll choice. | ## Usage Use this object to query all of the choices associated with a particular poll. To view how people voted on the poll, see the FeedPollVote object. <!-- document id=cca1ff730ec5ca42135bf9e98d51ab93329b5a25bc9ce386c64e976d8133e3fd url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feedpollvote.md --> # FeedPollVote Shows how users voted on a poll posted in the feed. This object is available in API version 29.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ChoiceId | Type reference Properties Filter, Group Description Indicates which choice a user selected on a poll posted in a feed. This is a relationship field. Relationship Name Choice Relationship Type Lookup Refers To FeedPollChoice | | FeedItemId | Type reference Properties Filter, Group, Sort Description ID of the feed item for the poll. | ## Usage Use this object to query how users voted on a particular poll. <!-- document id=ac2e4e870fc22e7084b3984caf2a96c10473c5c09a74f82e14b73f0f00c01421 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feedpost.md --> # FeedPost FeedPost represents the following types of changes in a record feed, such as AccountFeed: text posts, link posts, and content posts. This object is available in API version 18.0 through 21.0. FeedPost is no longer available in later versions. Starting with API version 21.0, use FeedItem to represent text posts, link posts, and content posts in feeds. ## Supported Calls create(), delete(), describeSObjects(), search() ## Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: - “Modify All Data” - “Modify All Records” on the object associated with the feed and delete permission on the parent feed - “Moderate Chatter” ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Users with the “Moderate Chatter” permission can delete only the feed items and comments they can see. - Manage Unlisted Groups Only users with this permission can delete items in unlisted groups. Only users with the Modify All Data permission can delete a feed item of Type TrackedChange. If the context user has the Insert System Field Values for Chatter Feeds user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the context user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration. ## Fields | Field | Details | | --- | --- | | Body | Type string Properties Create, Filter, Nillable, Sort Description The content of the FeedPost. Required when Type is TextPost or AdvancedTextPost. Optional when Type is ContentPost or LinkPost. | | ContentData | Type base64 Properties Create, Nillable Description This field is required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost. | | ContentDescription | Type string Properties Create, Nillable, Sort Description The description of the file specified in ContentData. | | ContentFileName | Type string Properties Create, Group, Nillable, Sort Description This field is required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost. | | ContentSize | Type int Properties Group, Nillable, Sort Description This field is the size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert. | | ContentType | Type string Properties Group, Nillable, Sort Description This field is the MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert. | | FeedItemId | Type reference Properties Filter, Group, Sort Description ID of the feed containing the FeedPost. | | InsertedById | Type reference Properties Filter, Group, Sort Description ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user. | | IsDeleted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the record has been moved to the Recycle Bin (true) or not (false). This field is a standard system field. | | LinkUrl | Type url Properties Create, Filter, Nillable, Sort Description The URL of a LinkPost. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the object type to which the FeedPost is related. For example, set this field to a UserId to post to someone’s profile feed, or an AccountId to post to a specific account. | | Title | Type string Properties Create, Filter, Group, Nillable, Sort Description The title of the FeedPost. When the Type is LinkPost, the Body is the URL and the Title is the label for the link. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of FeedPost: - UserStatus—automatically generated when a user updates their status - TrackedChange—ignore - TextPost—a direct text entry on a feed - LinkPost—a URL posting on a feed - ContentPost—an uploaded file on a feed ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you set Type to ContentPost, you must specify ContentData and ContentFileName. | ## Usage - You can’t directly query for a FeedPost. FeedPosts are always associated with a feed item, so you can query for them through the feeds. The following example returns all feed items for a given account, ordered by date descending: SELECT Id, Type, FeedPost.Body FROM AccountFeed WHERE ParentId = AccountId ORDER BY CreatedDate DESC - A FeedPost of type UserStatus is automatically created when a user adds a post to update the current status. You can’t explicitly create a FeedPost of type UserStatus. - The size limit for an attachment on a profile, news, or record feed is 2 GB. - You can’t use the content fields to update or delete the content. - You can’t filter or update the content fields. - Deleting a FeedPost via the API also deletes the associated content and FeedPost objects. Likewise, undeleting a FeedPost restores associated content and FeedPost objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is hard deleted. It isn’t sent to the Recycle Bin. - After uploading to a feed, it is possible for an attachment or document to be deleted, marked private, or hidden by sharing rules. In this case, all content fields in FeedPost appear as null in a SOQL query. - You can’t explicitly create or delete a FeedTrackedChange record. <!-- document id=8f10e8837eea10b672c7badf08a74e631f892bbc4ed6a088cfec85ddb7c699e2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feedrevision.md --> # FeedRevision Holds the revision history of a specific feed item or comment, including a list of attributes that changed for each revision. This object is available in API version 34.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | Action | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Holds the type of modification to the underlying feed item or comment attribute. Action can have the value Changed. | | EditedAttribute | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Identifies the part of the feed item or comment which was modified. A single revision can have many edited attributes. | | FeedEntityId | Type reference Properties Filter, Group, Sort Description Identifies the modified feed item or comment. | | [IsDeleted](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/system_fields.htm "System fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example, the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies a record.") | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the record has been moved to the Recycle Bin (true) or not (false). This field is a standard system field. | | IsValueRichText | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. If you post a rich text feed comment using SOAP API, set IsRichText to true and escape HTML entities from the body. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: - <p> Though the <br> tag isn’t supported, you can use <p> </p> to create lines. - <a> - <b> - <code> - <i> - <u> - <s> - <ul> - <ol> - <li> - <img> The <img> tag is accessible only through the API and must reference files in Salesforce similar to this example: <img src="sfdc://069B0000000omjh"></img> In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. | | OriginNetworkId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Experience Cloud site in which a user modified the feed item or comment. This field is only available, if digital experiences is enabled for your org. | | Revision | Type int Properties Filter, Group, Nillable, Sort Description The revision number of the feed item or comment. | | Value | Type textarea Properties Nillable Description Identifies the value of the EditedAttribute field before the update. | ## Usage This object tracks the changes made to a feed item or feed comment and stores a list of attributes that changed for each revision. - To query the FeedRevision object, users need the View All Data permission or supply a WHERE clause on the FeedEntityId. <!-- document id=ac38bc0f711bf298b7403845bc658a3b2f42f18d79d12e68ce46485e593adaf3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feedsignal.md --> # feedSignal Attach feed signals, like UpDownVote, UserVerified, and Verified, to a feed post or comment. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeSObjects() ## Fields | Field | Details | | --- | --- | | FeedEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the Feed entity. | | FeedItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the feed post or comment. Possible values are: - FeedItem - FeedComment | | InsertedById | Type reference Properties Filter, Group, Sort Description ID of user who inserted the signal. This is a relationship field. Relationship Name InsertedBy Relationship Type Lookup Refers To User | | SignalType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of signal. Possible values are: - UpDownVote - UserVerified - Verified | | SignalValue | Type int Properties Create, Filter, Group, Nillable, Sort Description The value of the signal. For example, for UpDownVote, the value specifies whether the signal is an upvote or a downvote. | <!-- document id=c24d153f202e860fcbd44f2801a36b94711152c70611e83c3bc62f9d35fe2476 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_feedtrackedchange.md --> # FeedTrackedChange Represents an individual field change or set of field changes. A FeedTrackedChange is a child object of a record feed, such as AccountFeed. This object is available in API version 18.0 and later. ## Supported Calls describeSObjects() ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Group, Restricted picklist, Sort Description Available only for organizations with the multicurrency feature enabled. Contains the ISO currency code for the field, if FieldName is a currency field. | | FeedItemId | Type reference Properties Filter, Group, Sort Description ID of the parent feed that tracks the field change. | | FieldName | Type string Properties Group, Sort Description The name of the field that was changed. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field also tracks other events that are not related to an individual field for a parent feed. These events occur as the parent record advances through its pipeline. For example, a value of leadConverted indicates that a lead has been converted to an opportunity. For a full list of values, see [Tracking of Special Events](#sforce_api_objects_feedtrackedchange "Represents an individual field change or set of field changes. A FeedTrackedChange is a child object of a record feed, such as AccountFeed. This object is available in API version 18.0 and later."). | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldCurrencyIsoCode | Type string Properties Group, Nillable, Sort Description Available only for organizations with the multicurrency feature enabled. Contains the ISO currency code for the OldValue field, if FieldName is a currency field. | | OldValue | Type anyType Properties Nillable, Sort Description The last value of the field before it was changed. | ## Usage A user can subscribe to a record or to another user. Changes to the record and updates from the users are displayed in the Chatter feed on the user's home page, which is a useful way to stay up-to-date with other users and with changes made to records in Salesforce. Feeds are available in API version 18.0 and later. If you move a custom field to the Recycle Bin, all FeedTrackedChange records that track historical changes to the custom field are automatically deleted and are not restored if the custom-field is undeleted. The following sections outline the difference between standard feeds and custom feeds. ## Standard Feeds A standard feed is a record feed, such as AccountFeed. FeedTrackedChange records for standard feeds can only be queried via the parent feed object. Note the following when working with standard feed items: - Feed items for standard feeds are read only in the API. - A FeedTrackedChange record is visible when you have read access on the record feed, and when the field is visible in the field-level security settings. ## Custom Feeds If you want more control over the information provided in a record feed, such as AccountFeed, you can create a custom feed. A custom feed can replace or augment an existing record feed. For example, you might want to: - Disable the standard account record feed and use an Apex trigger to generate FeedTrackedChange records for the events that you want to track in the feed instead. - Augment the standard contact record feed by writing an API client that inserts feed items for events that are not tracked in the standard feed. ## Tracking of Special Events The FieldName field also tracks other events that are not related to an individual field for a parent feed. These events occur as the parent record advances through its pipeline. For example, a value of leadConverted indicates that a lead has been converted to an opportunity. Valid values for the FieldName field for multiple objects: - created - ownerAccepted - ownerAssignment Additional valid values for the FieldName field for individual objects: Account - accountCreatedFromLead - accountMerged - accountUpdatedByLead - personAccountUpdatedByLead Case - closed - ownerEscalated Contact - contactCreatedFromLead - contactMerged - contactUpdatedByLead Contract - contractActivation - contractApproval - contractConversion - contractExpiration - contractTermination Lead - leadConverted - leadMerged Opportunity - opportunityCreatedFromLead #### See Also - [Custom Object\_\_Feed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customobject__feed.htm "Represents the feed, specifically posts and feed-tracked changes, on a custom object.") <!-- document id=aee10097a451d1d2f97da4b8e11c03356b335256295203bc9ac920a776ecedd3 url=/legacydeveloper/current/en-us/object_reference/api_ui_datatype_map.md --> # Field and Type Differences in Salesforce Apps and APIs Generally, API data types and field types in the user interface have the same names. For example, a date field is represented by a date data type in the API. However, some field types are represented differently depending on whether you inspect an object via the API or the user interface. This table contains the mapping for field types and data types that are different. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. | API Data Type | Corresponding Field Types in the User Interface | | --- | --- | | ID | Lookup relationship, master-detail relationship | | string | Auto number, email, phone, picklist, multi-select picklist, text, text area, long text area, rich text area, data category group reference, and URL. Different maximum lengths are specified in the WSDL for text, text area, and long text area. | | boolean | Checkbox | | double | Currency, formula, number, percent, and roll-up summary | | Varies by type | When formula fields are created in the user interface, a type must be specified. This type corresponds to the API data type of the same name: currency, date, date/time, number, percent, or text. | All other fields that you can create in the user interface fall into one of these categories. - The field isn’t available in both the user interface and the API. For example, the BusinessHours object has fields of API data type time, but you can’t create a custom field of this type. - Field types are the same as their corresponding API data type. For example, if you create a date field in the user interface, that field is the date data type in the API. Additionally, the user interface allows you to change the labels on some fields and tabs. Although you can’t relabel fields or tabs using the API, you can retrieve the current values. To do so, issue a describeSObjects() call and inspect the label field of the returned DescribeSObjectResult. For more information about API data types, see [Primitive Data Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/primitive_data_types.htm) and [Field Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm "In addition to the primitive data types, the API defines the following data types for fields."). <!-- document id=e330b8e5bd7e348f0ea223d5c9117045a5700d6f5111c4704258b3b41b4296fd url=/legacydeveloper/current/en-us/object_reference/field_types.md --> # Field Types In addition to the primitive data types, the API defines the following data types for fields. Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For fields that contain strings, behavior is different beginning with API version 15.0. In API versions previous to 15.0, if you specify a value for a field, and that value is too large, the value is truncated. For API version 15.0 and later, if a value is specified that is too large, the operation fails and the fault code STRING\_TOO\_LONG is returned. AllowFieldTruncationHeader allows you to specify that the previous behavior, truncation, be used instead of the new behavior in API versions 15.0 and later. This header has no effect in versions 14.0 and earlier. The affected fields are: anyType, email, encryptedstring, multipicklist, phone, picklist, string, and textarea. <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d11863e40">Field Type</th> <th class="featureTableHeader " id="d11863e43">What the Field Contains</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">address</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">A compound data type that contains address field data. </td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">anyType</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains"> <p class="p">Polymorphic data type that returns string, picklist, reference, Boolean, currency, int, double, percent, ID, date, datetime, url, or email data depending on the kind of field involved. See <a class="xref" href="#i1435524">AnyType Field Type</a>.</p> </td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">calculated</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Fields that are defined by a formula. See <a class="xref" href="#i1435527">Calculated Field Type</a>.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">combobox</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">A combobox, which includes a set of enumerated values and allows the user to specify a value not in the list. See <a class="xref" href="#i1435537">ComboBox Field Type</a>.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">currency</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Currency values. See <a class="xref" href="#i1435541">Currency Field Type</a>.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">DataCategoryGroupReference</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Reference to a data category group or a category unique name. See <a class="xref" href="#datacategorygroupreference_title">DataCategoryGroupReference Field Type</a>. </td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">email</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Email addresses. See <a class="xref" href="#i1435603">Email Field Type</a>.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">encryptedstring</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Encrypted text fields contain any combination of letters, numbers, or symbols that are stored in encrypted form. You can set a maximum length of up to 175 characters. Available in API versions 11.0 and later.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">floatarray</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Reserved for future use.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">ID</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Primary key field for the object. See <a class="xref" href="#i1435616">ID Field Type</a>. <p class="p">Most Web services tools, including .NET and WSC, map the ID simple type defined in the API WSDL (Enterprise or Partner) to a string. However, other tools generate a specific ID class to represent the ID simple type. Consult your Web services toolkit documentation for more information.</p> </td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">JunctionIdList</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">A string array of referenced ID values that represent the many-to-many relationship of an underlying junction entity. Query and manipulate the string array to query and manipulate the underlying junction entities in a single API call. See <a class="xref" href="#JunctionIdList_Field_Type_title_ph">JunctionIdList Field Type</a>.<p class="p">Adding a <span class="keyword parmname">JunctionIdList</span> field name to the <span class="keyword parmname">fieldsToNull</span> property deletes all related junction records. This action can’t be undone. </p> </td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">location</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">A compound data type that contains latitude and longitude values for geolocation fields.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">masterrecord</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">When records are merged, the ID of the record that is saved (the other records are deleted).</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">multipicklist</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Multi-select picklists, which include a set of enumerated values from which multiple values can be selected. See <a class="xref" href="#i1435691">Multi-Select Picklist Field Type</a>.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">percent</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Percentage values. See <a class="xref" href="#i1435698">Percent Field Type</a>.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">phone</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Phone numbers. Values can include alphabetic characters. Client applications are responsible for phone number formatting. See <a class="xref" href="#i1435705">Phone Field Type</a>.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">picklist</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Picklists, which include a set of enumerated values from which one value can be selected. See <a class="xref" href="#i1435709">Picklist Field Type</a>.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">reference</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Cross-references to a different object. Analogous to a foreign key field in SQL. See <a class="xref" href="#i1435823">Reference Field Type</a>. </td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">textarea</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">String that’s displayed as a multiline text field. See <a class="xref" href="#i1435887">Textarea Field Type</a>.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">textarray</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">Reserved for future use.</td> </tr> <tr> <td class="entry" headers="d11863e40" data-title="Field Type">url</td> <td class="entry" headers="d11863e43" data-title="What the Field Contains">URL values. Client applications commonly display URLs as hyperlinks. See <a class="xref" href="#i1435915">URL Field Type</a>.</td> </tr> </tbody> </table> These field types extend [primitive data types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/primitive_data_types.htm). Many of these field types follow common data typing conventions that are made explicit in their metadata. However, certain field types have unique characteristics that you must understand before using them in your client application. These field types apply to both standard and custom fields. They’re enumerated in the type field of the [Field Types](#field_types "In addition to the primitive data types, the API defines the following data types for fields.") type, which is described in the fields property of the DescribeSObjectResult. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Some numeric fields have precision and scale limits. In addition, certain text fields have length restrictions. These restrictions are enforced when you create() or update() objects. However, the API can return data that doesn’t meet these restrictions. ## AnyType Field Type The anyType field type is dynamic and returns string, date, number, or boolean data depending on the kind of field involved. For example, the element in a SOAP message has an xsi:type="xsd:string" attribute if the field is of type string. This field type is used in history objects for the NewValue and OldValue fields. It’s also a valid field type for fieldType and soapType. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Most SOAP toolkits automatically deserialize this element into the correct native type. ## Calculated Field Type Calculated fields are read-only fields in the API. These fields are defined by a formula, which is an algorithm that derives its value from other fields, expressions, or values. You can filter on these fields in SOQL, but you don’t replicate these fields. The length of text calculated fields is 3,900 characters or less—anything longer is truncated. Calculated fields are called formula fields in the Salesforce user interface. ## ComboBox Field Type A combobox is a picklist that also allows users to type a value that isn’t already specified in the list. A combobox is defined as a string value. ## Currency Field Type Currency fields contain currency values, such as the ExpectedRevenue field in a Campaign, and are defined as type double. For orgs that have the multicurrency option enabled, the CurrencyIsoCode field is defined for any object that can have currency fields. The CurrencyIsoCode field and currency fields are linked in a special way. On any specific record, the CurrencyIsoCode field defines the currency of that record. Therefore, the values of all currency fields on that record are expressed in that currency. For most cases, clients don’t need to consider the linking of the CurrencyIsoCode field and the currency fields on an object. However, consider these points. - The CurrencyIsoCode field exists only for those orgs that have enabled multicurrency support. - When you display the currency values in a user interface, it’s recommended that you prepend each currency value with its CurrencyIsoCode value and a space separator. - The CurrencyIsoCode field is a restricted picklist field. The set of allowable values, defined in the CurrencyType object, can vary from org to org. Attempting to set it to a value that isn’t defined for an org causes the operation to be rejected. - If you update the CurrencyIsoCode field on an object, it implicitly converts all currency values on that object to the new currency code. The field uses the conversion rates that are defined for that org in the Salesforce user interface. If you specify currency values in that same update() call, the new currency values you specify are interpreted in the new CurrencyIsoCode field value, without conversion. - The picklist values in a CurrencyIsoCode field don’t exactly match the labels displayed in Salesforce. To perform currency conversions, client applications can look up the CurrencyIsoCode in the CurrencyType object. ## DataCategoryGroupReference Field Type A data category group has categories that classify articles in Salesforce Knowledge and questions in the Answers feature. Every article and question object has two fields of type DataCategoryGroupReference which contain the category group and category unique name. You can use the describeDataCategoryGroups() and describeDataCategoryGroupStructures() calls to retrieve the category groups and categories related to these objects. ## Email Field Type Email fields contain email addresses. Client applications are responsible for specifying valid and properly formatted email addresses in create() and update() calls. ## ID Field Type With rare exceptions, all objects in the API have a field of type ID. The field is named Id and contains a unique identifier for each record in the object. It’s analogous to a primary key in relational databases. When you create() a new record, the Web service generates an ID value for the record, ensuring that it’s unique within your org’s data. You can’t use the update() call on ID fields. Because the ID value stays constant over the lifetime of the record, you can refer to the record by its ID value in subsequent API calls. Also, the ID value contains a three-character code that identifies the object type, which client applications can retrieve via the describeSObjects() call. In addition, certain objects, including custom objects, have one or more fields of type reference that contain the ID value for a related record. These fields have names that end in the suffix “Id”, for example, OwnerId in the account object. OwnerId contains the ID of the user who owns that object. Unlike the field named Id, reference fields are analogous to foreign keys and can be changed via the update() call. Some API calls, such as retrieve() and delete(), accept an array of IDs as parameters—each array element uniquely identifies the row to retrieve or delete. Similarly, the update() call accepts an array of sObject records—each sObject contains an Id field that uniquely identifies the sObject. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Most Web services tools, including .NET and WSC, map the ID simple type defined in the API WSDL (Enterprise or Partner) to a string. However, other tools generate a specific ID class to represent the ID simple type. Consult your web services toolkit documentation for more information. Salesforce IDs are often represented by 15-character, base-62, strings. Each of the 15 characters can be a numeric digit (0-9), a lowercase letter (a-z), or an uppercase letter (A-Z). These 15-character IDs are _case-sensitive_. To Salesforce, 000000000000Abc isn’t the same as 000000000000aBC. Don’t use 15-character IDs in case-insensitive applications like Microsoft Access™. These applications incorrectly consider 000000000000Abc to be the same as 000000000000aBC. To avoid these issues, all API calls return an 18-character ID that’s _case-safe_, meaning that it’s compared correctly by case-insensitive applications. The extra 3 characters at the end of the ID encode the case of the preceding 15 characters. Use 18-character IDs in all API calls when creating, editing, or deleting data. ![Case-insenstive applications give incorrect results when comparing 15-character IDs](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/case_of_ids.1.png) ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note 18-character IDs are _case-safe_, but not _case-insensitive_. In other words, if you manually change the case of an 18-character ID, Salesforce detects that the three extra characters don’t match the case of the preceding characters and returns an error. ![Salesforce gives an error if you change the case of an 18-character ID](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/case_of_ids.2.png) To convert the 18-character ID to a 15-character version, you may truncate the last three characters. However, Salesforce recommends that you use the 18-character ID. ## JunctionIdList Field Type Starting in API version 34.0, the JunctionIdList field type lets you directly manipulate the many-to-many relationship of an entity. You no longer need to manipulate underlying junction entity records. JunctionIdList fields can be queried and updated like any other field on the entity. Queries or updates to JunctionIdList fields act as queries or updates to the underlying junction entity records. Fields of type JunctionIdList appear in the WSDL as an unbounded array of type ID. Query JunctionIdList fields like any other field. For example, this SOQL query includes TaskWhoIds, which is a JunctionIdList field. SELECT Id, Subject, TaskWhoIds FROM Task WHERE LastModifiedDate > LAST\_WEEK The total number of records allowed in a single SOQL query can’t exceed 500 when one of the fields being queried on is a JunctionIdList type. If the number of IDs in the query exceeds 500, the query fails and returns the MALFORMED\_QUERY exception. The restriction is (total number of entity records) \* (total number of records in the entity's JunctionIdList field) must equal less than 500. For example, you query on the EventWhoIds JunctionIdList field for a list of events. There are 101 events and for each event, there are 5 records in the EventWhoIds JunctionIdList. Therefore, the Salesforce Object Query Language query would be querying for 505 records in total, which is over the 500 limit, and you get an exception. To avoid exceeding the record limit, reformulate the query so it includes fewer than 500 junction IDs or query a parent/child relationship instead of junction IDs. For example, this Salesforce Object Query Language query includes CcIds, which is a JunctionIdList field. SELECT Subject, CcIds FROM EmailMessage This example shows the conversion of a JunctionIdList query into a parent/child query. SELECT Subject, (SELECT Id FROM EmailMessageRelations WHERE RelationType = 'CcAddress') FROM EmailMessage All JunctionIdLists are read-only in Apex. Attempting to set a new value on an existing object results in an exception. ## Multi-Select Picklist Field Type Multi-select picklist fields contain a list of one or more items from which a user can choose multiple items. One of the items can be configured as the default item. Selections are maintained as a string containing a series of attributes delimited by semicolons. For example, a query can return the values of a multivalue picklist as “first value; second value; third value”. For information on querying multi-select picklists, see Query Multi-Select Picklists in the [Salesforce SOQL and SOSL Reference Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/ "HTML (New Window)"). ## Percent Field Type Percent fields contain percent values. Percent fields are defined as type double. ## Phone Field Type Phone fields contain phone numbers, which can include alphabetic characters. Client applications are responsible for phone number formatting. ## Picklist Field Type Picklist fields contain a list of one or more items from which a user chooses a single item. They display as dropdown lists in the Salesforce user interface. One of the items can be configured as the default item. In the Field object associated with the DescribeSObjectResult, the restrictedPicklist field defines whether the field is a restricted picklist or not. The API doesn’t enforce the list of values for advisory (unrestricted) picklist fields on create() or update(). When inserting an unrestricted picklist field that doesn’t have a PicklistEntry, the system creates an “inactive” picklist value. This value can be promoted to an “active” picklist value by adding the picklist value in the Salesforce user interface. When creating new, inactive picklists, the API checks to see if there’s a match. This check is case-insensitive. In the Field object associated with the DescribeSObjectResult, the picklistValues field contains an array of items (PicklistEntry objects). Each PicklistEntry defines the item’s label, value, and whether it’s the default item in the picklist (a picklist has no more than one default value). Enumerated fields support localization of the labels to the language of the user. For example, for the Industry field on an Account, the value “Agriculture” can be translated to various languages. The enumerated field values are fixed and don’t change with a user’s language. However, each value may have a specified “label” field that provides the localized label for that value. Always use the value when inserting or updating a field. The query() call always returns the value, not the label. Use the corresponding label for a value in the describeSObjectResult when displaying the value to the user in any user interface. The API supports the retrieval of the certain picklists in the following objects: CaseStatus, ContractStatus, LeadStatus, OpportunityStage, PartnerRole, SolutionStatus, TaskPriority, and TaskStatus. Each object represents a value in the respective picklist. These picklist entries always specify some other piece of information, such as whether the status is converted. Your client application can invoke the query() call on any of these objects (such as CaseStatus) to retrieve the set of values in the picklist. The application can then use that information while processing other objects (such as Case objects) to find more information about those objects (such as a given case). These objects are read-only via the API. To modify items in picklists, you must use the Salesforce user interface. ## Reference Field Type A reference field contains an Id value that points to a unique record (usually the parent record) on another object. A reference field is analogous to the concept of a foreign key in relational databases. The name of a reference field ends, by convention, with the letters Id (such as CaseId or OpportunityId). For example, in the OpportunityCompetitor object, the OpportunityId field is a reference field that points to the Opportunity object. It contains an ID value that uniquely identifies an Opportunity record. Sometimes, an object can refer to another object of its same type. For example, an Account can have a parent link that points to another Account. The Event and Task objects both have WhoId and WhatId cross-reference ID fields. Each of these cross-reference fields can point to one of several other objects. The WhoId field can point to a Contact or Lead, and the WhatId field can point to an Account, Opportunity, Campaign, or Case. In addition, if the WhoId field refers to a Lead, then the WhatId field must be empty. You can describe and query each cross-referenced object. When you query a cross-reference ID field, it returns an object ID of the appropriate type. You can then query that ID to get additional information about the object, using the ID in the id field for that query. The cross-reference ID field value is either: - a valid record in your organization, or - an empty value, which indicates an empty reference The cross-reference ID field value, if non-null, is guaranteed to be an object in your org. However, it isn’t guaranteed that you can query that object. Users with the “View All Data” permission can always query that object. Other users can be restricted from viewing or editing the referenced object. When specifying a value for a cross-reference ID field in a create() or update() call, the value must be a valid value of type ID, and the user must have appropriate access to that object. The exact requirements vary from field to field. ## Textarea Field Type Textarea fields contain text that can be longer than 4,000 bytes. Unlike string fields, textarea fields can’t be specified in the WHERE clause of a queryString of a query() call. To filter records on this field, you must do so while processing records in the QueryResult. For fields with this restriction, its filterable field in the Field type (described in the fields property of the DescribeSObjectResult) is false. ## URL Field Type URL fields contain URLs. Client applications are responsible for specifying valid and properly formatted URLs in create() and update() calls. <!-- document id=860cb4b1ab351c269fcfaf71153b23036081c4d43f9811d1b4310a49a4a054e9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fieldchangesnapshot.md --> # FieldChangeSnapshot Use this virtual object to learn which opportunities' close dates changed during the specified time period. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To use FieldChangeSnapshot, set up historical trend reporting for opportunities in your org. You must also have the Pipeline Inspection user permission and the Pipeline Inspection setting enabled. ## Fields | Field | Details | | --- | --- | | CurrentValueDateOnly | Type date Properties Filter, Group, Nillable Description The current value of a date field on the opportunity. | | FieldName | Type string Properties Filter, Group Description The name of the field to get the change history for. Possible values are: - CloseDate | | ParentId | Type reference Properties Filter, Group Description The ID of the opportunity to get the change history for. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Opportunity | | ValidFrom | Type dateTime Properties Filter Description The date and time that specifies the beginning of the time period. | | ValidTo | Type dateTime Properties Filter Description The date and time that specifies the end of the time period. | ## Usage Use FieldChangeSnapshot to learn about the first change made to the specified opportunity during the specified time period. Subsequent changes are not returned. ## Example Suppose that last week you changed an opportunity's close date to June 1, 2021. Assuming the opportunity had the ID '006R0000XXXXXXXXXX', the following query would return the CurrentValueDateOnly of June 1, 2021: Select CurrentValueDateOnly from FieldChangeSnapshot where ParentID = '006R0000XXXXXXXXXX' and FieldName = 'CloseDate' and ValidTo = LAST\_WEEK AND ValidFrom = LAST\_WEEK and CurrentValueDateOnly < 2021-07-01 <!-- document id=e3f60fbaf04fb9e2f4afed2b5f009f56632636b0dbc95164eccaad5b0e3d4d0d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fieldhistoryarchive.md --> # FieldHistoryArchive Represents field history values for all objects that retain field history. FieldHistoryArchive is a big object, available only to users with the “Retain Field History” permission. This object is available in API version 29.0 and later. Each instance of the FieldHistoryArchive object represents a single change in the value of a field. FieldHistoryArchive stores history for both standard and custom fields. The Field field returns the name of the field unless the parent field or object is deleted, in which case it returns the field ID. You can use the ID to retrieve the old field and object name from the FieldNameAfterArchival and ParentNameAfterArchival fields, respectively. ## Supported Calls describeSObjects(), query() ## Fields | Field Name | Details | | --- | --- | | ArchiveFieldName | Type string Properties Nillable Description The name of the field at the time the data was archived. If the field name changed, the name is sometimes not the same for all records related to a single field. | | ArchiveParentName | Type string Properties Nillable Description The name of the parent object at the time the data was archived. If the object name changed, the name is sometimes not the same for all records related to a single field. | | ArchiveParentType | Type string Properties Nillable Description The type of the field at the time the data was archived. If the field type changed, the type is sometimes not the same for all records related to a single field. | | ArchiveTimestamp | Type dateTime Properties Nillable Description The date and time at which the data was archived. | | Field | Type picklist Properties Restricted picklist Description The name of the field that was changed. If the field is deleted from the parent object, the Field field contains the field ID instead. | | FieldHistoryType | Type picklist Properties Filter, Nillable, Restricted picklist, Sort Description The name of the object that contains the field history. Possible values are: - Account - Article - Asset - AuthorizationFormConsent – Available in version 58.0 and later. - Case - CommSubscriptionConsent – Available in version 58.0 and later. - Contact - ContactPointConsent – Available in version 58.0 and later. - ContactPointTypeConsent – Available in version 58.0 and later. - Contract - ContractLineItem - Crisis - Employee - EmployeeCrisisAssessment - Entitlement - Individual - InternalOrganizationUnit - Knowledge - Lead - Opportunity - Order - OrderItem - PartyConsent – Available in version 58.0 and later. - Pricebook2 - PricebookEntry - Product2 - ServiceAppointment - ServiceContract - Solution - WorkOrder - WorkOrderLineItem | | HistoryId | Type reference Properties Filter, Sort Description The ID of the relevant history object (for example, AccountHistory). This field is available in versions 42.0 and later. | | NewValue | Type anyType Properties Nillable Description The new value of the modified field. | | OldValue | Type anyType Properties Nillable Description The previous value of the modified field. | | ParentId | Type reference Properties Filter, Sort Description The ID of the object that contains the field (the parent object). | ## Usage When sorting fields, order them as follows: 1. FieldHistoryType ASC 2. ParentID ASC 3. CreatedDate DESC #### See Also - [_Developer Guide:_Big Objects Implementation Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.bigobjects.meta/bigobjects/big_object.htm " Developer Guide:Big Objects Implementation Guide - HTML (New Window)") <!-- document id=3aa7851d219d71f97eb98cd43cd65b5c1947d5ae49f440fe3f98c0a04ebd364e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fieldpermissions.md --> # FieldPermissions Represents the enabled field permissions for the parent PermissionSet. This object is available in API version 24.0 and later. To grant a user access to a field, associate a FieldPermissions record with a PermissionSet that’s assigned to a user. FieldPermissions records are only supported in PermissionSet, not in Profile. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules In API version 49.0 and later, only users with the View Setup and Configuration permission can access this object. ## Fields In API version 50.0 and later, for lookup field inserts and queries, you can leave off the Id in the field name or include it. The rows returned always use the API name. For example: SELECT SobjectType, Field FROM FieldPermissions WHERE Field='Contact.Account' and SELECT SobjectType, Field FROM FieldPermissions WHERE Field='Contact.Account**Id**' both return Contact, Contact.AccountId | Field Name | Details | | --- | --- | | Field | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The field’s API name. This name must be prefixed with the SobjectType. For example, Merchandise\_\_c.Description\_\_c | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The Id of the field’s parent [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later."). This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To PermissionSet | | PermissionsEdit | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, users assigned to the parent PermissionSet can edit this field. Requires PermissionsRead for the same field to be true. | | PermissionsRead | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, users assigned to the parent PermissionSet can view this field. A FieldPermissions record must have at minimum PermissionsRead set to true, or it will be deleted. | | SobjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The object’s API name. For example, Merchandise\_\_c. | ## Usage FieldPermissions work similarly to ObjectPermissions. However, FieldPermissions includes a Field attribute to return the name of the field. For example, the following query returns all FieldPermissions records that have at least the “Read” permission. The results include the field, object, and permission set names. SELECT SobjectType, Field, PermissionsRead, Parent.Name FROM FieldPermissions WHERE PermissionsRead = True Include the field’s parent object when querying FieldPermissions. For example, to find all rows that match the Account object’s Type field, create the following query: SELECT Id, SobjectType, Field FROM FieldPermissions WHERE Field = 'Account.Type' AND SobjectType = 'Account' To find which permission sets are backed by profiles with the Account object, you can use a query like the following example: SELECT Id, ParentId, SobjectType, Field, PermissionsEdit, PermissionsRead, Parent.Name FROM FieldPermissions WHERE SobjectType = 'Account' and Parent.IsOwnedByProfile = true ORDER BY SObjectType, Field Both SobjectType and Field must be included in the SELECT line of the query. Provide the full API name of the field in the form of SobjectType.Field when querying for a field. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When using the FieldPermission object to download records, depending on the SOQL query you use, you might not receive all expected records. Results can also appear incomplete. However, all records do download; fields that don't support field security and rows for entities not visible to the org are hidden. ## Special Properties for Field Permissions The auto-number and formula fields have special rules for how field permissions work. Both have FieldPermissions records, but inserting and updating is limited to PermissionsRead. PermissionsEdit isn’t allowed for either field type, since these fields must be read-only for users. The following field types don’t return a FieldPermissions record because they are assumed to always be readable. - Id - CreatedById - CreatedDate - IsDeleted - LastModifiedById - LastModifiedDate - SystemModStamp The following field types don’t return a FieldPermissions record because they are assumed to always be readable and writable. - OwnerId - Master-detail custom (relationship) fields - Universally required custom fields As a result, the following query returns no records, even though users do have some access to some of the fields. SELECT Field, SobjectType, PermissionsRead FROM FieldPermissions WHERE Field='Id' To determine if a field can return a FieldPermissions record, you can call a describeSObject() on the field. For example, describeSObject('Merchandise\_\_c'), returns all the properties of the Merchandise custom object, including field properties. If you use a field whose permissionable property is false (like the field types listed in this section), you can’t query, insert, update, or delete field permissions records, because they don’t exist. If the View All Fields object permission is enabled for an object in the permission set, the PermissionsRead field equals true for all queried fields for that object. ## Working with Custom Activity Fields While tasks and events are considered separate objects, they share a common set of activity custom fields. As a result, when a custom task field is created, a custom event field is also created, and vice versa. You can display the custom field on the event layout, task layout, or both event and task layouts. Although custom activity fields are shared between tasks and events, you see separate FieldPermissions records for the task and event. However, changes made to one field permission record are automatically made to the other. For example, if you create a custom activity field, assign field permissions to it in a permission set, and run the following query, the query returns two records with the same permission value. SELECT Field, Id, ParentId, PermissionsEdit, PermissionsRead, SobjectType FROM FieldPermissions WHERE SobjectType = 'event' OR SobjectType ='task' If you then update one of the records with another set of field permission values and run the query, the same permission values for both records are returned. ## Nesting Field Permissions You can nest FieldPermissions in a PermissionSet query. For example, the following returns any permission sets where “Edit Read Only Fields” is true. Also, the result set includes both the “Read” and “Edit” field permission on the Merchandise object. Get similar results by nesting the SOQL with a field permission query using the relationship name for field permissions: FieldPerms. SELECT PermissionsEditReadonlyFields, (SELECT SobjectType, Field, PermissionsRead, PermissionsEdit FROM FieldPerms WHERE SobjectType = 'Merchandise\_\_c') FROM PermissionSet WHERE PermissionsEditReadonlyFields = true As a result, it’s possible to traverse the relationship between the PermissionSet and any child-related objects (in this case, FieldPermissions). You can do this from the PermissionSet object by using the child relationship (ObjectPerms, FieldPerms, and so on) or from the child object by referencing the PermissionSet with Parent.permission\_set\_attribute. It’s important to consider when to use a conditional WHERE statement to restrict the result set. To query based on an attribute on the permission set object, nest the SOQL with the child relationship. However, to query based on an attribute on the child object, you must reference the permission set parent attribute in your query. The following two queries return the same columns with different results, based on whether you use the child relationship or parent notation. SELECT PermissionsEditReadonlyFields, (SELECT SobjectType, Field, PermissionsRead, PermissionsEdit FROM FieldPerms WHERE SobjectType = 'Merchandise\_\_c') FROM PermissionSet WHERE PermissionsEditReadonlyFields = true Versus: SELECT SobjectType, Field, PermissionsRead, PermissionsEdit, Parent.Name, Parent.PermissionsEditReadonlyFields FROM FieldPermissions WHERE SObjectType='Merchandise\_\_c' ## Muting Permissions Field permissions with a parent muting permission set act differently than those enabled in a regular permission set. For a regular permission set, if a FieldPermissions record grants full access to a field (for example, granting read and edit access), users have full access to that field. With muting permission sets, a FieldPermissions record defines the muting of access. So if a muting permission set is set for read and edit, the read and edit access is muted. For example, we have a permission set and a muting permission set that controls access to the Account object’s fields. Each permission set has settings for the Website field. Regular Permission Set | Field | PermissionsRead | PermissionsEdit | Result | | --- | --- | --- | --- | | Account.Website | true | false | The Account.Website field is read only. | | Account.Website | true | true | The Account.Website field has both read and edit permissions. | Muting Permission Set | Field | PermissionsRead | PermissionsEdit | Result | | --- | --- | --- | --- | | Account.Website | false | true | Edit permissions on the Account.Website fields are muted. | | Account.Website | true | true | Read and edit permissions on the Account.Website field are muted. | Field permissions are aggregated by combining the permissions granted by the permission set and the permissions muted by the muting permission set. For example, if you have a permission set that grants read and edit permissions for a field, and a muting permission that mutes the same field’s edit permission, the result is that only the read permission is enabled. #### See Also - [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.") - [ObjectPermissions](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectpermissions.htm "Represents the enabled object permissions for the parent PermissionSet. This object is available in API version 24.0 and later.") <!-- document id=562f92fb016b850d72ce1057303fae1281c7a706a5db7e18ccf1bb71d62282c7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fieldsecurityclassification.md --> # FieldSecurityClassification Represents a field’s data sensitivity value selected from the SecurityClassification picklist. This object is available in API version 46.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To view this object, you need the Customize Application or Modify Data Classification permission. ## Fields | Field Name | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description The API name of the data sensitivity picklist value. Default values: - Public - Internal - Confidential - Restricted - MissionCritical | | Description | Type textarea Properties Filter, Group, Nillable, Sort Description The description of the data sensitivity picklist value. | | IsHighRiskLevel | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that fields with this picklist value contain data highly sensitive to your company. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The data sensitivity picklist value. Default values: - Public - Internal - Confidential - Restricted - MissionCritical | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description The value’s position in the picklist. | ## Usage Use this object to return information about data sensitivity values in the SecurityClassification picklist. This object is read-only, but you can update the SecurityClassification picklist using the [StandardValueSet](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_standardvalueset.htm) Metadata API type. <!-- document id=e590ab2fdc76d5779f4280eb679c16bc7ea19d9c12067126db1948b12d235b0c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fieldservicemobilesettings.md --> # FieldServiceMobileSettings Represents a configuration of settings that control the Field Service iOS and Android mobile app experience. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | AscAutomaticMode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Describes how status changes are handled. Possible values are: - Off—No automatic status changes. - Manual—The mobile worker can cancel or update the status change. - Timed—The mobile worker has a time period to prevent the status change. When the timer ends, the status changes. - Automated—The mobile worker is notified that the status has changed. | | AscCancellationTimerInSec | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description For the Timed mode only. Time that the user has to cancel the appointment status change. | | AscCompletedStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status that indicates that a mobile worker completed a service appointment. Possible values are: - Canceled - Cannot Complete - Completed - Dispatched - In Progress - None - Scheduled | | AscOnSiteStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status that indicates that a mobile worker is at a service appointment. Possible values are: - Canceled - Cannot Complete - Completed - Dispatched - In Progress - None - Scheduled | | AscRadiusInMeters | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Service appointment radius that can trigger a status change. | | AscTimeLimitationInMin | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description A time period when status changes can occur, before an appointment’s scheduled start time and after the scheduled end time. The time is applied only if IsAscTimeLimitEnabled is true. | | AscTravelStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status that indicates that a mobile worker is traveling to a service appointment. Possible values are: - Canceled - Cannot Complete - Completed - Dispatched - In Progress - None - Scheduled | | BgGeoLocationAccuracy | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The accuracy of geolocation tracking of services resources while the app is running in the background. Lowering accuracy reduces battery consumption for mobile devices. Available in API version 41.0 and later. Picklist options: - Medium—Accurate to within about 100 meters. - Coarse—Accurate to within about 1 kilometer. - Very Coarse—Accurate to within about 3 kilometers. The default value is Coarse. | | BgGeoLocationMinUpdateFreqMins | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The frequency of geolocation poling of services resources while the app is running in the background. Less frequent poling decreases battery consumption for mobile devices. The label in the UI is **Minimum Update Frequency of Geo Location in Minutes (Background)**. Available in API version 41.0 and later. | | BrandInvertedColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of toasts and the contrast color of the floating action button. | | ContrastInvertedColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of secondary backgrounds in the UI. | | ContrastPrimaryColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of primary text. | | ContrastQuaternaryColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of secondary lines that delineate different areas of the UI. | | ContrastQuinaryColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of primary backgrounds in the UI. | | ContrastSecondaryColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of secondary text. | | ContrastTertiaryColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of the icons on the settings screen and of primary lines that delineate different areas of the UI. | | DaysBeforeCurrentServiceDate | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Days before the current service date during which to prime service documents for offline use. | | DayAfterCurrentServiceDate | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Days after the current service date during which to prime service documents for offline use. | | DefaultListViewDeveloperName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of the default service appointment list view on the schedule screen. | | DestinationType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines if the mobile worker navigates to the destination based on the address or based on the latitude and longitude. Possible values are: - Address - Latitude and Longitude The default value is Address. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the set of field service mobile settings. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | FeedbackPrimaryColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of error messages. | | FeedbackSecondaryColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of success messages. | | FeedbackSelectedColor | Type string Properties Create, Defaulted on create, Group, Sort, Update Description The color indicating the user’s current selection. | | FutureDaysInDatePicker | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The number of days into the future that a user can select from the date picker on the schedule screen. | | GeoLocationAccuracy | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The accuracy of service resource geolocation tracking. Lowering accuracy reduces battery consumption for mobile devices. Picklist values: - Fine—Accurate to within 10 meters. - Medium—Accurate to within 100 meters. - Coarse—Accurate to within 1 kilometer. The default value is Medium. | | GeoLocationMinUpdateFreqMins | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The minimum number of minutes between attempts to poll geolocation. | | IsAscTimeLimitEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether AscTimeLimitationInMin is applied. Default is true | | IsAssignmentNotification | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether service appointment notifications are sent when the service resource is assigned the appointment. Default is false. This field is available in API version 46.0 and later. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the set of field service mobile settings is the default set that is automatically assigned to users. You can’t make a different settings record the default, but you can modify the default settings record. Default is false. Available in API version 41.0 and later. | | IsDispatchNotification | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether service appointment notifications are sent when the service resource is dispatched for the appointment. Default is false. This field is available in API version 46.0 and later. | | IsLimitedLocTrackingEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description When limited tracking for Appointment Assistant is enabled, the mobile worker’s location is shown only on the way to a service appointment. The default value is false. | | IsOptimizedImageUploadEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to configure the size of images uploaded by your mobile workers. To optimize upload speeds, you can limit your file size to a defined maximum size using the OptimizeImageSizeInMb field. Resizing your images affects the resolution of your images. The default value is false. | | IsScheduleViewResourceAbsences | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether resource absences appear in the Schedule tab of the mobile app. This field is available in API version 55.0 and later. | | IsSendLocationHistory | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether geolocation tracking of services resources is enabled. Default is false. | | IsShowEditFullRecord | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether users can edit records with the field service mobile app. Default is false. | | IsTimeSheetEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether users can access time sheets on their mobile devices (Beta). Default is false. | | IsTimeZoneEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether the time zone of timesheet entries on the mobile app is recorded. The current time zone is recorded in the LocationTimeZone field of the TimeSheetEntry object. Default is false. Available in API version 50.0 and later. | | IsUseSalesforceMobileActions | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Reserved for future use. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The localization preference for a user. The format is a two letter language code and, if there’s a dialect, followed by the two letter dialect, for example, fr for French, and fr\_BE for Belgian French | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label in the UI for the set of field service mobile settings. Available in API version 41.0 and later. | | MaxNumberOfServiceAppointments | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Sets the maximum number of service appointments to use for offline priming of service documents. If you don’t have dates on your service appointments, this setting helps to optimize offline priming in place of DaysBeforeCurrentServiceDate and DaysBeforeCurrentServiceDate fields. | | MetadataCacheTimeDays | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The number of days that org metadata, such as layouts, is kept in the app’s local cache of memory. | | NavbarBackgroundColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of the top bar in the app. | | NavbarInvertedColor | Type string Properties Create, Defaulted on create, Group, Sort, Update Description The secondary color of the tap bar in the app. | | OptimizeImageSizeInMb | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Configure the size of images uploaded by your mobile workers. To optimize upload speeds, you can limit your file size to a defined maximum size. Resizing your images affects the resolution of your images. Enter 0.2 or higher. Used only if IsOptimizedImageUploadEnabled is true. | | PastDaysInDatePicker | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The number of days into the past that a user can select from the date picker on the schedule screen. | | PrimaryBrandColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The main branding color used throughout the UI. | | QuickStatusChangeFlowName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of an existing Field Service flow with a Quick Status Change action to change the work order or service appointment status or both. This applies to flows invoked on the mobile app only. This field is available in API version 51.0 and later. | | RecordDataCacheTimeMins | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The number of minutes that record data is kept in the app’s local cache of memory. | | SecondaryBrandColor | Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of action buttons. | | TimeIntervalSetupMins | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Controls the spacing of picklist options for time values such as when creating resource absences. | | UpdateScheduleTimeMins | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The minimum number of minutes between attempts to update a user’s schedule.The user’s schedule might not refresh on this cadence if the user’s device isn’t connected to a network or doesn’t have adequate battery life. | ## Usage Field Service Mobile settings allow you to create sets of settings to apply to different field service mobile users. The settings apply to both the Android and iOS versions of the app. For example, suppose you want to accommodate workers that are color blind, or who work in dark or bright conditions. You can choose different branding options for different workers to suit their needs, and assign them to their profiles. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [FieldServiceMobileSettingsChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. <!-- document id=dbc287ea3c7db68d86e7bd6e77f10d972c7b3e6f9cb3f15f957b41a7807a0d55 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fieldserviceorgsettings.md --> # FieldServiceOrgSettings Represents the org settings for Field Service, such as Appointment Assistant settings. If Field Service is enabled, the org contains one read-only record of this object. This object is available in API version 51.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To see this object, Field Service must be enabled. For specified fields in the table, Appointment Assistant must also be enabled. ## Fields | Field | Details | | --- | --- | | ApptAssistantExpiration | Type int Properties Filter, Group, Nillable, Sort Description The expiry time in minutes of when the customer stops seeing the mobile worker’s location. Appointment Assistant must also be enabled to see this field. | | ApptAssistantInfoUrl | Type string Properties Filter, Group, Nillable, Sort Description The page URL that enables Appointment Assistant. Appointment Assistant must also be enabled to see this field. | | ApptAssistantRadiusUnit | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The unit of the radius of the service appointment that prompts the Last Mile event for Appointment Assistant. Appointment Assistant must also be enabled to see this field. Possible values are: - Kilometer - Meter - Mile - Yard | | ApptAssistantRadiusValue | Type int Properties Filter, Group, Nillable, Sort Description The radius of the service appointment that prompts the Last Mile event for Appointment Assistant. Appointment Assistant must also be enabled to see this field. | | ApptAssistantStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description The value that prompts the En Route event for Appointment Assistant. Appointment Assistant must also be enabled to see this field. Possible values are: - Canceled - Cannot Complete - Checked In - Completed - Dispatched - In Progress - None - Scheduled - TestSharing The default value is 'None'. | | CanPopulateGoogleAddress | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Allows desktop and mobile to send geolocation and map data to Google and Apple. Available in API version 57.0 and later. The default value is true. | | CanSendAppCenterCrashReports | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Allows Salesforce to send crash reports to Microsoft App Center. Available in API version 57.0 and later. The default value is true. | | CanStoreMobileAnalytics | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Allows third parties to store mobile analytics. Available in API version 57.0 and later. The default value is true. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the object in the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | DoesAvlCalcInclOvertime | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether overtime is included in work capacity availability calculations. Available in API version 59.0 and later. The default value is false. | | DoesAvlCalcInclPrimOnly | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies if primary members only are included in work capacity availability calculations. If the value is false both primary and secondary members of the service territory are included. Available in API version 59.0 and later. The default value is false. | | | | | EnrouteStatus | Type string Properties Filter, Group, Nillable, Sort Description The en route status value for Appointment Assistant. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the field service org settings. The format for the values is a two-letter language code in small letters, for example, fr for French. If the language has regional dialects, add the two-letter country code in capital letters, for example, use fr\_BE for Belgian French. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label of the field service org settings. | <!-- document id=35164e638b6f16e209172bef25e2707532fa0c289004eb9e9b5578b6015c59b1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_filesearchactivity.md --> # FileSearchActivity Represents search activity on a file. This object is available in API version 38.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AvgNumResults | Type double Properties Filter, Sort Description The number of search results returned for the search term. If Period is also included, this value is aggregated based on the time period specified. | | ClickRank | Type double Properties Filter, Nillable, Sort Description The order that the file appeared in the search results when users clicked it from the list of results. | | CountQueries | Type int Properties Filter, Group, Sort Description The number of searches for the period (day, month, or year). | | CountUsers | Type int Properties Filter, Group, Sort Description The number of individual users who clicked the file. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of search activity. | | Period | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The time period that the search count is applied to. For example, a record where the Count is 70 and the Period is Monthly indicates that 70 searches took place over the past month. Totals are aggregated daily for the current month, monthly from the past full month through the past full year, and yearly beyond that. Possible values are: - DAY - MONTH - YEAR | | QueryDate | Type date Properties Filter, Group, Sort Description The date of the search. | | QueryLanguage | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language filter that’s applied to the user’s search. | | SearchTerm | Type string Properties Filter, Group, Sort Description The first 100 characters of the search term that was used to search published files. | <!-- document id=ade390ac553b4365b8ba13cf927471e6b5647f39f535734ab22a52ca2d61273b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fiscalyearsettings.md --> # FiscalYearSettings Settings to define a custom or standard fiscal year for your organization. This object has a parent-child relationship with the Period object. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only partner users and standard users can access this object. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Filter, Group, Nillable, Sort Description Description of the setting. | | EndDate | Type date Properties Filter, Group, Nillable, Sort Description End date of the fiscal year. | | IsStandardYear | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the fiscal year is a standard calendar year (true) or a custom fiscal year (false). | | Name | Type string Properties Filter, Group, idLookup, Sort Description A name for the fiscal year. Limit: 80 characters. | | PeriodId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated fiscal period. | | PeriodLabelScheme | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The numbering scheme used for fiscal periods. | | PeriodPrefix | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description The prefix of fiscal periods. For example, if p is the prefix, then the first period is “P1.” | | QuarterLabelScheme | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The numbering scheme used for fiscal quarters. | | QuarterPrefix | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description The prefix of fiscal quarters. For example, if “Q” is the prefix, then the fourth quarter would be “Q4.” | | StartDate | Type date Properties Filter, Group, Nillable, Sort Description Start date of the fiscal year. | | WeekLabelScheme | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The numbering scheme used for weeks. | | WeekStartDay | Type int Properties Filter, Group, Nillable, Sort Description The name of the day that starts the week, for example Monday or Sunday | | YearType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates one of two types of fiscal years, Standard or Custom. Standard denotes the standard Gregorian calendar, while Custom means a fiscal year with a custom structure. | #### See Also - [Period](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_period.htm "Represents a fiscal period defined in FiscalYearSettings.") - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=32cd7689b00d8bb140efdf525f4a879d75aa89fd77ef4fa5b47980df5167ab86 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fldsvcobjchg.md --> # FldSvcObjChg Represents a change made to one of a service appointment’s tracked fields. This object is available in API version 63.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules - Field Service must be enabled. - The Field Service managed package must be installed. - The **Track the lifecycle of service appointments** setting in **Setup** | **Field Service Settings** must be enabled. - The Platform Integration User must have the Manage Service Appointment Lifecycle and the View Service Appointment Lifecycle permissions. - To view this object, users must have the View Service Appointment Lifecycle user permission. ## Fields | Field | Details | | --- | --- | | Activity | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The available scheduling activities for the service appointment. Possible values are: - AddedToBundle—Currently not supported - BundleMemberAdded—Currently not supported - BundleMemberRemoved—Currently not supported - Created - Deleted - RemovedFromBundle—Currently not supported - Rescheduled—An appointment is considered ‌rescheduled if a change is made to its assigned service resource or to its scheduled start time. - Scheduled - ServiceResourceAssigned - StatusChanged—The service appointment status was changed. The manual activities of scheduling, rescheduling, and unscheduling are also reported as status changes because they change the status of an appointment. - Unscheduled - Updated—Captures changes made to one or more of the tracked scheduling fields that aren’t associated with another activity. | | ActivityDetails | Type string Properties Filter, Nillable, Sort Description Details about the scheduling activity such as the scheduling policy that was used and the unscheduling reason (when applicable). | | ActivityTimeStamp | Type dateTime Properties Filter, Nillable, Sort Description Date and time of when the change to the service appointment was made. | | IsPrimary | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the change was made directly to the service appointment or indirectly. If the change was made directly to the appointment, it’s flagged as Primary. If it was made to another appointment and affected this one, it’s flagged as Secondary. | | OriginalSvcAppointment | Type string Properties Filter, Group, Nillable, Sort Description The ID of the service appointment that was changed. The field value isn’t deleted when the Service Appointment object is deleted. | | ServiceAppointmentId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the service appointment that was changed. Because this is a relationship field, the field value is deleted when the Service Appointment object is deleted. This field is a relationship field. Relationship Name ServiceAppointment Relationship Type Lookup Refers To ServiceAppointment | | TimeZone | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The time zone of the service appointment or the assigned resource. | | Transaction | Type string Properties Filter, Nillable, Sort Description The last transaction ID of the scheduling and optimization request that updated this object. The transaction ID is automatically generated and populated by the Enhanced Scheduling and Optimization engine. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description The user who made the change to the service appointment. If an activity is a scheduled job, it’s registered with the System Administrator user who configured it. This field is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | #### See Also - [FldSvcObjChgDtl](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fldsvcobjchgdtl.htm "Represents the details of a change made to one of a service appointment’s tracked fields. This object is available in API version 63.0 and later.") <!-- document id=6f6451cd649648ffba3da5bcd70cdf39da4d1c98c51e5c0c4f402c0838ad7133 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fldsvcobjchgdtl.md --> # FldSvcObjChgDtl Represents the details of a change made to one of a service appointment’s tracked fields. This object is available in API version 63.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules - Field Service must be enabled. - The Field Service managed package must be installed. - The **Track the lifecycle of service appointments** setting in **Setup** | **Field Service Settings** must be enabled. - The Platform Integration User must have the Manage Service Appointment Lifecycle and the View Service Appointment Lifecycle permissions. - To view this object, users must have the View Service Appointment Lifecycle user permission. ## Fields | Field | Details | | --- | --- | | FieldChangedName | Type string Properties Filter, Group, Sort Description The API name of the field that was changed. | | FieldChangedValue | Type string Properties Filter, Nillable, Sort Description The updated value of the field that was changed. | | FldSvcObjChgId | Type reference Properties Filter, Group, Sort Description The parent record associated with the details of the change. The parent record has multiple detail records associated with it. Each record includes the name and the current value of the tracked fields. This field is a relationship field. Relationship Name FldSvcObjChg Relationship Type Lookup Refers To FldSvcObjChg | #### See Also - [FldSvcObjChg](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fldsvcobjchg.htm "Represents a change made to one of a service appointment’s tracked fields. This object is available in API version 63.0 and later.") <!-- document id=bcc2a6ecbe564463dad24c7e373b01a2388eb1c3b6149f2671c72787054669b9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flexqueueitem.md --> # FlexQueueItem Represents an asynchronous Apex job in the Apex flex queue. Provides information about the job type and flex queue position of the AsyncApexJob. This object is available in API version 36.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules In API version 49.0 and later, users must have the View Setup and Configuration permission to access this object. ## Fields | Field Name | Description | | --- | --- | | AsyncApexJobId | Type reference Properties Filter, Group, Sort Description The ID of an [AsyncApexJob](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_asyncapexjob.htm#sforce_api_objects_asyncapexjob "Represents an individual Apex sharing recalculation job, a batch Apex job, a method with the future annotation, or a job that implements Queueable or Schedulable. Use this object to query Apex batch jobs in your organization.") that’s waiting in the flex queue. This is a relationship field. Relationship Name AsyncApexJob Relationship Type Lookup Refers To AsyncApexJob | | FlexQueueItemId | Type string Properties Filter, Group, Nillable, Sort Description The primary key for this FlexQueueItem. | | JobPosition | Type int Properties Filter, Group, Sort Description The position in the flex queue of the waiting job. The highest-priority job in the queue is at position 0. | | JobType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of the job. Valid values are: - ApexToken - BatchApex - BatchApexWorker - Future - Queueable - ScheduledApex - SharingRecalculation - TestRequest - TestWorker Currently, queries are supported only on BatchApex jobs. | ## Usage To find the position of an AsyncApexJob in the flex queue, query JobPosition. For example: SELECT JobPosition FROM FlexQueueItem WHERE JobType = 'BatchApex' AND AsyncApexJobId = '707xx000000DABC' To find the job at a given position, query AsyncApexJobId. For example: SELECT AsyncApexJobId FROM FlexQueueItem WHERE JobType = 'BatchApex' AND JobPosition = '2' To find all batch jobs in the flex queue, query JobType. To get other information about the jobs, include AsyncApexJob in your query. For example: SELECT JobType, JobPosition, AsyncApexJob.ApexClass.Name, AsyncApexJob.CreatedDate, AsyncApexJob.CreatedById FROM FlexQueueItem WHERE JobType='BatchApex' AND AsyncApexJob.ApexClass.Name LIKE '%BatchAJob%' ORDER BY JobPosition DESC <!-- document id=f8cf0327956658f9c50a40c98dc00593d8ca200f7df4ef7871a4086b97966043 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_flowexecution.md --> # Flow Execution Event Type Flow Execution events contain information about flows that were executed including details such as total execution time, number of interviews, and number of errors. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | BOT\_IDENTIFIER | Type string Description The ID of the bot. | | BOT\_SESSION\_IDENTIFIER | Type string Description The bot session ID. | | EVENT\_TYPE | Type String Description The type of event. The value is always FlowExecution. | | TIMESTAMP | Type String Description The time that the flow was executed in GMT. For example: 20210606032436.520. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: TID:000000000000c00fff. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. For example: 00D000000000123. | | USER\_ID | Type Id Description The 15-character ID of the user who executed the flow through the UI or the API. For example: 00530000009M943 | | PLANNER\_IDENTIFIER | Type string Description The ID of the agent planner. | | PROCESS\_TYPE | Type String Description The type of the flow. Valid values are: - ActionableEventManagementFlow—A flow that triggers an actionable event orchestration process in the background and automatically executes different types of actions based on the event type. This value is available in API version 62.0 and later. - ActionCadenceAutolaunchedFlow—A flow that’s executed when a user completes a cadence step. This value is available in API version 56.0 and later. - ActionCadenceStepFlow—A screen flow used as a cadence step. This value is available in API version 56.0 and later. - ActivityObjectMatchingFlow—A flow that launches when Einstein Activity Capture detects and captures a new activity, such as an email. This type of flow runs in the background without user interaction. This value is available with Sync Email as Salesforce Activity in API version 64.0 and later. - Appointments—A flow for Lightning Scheduler. This value is available in API version 44.0 and later. - ApprovalWorkflow—An orchestration that’s used for an approval process. This value is available in API version 63.0 and later. - AutoLaunchedFlow—A flow that doesn’t require user interaction. - CheckoutFlow—A flow used in Lightning B2B Commerce to create a checkout in a store. This value is available in API version 48.0 and later. - ContactRequestFlow—A flow that lets customers request to be contacted by customer support. This flow is used to create contact request records. This value is available in API version 45.0 and later. - CustomerLifecycle—A Salesforce Surveys flow that lets you associate survey questions with different stages in customer lifecycles. This value is available in API version 49.0 and later and only when the Customer Lifecycle Designer license is enabled. - CustomEvent—A process that is invoked when it receives a platform event message. In the UI, it’s an event process. This value is available in API version 41.0 and later. - DataCaptureFlow— In the UI, Data Capture flows configure the Form tab in the Field Service mobile app. When the Data Capture flow is launched, its Flow metadata is publicly available in JavaScript format. This value is available in API version 62.0 and later. - DcvrFrameworkDataCaptureFlow—A screen flow that presents assessment questions from Discovery Framework. Launches when invoked by a user on a mobile device. This type of flow collects or displays information, requires user interaction, and works offline or online. This value is available in API version 62.0 and later. - EvaluationFlow—A flow for evaluating custom entry and exit conditions in an orchestration. Uses the isOrchestrationConditionMet output variable and discards values from any other output variables. This value is available in API version 54.0 and later. - FieldServiceMobile—A flow for the Field Service mobile app. This value is available in API version 39.0 and later. - FieldServiceWeb—A flow for embedded Appointment Booking. Its UI label is Field Service Embedded Flow. This value is available in API version 41.0 and later. - Flow—A flow that requires user interaction because it contains one or more screens or local actions, choices, or dynamic choices. In the UI and Salesforce Help, it’s a screen flow. Screen flows can be launched from the UI, such as with a flow action, Lightning page, or web tab. - FSCLending—A flow for Financial Services Cloud Mortgage. This value is available in API version 46.0 and later. - IdentityUserRegistrationFlow—A flow to handle user registration and updates for single sign-on with the authentication provider framework. Available in API version 64.0 and later. - IndicatorResultFlow—A flow for Outcome Management that calculates and creates indicator results for a selected indicator performance period. This value is available with the Outcome Management license in API version 60.0 and later. - IndividualObjectLinkingFlow—A flow that associates individuals with interactions such as voice calls, messaging sessions, or case-related emails. This value is available in API version 58.0 and later. - InvocableProcess—A process that another process or the Invocable Actions resource in REST API invokes. This value is available in API version 38.0 and later. - Journey—An audience-driven flow for Marketing Cloud. This value is available in API version 57.0 and later. - LoginFlow—A flow for login. This value is available in API version 51.0 and later. - LoyaltyManagementFlow—A flow for the Loyalty Management app that’s invokable by loyalty program processes. This value is available in API version 54.0 and later. - Orchestrator—An orchestration that organizes flows into groups of steps contained in a series of stages. This value is available in API version 53.0 and later. - PromptFlow—A flow for Prompt Builder. Pass data between Prompt Builder and the flow. This value is available in API version 60.0 and later. - RecommendationStrategy—Build recommendations for your users. A recommendation launches its assigned flow. This value is available in API version 54.0 and later. See [Flow Builder Strategies](https://help.salesforce.com/s/articleView?id=platform.nba_building_flow_builder_strategy.htm&type=5&language=en_US "HTML (New Window)"). - RoutingFlow—A flow for Salesforce Omni-Channel routing and other business logic. This value is available in API version 52.0 and later. - Survey—A flow for Salesforce Surveys. From the UI, this type of flow is created in Survey Builder. This value is available in API version 42.0 and later. - SurveyEnrich—A Salesforce Surveys flow that uses the Survey Data Mapper. From the UI, this type of flow is created in the Survey Builder and requires an associated survey flow type. This value is available in API version 49.0 or later and only when the Customer Lifecycle Designer license is enabled. - Workflow—A process that is invoked when a record is created or edited. In the UI and Salesforce Help, it’s a record change process. These values are reserved for future use. - ActionPlan - AppProcess - ApprovalWorkflow - CartAsyncFlow - DigitalForm - JourneyBuilderIntegration - LoginFlow - ManagedContentFlow - OrchestrationFlow - SalesEntryExperienceFlow - TransactionSecurityFlow - UserProvisioningFlow | | FLOW\_VERSION\_ID | Type Id Description The ID of the flow version that was executed. | | FLOW\_LOAD\_TIME | Type Number Description The time in milliseconds to load the flow’s metadata. | | TOTAL\_EXECUTION\_TIME | Type Number Description The total time in milliseconds to start and finish all flow interviews. | | NUMBER\_OF\_INTERVIEWS | Type Number Description The number of flow interviews that started after the flow version was executed. | | NUMBER\_OF\_ERRORS | Type Number Description The number of errors for all flow interviews after the flow version was executed. | | TIMESTAMP\_DERIVED | Type DateTime Description The time that the flow was executed in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | <!-- document id=af16d76c92fea438a15b8abca42e8ca315b34e0d647f724d368718ef5a7da59b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowdefinitionview.md --> # FlowDefinitionView Represents the description of a flow definition. This object is available in API version 46.0 and later. ## Supported Calls describeSObjects(), query() ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d933323e73">Field</th> <th class="featureTableHeader " id="d933323e76">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">ActiveVersionId</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the active flow version.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">ApiName</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The API name of the flow definition.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">ApiVersion</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <a name="dl_msv_t5d_lcc"><!-- --></a> <dl class="dl detailList" id="dl_msv_t5d_lcc"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The API version of the flow definition.</dd> <dd class="dd">Available in API version 59.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">AreMetricsLoggedToDataCloud</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <a name="dl_y1k_cx1_ndc"><!-- --></a> <dl class="dl detailList" id="dl_y1k_cx1_ndc"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether this flow’s metrics are logged in Data Cloud. The default value is false. This field is available in API version 63.0 and later. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">Builder</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The name of the tool that created this flow. Possible values are:<ul class="ul bulletList"> <li class="li">Cloud Flow Designer</li> <li class="li">Flow Builder</li> <li class="li">Swing Designer</li> </ul> </dd> </dl> <p class="p">This field is available in API version 47.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">CapacityCategory</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The category that determines the usage limits of the flow. Possible values are:<ul class="ul bulletList"> <li class="li">Marketing Cloud Flow</li> </ul> </dd> </dl> <p class="p">This field is available in API version 62.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">Description</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Flow definition information, specified by the org’s admin.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">DurableId</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the flow definition.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">Environments</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">multipicklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The environment in which the flow can run. Valid values are: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">Default</samp>—The flow can run from a Visualforce component, Lightning page, flow action, or custom Aura component. </li> <li class="li"> <samp class="codeph nolang">Offline</samp>—The flow can run only offline. Flow types that support offline flows must set this value. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang">Slack</samp>—The flow can run in Slack and the default environment. You specify the Slack flow environment when you save the flow. </li> </ul> This field is available in API version 55.0 to 62.0. This field is deprecated in API version 63.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">HasAsyncAfterCommitPath</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the scheduled path runs asynchronously after a save. The default value is false. This field is available in API version 54.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">InstalledPackageName</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The name of the installed package that includes this flow definition.</dd> </dl> <p class="p">This field is available in API version 47.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">IsActive</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the latest version of the flow definition is the active flow version.</dd> </dl> <p class="p">This field is available in API version 47.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">IsOutOfDate</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the active flow version is the latest version of the flow definition.</dd> </dl> <p class="p">This field is available in API version 47.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">IsOverridable</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the flow is overridable. The default value is false. This field is available in API version 53.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">IsSwingFlow</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the flow is built with Desktop Flow Designer.</dd> </dl> <p class="p">This field is available in API version 49.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">IsTemplate</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the process or flow is a template. The default value is <samp class="codeph nolang">false</samp>. When installed from managed packages, subscribers can’t view or clone processes or flows because of intellectual property (IP) protection. But when those processes and flows are templates, subscribers can open them in a builder, clone them, and customize the clones.</dd> </dl> <p class="p">This field is available in API version 47.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">Label</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The label of the flow definition.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">LastModifiedBy</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Name of the user who last updated this flow definition.</dd> </dl> <p class="p">This field is available in API version 47.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">LatestVersionId</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the latest flow version, regardless of the flow’s status.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">ManageableState</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates the manageable state of the flow that is contained in a package. Possible values are: <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">beta</samp></li> <li class="li"><samp class="codeph nolang">deleted</samp></li> <li class="li"><samp class="codeph nolang">deprecated</samp></li> <li class="li"><samp class="codeph nolang">deprecatedEditable</samp></li> <li class="li"><samp class="codeph nolang">installed</samp></li> <li class="li"><samp class="codeph nolang">installedEditable</samp></li> <li class="li"><samp class="codeph nolang">released</samp></li> <li class="li"><samp class="codeph nolang">unmanaged</samp></li> </ul> </dd> </dl> <p class="p">This field is available in API version 47.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">NamespacePrefix</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The namespace prefix associated with the flow definition.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">OverriddenById</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The flow that’s overriding the current flow. This is a relationship field. This field is available in API version 53.0 and later.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">OverriddenBy</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowDefinitionView</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">OverriddenFlowId</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The flow that the current flow is overriding. This is a relationship field. This field is available in API version 53.0 and later.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">OverriddenFlow</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowDefinitionView</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">ProcessType</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of the flow. Valid values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">ActionableEventManagementFlow</samp>—A flow that triggers an actionable event orchestration process in the background and automatically executes different types of actions based on the event type. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang">ActionCadenceAutolaunchedFlow</samp>—A flow that’s executed when a user completes a cadence step. This value is available in API version 56.0 and later. </li> <li class="li"> <samp class="codeph nolang">ActionCadenceStepFlow</samp>—A screen flow used as a cadence step. This value is available in API version 56.0 and later. </li> <li class="li"> <samp class="codeph nolang">ActivityObjectMatchingFlow</samp>—A flow that launches when Einstein Activity Capture detects and captures a new activity, such as an email. This type of flow runs in the background without user interaction. This value is available with Sync Email as Salesforce Activity in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Appointments</samp>—A flow for Lightning Scheduler. This value is available in API version 44.0 and later. </li> <li class="li"> <samp class="codeph nolang">ApprovalWorkflow</samp>—An orchestration that’s used for an approval process. This value is available in API version 63.0 and later. </li> <li class="li"> <samp class="codeph nolang" id="processtype_autolaunched"><a name="processtype_autolaunched"><!-- --></a>AutoLaunchedFlow</samp>—A flow that doesn’t require user interaction. </li> <li class="li"> <samp class="codeph nolang">CheckoutFlow</samp>—A flow used in Lightning B2B Commerce to create a checkout in a store. This value is available in API version 48.0 and later. </li> <li class="li"> <samp class="codeph nolang">ContactRequestFlow</samp>—A flow that lets customers request to be contacted by customer support. This flow is used to create contact request records. This value is available in API version 45.0 and later. </li> <li class="li"> <samp class="codeph nolang">CustomerLifecycle</samp>—A Salesforce Surveys flow that lets you associate survey questions with different stages in customer lifecycles. This value is available in API version 49.0 and later and only when the Customer Lifecycle Designer license is enabled. </li> <li class="li"> <samp class="codeph nolang">CustomEvent</samp>—A process that is invoked when it receives a platform event message. In the UI, it’s an event process. This value is available in API version 41.0 and later. </li> <li class="li"> <samp class="codeph nolang">DataCaptureFlow</samp>— In the UI, Data Capture flows configure the Form tab in the Field Service mobile app. When the Data Capture flow is launched, its Flow metadata is publicly available in JavaScript format. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang">DcvrFrameworkDataCaptureFlow</samp>—A screen flow that presents assessment questions from Discovery Framework. Launches when invoked by a user on a mobile device. This type of flow collects or displays information, requires user interaction, and works offline or online. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang">EvaluationFlow</samp>—A flow for evaluating custom entry and exit conditions in an orchestration. Uses the <samp class="codeph nolang">isOrchestrationConditionMet</samp> output variable and discards values from any other output variables. This value is available in API version 54.0 and later. </li> <li class="li"> <samp class="codeph nolang">FieldServiceMobile</samp>—A flow for the Field Service mobile app. This value is available in API version 39.0 and later. </li> <li class="li"> <samp class="codeph nolang">FieldServiceWeb</samp>—A flow for embedded Appointment Booking. Its UI label is Field Service Embedded Flow. This value is available in API version 41.0 and later. </li> <li class="li"> <samp class="codeph nolang" id="processtype_flow"><a name="processtype_flow"><!-- --></a>Flow</samp>—A flow that requires user interaction because it contains one or more screens or local actions, choices, or dynamic choices. In the UI and Salesforce Help, it’s a screen flow. Screen flows can be launched from the UI, such as with a flow action, Lightning page, or web tab. </li> <li class="li"><span class="ph" id="enumprocesstype_fsclending"><a name="enumprocesstype_fsclending"><!-- --></a><samp class="codeph nolang" id="processtype_fsclending"><a name="processtype_fsclending"><!-- --></a>FSCLending</samp>—A flow for Financial Services Cloud Mortgage. This value is available in API version 46.0 and later.</span></li> <li class="li"> <samp class="codeph nolang">IdentityUserRegistrationFlow</samp>—A flow to handle user registration and updates for single sign-on with the authentication provider framework. Available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">IndicatorResultFlow</samp>—A flow for Outcome Management that calculates and creates indicator results for a selected indicator performance period. This value is available with the Outcome Management license in API version 60.0 and later. </li> <li class="li"> <samp class="codeph nolang">IndividualObjectLinkingFlow</samp>—A flow that associates individuals with interactions such as voice calls, messaging sessions, or case-related emails. This value is available in API version 58.0 and later. </li> <li class="li"> <samp class="codeph nolang">InvocableProcess</samp>—A process that another process or the Invocable Actions resource in REST API invokes. This value is available in API version 38.0 and later. </li> <li class="li"> <samp class="codeph nolang">Journey</samp>—An audience-driven flow for Marketing Cloud. This value is available in API version 57.0 and later. </li> <li class="li"><span class="ph" id="loginflow"><a name="loginflow"><!-- --></a><samp class="codeph nolang">LoginFlow</samp>—A flow for login. This value is available in API version 51.0 and later.</span></li> <li class="li"> <samp class="codeph nolang">LoyaltyManagementFlow</samp>—A flow for the Loyalty Management app that’s invokable by loyalty program processes. This value is available in API version 54.0 and later. </li> <li class="li"> <samp class="codeph nolang">Orchestrator</samp>—An orchestration that organizes flows into groups of steps contained in a series of stages. This value is available in API version 53.0 and later. </li> <li class="li"> <samp class="codeph nolang">PromptFlow</samp>—A flow for Prompt Builder. Pass data between Prompt Builder and the flow. This value is available in API version 60.0 and later. </li> <li class="li"> <samp class="codeph nolang">RecommendationStrategy</samp>—Build recommendations for your users. A recommendation launches its assigned flow. This value is available in API version 54.0 and later. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.nba_building_flow_builder_strategy.htm&type=5&language=en_US" target="_blank" title="HTML (New Window)">Flow Builder Strategies</a>. </li> <li class="li"> <samp class="codeph nolang">RoutingFlow</samp>—A flow for Salesforce Omni-Channel routing and other business logic. This value is available in API version 52.0 and later. </li> <li class="li"> <samp class="codeph nolang">Survey</samp>—A flow for Salesforce Surveys. From the UI, this type of flow is created in Survey Builder. This value is available in API version 42.0 and later. </li> <li class="li"> <samp class="codeph nolang">SurveyEnrich</samp>—A Salesforce Surveys flow that uses the Survey Data Mapper. From the UI, this type of flow is created in the Survey Builder and requires an associated survey flow type. This value is available in API version 49.0 or later and only when the Customer Lifecycle Designer license is enabled. </li> <li class="li"> <samp class="codeph nolang">Workflow</samp>—A process that is invoked when a record is created or edited. In the UI and Salesforce Help, it’s a record change process. </li> </ul> <p class="p">These values are reserved for future use:</p> <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">ActionPlan</samp></li> <li class="li"><samp class="codeph nolang">AppProcess</samp></li> <li class="li"><samp class="codeph nolang">ApprovalWorkflow</samp></li> <li class="li"><samp class="codeph nolang">CartAsyncFlow</samp></li> <li class="li"><samp class="codeph nolang">DigitalForm</samp></li> <li class="li"><samp class="codeph nolang">JourneyBuilderIntegration</samp></li> <li class="li"><samp class="codeph nolang" id="flow_process_loginflow"><a name="flow_process_loginflow"><!-- --></a>LoginFlow</samp></li> <li class="li"><samp class="codeph nolang">ManagedContentFlow</samp></li> <li class="li"><samp class="codeph nolang">OrchestrationFlow</samp></li> <li class="li"><samp class="codeph nolang">SalesEntryExperienceFlow</samp></li> <li class="li"><samp class="codeph nolang">TransactionSecurityFlow</samp></li> <li class="li"><samp class="codeph nolang">UserProvisioningFlow</samp></li> </ul> This value has significant impact on validation when saving the flow and on the flow’s runtime behavior. Don’t change this value unless you understand the flow properties of the specified type. </dd> </dl> <p class="p">Across flow versions, you can change the type only from <samp class="codeph nolang">Flow</samp> to <samp class="codeph nolang">AutoLaunchedFlow</samp> or vice versa. Before you change the flow type, make sure that the flow contains only the elements, resources, and functionality that the new flow type supports.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">RecordTriggerType</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Specifies what type of record changes can start the flow. Possible values are:<ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">Create</samp></li> <li class="li"><samp class="codeph nolang">CreateAndUpdate</samp></li> <li class="li"><samp class="codeph nolang">Delete</samp></li> <li class="li"><samp class="codeph nolang">None</samp></li> <li class="li"><samp class="codeph nolang">Update</samp></li> </ul> Available only when <samp class="codeph nolang">triggerType</samp> is <samp class="ph systemoutput">RecordBeforeSave</samp>. This field is available in API version 54.0 and later. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">SourceTemplateId</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The template that the current flow was created from. This is a relationship field. This field is available in API version 53.0 and later.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">SourceTemplate</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowDefinitionView</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">SupportedEnvironments</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <a name="dl_sjj_r4k_tdc"><!-- --></a> <dl class="dl detailList" id="dl_sjj_r4k_tdc"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The environment in which the flow can run. Valid values are: <a name="ul_tjj_r4k_tdc"><!-- --></a> <ul class="ul bulletList" id="ul_tjj_r4k_tdc"> <li class="li"> <samp class="codeph nolang">Default</samp>—The flow can run from a Visualforce component, Lightning page, flow action, or custom Aura component. </li> <li class="li"> <samp class="codeph nolang">Offline</samp>—The flow can run only offline. Flow types that support offline flows must set this value. </li> <li class="li"> <samp class="codeph nolang">Slack</samp>—The flow can run in Slack and the default environment. You specify the Slack flow environment when you save the flow. </li> </ul> This field is available in API version 63.0 and later. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">TriggerObjectOrEventId</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">ID of the object or platform event that triggers this flow. This field is available in API version 53.0 and later.<p class="p">This is a relationship field.</p> </dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">TriggerObjectOrEvent</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">EntityDefinition</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">TriggerObjectOrEventLabel</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The label of the object or platform event that triggers this flow. This field is available in API version 53.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">TriggerOrder</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The run order of a record-triggered flow, from 1 to 2,000. See "<a class="xref" href="https://help.salesforce.com/s/articleView?id=flow_concepts_trigger_guidelines.htm&type=5&language=en_US" target="_blank" title="HTML (New Window)">Guidelines for Defining the Run Order of Record-Triggered Flows for an Object</a>" in Salesforce Help. Available in API version 54.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">TriggerType</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Specifies what causes the flow to run. If you exclude this field, the flow has no trigger and starts only when a user or app launches the flow. Valid values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">AutomationEvent</samp>—The flow starts when an automation event such as an SMS subscription occurs. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang">CampaignMember</samp>—t the scheduled time, the flow performs actions on or sends messages to individuals from the selected campaign. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">Capability</samp>—The flow starts when the specified capability that the flow integrates with is invoked. This value is available in API version 60.0 and later. </li> <li class="li"> <samp class="codeph nolang">CrmRecordQuery</samp>—At the scheduled time, the flow performs actions on or sends messages to individuals from the queried customer relationship management record. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">DataCloudDataChange</samp>—The flow starts when data model object (DMO) or calculated insight object (CIO) conditions are met. This value is available in API version 59.0 and later. </li> <li class="li"> <samp class="codeph nolang">DataGraphDataChange</samp>—The flow starts when conditions are met in the specified data graph field. This value is available in API version 63.0 and later. </li> <li class="li"> <samp class="codeph nolang">EnterpriseScaleExternalSystemChange</samp>—The flow runs when triggered by MuleSoft. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">EventDrivenJourney</samp>—Reserved for internal use. </li> <li class="li"> <samp class="codeph nolang">ExternalSystemChange</samp>—The flow starts when an external system change event is received. This value is available in API version 61.0 and later. </li> <li class="li"> <samp class="codeph nolang">FormSubmissionEvent</samp>—The flow runs when a user submits data via a webform. In Flow Builder, this value corresponds to <samp class="codeph nolang">Form</samp>. This value is available in API version 60.0 and later. </li> <li class="li"> <samp class="codeph nolang">IndivRelatedRecord</samp>—The flow starts when an object or an object with fields related to an individual is created or updated. This value is available in API version 66.0 and later. </li> <li class="li"> <samp class="codeph nolang">List</samp>—At the scheduled time, the flow performs actions on or sends messages to individuals from the selected list.  This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">PlatformEvent</samp>—The flow starts when a platform event message is received. This value is available in API version 49.0 and later. </li> <li class="li"> <samp class="codeph nolang">RecordAfterSave</samp>—The flow starts after a record is saved. This value is available in API version 49.0 and later. </li> <li class="li"> <samp class="codeph nolang">RecordBeforeDelete</samp>—Deleting a record triggers an autolaunched flow before the record is deleted from the database. This value is available in API version 50.0 and later. </li> <li class="li"> <samp class="codeph nolang">RecordBeforeSave</samp>—Creating and/or updating a record triggers an autolaunched flow to make additional updates to that record before it's saved to the database. This value is available in API version 48.0 and later. </li> <li class="li"> <samp class="codeph nolang">Scheduled</samp>—The flow starts at the scheduled time. This value is available in API version 47.0 and later. </li> <li class="li"> <samp class="codeph nolang">Segment</samp>— At the scheduled time, the flow performs actions on or sends messages to individuals from the selected segment. This value is available in API version 56.0 and later. </li> </ul> </dd> </dl> <p class="p">Available only when <span class="keyword parmname">processType</span> is <samp class="codeph nolang">AutoLaunchedFlow</samp> or <samp class="codeph nolang">PromptFlow</samp>. This field is available in API version 47.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d933323e73" data-title="Field"><span class="keyword parmname">VersionNumber</span></td> <td class="entry" headers="d933323e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The flow’s version number. This field is available in API version 54.0 and later.</dd> </dl> </td> </tr> </tbody> </table> ## Usage Use this object to query information about flow definitions. <!-- document id=87bf092ffda2c02c04742f8fd6a7acf2dc3266a236a2b685bda78f6e7102ef24 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowinterview.md --> # FlowInterview Represents a flow interview. A flow interview is a running instance of a flow. This object is available in API version 32.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To delete a flow interview, you must have the “Manage Flow” user permission. All other calls require the “Run Flows” user permission or the Flow User field enabled on the user detail page. If **Override default behavior and restrict access to enabled profiles or permission sets** is selected for an individual flow, access to that specific flow and its interviews is given to users by profile or permission set. ## Fields | Field Name | Details | | --- | --- | | CurrentElement | Type string Properties Filter, Group, Nillable, Sort Description The flow element at which the interview is paused. | | CurrentFlowVersion | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. | | EngineType | Type picklist Properties Filter, Group, Sort Description The engine type used to run the flow interview. | | Error | Type textarea Properties Create, Nillable, Update Description The error message that explains why the flow interview failed. This field is available in API version 62.0 and later. | | FlowVersionViewId | Type string Properties Filter, Nillable, Sort Description This field is a relationship field. This field is available in API version 51.0 and later. Relationship Name FlowVersionView Relationship Type Lookup Refers To FlowVersionView | | Guid | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Globally unique identifier for the interview. | | InterviewLabel | Type string Properties Filter, Nillable, Sort Description Label for the interview. This label helps users and administrators differentiate interviews from the same flow. In the user interface, this label appears in the Paused Flow Interviews component on the user’s Home tab and in the list of paused flow interviews in Setup. | | InterviewStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Status of the interview. Valid values are: - Completed—This flow is complete. There are no more records to process. - Error—This flow has one or more errors. To resolve each error, check the error code for instructions. - Paused—This flow is paused. No new processes are added until the flow is resumed. - Running—This flow is running or is ready to run. - VersionPaused—This flow version is paused. No more records are processed until the flow is resumed. This value is available in API version 60.0 and later. This field is available in API version 50.0 and later. | | MasterFlowVersion | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name for the interview. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user who owns the interview. Only this user or an admin can resume the interview. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PauseLabel | Type string Properties Filter, Nillable, Sort Description Information about why the interview was paused. This string is entered by the user who paused the flow interview. The label is **Why Paused**. | | SerializedView | Type textarea Properties Create, Nillable, Update Description For internal use only. | | WasPausedFromScreen | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the flow interview was paused by a user from a flow Screen element (true ) or not (false ). This field is available in API version 46.0 and later. | ## Associated Objects This object has these associated objects. Unless noted, these objects are available in the same API version as this object. [FlowInterviewOwnerSharingRule](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. [FlowInterviewShare](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. <!-- document id=7b9228326791d73e61a8d5540f2ac0d41f9d6ebc1614d6f6ab23e81c5c8fc913 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowinterviewlog.md --> # FlowInterviewLog Represents the logs of a screen flow interview. An interview is an instance of a running or previously run flow.This object is available in API version 49.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules By default, only users with the View All Data permission can access the logs for flows that are run by other users. To let users access other users’ flow logs, set up sharing settings with the FlowInterviewLogOwnerSharingRule object. ## Fields | Field Name | Details | | --- | --- | | FlowDeveloperName | Type string Properties Filter, Group, Nillable, Sort Description The flow's API name. | | FlowInterviewGuid | Type string Properties Filter, Group, idLookup, Sort Description Globally unique identifier for the interview. | | FlowLabel | Type string Properties Filter, Group, Nillable, Sort Description The flow’s label. Only shows up in API results when users query FlowInterviewLog, or when they include this field in a report. | | FlowNamespace | Type string Properties Filter, Group, Nillable, Sort Description Namespace of the flow interview logged in the FlowInterviewLog. | | FlowVersionNumber | Type int Properties Filter, Group, Nillable, Sort Description The number of the flow version for a flow definition. Flow versions are counted sequentially from 1. | | InterviewDurationInMinutes | Type double Properties Filter, Nillable, Sort Description Total number of minutes between InterviewStartTimestamp and InterviewEndTimestamp, even if flow interview is paused. | | InterviewEndTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the interview ended. | | InterviewStartTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the interview started. | | InterviewStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Status of the interview. Valid values are: - Autosaved—This value is available in API version 62.0 and later. - Completed - Error - Expired—This value is available in API version 62.0 and later. - Paused - Running - VersionPaused—This value is available in API version 60.0 and later. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Autogenerated name of the flow interview log record. | | OwnerId | Type reference Properties Filter, Group, Sort Description The user who owns the FlowInterviewLog record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [FlowInterviewOwnerSharingRule](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. <!-- document id=218232f8fced639efd0dac948baffdcd99cda1b6536fd6fa2b902bdb3c249f79 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowinterviewlogentry.md --> # FlowInterviewLogEntry Represents the log of a specific element that’s executed by a screen flow interview. An interview is an instance of a running or previously run flow. This object is available in API version 49.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules By default, only users with the View All Data permission can access the log entries for flows that are run by other users. ## Fields | Field Name | Details | | --- | --- | | DurationSinceStartInMinutes | Type double Properties Filter, Nillable, Sort Description Number of minutes that elapsed since the flow interview started, even if flow interview is paused. | | ElementApiName | Type string Properties Filter, Group, Nillable, Sort Description API name of the flow element. | | ElementDurationInMinutes | Type double Properties Filter, Nillable, Sort Description Number of minutes that elapsed since the element executed. For example, if a screen element takes users a long time to complete, consider simplifying the screen. | | ElementLabel | Type string Properties Filter, Group, Nillable, Sort Description The flow element’s label. | | FlowInterviewLogId | Type reference Properties Filter, Group, Sort Description This field is a relationship field. Relationship Name FlowInterviewLog Relationship Type Lookup Refers To FlowInterviewLog | | LogEntryTimestamp | Type datetime Properties Filter, Sort Description Date and time when the flow element started to execute. | | LogEntryType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of screen flow user action triggered the log entry. Valid values are: - Error - FlowFinish-Finished Flow - FlowPause-Paused Flow - FlowResume-Resumed Flow - FlowStart-Started Flow - ScreenFinish-Clicked Finish - ScreenNext-Clicked Next - ScreenPrevious-Clicked Previous | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Autogenerated name of the flow interview log entry. | <!-- document id=282bbed492d10de286774bea75efdc90b71a8e6d0fa963f55b0ca1aa60a8ffab url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowinterviewlogownersharingrule.md --> # FlowInterviewLogOwnerSharingRule Represents the rules for sharing a FlowInterviewLog with users other than the owner.This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. Possible values are: - Edit—Read/Write - Read—Read Only | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1,000 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, 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 org. 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. Corresponds to **Rule Name** in the user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | OptionsIncludeHVUOwnedRecords | Type boolean Properties Create, Filter, Update Description | | OptionsIncludeRecordsOwnedByAll | Type boolean Properties Create, Filter, Update Description | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the target user or group that’s given access. | ## Usage Use this object to manage the sharing rules for FlowInterviewLog records. General sharing uses this object. <!-- document id=744f96cf66e0dd43a15bc9805deb7bd8c53d7bc72459309da96efba0de7d8df4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowinterviewownersharingrule.md --> # FlowInterviewOwnerSharingRule Represents the rules for sharing a FlowInterview with users other than the owner. This object is available in API version 33.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. The possible values are: - Read - Edit—In API version 42.0 and later, when **Let users resume shared flow interviews** is enabled for your org, users can resume all flow interviews that they have edit access to. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. | | DeveloperName | Type string Properties 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 org. 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. Corresponds to **Rule Name** in the user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the target user or group that’s given access. | ## Usage Use this object to manage the sharing rules for FlowInterview records. General sharing uses this object. In API version 42.0 and later, when **Let users resume shared flow interviews** is enabled for your org, users can resume all flow interviews that they have edit access to. When that setting is disabled, only the owner or a flow admin can resume a flow interview. To disable this setting, go to your org’s Process Automation Settings in Setup. <!-- document id=d72c17f29a91b80dc2c22fa138867527a190af4c9e5603f1272c2a14b4615f22 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowinterviewshare.md --> # FlowInterviewShare Represents a sharing entry on a FlowInterview. This object is available in API version 33.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the FlowInterview. The possible values are: - Read - Edit—In API version 42.0 and later, when **Let users resume shared flow interviews** is enabled for your org, users can resume all flow interviews that they have edit access to. - All—This value is not valid for creating or deleting records. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the FlowInterview associated with this sharing entry. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To FlowInterview | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Manual—The User or Group has access because a user with “All” access manually shared the FlowInterview with them. - Owner—The User is the owner of the FlowInterview. - Rule—The User or Group has access via a FlowInterview sharing rule. - GuestRule—The User or Group has access via a FlowInterview guest user sharing rule. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the FlowInterview. This field can't be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object lets you determine which users and groups can view and edit flow interviews that are owned by other users. In API version 42.0 and later, when **Let users resume shared flow interviews** is enabled for your org, users can resume all flow interviews that they have edit access to. When that setting is disabled, only the owner or a flow admin can resume a flow interview. To disable this setting, go to your org’s Process Automation Settings in Setup. <!-- document id=dbc55849e4b9383af6d26dc61b9e8fd1c8f2490f74263a2db27c7b6d0f5b0b8c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flownavmetriceventlog.md --> # FlowNavMetricEventLog Flow Navigation Metric event logs contain metric data for flow interviews such as total execution time, number of interviews, and number of errors. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | BotIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the bot. | | BotSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The bot session ID. | | ErrorCount | Type int Properties Filter, Group, Nillable, Sort Description The number of errors for all flow interviews after the flow version was executed. | | FlowLoadTime | Type double Properties Filter, Nillable, Sort Description The time in milliseconds to load the flow’s metadata. | | FlowVersionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the flow version that was executed. | | InterviewCount | Type int Properties Filter, Group, Nillable, Sort Description The number of flow interviews that started after the flow version was executed. | | PlannerIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the agent planner. | | ProcessType | Type string Properties Filter, Group, Nillable, Sort Description The type of the flow. Valid values are: - ActionableEventManagementFlow—A flow that triggers an actionable event orchestration process in the background and automatically executes different types of actions based on the event type. This value is available in API version 62.0 and later. - ActionCadenceAutolaunchedFlow—A flow that’s executed when a user completes a cadence step. This value is available in API version 56.0 and later. - ActionCadenceStepFlow—A screen flow used as a cadence step. This value is available in API version 56.0 and later. - ActivityObjectMatchingFlow—A flow that launches when Einstein Activity Capture detects and captures a new activity, such as an email. This type of flow runs in the background without user interaction. This value is available with Sync Email as Salesforce Activity in API version 64.0 and later. - Appointments—A flow for Lightning Scheduler. This value is available in API version 44.0 and later. - ApprovalWorkflow—An orchestration that’s used for an approval process. This value is available in API version 63.0 and later. - AutoLaunchedFlow—A flow that doesn’t require user interaction. - CheckoutFlow—A flow used in Lightning B2B Commerce to create a checkout in a store. This value is available in API version 48.0 and later. - ContactRequestFlow—A flow that lets customers request to be contacted by customer support. This flow is used to create contact request records. This value is available in API version 45.0 and later. - CustomerLifecycle—A Salesforce Surveys flow that lets you associate survey questions with different stages in customer lifecycles. This value is available in API version 49.0 and later and only when the Customer Lifecycle Designer license is enabled. - CustomEvent—A process that is invoked when it receives a platform event message. In the UI, it’s an event process. This value is available in API version 41.0 and later. - DataCaptureFlow— In the UI, Data Capture flows configure the Form tab in the Field Service mobile app. When the Data Capture flow is launched, its Flow metadata is publicly available in JavaScript format. This value is available in API version 62.0 and later. - DcvrFrameworkDataCaptureFlow—A screen flow that presents assessment questions from Discovery Framework. Launches when invoked by a user on a mobile device. This type of flow collects or displays information, requires user interaction, and works offline or online. This value is available in API version 62.0 and later. - EvaluationFlow—A flow for evaluating custom entry and exit conditions in an orchestration. Uses the isOrchestrationConditionMet output variable and discards values from any other output variables. This value is available in API version 54.0 and later. - FieldServiceMobile—A flow for the Field Service mobile app. This value is available in API version 39.0 and later. - FieldServiceWeb—A flow for embedded Appointment Booking. Its UI label is Field Service Embedded Flow. This value is available in API version 41.0 and later. - Flow—A flow that requires user interaction because it contains one or more screens or local actions, choices, or dynamic choices. In the UI and Salesforce Help, it’s a screen flow. Screen flows can be launched from the UI, such as with a flow action, Lightning page, or web tab. - FSCLending—A flow for Financial Services Cloud Mortgage. This value is available in API version 46.0 and later. - IdentityUserRegistrationFlow—A flow to handle user registration and updates for single sign-on with the authentication provider framework. Available in API version 64.0 and later. - IndicatorResultFlow—A flow for Outcome Management that calculates and creates indicator results for a selected indicator performance period. This value is available with the Outcome Management license in API version 60.0 and later. - IndividualObjectLinkingFlow—A flow that associates individuals with interactions such as voice calls, messaging sessions, or case-related emails. This value is available in API version 58.0 and later. - InvocableProcess—A process that another process or the Invocable Actions resource in REST API invokes. This value is available in API version 38.0 and later. - Journey—An audience-driven flow for Marketing Cloud. This value is available in API version 57.0 and later. - LoginFlow—A flow for login. This value is available in API version 51.0 and later. - LoyaltyManagementFlow—A flow for the Loyalty Management app that’s invokable by loyalty program processes. This value is available in API version 54.0 and later. - Orchestrator—An orchestration that organizes flows into groups of steps contained in a series of stages. This value is available in API version 53.0 and later. - PromptFlow—A flow for Prompt Builder. Pass data between Prompt Builder and the flow. This value is available in API version 60.0 and later. - RecommendationStrategy—Build recommendations for your users. A recommendation launches its assigned flow. This value is available in API version 54.0 and later. See [Flow Builder Strategies](https://help.salesforce.com/s/articleView?id=platform.nba_building_flow_builder_strategy.htm&type=5&language=en_US "HTML (New Window)"). - RoutingFlow—A flow for Salesforce Omni-Channel routing and other business logic. This value is available in API version 52.0 and later. - Survey—A flow for Salesforce Surveys. From the UI, this type of flow is created in Survey Builder. This value is available in API version 42.0 and later. - SurveyEnrich—A Salesforce Surveys flow that uses the Survey Data Mapper. From the UI, this type of flow is created in the Survey Builder and requires an associated survey flow type. This value is available in API version 49.0 or later and only when the Customer Lifecycle Designer license is enabled. - Workflow—A process that is invoked when a record is created or edited. In the UI and Salesforce Help, it’s a record change process. These values are reserved for future use. - ActionPlan - AppProcess - ApprovalWorkflow - CartAsyncFlow - DigitalForm - JourneyBuilderIntegration - LoginFlow - ManagedContentFlow - OrchestrationFlow - SalesEntryExperienceFlow - TransactionSecurityFlow - UserProvisioningFlow | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: TID:000000000000c00fff. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The time that the flow was executed in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | TotalExecutionTime | Type double Properties Filter, Nillable, Sort Description The total time in milliseconds to start and finish all flow interviews. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who executed the flow through the UI or the API. For example: 00530000009M943. | <!-- document id=b78858d230e4a68fe3136c71ce1f47453a81912efd8a4dc92d858a305fe159af url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_floworchestration.md --> # FlowOrchestration Represents the details of an orchestration definition. This object is available in API version 62.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Fields | Field | Details | | --- | --- | | ActiveVersionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the active orchestration version. This field is a relationship field. This field is a relationship field. Relationship Name ActiveVersion Refers To FlowOrchestrationVersion | | ApiName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the the orchestration. | | ApiVersion | Type int Properties Filter, Group, Nillable, Sort Description The API version of the active orchestration or the last saved orchestration. | | AverageRunTime | Type int Properties Filter, Group, Nillable, Sort Description The average duration of an orchestration run that has completed without error. | | CompletionRate | Type percent Properties Filter, Nillable, Sort Description The percentage of the total number of orchestration runs that have completed without error. | | Description | Type textarea Properties Nillable, Update Description The description of the flow orchestration. | | FailedRunCount | Type int Properties Filter, Group, Nillable, Sort Description The number of orchestration runs that have failed. | | InstalledPackageName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the installed package that the orchestration is a part of. | | IsCitizenEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the orchestration can be modified by non-admins. Valid value is False. The default value is false. | | IsOverridable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the orchestration that's part of a managed package is overridable. The default value is false. | | IsTemplate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the orchestration record is a template. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. | | ManageableState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the managable state of the orchestration that's contained in a package. Valid values are: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description The label of the orchestration. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with the orchestration record. | | OrchestrationDefinition | Type string Properties Filter, Group, Nillable, Sort Description Represents the orchestration definition. | | OrchestrationLabel | Type string Properties Filter, Group, Nillable, Sort, Update Description The label of the orchestration. | | OrchestrationType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The orchestration's flow type. FlowType consolidates ProcessType and TriggerType into one field. FlowType is used with permissions, so admins can control access to each flow type. Valid values are: - OrchAutolnch—Autolaunched No Trigger Orchestration: Launches when invoked by Apex, REST API, custom buttons, or custom links. An orchestration lets you create a multi-step, multi-user process. - OrchRecTrigAftSave—Record-Triggered After Save Orchestration: Launches when a record is created or updated. An orchestration lets you create a multi-step, multi-user process. This type of flow runs in the background without user interaction. - CmsOrchAutolnch —CMS Workflow Orchestration Autolaunched: Launches when invoked from the Workflows component in a CMS workspace. This type of orchestration lets you create a multi-step, multi-user process to create, edit, organize, and manage digital content from a centralized location | | OverriddenById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the orchestration that's overriding the current orchestration. This field is a relationship field. Relationship Name OverriddenBy Refers To FlowOrchestration | | OverriddenOrchestrationId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the orchestration that the current orchestration is overriding. This field is a relationship field. Relationship Name OverriddenOrchestration Refers To FlowOrchestration | | RunCount | Type int Properties Filter, Group, Nillable, Sort Description The number of orchestration runs that have been started across all orchestration versions. | | SourceTemplateId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the template that the orchestration was created from. This field is a relationship field. Relationship Name SourceTemplate Refers To FlowOrchestration | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the record. Valid values are: - Active—Active - Draft—Inactive - InvalidDraft—Draft - Obsolete—Inactive - UnderReview—Under Review | | TriggerType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the trigger type for a record-triggered orchestration. Valid values are: - RecordAfterSave—Record—Run After Save | ## 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. [FlowOrchestrationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. <!-- document id=cbd9a42b59a55deda0ab59ee4d40b602aed6cffbc757b4bf55fc6e4a1bbb039d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_floworchestrationinstance.md --> # FlowOrchestrationInstance Represents a run-time instance of an orchestration. This object is available in API version 53.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules If sharing rules are defined for FlowOrchestrationInstance, they determine access to specific orchestration run records. Or the user must have the View All Data permission. ## Fields | Field | Details | | --- | --- | | AuxiliaryTriggeringRecord | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The related object ID or service appointment ID. This fields isn’t used by flow approval processes or orchestrations. This field is available in API version 65.0 and later. | | CurrentStage | Type string Properties Filter, Group, Nillable, Sort Description The API name of the stage that was running when the orchestration run was paused or failed because of an error in an action called by a step. This field is available in API version 62.0 and later. | | Duration | Type long Properties Filter, Group, Nillable, Sort Description The duration of the orchestration instance in seconds. Durations are incremented until the orchestration is completed, canceled, or ends in an error. This field is available in API version 62.0 and later. | | FlowDefinitionVersionName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The fully qualified API name of the underlying orchestration. Possible values are active flow approval processes and orchestrations in the org. This field is available in API version 62.0 and later. | | FlowType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The flow type of the orchestration that created the orchestration work item. Valid values are: - ApprovalOrchAutolnch—Autolaunched Flow Approval Process - ApprovalOrchRecTrigAftSave—Record-Triggered After Save Flow Approval Process - ExtSysChgFlowAppvl—External System Change-Triggered Flow Approval Process - ExtSysChgOrch—External System Change-Triggered Orchestration - OrchAutolnch—Autolaunched No Trigger Orchestration - OrchRecTrigAftSave—Record-Triggered After Save Orchestration This field is available in API version 62.0 and later. | | InterviewId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The globally unique flow interview ID associated with the orchestration instance. This field is a relationship field. Relationship Name Interview Relationship Type Lookup Refers To FlowInterview | | IsDebugRun | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the instance was executed from a debug run. The default value is false. This field is available in API version 65.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent time a user viewed a record related to the orchestration run. This field is available in API version 55.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent time a user viewed the orchestration run. This field is available in API version 55.0 and later. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name for the orchestration instance. | | OrchestrationDeveloperName | Type string Properties Filter, Group, Nillable, Sort Description The developer name of the flow definition associated with the orchestration run. This field is available in API version 55.0 and later. | | OrchestrationLabel | Type string Properties Filter, Group, Nillable, Sort Description The label of the orchestration. This field is available in API version 63.0 and later. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the automated process user. This field is available in API version 56.0 and later. Relationship Name Owner Relationship Type Lookup Refers To User | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The status of the orchestration run. Valid values are: - Canceled—The orchestration instance was canceled. - Completed—The orchestration instance completed. - Error—The orchestration instance, or a stage or step within the orchestration instance, encountered an error. - InProgress—The orchestration instance is in progress. - Suspended—The orchestration instance was suspended. | | TriggeringRecord | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the record that triggered the record-triggered orchestration. This field is available in API version 62.0 and later. | | TriggeringRecordType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the Salesforce object configured to trigger the orchestration. This field is available in API version 64.0 and later. | ## 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. [FlowOrchestrationInstanceFeed](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. [FlowOrchestrationInstanceHistory](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. [FlowOrchestrationInstanceOwnerSharingRule](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. This object is available in API version 56.0 and later. [FlowOrchestrationInstanceShare](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. This object is available in API version 56.0 and later. <!-- document id=4b544255f5845aecb0b06a163c44867fb005a999205b47bd9f9b61ea181d192d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_floworchestrationlog.md --> # FlowOrchestrationLog Represents logging data for a FlowOrchestrationInstance. This object is available in API version 54.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()update() ## Special Access Rules If sharing rules are defined for FlowOrchestrationInstance and the Inherit orchestration run sharing rules to control orchestration run log record access setting is enabled, then orchestration run log record access is inherited from related orchestration run records. If the Inherit orchestration run sharing rules to control orchestration run log record access setting isn’t enabled, a user must have the Manage Flow permission. Or the user must have the View All Data permission. ## Fields | Field | Details | | --- | --- | | Actor | Type string Properties Filter, Group, idLookup, Nillable, Sort Description For an interactive step, the user that completed the work item. For a background or MuleSoft step, the username of the user that the step ran as. | | Assignee | Type string Properties Filter, Group, Nillable, Sort Description For an interactive step, the user, group, or queue assigned to a work item when the FlowOrchestrationLog relates to an interactive FlowOrchestrationStep. | | AssigneeType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description For an interactive step, the assignee type associated with an interactive step's work item. Valid values are: - Group - Invalid - Queue - User | | Comments | Type string Properties Filter, Nillable, Sort Description The string stored in an output variable with the API name of Comments from a flow called by a completed orchestration step. | | Context | Type string Properties Filter, Group, Nillable, Sort Description The ID of the record where the assigned user completed the flow associated with an interactive step in the Work Guide component. | | Duration | Type long Properties Filter, Group, Nillable, Sort Description A long number that indicates the duration, in seconds, of the associated FlowOrchestrationInstance, FlowOrchestrationStage, FlowOrchestrationStep, or FlowOrchestrationWorkItem. | | Kind | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The milestone associated with the FlowOrchestrationLog. Valid values are: - CancelInstance—The associated FlowOrchestrationInstance was canceled. - DiscontinueStage—The associated FlowOrchestrationStage was discontinued. - DiscontinueStep—The associated FlowOrchestrationStep was discontinued. - EndInstance—The associated FlowOrchestrationInstance was completed successfully. - EndStage—The associated FlowOrchestrationStage was exited successfully. - EndStep—The associated FlowOrchestrationStep was exited successfully. - EndWorkItem—The associated FlowOrchestrationWorkItem was completed successfully. - FailInstance—The associated FlowOrchestrationInstance encountered an error. - FailStage—The associated FlowOrchestrationStage encountered an error. - FailStep—The associated FlowOrchestrationStep encountered an error. - ResumeInstance—A failed or paused orchestration instance was resumed. - ReassignWorkItem—The associated FlowOrchestrationWorkItem was reassigned. - RunRecallPath—The associated approval submission was recalled. - StartInstance—The associated FlowOrchestrationInstance started. - StartStage—The associated FlowOrchestrationStage started. - StartStep—The associated FlowOrchestrationStep started. - StartWorkItem—The associated FlowOrchestrationWorkItem started. - SuspendInstance—The associated FlowOrchestrationInstance was suspended. - SuspendStage—The associated FlowOrchestrationStage was suspended. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The name for the FlowOrchestrationLog record. | | OrchestationInstanceId | Type reference Properties Filter, Sort, Group Description The FlowOrchestrationInstance associated with the FlowOrchestrationLog. This field is a relationship field. Relationship Name OrchestrationInstance Relationship Type Lookup Refers To FlowOrchestrationInstance | | OrchestrationName | Type string Properties Filter, Group, idLookup , Sort Description The API name of the orchestration. | | OrchestrationVersion | Type int Properties Filter, Group, Sort Description An integer for the FlowDefinitionVersion of the orchestration associated with the FlowOrchestrationLog. | | StageName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the stage in the associated orchestration. | | StepName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the step in the associated orchestration. | | Timestamp | Type dateTime Properties Filter, Sort Description The date and time when the FlowOrchestrationLog milestone occured. | ## 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. [FlowOrchestrationLogFeed](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. [FlowOrchestrationLogHistory](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. [FlowOrchestrationLogOwnerSharingRule](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. [FlowOrchestrationLogShare](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. <!-- document id=c1f9035bfbdf943e3e1f6751a8bb13057dfa10e680a99aae71709ca5a5ed4b5d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_floworchestrationstageinstance.md --> # FlowOrchestrationStageInstance Represents a run-time instance of a stage in a run-time instance of an orchestration. This read-only object is available in API version 53.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules If sharing rules are defined for FlowOrchestrationStageInstance, they determine access to specific orchestration stage run records. Or the user must have the View All Data permission. ## Fields | Field | Details | | --- | --- | | Label | Type string Properties Create, Filter, Group, Sort, Update Description The label for the flow orchestration stage instance. This label helps users and administrators differentiate between step instances from the same orchestration. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The API name for the flow orchestration stage instance. | | OrchestrationInstanceId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the FlowOrchestrationInstance associated with the orchestration stage instance. This field is a relationship field. Relationship Name OrchestrationInstance Relationship Type Lookup Refers To FlowOrchestrationInstance | | OrchestrationName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of flow orchestration stage instance. This field is available in API version 66.0 and later. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the automated process user. This field is available in API version 56.0 and later. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Position | Type int Properties Create, Filter, Group, Sort, Update Description For internal use only. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The run status of the orchestration stage instance. Valid values are: - Completed—The stage instance completed. - Discontinued—The stage was in progress or completed when the orchestration instance encountered an error. - Error—The stage instance encountered an error, an instance of a background step within the stage encountered and error, or an autolaunched flow called by a background step within the stage encountered an error. - InProgress—The stage instance is in progress. - Suspended—The stage was in progress when the orchestration instance was manually suspended. | ## 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. [FlowOrchestrationStageInstanceFeed](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. [FlowOrchestrationStageInstanceHistory](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. [FlowOrchestrationStageInstanceOwnerSharingRule](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. [FlowOrchestrationStageInstanceShare](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. <!-- document id=b1480b37c147caa7e97ba0667fa66e82fe39bd8b0f4b2fa4ff48171cb2ca903d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_floworchestrationstepinstance.md --> # FlowOrchestrationStepInstance Represents a run-time instance of a step in a run-time instance of a stage of a run-time instance of an orchestration. This read-only object is available in API version 53.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules If sharing rules are defined for FlowOrchestrationStepInstance, they determine access to specific orchestration step run records. Or the user must have the View All Data permission. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Filter, Group, Nillable, Sort Description The description of the step. | | Label | Type string Properties Filter, Group, Sort Description The label of the step. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The API name of the step. | | OrchestrationInstanceId | Type reference Properties Filter, Group, Sort Description The ID of the FlowOrchestrationInstance associated with the orchestration step instance. This field is a relationship field. Relationship Name OrchestrationInstance Relationship Type Lookup Refers To FlowOrchestrationInstance | | OwnerId | Type reference Properties Filter, Group, Sort, Update Description The ID of the automated process user. This field is available in API version 56.0 and later. Relationship Name Owner Relationship Type Lookup Refers To User | | StageInstanceId | Type reference Properties Filter, Group, Sort Description The ID of the FlowOrchestrationStageInstance associated with the orchestration step instance. This field is a relationship field. Relationship Name StageInstance Relationship Type Lookup Refers To FlowOrchestrationStageInstance | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the orchestration step instance. Valid values are: - Completed—The step instance completed. - Discontinued—The step instance was in progress or completed when it’s associated stage instance completed, or the step was in progress or completed when the orchestration instance encountered an error. - Error—The step instance encountered an error or the autolaunched flow associated with a step instance encountered an error. - InProgress—The step instance is running, the step instance was in progress when its associated stage encountered an error, or the screen flow associated with the step instance encountered an error. - NotStarted—The step instance was created, but hasn’t met its entry condition. | | StepType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of step. Valid values are: - InteractiveStep—Interactive Step - BackgroundStep—Background Step - AynchronousBackgroundStep—Asynchronous Background Step This value is available in API version 54.0 and later. | ## 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. [FlowOrchestrationStepInstanceFeed](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. [FlowOrchestrationStepInstanceHistory](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. [FlowOrchestrationStepInstanceOwnerSharingRule](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. [FlowOrchestrationStepInstanceShare](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. <!-- document id=d56011e285a8c06aa764b88f6cba0694d3e3192379c08d822f61e41918bf03a4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_floworchestrationversion.md --> # FlowOrchestrationVersion Represents the version of an orchestration. This object is available in API version 62.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ActivatedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user that activated the orchestration. This field is a relationship field. Relationship Name ActivatedBy Refers To User | | ActivatedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the orchestration was activated. | | ApiVersion | Type double Properties Filter, Nillable, Sort Description The API version of this orchestration record version. | | Description | Type textarea Properties Nillable Description The description of the flow orchestration version. | | FlowOrchestrationId | Type reference Properties Filter, Group, Sort Description The ID of the parent orchestration running this version. This field is a relationship field. Relationship Name FlowOrchestration Relationship Type Master-detail Refers To FlowOrchestration | | IsOverridable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the orchestration that's part of a managed package is overridable. The default value is false. | | IsTemplate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the orchestration record version is a template. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The label of the orchestration. | | OrchestrationType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The orchestration's flow type. FlowType consolidates ProcessType and TriggerType into one field. FlowType is used with permissions, so admins can control access to each flow type. Valid values are: - OrchAutolnch—Autolaunched No Trigger Orchestration: Launches when invoked by Apex, REST API, custom buttons, or custom links. An orchestration lets you create a multi-step, multi-user process. - OrchRecTrigAftSave—Record-Triggered After Save Orchestration: Launches when a record is created or updated. An orchestration lets you create a multi-step, multi-user process. This type of flow runs in the background without user interaction. - CmsOrchAutolnch—CMS Workflow Orchestration Autolaunched: Launches when invoked from the Workflows component in a CMS workspace. This type of orchestration lets you create a multi-step, multi-user process to create, edit, organize, and manage digital content from a centralized location | | OverriddenById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the orchestration that's overriding the current orchestration. This field is a relationship field. Relationship Name OverriddenBy Refers To FlowOrchestration | | OverriddenOrchestrationId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the orchestration that the current orchestration is overriding. This field is a relationship field. Relationship Name OverriddenOrchestration Refers To FlowOrchestration | | RunInMode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The mode that the orchestration runs in. Possible values are: - DefaultMode—The orchestration version runs in system or user context, depending on how the orchestration is launched. - SystemModeWithSharing—The orchestration version always runs in system mode with sharing. The orchestration respects org-wide default settings, role hierarchies, sharing rules, manual sharing, teams, and territories. But it doesn’t respect object permissions, field-level access, or other permissions of the running user. - SystemModeWithoutSharing—The orchestration version can access all data. In the UI, this value appears as System Context without Sharing—Access All Data. | | SourceTemplateId | Type reference Properties Filter, Group, Nillable, Sort Description This field is a relationship field. Relationship Name SourceTemplate Refers To FlowOrchestration | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The ID of the template that the orchestration was created from. This is a relationship field.(Refers to Orchestration Record). Possible values are: - Active—Active - Draft—Inactive - InvalidDraft—Draft - Obsolete—Inactive - UnderReview—Under Review | | TriggerObjectOrEventLabel | Type string Properties Filter, Group, Nillable, Sort Description The label of the object or platform event that triggers this flow. | | VersionNumber | Type int Properties Filter, Group, Nillable, Sort Description The version number of the orchestration version. | ## 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. [FlowOrchestrationVersionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. <!-- document id=ef5ea8c39938d8f4c1583430814e29cd3c72a1ea12988d08739918d64c17b5aa url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_floworchestrationworkitem.md --> # FlowOrchestrationWorkItem Represents a work item associated with a run-time instance of an interactive step in a run-time instance of an orchestration. This object is available in API version 54.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules An assignee can see all work item records assigned to them. If sharing rules are defined for FlowOrchestrationWorkItem, they determine access to specific orchestration work item records for users other than the assignee. Or the user must have the View All Data permission. ## Fields | Field | Details | | --- | --- | | AssigneeId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user, group, or queue assigned to the orchestration work item. This field is a polymorphic relationship field. Relationship Name Assignee Relationship Type Lookup Refers To Group (Type = Regular), Group (Type = Queue), User | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the orchestration work item. | | ElapsedTimeSinceAsgntInSec | Type long Properties Filter, Group, Nillable, Sort Description When status is Assigned, the number of seconds that have passed since the work item was last assigned. When status is Completed, this value is null. This field is available in API version 63.0 and later. | | ElapsedTimeSinceCreationInSec | Type long Properties Filter, Group, Nillable, Sort Description When status is Assigned, the number of seconds that have passed since the work item was created. When status is Completed, this value is null. This field is available in API version 63.0 and later. | | FlowType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The flow type of the orchestration that created the orchestration work item. Valid values are: - ApprovalOrchAutolnch—Autolaunched Flow Approval Process - ApprovalOrchRecTrigAftSave—Record-Triggered After Save Flow Approval Process - ExtSysChgFlowAppvl—External System Change-Triggered Flow Approval Process - ExtSysChgOrch—External System Change-Triggered Orchestration - OrchAutolnch—Autolaunched No Trigger Orchestration - OrchRecTrigAftSave—Record-Triggered After Save Orchestration This field is available in API version 62.0 and later. | | Label | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The label of the orchestration work item. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent time a user viewed a record related to the orchestration work item. This field is available in API version 55.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent time a user viewed the orchestration work item. This field is available in API version 55.0 and later. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The API name of the orchestration work item. | | OrchestrationName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of the orchestration associated with the orchestration work item. This field is avavilable in API version 56.0 and later. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description When the assignee is an internal user: the ID of the internal user When the assignee is a credentialed Experience Cloud site visitor: the ID of the credentialed Experience Cloud site visitor When the assignee is a group or queue: the ID of the automated process user This field is available in API version 56.0 and later. Relationship Name Owner Relationship Type Lookup Refers To Group (Type = Regular), Group (Type = Queue), User | | ParentWorkItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent orchestration work item. When multiple group members receive child work items, this field links each child to its parent. This field is available in API version 67.0 and later. Relationship Name ParentWorkItem Relationship Type Lookup Refers To FlowOrchestrationWorkItem | | RelatedRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the context record, such as an account, case, or expense, that the orchestration work item is related to. An assigned user completes the associated orchestration work item on the page for this record. This field is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To All objects except AccountContactRelation, AccountTeamMember, ActiveScratchOrg, ActivityMetric, ActivityMetricRollup,CampaignMember, CartCheckoutSession, CartDeliveryGroup, CartDeliveryGroupMethod, ChatterActivity,CollaborationGroupMember, ContentDesignKit, ContentDesignKitVersion, ConversationBroadcastEntry,ConversationReason, ConversationReasonExcerpt, ConversationReasonGroup, CustomPersonDataTemplate,ElectronicMediaGroup, EngagementScore, Event, FeedItem, FlowOrchestrationWorkItem, FtestDelPlatform1,FtestDelPlatform2, FtestFormulaFieldRefSql,HighScaleSample, HighScaleSampleItem, LegalEntity, LocationWaitlist, LocationWaitlistedParty,LocWaitlistMsgTemplate, ManagedContentVersion, MessagingEndUser, MessagingSession, MLModel,MLModelFactor, MLModelFactorComponent, NetworkMember, NetworkMemberChunk, OpportunityContactRole,OpportunityLineItem, OpportunityScore, OpportunityTeamMember, OrgSnapshot, PaymentTermItem,RequestsForAccessSIQ, ScoreIntelligence, ScratchOrgInfo, SharingRecordCollection, SharingRecordCollectionItem,SharingRecordCollectionMember, StreamActivityAccess, Survey, SurveyMessagingChannel, SurveyPage,SurveyQuestionChoice, SurveyVersion, Task, TenantSecurityAlertRuleSelectedTenant, TenantSecurityApiAnomaly,TenantSecurityConnectedApp, TenantSecurityCredentialStuffing, TenantSecurityHealthCheckBaselineTrend,TenantSecurityHealthCheckDetail, TenantSecurityHealthCheckTrend, TenantSecurityLogin, TenantSecurityMetricDetail,TenantSecurityMetricDetailLink, TenantSecurityMobilePolicyTrend, TenantSecurityMonitorMetric,TenantSecurityNotification, TenantSecurityNotificationRule, TenantSecurityPackage, TenantSecurityPolicy,TenantSecurityPolicyChangeLog, TenantSecurityPolicyDeployment, TenantSecurityPolicySelectedTenant,TenantSecurityReportAnomaly, TenantSecuritySessionHijacking, TenantSecurityTenantChangeLog,TenantSecurityTenantInfo, TenantSecurityTrustedIpRangeTrend, TenantSecurityUserActivity, TenantSecurityUserPerm,TenantSecurityWebsite, TopicAssignment, UserExternalCredential, VoiceCall | | ScreenFlow | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The screen flow associated with the orchestration work item. Possible values are screen flows in the org. | | ScreenFlowInputs | Type textarea Properties Create, Nillable, Update Description The input parameters required by the screen flow. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the work item. Valid values are: - Assigned - Completed | | StepInstanceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the flow orchestration step associated with the orchestration work item. This field is a relationship field. Relationship Name StepInstance Relationship Type Lookup Refers To FlowOrchestrationStepInstance | ## 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. [FlowOrchestrationWorkItemFeed](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. [FlowOrchestrationWorkItemHistory](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. [FlowOrchestrationWorkItemOwnerSharingRule](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. [FlowOrchestrationWorkItemShare](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. <!-- document id=b55affaef3cf176e1711031771fe30b80950b91c9a355f0c90e590d77145d9e6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowrecord.md --> # FlowRecord Represents the details of a flow. This object is available in API version 58.0 and later. ## Supported Calls delete(), query(), update() ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d954317e75">Field Name</th> <th class="featureTableHeader " id="d954317e78">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">ActivationId</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <a name="dl_a34_1bh_5fc"><!-- --></a> <dl class="dl detailList" id="dl_a34_1bh_5fc"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the marketing segment activation. This field is available in API version 64.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">Activation</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">MarketSegmentActivation</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">ActiveVersionId</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the active flow version. This field is available in API version 61.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">ActiveVersion</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowRecordVersion</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">ApiVersion</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The API version of the flow record. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">AreMetricsLoggedToDataCloud</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <a name="dl_y1k_cx1_ndc"><!-- --></a> <dl class="dl detailList" id="dl_y1k_cx1_ndc"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether this flow’s metrics are logged in Data Cloud. The default value is false. This field is available in API version 63.0 and later. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">AssociatedRecordId</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the record the flow is associated with.</dd> <dd class="dd">This field is a polymorphic relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">AssociatedRecord</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Campaign</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">Builder</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The name of the tool that created this flow. Valid values are: <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">Cloud Flow Designer</samp></li> <li class="li"><samp class="codeph nolang">Flow Builder</samp></li> <li class="li"><samp class="codeph nolang">Swing Designer</samp></li> </ul> <p class="p">This field is available in API version 61.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">CapacityCategory</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The category that determines the usage limits of the flow. Possible values are:<ul class="ul bulletList"> <li class="li">Marketing Cloud Flow</li> </ul> </dd> </dl> <p class="p">This field is available in API version 62.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">Description</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The description of the flow.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name">ElementEntries</td> <td class="entry" headers="d954317e78" data-title="Details"> <a name="dl_hgy_jm3_gjc"><!-- --></a> <dl class="dl detailList" id="dl_hgy_jm3_gjc"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The number of times the last flow occurrence activated an element. This field is available in API version 67.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name">ElementErrors</td> <td class="entry" headers="d954317e78" data-title="Details"> <a name="dl_a4k_qm3_gjc"><!-- --></a> <dl class="dl detailList" id="dl_a4k_qm3_gjc"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The number of times the last flow occurrence activated an element which caused an error. This field is available in API version 67.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">ErrorCode</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The error code if the flow element run encountered an error. Valid values are: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">ACTIVATING_USER_ACCOUNT_DEACTIVATED</samp>—We can't run this flow because the user who activated it has a deactivated user record. </li> <li class="li"> <samp class="codeph nolang">ACTIVATING_USER_LOST_PERMISSIONS</samp>—We can't run this flow because the user that activated it no longer has permission to it. </li> <li class="li"> <samp class="codeph nolang">CANNOT_PUBLISH_SEGMENT</samp>—We can't run this flow because we can't publish the segment it's using. Contact Salesforce Customer Support and ask for help with the error ID. </li> <li class="li"> <samp class="codeph nolang">CANNOT_QUERY_SEGMENT_MEMBER_DATA</samp>—We can't run this flow because we can't query the segment membership data it's using. Contact Salesforce Customer Support and ask for help with the error ID. </li> <li class="li"> <samp class="codeph nolang">CANNOT_RUN_ACTIVATION_TRIGGERED_FLOW</samp>—Something went wrong with your automation. Contact Salesforce Customer Support and ask for help with the error ID. </li> <li class="li"> <samp class="codeph nolang">CANNOT_REFRESH_DATA_STREAM</samp>—We can't run this flow because we can't refresh your data stream metadata. Contact Salesforce Customer Support and ask for help with the error ID. </li> <li class="li"> <samp class="codeph nolang">CANNOT_REFRESH_IDENTITY_RES_DATA</samp>—We can't run this flow because we can't refresh your identity resolution data. Contact Salesforce Customer Support and ask for help with the error ID. </li> <li class="li"> <samp class="codeph nolang">CANNOT_REFRESH_IDENTITY_RES_METADATA</samp>—We can't run this flow because we can't refresh your identity resolution metadata. Contact Salesforce Customer Support and ask for help with the error ID. </li> <li class="li"> <samp class="codeph nolang">CANNOT_UPDATE_DATASTREAM_METADATA</samp>—We can't run this flow because we can't update your DataStream metadata. Contact Salesforce Customer Support and ask for help with the error ID. </li> <li class="li"> <samp class="codeph nolang">CREATE_EXPERIMENT_ERROR</samp>—We can't run this flow because an error occurred while executing the Path Experiment element. To try again, save and activate a new version of the flow. </li> <li class="li"> <samp class="codeph nolang">DATA_ACTION_STATUS_ERROR</samp>—We can’t run this flow because we couldn’t create the data action. To try again, save and activate a new version of the flow. </li> <li class="li"> <samp class="codeph nolang">FLOW_FAILED_TO_START</samp>—This flow failed to start. Contact Salesforce Customer Support and ask for help with the error ID. </li> </ul> <p class="p">This field is available in API version 59.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">ErrorDetails</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The error ID. This field is available in API version 59.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">FlowCategory</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The API name of a category. Sharing rules assign permissions to view and edit flows by category and subcategory. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">FlowDefinition</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Represents the flow definition.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">FlowSubcategory</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The API name of a subcategory. Sharing rules assign permissions to view and edit flows by category and subcategory. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">FlowType</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The label of a flow type. <span class="keyword parmname">FlowType</span> consolidates <span class="keyword parmname">ProcessType</span> and <span class="keyword parmname">TriggerType</span> into one field. <span class="keyword parmname">FlowType</span> is used with permissions, so admins can control access to each flow type. Valid values are: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">Action Cadence Step Screen Flow</samp>—Launches from a cadence step. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Action Plan Autolaunched Flow</samp>—Launches an action plan task from an action plan when conditions in the associated action plan template process are met. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Activity-Object Matching No Trigger Flow</samp>—Launches when Einstein Activity Capture detects and captures a new activity, such as an email. This type of flow runs in the background without user interaction. Requires Sync Email as Salesforce Activity to be enabled. </li> <li class="li"> <samp class="codeph nolang">Activation-Triggered Autolaunched Flow</samp>—Launches when an activation is published. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Admin Automation Event-Triggered Flow</samp>—Launches when invoked by Apex, processes, REST API, and more. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Autolaunched Approval Orchestration</samp>—Launches when invoked by Apex, REST API, custom buttons, or custom links. An approval orchestration lets you create a multi-step, multi-user approval process. </li> <li class="li"> <samp class="codeph nolang">Autolaunched No Trigger Flow</samp>—Launches when invoked by processes or code such as Apex and REST API. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Autolaunched No Trigger Orchestration</samp>—Launches when invoked by Apex, REST API, custom buttons, or custom links. An orchestration lets you create a multi-step, multi-user process. </li> <li class="li"> <samp class="codeph nolang">Automation Event-Triggered Autolaunched Flow</samp>—Launches when invoked by Apex, processes, REST API, and more. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Automation Event-Triggered Flow</samp>—Launches when a user performs an automation event, like subscribing to SMS messages. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Automation Event-Triggered Flow v0</samp>—Deprecated. Launches when a user performs an automation event, like subscribing to SMS messages. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Campaign Member</samp>—Launches when scheduled to perform actions on or send messages to individuals from the selected campaign member. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">Cart Async Autolaunched Flow</samp>—Launches when invoked by a cart change, such as an Add to Cart. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Checkout Screen Flow</samp>—Create a screen flow that implements a Commerce Cloud checkout process. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">CMS Workflow Orchestration Autolaunched</samp>—Launches when invoked from the Workflows component in a CMS workspace. This type of orchestration lets you create a multi-step, multi-user process to create, edit, organize, and manage digital content from a centralized location. </li> <li class="li"> <samp class="codeph nolang">Contact Request Screen Flow</samp>—Launches when invoked by a customer, allowing them to enter contact details into a self-service form. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Customer Lifecycle Record-Triggered After Save Flow</samp>—Launches after a customer lifecycle map is saved and changes records related to the triggering record. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Data Cloud Data Change Flow</samp>—Launches when a record from a Data Cloud data model object or a calculated insight object is changed and meets the specified conditions. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Data Graph-Triggered Autolaunched Flow</samp>—Launches when invoked by Apex, processes, REST API, and more. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Data Graph-Triggered Flow</samp>—Launches when invoked by Apex, processes, REST API, and more. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Data Graph-Triggered Flow v0</samp>—Deprecated. Launches when invoked by Apex, processes, REST API, and more. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Digital Form Screen Flow</samp>—Launches from app extensions. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Discovery Framework Data Capture Screen Flow (Beta)</samp>—Launches when invoked by a user on a mobile device and presents assessment questions from Discovery Framework. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Employee Service Catalog Item Screen Flow</samp>—Launches when invoked by a user and allows them to browse and order items from the Employee Service Catalog. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Enterprise Scale External System Change-Triggered Flow</samp>—Launches when invoked by MuleSoft. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">Evaluation Autolaunched Flow</samp>—Launches when invoked by an orchestration to evaluate custom criteria for a stage or step. To indicate that the criteria are met, set the output variable <samp class="codeph nolang">isOrchestrationConditionMet</samp> to <samp class="codeph nolang">true</samp>. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">External System Change-Triggered Flow</samp>—Launches when an event is received from an external system. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Event-Driven Flow</samp>—Launches when an event is received. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Field Service Mobile Screen Flow</samp>—Launches when invoked by a user in the Field Service mobile app. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Field Service Web Screen Flow</samp>—Launches from the Field Service app and lets users schedule, modify, or cancel an appointment in a web browser. This type of flow requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Form-Triggered Autolaunched Flow</samp>—Launches when a web visitor submits a marketing form. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Form-Triggered Flow</samp>—Launches when a web visitor submits a marketing form. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Form-Triggered Flow v0</samp>—Deprecated. Launches when a web visitor submits a marketing form. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Identity User Registration Flow</samp>—Launches when a user logs in via a single sign-on process that uses the authentication provider framework. After the third-party identity provider authenticates the user, the flow creates a user or updates an existing user. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Indicator Result Screen Flow</samp>—Launches a screen flow when initiated by a user to calculate and create indicator results for a selected indicator performance period. </li> <li class="li"> <samp class="codeph nolang">Individual-Object Linking Screen Flow</samp>—Launches when invoked by an agent to link a record like a case or messaging session to a contact, lead, person account, or employee. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">List</samp>—Launches when scheduled to perform actions on or send messages to individuals from the selected list. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">Login Screen Flow</samp>—Launches when a user tries to log in to Salesforce. This type of flow extends Salesforce's default authentication process by sending users with certain profiles through a flow when they log in and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Loyalty Management Autolaunched Flow</samp>—Launches when invoked by a loyalty program process, and contains Assignment, Decision, and Action elements. The Action element in this type of flow supports Apex and quick actions. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Managed Content Autolaunched Flow</samp>—Launches when invoked by the ManagedContentRelease translator. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Mortgage Lending Screen Flow</samp>—Launches when invoked by a user and allows them to provide Financial Service Cloud mortgage application details. This type of flow requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Platform Event Triggered Flow</samp>—Launches when a platform event occurs. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Process Builder Autolaunched Process</samp>—Launched when invoked from a Process Builder process. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Process Builder Custom Event Process</samp>—A process created in Process Builder that launches when a custom event message is received. This type of process runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Process Builder Workflow</samp>—Launches when a record is created or updated. This type of process runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Prompt Template Capability-Triggered Flow</samp>—Launches from a prompt template. This type of flow adds prompt instructions to the associated prompt template and runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Recommendation Strategy Autolaunched Flow</samp>—Build a personalized list of recommendations. When a recommendation is selected, it launches its assigned flow. Used by Einstein Next Best Action. Show recommendations in Lightning App Builder with the Einstein Next Best Action component and in Experience Builder with the Suggested Actions component. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered After Save Flow</samp>—Launches after a record is created or updated and has been saved. This type of flow can make changes only to records related to the triggering record and runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered After Save Approval Orchestration</samp>—Launches when a record is created or updated. An approval orchestration lets you create a multi-step, multi-user approval process. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered After Save Orchestration</samp>—Launches when a record is created or updated. An orchestration lets you create a multi-step, multi-user process. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered Before Delete Flow</samp>—Launches when a record is deleted. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered Before Save Flow</samp>—Launches after a record is created or updated, but hasn't been saved. This type of flow can make changes only to the triggering record and runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Record Query</samp>—Launches when scheduled to perform actions on or send messages to individuals from the queried customer relationship management record. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">Routing Autolaunched Flow</samp>—Launches when a customer initiates a chat, voice, or messaging conversation and routes the work item to a queue, skill, agent, or bot. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Schedule-Triggered Flow</samp>—Launches at a specified time and frequency for each record that meets the flow criteria. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Scheduler Appointments Screen Flow</samp>—Launches when invoked by a user and lets them schedule appointments in Salesforce Scheduler. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Screen Flow</samp>—Launches from Lightning pages, Experience Cloud sites, quick actions and more. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Segment-Triggered Autolaunched Flow</samp>—Launches when activated or when scheduled for qualified Data Cloud segment members. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Segment-Triggered Flow</samp>—Launches when activated or when scheduled for qualified Data Cloud segment members. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Segment-Triggered Flow v0</samp>—Deprecated. Launches when activated or when scheduled for qualified Data Cloud segment members. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Stage Management Evaluation Autolaunched Flow</samp>—Launches when invoked by a stage transition in Stage Management to evaluate custom criteria for a stage or step. To indicate that the criteria are met, set the output variable isCriteriaMet to True. </li> <li class="li"> <samp class="codeph nolang">Survey Enrich Autolaunched Flow</samp>—Launches in the context of a survey response and can't execute without a corresponding survey. Use it to conditionally map a response to a record, create records, or send notifications. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Survey Screen Flow</samp>—Launches when invoked by an internal or external survey participant. This type of flow saves participant feedback as survey response records and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Transaction Security Autolaunched Flow</samp>—Used by Condition Builder to declaratively build customized security policies to protect data. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">User Provisioning Screen Flow</samp>—Launches when invoked by a user and allows them to create a user account and link it to a third-party service or app. This type of flow requires user interaction. </li> </ul> This field is available in API version 60.0 and later. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">Health</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <a name="dl_z14_nn3_gjc"><!-- --></a> <dl class="dl detailList" id="dl_z14_nn3_gjc"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The value of <span class="keyword parmname">ElementErrors</span> divided by <span class="keyword parmname">ElementEntries</span> multiplied by 100. This field is available in API version 67.0 and later. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">Id</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">text</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the flow.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">IsLightningAppEnabled</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> Indicates whether this flow’s flow type has been enabled in Lightning Experience apps. The default value is <samp class="codeph nolang">false</samp>. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">IsOverridable</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> Indicates whether the flow record version is overridable. The default value is <samp class="codeph nolang">false</samp>. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">IsPaused</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <a name="dl_avg_dbn_thc"><!-- --></a> <dl class="dl detailList" id="dl_avg_dbn_thc"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the segment-triggered flow is paused (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When the value is <samp class="codeph nolang">true</samp>, no additional records are processed until the flow is resumed. The default value is <samp class="codeph nolang">false</samp>. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">IsTemplate</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the flow record version is a template. Template flow record versions are automatically shared with all users in your Salesforce org. The default value is <samp class="codeph nolang">false</samp>. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">LogsEnabledFlowVersion</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <a name="dl_jvs_h1n_thc"><!-- --></a> <dl class="dl detailList" id="dl_jvs_h1n_thc"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The version number of the flow that enabled persistent logging. This field is available in API version 66.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">Manageable State</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <p class="p">Indicates the manageable state of the flow record that is contained in a package. Valid values are: </p> <ul class="ul bulletList"> <li class="li">beta</li> <li class="li">deleted</li> <li class="li">deprecated</li> <li class="li">deprecatedEditable</li> <li class="li">installed</li> <li class="li">installedEditable</li> <li class="li">released</li> <li class="li">unmanaged</li> </ul> <p class="p">This field is available in API version 60.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">Name</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, idLookup, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The label of the flow.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">NamespacePrefix</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The namespace prefix associated with the flow record. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">OverriddenById</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the flow that’s overriding the current flow. This field is available in API version 61.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">OverriddenBy</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowRecord</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">OverriddenFlowId</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the flow that the current flow is overriding. This field is available in API version 61.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">OverriddenFlow</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowRecord</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">OwnerId</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort, Update</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the user who owns the flow.</dd> <dd class="dd">This field is a polymorphic relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">Owner</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Group, User</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">ProgressStatus</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The progress status of the flow. Valid values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">Canceled</samp>— Indicates a flow that has been deactivated by a user who doesn’t process previously added records. No additional records are added to this flow. </li> <li class="li"> <samp class="codeph nolang">Completed</samp>— Indicates a flow that is complete. No additional records are eligible to be processed in this flow. </li> <li class="li"> <samp class="codeph nolang">Draft</samp>—Indicates a flow that is under construction and isn’t active yet. This status can be invalid because it needs additional information before it can be activated by the user. </li> <li class="li"> <samp class="codeph nolang">Error</samp>—Indicates a flow that has been deactivated because it encountered an error. When the error occurs, the error details are emailed to up to 5 users with the Manage Flows permission who most recently logged into Salesforce. </li> <li class="li"> <samp class="codeph nolang">Finishing</samp>— Indicates a flow that has been deactivated by a user, but is finishing previously added records that are eligible to run to completion. No additional records are added to this flow. </li> <li class="li"> <samp class="codeph nolang">InProgress</samp>— Indicates a flow that is running or ready to run. </li> <li class="li"> <samp class="codeph nolang">PreparingData</samp>— Indicates a flow that is preparing the necessary data to run. This process can take up to 2 hours. </li> <li class="li"> <samp class="codeph nolang">Scheduled</samp>— Indicates a flow scheduled to start on the date and time selected by the user. </li> <li class="li"> <samp class="codeph nolang">UnderReview</samp>—Indicates a flow that is under review before it is activated. This value is available in API version 64.0 and later. </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">ScheduledStartDate</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date and time that the flow is scheduled to start.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">SegmentId</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the segment used in the flow.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">Segment</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">MarketSegment</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">SourceTemplateId</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the template from which the current flow was created. This field is available in API version 61.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">SourceTemplate</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowRecord</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">TriggerObjectOrEventLabel</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The label of the object or platform event that triggers this flow. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d954317e75" data-title="Field Name"><span class="keyword parmname">Type</span></td> <td class="entry" headers="d954317e78" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The trigger type of the flow. Specifies what causes the flow to run. Valid values are: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">Activation</samp>—The flow starts when an activation is published. This type of flow runs in the background without user interaction. This value is available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">AdminAutomationEvent</samp>—The flow starts when an automation event is received. This type of flow runs in the background without user interaction. This value is available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Automation Event</samp>—The flow starts when an automation event such as an SMS subscription occurs. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang">CampaignMember</samp>—The flow starts at the scheduled time of a campaign member. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">Capability</samp>—The flow starts when the specified capability that the flow integrates with is invoked. This value is available in API version 60.0 and later. </li> <li class="li"> <samp class="codeph nolang">DataCloudDataChange</samp>—The flow starts when data model object (DMO) or calculated insight object (CIO) conditions are met. This value is available in API version 59.0 and later. </li> <li class="li"> <samp class="codeph nolang">DataGraphDataChange</samp>—The flow starts when conditions are met in the specified data graph field. This value is available in API version 63.0 and later. </li> <li class="li"> <samp class="codeph nolang">EnterpriseScaleExternalSystemChange</samp>—The flow starts when triggered by MuleSoft. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">EventDrivenJourney</samp>—Reserved for internal use. </li> <li class="li"> <samp class="codeph nolang">ExternalSystemChange</samp>—The flow starts when an external system change event is received. This value is available in API version 61.0 and later. </li> <li class="li"> <samp class="codeph nolang">FormSubmissionEvent</samp>—The flow runs when a user submits data via a webform. In Flow Builder, this value corresponds to <samp class="codeph nolang">Form</samp>. This value is available in API version 60.0 and later. </li> <li class="li"> <samp class="codeph nolang">List</samp>—The flow starts at the scheduled time of a list.  This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">PlatformEvent</samp>—The flow starts when a platform event message is received. This value is available in API version 49.0 and later. </li> <li class="li"> <samp class="codeph nolang">RecordAfterSave</samp>—The flow starts after a record is saved. This value is available in API version 49.0 and later. </li> <li class="li"> <samp class="codeph nolang">RecordBeforeDelete</samp>—Deleting a record triggers an autolaunched flow before the record is deleted from the database. This value is available in API version 50.0 and later. </li> <li class="li"> <samp class="codeph nolang">RecordBeforeSave</samp>—Creating and/or updating a record triggers an autolaunched flow to make additional updates to that record before it's saved to the database. This value is available in API version 48.0 and later. </li> <li class="li"> <samp class="codeph nolang">RecordQuery</samp>—The flow starts at the scheduled time of a queried customer relationship management record. This value is available in API version 67.0 and later. </li> <li class="li"> <samp class="codeph nolang">Scheduled</samp>—The flow starts at the scheduled time. This value is available in API version 47.0 and later. </li> <li class="li"> <samp class="codeph nolang">Segment</samp>—The flow runs at the scheduled time of a segment. </li> </ul> </dd> </dl> </td> </tr> </tbody> </table> ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [FlowRecordChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [FlowRecordOwnerSharingRule](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. [FlowRecordShare](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. <!-- document id=1e19052e60e0766c6266d2ec3512ea52b2a6c29520f677e93e42f6dc61254293 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowrecordelement.md --> # FlowRecordElement Represents a single element within a flow version. This object is available in API version 58.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | DataSpaceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the data space for this flow record element. This field is available in API version 66.0 and later. This field is a relationship field. Relationship Name DataSpace Refers To DataSpace | | ElementName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the flow element. | | FlowRecordVersionId | Type reference Properties Filter, Group, Sort Description The ID of the flow version the flow element is part of. This field is a relationship field. Relationship Name FlowRecordVersion Relationship Type Master-detail Refers To FlowRecordVersion (the master object) | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the flow element was last used. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the flow element was last viewed. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The label of the flow element. | [FlowRecordElementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. <!-- document id=16970057fbd4360c56cdae43c0995b12f3803ffcd5e42bc161d1707f627313af url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowrecordelementoccurrence.md --> # FlowRecordElementOccurrence Represents the execution metrics for a single element within a flow version. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The ISO code for the currency associated with the flow. Possible values are: - USD—U.S. Dollar The default value is USD. | | Entries | Type int Properties Filter, Group, Nillable, Sort Description The number of times the element was initiated in all flow interviews after the flow version was executed. | | Errors | Type int Properties Filter, Group, Nillable, Sort Description The number of errors for the element in all flow interviews after the flow version was executed. | | Exits | Type int Properties Filter, Group, Nillable, Sort Description The number of times the element was executed to completion in all flow interviews after the flow version was executed. | | FlowRecordElementId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the flow element. This field is a relationship field. Relationship Name FlowRecordElement Refers To FlowRecordElement | | FlowRecordId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the flow. This field is a relationship field. Relationship Name FlowRecord Refers To FlowRecord | | FlowRecordVersionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the flow version. This field is a relationship field. Relationship Name FlowRecordVersion Refers To FlowRecordVersion | | FlowRecordVersionOccurrenceId | Type reference Properties Filter, Group, Sort Description The ID of the flow occurrence. This field is a relationship field. Relationship Name FlowRecordVersionOccurrence Relationship Type Master-detail Refers To FlowRecordVersionOccurrence (the master object) | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The API name of the flow element. | | Stopped | Type int Properties Filter, Group, Nillable, Sort Description The number of times execution of the element was stopped in all flow interviews after the flow version was executed. | | TotalDuration | Type long Properties Filter, Group, Nillable, Sort Description The total time in milliseconds spent executing the element in all flow interviews. | ## 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. [FlowRecordElementOccurrenceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [FlowRecordElementOccurrenceFeed](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. [FlowRecordElementOccurrenceHistory](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. [FlowRecordElementOccurrenceOwnerSharingRule](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. [FlowRecordElementOccurrenceShare](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. <!-- document id=917dba263bca28abef3622b3ef71cb5d0c267aef376668dbc7f382e1cb2540f3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowrecordrelation.md --> # FlowRecordRelation Represents a relationship between a record and a flow interview. When a flow interview is paused, Salesforce uses the $Flow.CurrentRecord global variable in the flow to associate the interview with a record. Available in API version 42.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated ID of this relation. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The flow interview that the record is related to. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To FlowInterview | | RelatedRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The record that the flow interview is related to. Make sure that this field contains only one ID, and that the ID is for a valid object. Custom objects and most standard objects are supported. This is a relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To Account, AccountContactRole, AccountPartner, Accreditation, ActivationTarget, ActivationTrgtIntOrgAccess, Address, AlternativePaymentMethod, Announcement, ApexTestQueueItem, AppAnalyticsQueryRequest, AppUsageAssignment, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, AssociatedLocation, AsyncApexJob, Attachment, AuthorizationForm, AuthorizationFormConsent, AuthorizationFormDataUse, AuthorizationFormText, Award, BackgroundOperation, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, CalendarView, Campaign, CampaignMember, CardPaymentMethod, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CaseContactRole, CaseSolution, CodeSet, CodeSetBundle, CollaborationGroup, CollaborationGroupMember, CollaborationGroupMemberRequest, CollaborationGroupRecord, CollaborationInvitation, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConferenceNumber, ConsumptionRate, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContactPointAddress, ContactPointConsent, ContactPointEmail, ContactPointPhone, ContactPointTypeConsent, ContactRequest, ContentDistribution, ContentDocument, ContentDocumentLink, ContentDocumentSubscription, ContentFolder, ContentFolderLink, ContentFolderMember, ContentNotification, ContentVersion, ContentVersionComment, ContentVersionRating, ContentWorkspaceDoc, Contract, ContractContactRole, ConversationEntry, CoverageBenefit, CoverageBenefitItem, CreditMemo, CreditMemoLine, Dashboard, DashboardComponent, DataAssessmentFieldMetric, DataAssessmentMetric, DataAssessmentValueMetric, DataStream, DataUseLegalBasis, DataUsePurpose, DelegatedAccount, DeleteEvent, DialerCallUsage, DigitalSignature, DigitalWallet, Document, DocumentChecklistItem, DuplicateRecordItem, DuplicateRecordSet, EmailMessage, EmailMessageRelation, EngagementChannelType, EnhancedLetterhead, EnrollmentEligibilityCriteria, EntitySubscription, Event, EventRelation, ExternalEvent, ExternalEventMapping, FeedAttachment, FeedComment, FeedItem, FeedPollChoice, FeedPollVote, FeedRevision, FileSearchActivity, FlowInterviewLog, FlowInterviewLogEntry, FlowStageRelation, HealthCareDiagnosis, HealthCareProcedure, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Idea, Identifier, IdentityDocument, Image, Individual, IndividualApplication, InstalledMobileApp, Invoice, InvoiceLine, Lead, ListEmail, ListEmailIndividualRecipient, ListEmailRecipientSource, Location, LocationTrustMeasure, MarketSegment, MarketSegmentActivation, MatchingInformation, MemberPlan, MessagingDeliveryError, MessagingEndUser, MktCalculatedInsight, MktSgmntActvtnAudAttribute, MktSgmntActvtnContactPoint, Note, OperatingHours, Opportunity, OpportunityContactRole, OpportunityLineItem, OpportunityPartner, Order, OrderItem, OrgMetric, OrgMetricScanResult, OrgMetricScanSummary, OtherComponentTask, Partner, PartyConsent, Payment, PaymentAuthAdjustment, PaymentAuthorization, PaymentGateway, PaymentGatewayLog, PaymentGroup, PaymentLineInvoice, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, Pricebook2, PricebookEntry, ProcessException, ProcessInstance, ProcessInstanceNode, Product2, ProductConsumptionSchedule, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, PromptAction, ProviderSearchSyncLog, PurchaserPlan, PurchaserPlanAssn, PushTopic, QuickText, QuickTextUsage, ReceivedDocument, Recommendation, RecordAction, Refund, RefundLinePayment, ReplyText, Report, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderItemAdjustment, ReturnOrderItemTax, ReturnOrderLineItem, SearchPromotionRule, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SetupAssistantStep, SharingRecordCollection, SharingRecordCollectionItem, SharingRecordCollectionMember, Shift, Shipment, ShipmentItem, SkillRequirement, SocialPersona, SocialPost, Solution, StreamingChannel, Task, ThreatDetectionFeedback, TimeSlot, TodayGoal, Topic, TopicAssignment, UnitOfMeasure, UserAppInfo, UserAppMenuCustomization, UserEmailPreferredPerson, UserProvAccount, UserProvAccountStaging, UserProvMockTarget, UserProvisioningLog, UserProvisioningRequest, VideoCall, VideoCallParticipant, VideoCallRecording, Visit, VisitedParty, Visitor, VoiceCall, VoiceCallRecording, VoiceVendorLine, VolunteerProject, WaveAutoInstallRequest, WaveCompatibilityCheckItem, WorkAccess, WorkBadge, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkThanks, WorkType, WorkTypeGroup, WorkTypeGroupMember | <!-- document id=44919e9dc72b35f619c9702fbaefa454eb55d2827de0fc635fc4d1b42a166982 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowrecordversion.md --> # FlowRecordVersion Represents the version of a flow. This object is available in API version 58.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(),search() ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d960718e89">Field Name</th> <th class="featureTableHeader " id="d960718e92">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">AccessType</span></td> <td class="entry" headers="d960718e92" data-title="Details">Reserved for future use.</td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">ActivatedById</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the user that activated the flow. This field is available in API version 60.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">ActivatedBy</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">User</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">ActivatedDate</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date and time when the flow was activated. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">ApiVersion</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The API version of the flow record version. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">AreMetricsLoggedToDataCloud</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <a name="dl_y1k_cx1_ndc"><!-- --></a> <dl class="dl detailList" id="dl_y1k_cx1_ndc"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether this flow’s metrics are logged in Data Cloud. The default value is false. This field is available in API version 63.0 and later. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">Builder</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The name of the tool that created this flow. Valid values are: <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">Cloud Flow Designer</samp></li> <li class="li"><samp class="codeph nolang">Flow Builder</samp></li> <li class="li"><samp class="codeph nolang">Swing Designer</samp></li> </ul> <p class="p">This field is available in API version 61.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">CapacityCategory</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The category that determines the usage limits of the flow. Possible values are:<ul class="ul bulletList"> <li class="li">Marketing Cloud Flow</li> </ul> </dd> </dl> <p class="p">This field is available in API version 62.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">DataSpaceId</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <a name="dl_ffd_flf_rhc"><!-- --></a> <dl class="dl detailList" id="dl_ffd_flf_rhc"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the data space for this flow record version. This field is available in API version 65.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">DataSpace</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">DataSpace</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">Description</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The description of the flow record version. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">Entries</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The number of entries in this flow. To use this field, your org must use Salesforce Enterprise and Unlimited Editions with Marketing Cloud Growth Edition. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">Errors</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The number of errors in this flow. To use this field, your org must use Salesforce Enterprise and Unlimited Editions with Marketing Cloud Growth Edition. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">Exits</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The number of exits from this flow. To use this field, your org must use Salesforce Enterprise and Unlimited Editions with Marketing Cloud Growth Edition. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">FlowRecordId</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the parent flow running this version.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">FlowRecord</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowRecord</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">FlowType</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The label of a flow type. <span class="keyword parmname">FlowType</span> consolidates <span class="keyword parmname">ProcessType</span> and <span class="keyword parmname">TriggerType</span> into one field. <span class="keyword parmname">FlowType</span> is used with permissions, so admins can control access to each flow type. Valid values are: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">Action Cadence Step Screen Flow</samp>—Launches from a cadence step. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Activation-Triggered Autolaunched Flow</samp>—Launches when an activation is published. This type of flow runs in the background without user interaction. This value is available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Action Plan Autolaunched Flow</samp>—Launches an action plan task from an action plan when conditions in the associated action plan template process are met. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Admin Automation Event-Triggered Flow</samp>—Launches when invoked by Apex, processes, REST API, and more. This type of flow runs in the background without user interaction. This value is available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Agentic Guided Experience Background Flow</samp>—Creates, retrieves, updates, or deletes records. This autolaunched flow runs in the background. This value is available in API version 65.0 and later. </li> <li class="li"> <samp class="codeph nolang">Agentic Guided Experience Orchestration Flow</samp>—Launches when a mobile worker invokes it from the Field Service mobile app. With Agentic Guided Experience, configure the mobile experience to follow a tailored work completion process. This value is available in API version 65.0 and later. </li> <li class="li"> <samp class="codeph nolang">Agentic Guided Experience Screen Data Flow</samp>—Retrieve records for use throughout AGX Screen and AGX Orchestration flows. This autolaunched flow runs in the background. This value is available in API version 65.0 and later. </li> <li class="li"> <samp class="codeph nolang">Agentic Guided Experience Screen Flow</samp>—A screen flow that can launch from an interactive step on an AGX orchestration flow. This value is available in API version 65.0 and later. </li> <li class="li"> <samp class="codeph nolang">Autolaunched Approval Orchestration</samp>—Launches when invoked by Apex, REST API, custom buttons, or custom links. An approval orchestration lets you create a multi-step, multi-user approval process. </li> <li class="li"> <samp class="codeph nolang">Autolaunched No Trigger Flow</samp>—Launches when invoked by processes or code such as Apex and REST API. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Autolaunched No Trigger Orchestration</samp>—Launches when invoked by Apex, REST API, custom buttons, or custom links. An orchestration lets you create a multi-step, multi-user process. </li> <li class="li"> <samp class="codeph nolang">Automation Event-Triggered Flow</samp>—Launches when invoked by Apex, processes, REST API, and more. This type of flow runs in the background without user interaction. This value is available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Automation Event-Triggered Flow</samp>—Launches when an automation event is received. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Broadcast Flow</samp>—Launches when referenced by Apex, REST API, or subflow element. This value is available in API version 65.0 and later. </li> <li class="li"> <samp class="codeph nolang">Cart Async Autolaunched Flow</samp>—Launches when invoked by a cart change, such as an Add to Cart. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Checkout Screen Flow</samp>—Create a screen flow that implements a Commerce Cloud checkout process. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">CMS Workflow Orchestration Autolaunched</samp>—Launches when invoked from the Workflows component in a CMS workspace. This type of orchestration lets you create a multi-step, multi-user process to create, edit, organize, and manage digital content from a centralized location. </li> <li class="li"> <samp class="codeph nolang">Contact Request Screen Flow</samp>—Launches when invoked by a customer, allowing them to enter contact details into a self-service form. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Customer Lifecycle Record-Triggered After Save Flow</samp>—Launches after a customer lifecycle map is saved and changes records related to the triggering record. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Data Cloud Data Change Flow</samp>—Launches when a record from a Data Cloud data model object or a calculated insight object is changed and meets the specified conditions. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Data Graph-Triggered Flow</samp>—Launches when conditions are met in the specified data graph field. This type of flow runs in the background without user interaction. This value is available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Data Graph-Triggered Flow v0</samp>—Launches when conditions are met in the specified data graph field. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Digital Form Screen Flow</samp>—Launches from app extensions. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Discovery Framework Data Capture Screen Flow (Beta)</samp>—Launches when invoked by a user on a mobile device and presents assessment questions from Discovery Framework. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Employee Service Catalog Item Screen Flow</samp>—Launches when invoked by a user and allows them to browse and order items from the Employee Service Catalog. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Evaluation Autolaunched Flow</samp>—Launches when invoked by an orchestration to evaluate custom criteria for a stage or step. To indicate that the criteria are met, set the output variable <samp class="codeph nolang">isOrchestrationConditionMet</samp> to <samp class="codeph nolang">true</samp>. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Enterprise Scale External System Change-Triggered Flow</samp>—Reserved for future use. </li> <li class="li"> <samp class="codeph nolang">External System Change-Triggered Flow Approval Process</samp>—Launches when data changes in a supported external system. A flow approval process lets you create a multi-step, multi-user approval process. This value is available in API version 65.0 and later. </li> <li class="li"> <samp class="codeph nolang">External System Change-Triggered Orchestration</samp>—Launches when data changes in a supported external system. An orchestration lets you create a multi-step, multi-user process. This value is available in API version 65.0 and later. </li> <li class="li"> <samp class="codeph nolang">External System Change-Triggered Flow</samp>—Launches when an event is received from an external system. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Event-Driven Flow</samp>—Launches when an event is received. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Field Service Mobile Screen Flow</samp>—Launches when invoked by a user in the Field Service mobile app. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Field Service Web Screen Flow</samp>—Launches from the Field Service app and lets users schedule, modify, or cancel an appointment in a web browser. This type of flow requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Form-Triggered Flow</samp>—Launches when a web visitor submits a marketing form. This type of flow runs in the background without user interaction. This value is available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Form-Triggered Flow v0</samp>—Launches when a web visitor submits a marketing form. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Identity User Registration Autolaunched Flow</samp>—Launches when a user logs in via a single sign-on process that uses the authentication provider framework. After the third-party identity provider authenticates the user, the flow creates a user or updates an existing user. This type of flow runs in the background without user interaction. This value is available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Indicator Result Screen Flow</samp>—Launches a screen flow when initiated by a user to calculate and create indicator results for a selected indicator performance period. </li> <li class="li"> <samp class="codeph nolang">Individual-Object Linking Screen Flow</samp>—Launches when invoked by an agent to link a record like a case or messaging session to a contact, lead, person account, or employee. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Login Screen Flow</samp>—Launches when a user tries to log in to Salesforce. This type of flow extends Salesforce's default authentication process by sending users with certain profiles through a flow when they log in and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Loyalty Management Autolaunched Flow</samp>—Launches when invoked by a loyalty program process, and contains Assignment, Decision, and Action elements. The Action element in this type of flow supports Apex and quick actions. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Managed Content Autolaunched Flow</samp>—Launches when invoked by the ManagedContentRelease translator. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Mortgage Lending Screen Flow</samp>—Launches when invoked by a user and allows them to provide Financial Service Cloud mortgage application details. This type of flow requires user interaction. </li> <li class="li"> <samp class="codeph nolang">On-Demand Flow</samp>—Launches when referenced by the REST API. This autolaunched flow runs asynchronously in the background. This value is available in API version 65.0 and later. </li> <li class="li"> <samp class="codeph nolang">Platform Event Triggered Flow</samp>—Launches when a platform event occurs. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Process Builder Autolaunched Process</samp>—Launched when invoked from a Process Builder process. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Process Builder Custom Event Process</samp>—A process created in Process Builder that launches when a custom event message is received. This type of process runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Process Builder Workflow</samp>—Launches when a record is created or updated. This type of process runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Prompt Template Capability-Triggered Flow</samp>—Launches from a prompt template. This type of flow adds prompt instructions to the associated prompt template and runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Recommendation Strategy Autolaunched Flow</samp>—Build a personalized list of recommendations. When a recommendation is selected, it launches its assigned flow. Used by Einstein Next Best Action. Show recommendations in Lightning App Builder with the Einstein Next Best Action component and in Experience Builder with the Suggested Actions component. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered After Save Flow</samp>—Launches after a record is created or updated and has been saved. This type of flow can make changes only to records related to the triggering record and runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered After Save Orchestration</samp>—Launches when a record is created or updated. An orchestration lets you create a multi-step, multi-user process. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered After Save Orchestration</samp>—Launches when a record is created or updated. An orchestration lets you create a multi-step, multi-user process. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered Before Delete Flow</samp>—Launches when a record is deleted. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Record-Triggered Before Save Flow</samp>—Launches after a record is created or updated, but hasn't been saved. This type of flow can make changes only to the triggering record and runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Routing Autolaunched Flow</samp>—Launches when a customer initiates a chat, voice, or messaging conversation and routes the work item to a queue, skill, agent, or bot. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Schedule-Triggered Flow</samp>—Launches at a specified time and frequency for each record that meets the flow criteria. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Scheduler Appointments Screen Flow</samp>—Launches when invoked by a user and lets them schedule appointments in Salesforce Scheduler. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Screen Flow</samp>—Launches from Lightning pages, Experience Cloud sites, quick actions and more. This type of flow collects or displays information and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Segment-Triggered Flow</samp>—Launches when activated or when scheduled for qualified Data Cloud segment members. This type of flow runs in the background without user interaction. This value is available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Segment-Triggered Flow v0</samp>—Launches when activated or when scheduled for qualified Data Cloud segment members. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Survey Enrich Autolaunched Flow</samp>—Launches in the context of a survey response and can't execute without a corresponding survey. Use it to conditionally map a response to a record, create records, or send notifications. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">Survey Screen Flow</samp>—Launches when invoked by an internal or external survey participant. This type of flow saves participant feedback as survey response records and requires user interaction. </li> <li class="li"> <samp class="codeph nolang">Transaction Security Autolaunched Flow</samp>—Used by Condition Builder to declaratively build customized security policies to protect data. This type of flow runs in the background without user interaction. </li> <li class="li"> <samp class="codeph nolang">User Provisioning Screen Flow</samp>—Launches when invoked by a user and allows them to create a user account and link it to a third-party service or app. This type of flow requires user interaction. </li> </ul> This field is available in API version 60.0 and later. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">Id</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">text</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the flow version.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">IsOverridable</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the flow record version is overridable. The default value is <samp class="codeph nolang">false</samp>. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">IsPaused</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the segment-triggered flow is paused (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When the value is <samp class="codeph nolang">true</samp>, no additional records are processed until the flow is resumed. The default value is <samp class="codeph nolang">false</samp>. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">IsTemplate</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the flow record version is a template. Template flow record versions are automatically shared with all users in your Salesforce org. The default value is <samp class="codeph nolang">false</samp>. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">OverriddenById</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the flow that’s overriding the current flow. This field is available in API version 61.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">OverriddenBy</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowRecord</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">OverriddenFlowId</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">text</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the flow that the current flow is overriding. This field is available in API version 61.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">OverriddenFlow</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowRecord</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">PausedDate</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date and time the segment-triggered flow was paused. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">PausingUserId</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the user who paused the segment-triggered flow. This field is available in API version 60.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">PausingUser</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">User</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">ProgressStatus</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The running status of the flow. Valid values are: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">Canceled</samp>— Specifies a flow that was deactivated by a user. The flow doesn’t process previously added records and no additional records are added to this flow. </li> <li class="li"> <samp class="codeph nolang">Completed</samp>— Indicates a flow that is complete. No additional records are eligible to be processed in this flow. </li> <li class="li"> <samp class="codeph nolang">Draft</samp>— Indicates a flow that is under construction and isn’t active yet. This status can be invalid because it needs additional information before a user can activate it. </li> <li class="li"> <samp class="codeph nolang">Error</samp>— Indicates a flow that has been deactivated because it encountered an error. When the error occurs, the error details are emailed to up to 5 users with the Manage Flows permission who most recently logged into Salesforce. </li> <li class="li"> <samp class="codeph nolang">Finishing</samp>— Indicates a flow that was deactivated by a user, but is finishing records previously added that are eligible to run to completion. No additional records are added to this flow. </li> <li class="li"> <samp class="codeph nolang">InProgress</samp>— Indicates a flow that is running or ready to run. </li> <li class="li"> <samp class="codeph nolang">PreparingData</samp>— Indicates a flow that is preparing the resources it requires to run. This process can take up to 2 hours. </li> <li class="li"> <samp class="codeph nolang">Scheduled</samp>— Indicates a flow scheduled to start on the date and time selected by the user. </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">ReasonPaused</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The reason the segment-triggered flow was paused. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">ResumedDate</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date and time the segment-triggered flow resumed. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">ResumingUserId</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the user who resumed the segment-triggered flow. This field is available in API version 60.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">ResumingUser</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">User</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">RunInMode</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The mode that the flow runs in. Valid values are: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">DefaultMode</samp>—The flow record version runs in system or user context, depending on how the flow is launched. </li> <li class="li"> <samp class="codeph nolang">SystemModeWithSharing</samp>—The flow record version always runs in system mode with sharing. The flow respects org-wide default settings, role hierarchies, sharing rules, manual sharing, teams, and territories. But it doesn’t respect object permissions, field-level access, or other permissions of the running user. </li> <li class="li"> <samp class="codeph nolang">SystemModeWithoutSharing</samp>—The flow record version can access all data. In the UI, this value appears as System Context without Sharing—Access All Data. This value is available in API version 49.0 and later. </li> </ul> <p class="p">This field is available in API version 61.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">ScheduledStartDate</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date and time the flow started. This field is available in API version 60.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">SourceTemplateId</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the template from which the current flow was created. This field is available in API version 61.0 and later.</dd> <dd class="dd">This field is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">SourceTemplate</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowRecord</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">Status</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The flow’s status. Valid values are: <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">Active</samp></li> <li class="li"><samp class="codeph nolang">Draft</samp></li> <li class="li"><samp class="codeph nolang">InvalidDraft</samp></li> <li class="li"><samp class="codeph nolang">Obsolete</samp></li> <li class="li"> <samp class="codeph nolang">UnderReview</samp>— This value is available in API version 64.0 and later. </li> </ul> <p class="p">This field is available in API version 61.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">TriggerObjectOrEventLabel</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The label of the object or platform event that triggers this flow. This field is available in API version 61.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d960718e89" data-title="Field Name"><span class="keyword parmname">VersionNumber</span></td> <td class="entry" headers="d960718e92" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The version number of the flow version.</dd> </dl> </td> </tr> </tbody> </table> <!-- document id=9a5665c0622aa0728406e5afe7d51001f652dd069cec2d3b376768661e0cc777 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowrecordversionoccurrence.md --> # FlowRecordVersionOccurrence Represents an instance of a recurring flow that runs on a schedule. For example, a flow that runs weekly on Wednesdays creates an occurrence each time it runs. This object is available in API version 60.0 and later. ## Supported Calls describe(), read() ## Fields | Field | Details | | --- | --- | | DataSpaceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the data space for this occurence. This field is available in API version 65.0 and later. This field is a relationship field. Relationship Name DataSpace Refers To DataSpace | | Entries | Type integer Properties Filter, Group, Query, Retrieve, Sort Description The number of entries for this occurrence. | | Errors | Type integer Properties Filter, Group, Query, Retrieve, Sort Description The number of errors for this occurrence. | | ErrorDetail | Type string Properties Filter, Group, Nillable, Sort Description A description of the error. This field is available in API version 63.0 and later. | | Exits | Type integer Properties Filter, Group, Query, Retrieve, Sort Description The number of exits for this occurrence. | | FlowRecordId | Type string Properties Filter, Group, Query, Retrieve, Sort Description The ID of the associated flow record. | | FlowRecordVersionId | Type string Properties Filter, Group, Query, Retrieve, Sort Description The ID of the associated version of the flow record. | | ProgressStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The running status of the flow interview. Valid values are: - Canceled Specifies a flow interview that was deactivated by a user. The flow doesn’t process previously added records and no additional records are added to this flow. - Completed Indicates a flow interview that is complete. No additional records are eligible to be processed in this flow. - Error Indicates a flow interview that has been deactivated because it encountered an error. When the error occurs, the error details are emailed to up to 5 users with the Manage Flows permission who most recently logged into Salesforce. - Finishing Indicates a flow interview that was deactivated by a user, but is finishing records previously added that are eligible to run to completion. No additional records are added to this flow. - InProgress Indicates a flow interview that is running or ready to run. - PreparingData Indicates a flow interview that is preparing the resources it requires to run. This process can take up to 2 hours. | | ScheduledDate | Type dateTime Properties Filter, Group, Query, Retrieve, Sort Description The scheduled time and date of the occurrence. | | Stopped | Type integer Properties Filter, Group, Query, Retrieve, Sort Description The number of flows that were stopped for this occurrence. | <!-- document id=b6adb2983f608b6f864713ef75c9cf9fa1336a610b607f81d564eff0c3814b94 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowstagerelation.md --> # FlowStageRelation Represents a relationship between a paused flow interview and its stages. When a flow interview is paused, Salesforce creates a FlowStageRelation record for each stage that’s set to the $Flow.CurrentStage or $Flow.ActiveStages global variable. Available in API version 43.0 and later. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated ID of this relation. | | ParentId | Type reference Properties Filter, Group, Sort Description The flow interview that the record is related to. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To FlowInterview | | StageLabel | Type string Properties Filter, Nillable, Sort Description Label for the stage. If the stage is translated, the label respects the language of the user who is querying the label. | | StageOrder | Type int Properties Filter, Group, Sort Description The order of this stage when the flow interview was paused. This order may differ from the order in the stage definition. - If the type is Active, the order corresponds to the order of the stage in $Flow.ActiveStages. - If the type is Current and corresponds to an active stage, the order matches the order of the active stage. - If the type is Current and doesn't correspond to an active stage, the order is 0. | | StageType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Type of stage. The valid values are: - Current: Identifies that the stage is set to $Flow.CurrentStage. - Active: Identifies that the stage is set to $Flow.ActiveStages. | ## Usage You can use the FlowStageRelation records to represent the paused interview and its active and current stages visually. For example, an Online Purchasing flow interview starts with several stages in $Flow.ActiveStages. If the interview is paused, Salesforce creates a FlowStageRelation record for each stage in $Flow.ActiveStages or $Flow.CurrentStage. | StageLabel | StageType | StageOrder | | --- | --- | --- | | Review Cart | Active | 0 | | Shipping Details | Active | 1 | | Billing Details | Active | 2 | | Payment Details | Active | 3 | | Order Confirmation | Active | 4 | | Shipping Details | Current | 1 | <!-- document id=13a3c658ae31fcf42d78d9ba4623b800a58a5e9ac96fa89206ad5f5a24f625f3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowtestresult.md --> # FlowTestResult Represents the results for a flow test associated with a flow version. This object is available in API version 55.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To view test run details, you must have the View All Data user permission. You can view flow tests and test results without the View All Data permission. ## Fields | Field | Details | | --- | --- | | Error | Type string Properties Filter, Nillable, Sort Description The run-time error from the last test scenario run, if one occurred. This field is available in API version 68.0 and later. | | FailedAssertions | Type string Properties Filter, Nillable, Sort Description The failed assertions from the last test scenario run. This field is available in API version 68.0 and later. | | FlowDefinitionViewId | Type string Properties Filter, Nillable, Sort Description The ID of the flow definition associated with the flow test result. This is a relationship field. Relationship Name FlowDefinitionView Relationship Type Lookup Refers To FlowDefinitionView | | FlowTestViewId | Type string Properties Filter, Nillable, Sort Description The ID of the flow test associated with the flow test result. This is a relationship field. Relationship Name FlowTestView Relationship Type Lookup Refers To FlowTestView | | FlowVersionNumber | Type int Properties Filter, Group, Nillable, Sort Description The version number for the flow. | | FlowVersionViewId | Type string Properties Filter, Nillable, Sort Description The ID of the flow version associated with the flow test result. This is a relationship field. Relationship Name FlowVersionView Relationship Type Lookup Refers To FlowVersionView | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the flow test result. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user who owns this test result. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Result | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the flow test result. Possible values are: - Error - Fail - Pass - Skip—The test run was skipped because the test doesn’t exist for that flow version. This value appears only when you trigger tests by using Salesforce CLI. This value is available in API version 66.0 and later. | | TestEndDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the flow test ended. | | TestStartDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the flow test started. | ## 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. [FlowTestResultShare](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. <!-- document id=ffee329765eab82a97a538a0c66a29679e6d8b8b6d529557d8c64400a653ce40 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowtestview.md --> # FlowTestView Represents the description of a flow test associated with a flow definition. This object is available in API version 55.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Nillable Description The description of the flow test associated with the flow test view. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description The ID of the flow test associated with this flow test view. | | FlowDefinitionViewId | Type string Properties Filter, Nillable, Sort Description The ID of the flow definition associated with the flow test view. This is a relationship field. Relationship Name FlowDefinitionView Relationship Type Lookup Refers To FlowDefinitionView | | FlowTestApiName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the flow test associated with the flow test view. | | FlowTestLabel | Type string Properties Filter, Group, Nillable, Sort Description The label of the flow test associated with the flow test view. | <!-- document id=878f668b8cb688cb63f29cc0ed2596a513a18368c0d89ff489c22df953569182 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowvariableview.md --> # FlowVariableView Represents a variable within the flow version. This object is available in API version 46.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the flow variable. | | DataType | Type string Properties Filter, Group, Nillable, Sort Description The data type of the flow variable. Valid values are: - Apex—This value is available in API version 46.0 and later. - Boolean - Currency - Date - DateTime—This value is available in API version 30.0 and later. - Number - Multipicklist—This value is available in API version 34.0 and later. - Picklist—This value is available in API version 34.0 and later. - String - sObject | | Description | Type string Properties Filter, Group, Nillable, Sort Description Flow variable information, specified by the org’s admin. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description The Id of the flow variable. | | FlowVersionViewId | Type string Properties Filter, Nillable, Sort Description The Id of the flow version. This is a relationship field. Relationship Name FlowVersionView Relationship Type Lookup Refers To FlowVersionView | | IsCollection | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether or not the flow variable is a collection of values. | | IsInput | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicated whether or not the flow variable is available for input. | | IsOutput | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether or not the flow variable is available for output. | | ObjectType | Type string Properties Filter, Group, Nillable, Sort Description If the data type is sObject, this field indicates which object. | ## Usage Use this object to query information about flow variables. A query must be filtered by FlowVersionViewId to get results. Only variables with IsInput or IsOutput marked as true are visible. <!-- document id=414e535715a8189bd337f7810c282346daa1179e0b3846529eb98f540027ee30 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_flowversionview.md --> # FlowVersionView Represents the version of a flow definition. This object is available in API version 46.0 and later. ## Supported Calls describeSObjects(), query() ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d968639e73">Field</th> <th class="featureTableHeader " id="d968639e76">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">ApiVersion</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The API version for the flow definition. Every flow version has an API version specified at creation.<p class="p">This field is available in API version 50.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">ApiVersionRuntime</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">double</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The API version for running the flow. This value determines which versioned run-time behavior improvements are adopted by the flow version.<p class="p">If not specified when the flow or flow version is created, the latest available API version is used as the API version for running the flow. When an existing flow is saved as a new flow or flow version, the existing flow’s run-time API version is used in the new flow or flow version.</p> <p class="p">This field is available in API version 50.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">AreMetricsLoggedToDataCloud</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <a name="dl_y1k_cx1_ndc"><!-- --></a> <dl class="dl detailList" id="dl_y1k_cx1_ndc"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether this flow’s metrics are logged in Data Cloud. The default value is false. This field is available in API version 63.0 and later. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">CapabilityType</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The capability that integrates with the flow. An example value is <samp class="codeph nolang">PromptTemplateType://SalesEmail</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">CapacityCategory</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The category that determines the usage limits of the flow. Possible values are:<ul class="ul bulletList"> <li class="li">Marketing Cloud Flow</li> </ul> </dd> </dl> <p class="p">This field is available in API version 62.0 and later.</p> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">Description</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Flow version information, specified by the org’s admin.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">DurableId</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the flow version.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">FlowDefinitionViewId</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the flow definition.</dd> <dd class="dd">This field s a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">FlowDefinitionView</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">FlowDefinitionView</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">IsSwingFlow</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <a name="dl_rgk_kmz_4dc"><!-- --></a> <dl class="dl detailList" id="dl_rgk_kmz_4dc"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the flow is built with Desktop Flow Designer. <p class="p">This field is available in API version 49.0 and later.</p> <p class="p">Default: false</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">IsTemplate</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the process or flow is a template. When installed from managed packages, processes and flows can’t be viewed or cloned by subscribers because of intellectual property (IP) protection. But when those processes and flows are templates, subscribers can open them in a builder, clone them, and customize the clones. Available in API version 46.0 and later.<p class="p">Default: false</p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">Label</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The label of the flow version.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">ProcessType</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of the flow. Valid values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">ActionableEventManagementFlow</samp>—A flow that triggers an actionable event orchestration process in the background and automatically executes different types of actions based on the event type. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang">ActionCadenceAutolaunchedFlow</samp>—A flow executed when a user completes a cadence step. This value is available in API version 56.0 and later. </li> <li class="li"> <samp class="codeph nolang">ActionCadenceStepFlow</samp>—A screen flow used as a cadence step. This value is available in API version 56.0 and later. </li> <li class="li"> <samp class="codeph nolang">ActivityObjectMatchingFlow</samp>—A flow that launches when Einstein Activity Capture detects and captures a new activity, such as an email. This type of flow runs in the background without user interaction. This value is available with Sync Email as Salesforce Activity in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">Appointments</samp>—A flow for Lightning Scheduler. This value is available in API version 44.0 and later. </li> <li class="li"> <samp class="codeph nolang">ActivityObjectMatchingFlow</samp>—A flow that launches when Einstein Activity Capture detects and captures a new activity, such as an email. This type of flow runs in the background without user interaction. This value is available with Sync Email as Salesforce Activity in API version 63.0 and later. </li> <li class="li"> <samp class="codeph nolang">ApprovalWorkflow</samp>—An orchestration for approvals. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang" id="processtype_autolaunched"><a name="processtype_autolaunched"><!-- --></a>AutoLaunchedFlow</samp>—A flow that doesn’t require user interaction. </li> <li class="li"> <samp class="codeph nolang">CheckoutFlow</samp>—A flow used in Lightning B2B Commerce to create a checkout in a store. This value is available in API version 48.0 and later. </li> <li class="li"> <samp class="codeph nolang">ContactRequestFlow</samp>—A flow that lets customers request that customer support get back to them. This flow is used to create contact request records. This value is available in API version 45.0 and later. </li> <li class="li"> <samp class="codeph nolang">CustomerLifecycle</samp>—A Salesforce Surveys flow that lets you associate survey questions with different stages in customer lifecycles. This value is available in API version 49.0 and later and only when the Customer Lifecycle Designer license is enabled. </li> <li class="li"> <samp class="codeph nolang">CustomEvent</samp>—A process that is invoked when it receives a platform event message. In the UI, it’s an event process. This value is available in API version 41.0 and later. </li> <li class="li"> <samp class="codeph nolang">DataCaptureFlow</samp>—A flow that configures the Form tab on Work Order Overview or the related list for a service appointment or a work order line item. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang">DcvrFrameworkDataCaptureFlow</samp>—A screen flow that presents assessment questions from Discovery Framework. Launches when invoked by a user on a mobile device. This type of flow collects or displays information, requires user interaction, and works offline or online. This value is available in API version 62.0 and later. </li> <li class="li"> <samp class="codeph nolang">FieldServiceMobile</samp>—A flow for the Field Service mobile app. This value is available in API version 39.0 and later. </li> <li class="li"> <samp class="codeph nolang">FieldServiceWeb</samp>—A flow for embedded Appointment Booking. Its UI label is Field Service Embedded Flow. This value is available in API version 41.0 and later. </li> <li class="li"> <samp class="codeph nolang" id="processtype_flow"><a name="processtype_flow"><!-- --></a>Flow</samp>—A flow that requires user interaction because it contains one or more screens or local actions, choices, or dynamic choices. In the UI and Salesforce Help, it’s a screen flow. Screen flows can be launched from the UI, such as with a flow action, Lightning page, or web tab. </li> <li class="li"><span class="ph" id="enumprocesstype_fsclending"><a name="enumprocesstype_fsclending"><!-- --></a><samp class="codeph nolang" id="processtype_fsclending"><a name="processtype_fsclending"><!-- --></a>FSCLending</samp>—A flow for Financial Services Cloud Mortgage. This value is available in API version 46.0 and later.</span></li> <li class="li"> <samp class="codeph nolang">IdentityUserRegistrationFlow</samp>—A flow to handle user registration and updates for single sign-on with the authentication provider framework. Available in API version 64.0 and later. </li> <li class="li"> <samp class="codeph nolang">IndicatorResultFlow</samp>—A flow for Outcome Management that calculates and creates indicator results for a selected indicator performance period. This value is available with the Outcome Management license in API version 60.0 and later. </li> <li class="li"> <samp class="codeph nolang">IndividualObjectLinkingFlow</samp>—A screen flow that helps search for contacts, leads, person accounts, and employees and links them to support interactions. This value is available in API version 58.0 and later. </li> <li class="li"> <samp class="codeph nolang">InvocableProcess</samp>—A process that can be invoked by another process or the Invocable Actions resource in REST API. This value is available in API version 38.0 and later. </li> <li class="li"> <samp class="codeph nolang">LoyaltyManagementFlow</samp>—A flow for the Loyalty Management app and can be invoked by loyalty program processes. This value is available in API version 54.0 and later. </li> <li class="li"> <samp class="codeph nolang">PromptFlow</samp>—A flow for Prompt Builder. Pass data between Prompt Builder and the flow. This value is available in API version 60.0 and later. </li> <li class="li"> <samp class="codeph nolang">RoutingFlow</samp>—A flow for Salesforce Omni-Channel routing and other business logic. This value is available in API version 52.0 and later. </li> <li class="li"> <samp class="codeph nolang">StageManagementEvaluationFlow</samp>—A flow for evaluating custom criteria for a stage or step in Stage Management. This value is available in API version 63.0 and later. </li> <li class="li"> <samp class="codeph nolang">Survey</samp>—A flow for Salesforce Surveys. From the UI, this type of flow is created in Survey Builder. This value is available in API version 42.0 and later. </li> <li class="li"> <samp class="codeph nolang">SurveyEnrich</samp>—A Salesforce Surveys flow that uses the Survey Data Mapper. From the UI, this type of flow is created in the Survey Builder and requires an associated survey flow type. This value is available in API version 49.0 or later and only when the Customer Lifecycle Designer license is enabled. </li> <li class="li"> <samp class="codeph nolang">Workflow</samp>—A process that is invoked when a record is created or edited. In the UI and Salesforce Help, it’s a record change process. </li> </ul> <p class="p">These values are reserved for future use.</p> <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">ActionCadenceFlow</samp></li> <li class="li"><samp class="codeph nolang">ActionPlan</samp></li> <li class="li"><samp class="codeph nolang">ActivitySmartMatchingFlow</samp></li> <li class="li"><samp class="codeph nolang">AppProcess</samp></li> <li class="li"><samp class="codeph nolang">CartAsyncFlow</samp></li> <li class="li"><samp class="codeph nolang">DigitalForm</samp></li> <li class="li"><samp class="codeph nolang">Journey</samp></li> <li class="li"><samp class="codeph nolang">JourneyBuilderIntegration</samp></li> <li class="li"><samp class="codeph nolang" id="flow_process_loginflow"><a name="flow_process_loginflow"><!-- --></a>LoginFlow</samp></li> <li class="li"><samp class="codeph nolang">ManagedContentFlow</samp></li> <li class="li"><samp class="codeph nolang">OrchestrationFlow</samp></li> <li class="li"><samp class="codeph nolang">RecommendationStrategy</samp></li> <li class="li"><samp class="codeph nolang">SalesEntryExperienceFlow</samp></li> <li class="li"><samp class="codeph nolang">TransactionSecurityFlow</samp></li> <li class="li"><samp class="codeph nolang">UserProvisioningFlow</samp></li> </ul> <p class="p">This value has significant impact on validation when saving the flow and on the flow’s runtime behavior. Don’t change this value unless you understand the flow properties of the specified type.</p> </dd> </dl> <p class="p">Across flow versions, you can change the type only from <samp class="codeph nolang">Flow</samp> to <samp class="codeph nolang">AutoLaunchedFlow</samp> or vice versa. Before you change the flow type, make sure that the flow contains only elements, resources, and functionality that the new flow type supports.</p> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">RunInMode</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The mode that the flow runs in. Valid values are:<ul class="ul bulletList"> <li class="li">DefaultMode — The flow version runs in system or user context, depending on how the flow is launched.</li> <li class="li">SystemModeWithSharing — The flow version always runs in system mode with sharing. The flow respects org-wide default settings, role hierarchies, sharing rules, manual sharing, teams, and territories. But it doesn’t respect object permissions, field-level access, or other permissions of the running user. </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">Status</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The flow’s status.<ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">Active</samp></li> <li class="li"><samp class="codeph nolang">Draft</samp></li> <li class="li"><samp class="codeph nolang">Obsolete</samp></li> <li class="li"><samp class="codeph nolang">InvalidDraft</samp></li> <li class="li"><samp class="codeph nolang">UnderReview</samp></li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d968639e73" data-title="Field"><span class="keyword parmname">VersionNumber</span></td> <td class="entry" headers="d968639e76" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The flow’s version number.</dd> </dl> </td> </tr> </tbody> </table> ## Usage Use this object to query information about flow versions. A query must be filtered by DurableId or FlowDefinitionViewId to get results. <!-- document id=a1530145c43caaaaddd4f7ec4111a2f1a0d0011dba47ac0292401efadf6c46aa url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_folder.md --> # Folder Represents a repository for a Dashboard, Document, EmailTemplate, Macro, QuickText, or Report. Only one type of item can be contained in a folder. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules - You must have the “Modify All Data” permission to create, update, or delete document folders and email template folders. - Guest and Customer Portal users can’t access this object. - To query this object, no special permissions are needed. - As of API version 35.0, when a folder is shared with a role, it is only visible to users in that role. Superior roles in the role hierarchy don’t gain visibility. - If analytics folder sharing is turned on, then users need these permissions to create and manage report folders and dashboard folders: - “Create Dashboard Folders” - “Create Report Folders” - To use folders for macros and quick text, enable folders for these objects in Setup on the Macro Settings and Quick Text Settings pages. ## Fields | Field | Details | | --- | --- | | AccessType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Indicates who can access the Folder. Available values include: - Hidden—Folder is hidden from everyone. - Public—Folder is accessible by all users. - Shared—Folder is accessible only by a User in a particular Group or UserRole. The API doesn’t allow you to view, insert, or update which group or Role the Folder is shared with. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If analytics folder sharing is turned on for your organization, then this field is present but not used. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, 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 org. 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 **Folder Unique Name**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | IsReadonly | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this Folder is read-only (true) or editable (false). Label is Read Only. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If analytics folder sharing is turned on for your organization, then this field is present but not used. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the folder as it appears in the user interface. Label is **Document Folder Label**. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the parent object, if any. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Required. Type of objects contained in the Folder. This field can’t be updated. Available values include: - Dashboard - Document - Email (for Salesforce Classic email templates) - EmailTemplate (for Lightning email templates) - Macro - QuickText - Report | ## Usage Only one type of item can be contained in a folder, either Dashboard, Document, EmailTemplate, Macro, QuickText, or Report. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=62f24b72660c41a36745fb1e12d7dc28f0dae0b6ebf11f5863042921311d6351 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_folderedcontentdocument.md --> # FolderedContentDocument Represents the relationship between a parent and child ContentFolderItem in a ContentWorkspace. ## Supported Calls describeSObjects() ## Fields | Field Name | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Sort Description ID of the ContentDocument that can be in a folder. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | ContentSize | Type int Properties Filter, Group, Nillable, Sort Description The size of the document in bytes for files smaller than 2 GB. In API version 66.0 and later, we recommend that you use the ContentSizeLong field even for documents smaller than 2 GB. | | ContentSizeLong | Type long Properties Filter, Group, Nillable, Sort Description The size of the document in bytes up to 10 GB. This field is available in API version 66.0 and later. | | FileExtension | Type string Properties Filter, Group, Nillable, Sort Description File extension of the ContentDocument. | | FileType | Type string Properties Filter, Group, Nillable, Sort Description File type of the ContentDocument. | | IsFolder | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the FolderedContentDocument is a folder, rather than a file. | | ParentContentFolderId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the ContentFoldr the ContentDocument resides in. This is a relationship field. Relationship Name ParentContentFolder Relationship Type Lookup Refers To ContentFolder | | Title | Type string Properties Filter, Group, idLookup, Sort Description Name of the file or folder in a ContentFolder. | <!-- document id=df5f0d4c160591b500ef73c7235bbfe29dcdfd1d4f967ce0d3455a98b80db709 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingadjustment.md --> # ForecastingAdjustment This object represents an individual forecast manager’s adjustment for a subordinate’s or child territory’s forecast via a ForecastingItem. Available in API versions 26.0 and later. This object is different from the ForecastingOwnerAdjustment object, which represents forecast users’ adjustments of their _own_ forecasts, including territory forecasts they own. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | AdjustedAmount | Type double Properties Create, Filter, Sort, Update Description The revenue amount of an individual forecast item, after an adjustment. | | AdjustedQuantity | Type double Properties Create, Filter, Sort, Update Description The quantity amount of an individual forecast item, after an adjustment. This field is available in API version 28.0 and later. | | AdjustmentNote | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A text note providing information about the adjustment. The maximum length is 255 characters. This field doesn’t appear in reports. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The currency code of the adjustment. If omitted, the default is the user’s personal currency. | | ForecastCategoryName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The category within the sales cycle that an opportunity is assigned to based on its opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit, Omitted, and Closed. You can add a Most Likely category and can customize forecast category names in single category rollups. The forecast categories display information for that specific category; for example, Best Case only reflects amounts in the Best Case category. | | ForecastingGroupItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If a forecast group is assigned to the forecast type, the ID of the group value that the manager adjustment belongs to. This field is a relationship field. Available in API version 60.0 and later. Relationship Name ForecastingGroupItem Relationship Type Lookup Refers To ForecastingGroupItem | | ForecastingItemCategory | Type picklist Properties Create, Filter, Group, Sort Description The category the forecast belongs to. For individual forecast category rollups, the possible values are: - PipelineOnly—Rollup from Pipeline opportunities only. - BestCaseOnly—Rollup from Best Case opportunities only. The value in this category is adjustable. - MostLikelyOnly—Rollup from Most Likely opportunities only. The value in this category is adjustable. - CommitOnly—Rollup from Commit opportunities only. The value in this category is adjustable. For cumulative forecast rollups, the possible values are: - OpenPipeline—Rollup from Pipeline, Best Case, Most Likely, and Commit opportunities. - BestCaseForecast—Rollup from Best Case, Most Likely, Commit, and Closed opportunities. The value in this category is adjustable. - MostLikelyForecast—Rollup from Most Likely, Commit, and Closed opportunities. The value in this category is adjustable. - CommitForecast—Rollup from Commit and Closed opportunities. The value in this category is adjustable. For either cumulative or individual forecast category rollups, the possible values are: - ClosedOnly —Rollup from Closed opportunities only. | | ForecastingItemId | Type reference Properties Filter, Group, Sort Description The ID of the related ForecastingItem. | | ForecastingTypeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related ForecastingType. | | IsAmount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a revenue amount. If false, then IsQuantity must be true. This field is available in API version 28.0 and later. | | IsQuantity | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a quantity amount. If false, then IsAmount must be true. This field is available in API version 28.0 and later. | | OwnerId | Type reference Properties Create,Defaulted on create, Filter, Group, Sort Description The ID of the forecast owner. | | PeriodId | Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the adjustment. Read only. | | ProductFamily | Type picklist Properties Create, Filter, Group, Nillable, Sort Description The Product Family for the adjustment. Read only. This field is available in API version 29.0 and later. | | StartDate | Type date Properties Create, Filter, Group, Sort Description The start of the adjustment, expressed as month and year. The date can include any day in a given month. Stored using the first date of the month. | | Territory2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the territory to forecast on. Available in API version 43.0 and later. | ## Usage Use this object to obtain a manager’s adjustment detail for a specified ForecastingItem. The ForecastingAdjustment object is visible to all users, but only forecast managers and users above them in the forecast hierarchy can read or write ForecastingAdjustment records. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary. The ForecastingItemCategory field differs from the ForecastCategoryName field. - The ForecastCategoryName field represents the forecast category of the _underlying opportunities_ rolling up to forecast amounts. In organizations using cumulative forecast rollups, the ForecastCategoryName field can be null because the cumulative forecast amounts include opportunities from multiple forecast categories. - The new ForecastingItemCategory field represents the _type of rollup_ a forecast amount or adjustment is from. In organizations using individual forecast category columns, it contains the individual forecast rollup categories. In organizations using cumulative forecast rollups, it contains the cumulative rollup categories. When inserting manager adjustments, the values you insert for ForecastCategoryName and ForecastingItemCategory must be compatible with each other. In organizations using cumulative forecast rollups, the ForecastCategoryName is nillable. The following pairs are valid. For individual forecast category rollups: - ForecastCategoryName: BestCase, ForecastingItemCategory: BestCaseOnly - ForecastCategoryName: MostLikely, ForecastingItemCategory: MostLikelyOnly - ForecastCategoryName: Commit, ForecastingItemCategory: CommitOnly For cumulative forecast category rollups: - ForecastCategoryName: null, ForecastingItemCategory: BestCaseForecast - ForecastCategoryName: null, ForecastingItemCategory: MostLikelyForecast - ForecastCategoryName: null, ForecastingItemCategory: CommitForecast #### See Also - [ForecastingFact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingfact.htm "This object is read-only and links a ForecastingItem with its opportunities, such as opportunities that share the same owner or forecast category and have a closing date within the period of the forecasting item. Available in API versions 26 and greater.") - [ForecastingItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingitem.htm "This object is read-only used for individual forecast amounts. Users see amounts based on their perspectives and forecast roles. The amounts users see include one of these values when forecasting in revenue: AmountWithoutAdjustments, AmountWithoutManagerAdjustment, ForecastAmount, OwnerOnlyAmount. The amounts users see include one of these values when forecasting in quantity: QuantityWithoutAdjustments, QuantityWithoutManagerAdjustment, ForecastQuantity, OwnerOnlyQuantity. Available in API version 26.0 and later.") - [ForecastingQuota](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingquota.htm "This object represents an individual user’s or territory’s quota for a specified time period. The Managed Quotas user permission is required for creating, updating, or deleting quotas. (Users can only edit their subordinates’ or child territories’ quotas, not their own.) The View All Forecasts permission is required to view any user's forecast, regardless of the forecast hierarchy. Available in API versions 25.0 and later. Forecast managers can view the forecasts of subordinates and territories below them in the forecast hierarchy.") <!-- document id=844f11acdd6be8cab5b14ecd18221fb3046aeac6f128aa106da256f46eba5daa url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingcolumndefinition.md --> # ForecastingColumnDefinition Represents a custom calculated column or a custom reference data column in a forecast type. This object is available in API version 56.0 and later. For a custom calculated column, a Formula field value is required. For a custom reference data column, a ReferenceField field value is required. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer (API) name of the custom calculated column or custom reference data column. | | ForecastingTypeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the forecast type. This field is a relationship field. Relationship Name ForecastingType Relationship Type Lookup Refers To ForecastingType | | Formula | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required for custom calculated columns. The formula for the custom calculated column. Use API column names in your formula (such as ForecastAmount0), not column header names (such as Closed or Closed Only). For details on API column names, operators, and functions to use in formulas, see [ForecastingColumnDefinition Formula Field Details](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingcolumndefinition_formula_details.htm "Use these API names, operators, and functions to construct formulas for the Formula field in the ForecastingColumnDefinition object. The API names apply to both singular and cumulative category rollups. For simplification, we included only the single category rollup column header name next to each API name."). Example The following formula calculates the gap to quota: ForecastingQuotaAmount - ForecastAmount0 | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the custom calculated column or custom reference data column. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for this object, which displays in Setup and in the column header on the forecasts page. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en\_US. | | ReferenceField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required for custom reference data columns. The number or currency custom field from the ForecastingCustomData object. For example, ForecastingCustomData.Realized\_Revenue\_\_c. Data from this field appears in a column in the forecasts summary. This field is available in API version 58.0 and later. | | ResultField | Type string Properties Create, Filter, Group, Sort, Update Description The field name to represent the custom calculated column or custom reference data column result. Possible values are: **Custom Calculated Column Result** - CalculatedAmount0 or CalculatedQuantity0 - CalculatedAmount1 or CalculatedQuantity1 - CalculatedAmount2 or CalculatedQuantity2 - CalculatedAmount3 or CalculatedQuantity3 - CalculatedAmount4 or CalculatedQuantity4 If the formula’s result is null or invalid, “-” is the value. For example, if the formula divided by 0. If you want to show “-” for 0 or negative values in your forecast, use the IF function in your formula to detect 0 or negative numbers. **Custom Reference Data Column Result** Use the appropriate field based on whether your column output is of Currency or Number type. - ExtensionCurrency0 or ExtensionNumber0 - ExtensionCurrency1 or ExtensionNumber1 - ExtensionCurrency2 or ExtensionNumber2 - ExtensionCurrency3 or ExtensionNumber3 - ExtensionCurrency4 or ExtensionNumber4 | ## Usage Each forecast type can include any combination of custom calculated columns and reference data columns, as long as they don’t exceed five in number. For example, a forecast type can have two custom calculated columns and three custom reference data columns. Custom calculated columns can’t be adjusted and aren’t included in rollups. In the UI, custom calculated columns can’t indicate changes in the last 7 days. If you have at least one custom calculated column in an active or inactive forecast type, you can’t do the following until you’ve removed the column. - Switch from single category to cumulative rollups in Forecast Settings - Enable the Most Likely category - Disable Show Quotas (only if your custom calculated column’s formula refers to a quota value) - **[ForecastingColumnDefinition Formula Field Details](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingcolumndefinition_formula_details.htm)** Use these API names, operators, and functions to construct formulas for the Formula field in the ForecastingColumnDefinition object. The API names apply to both singular and cumulative category rollups. For simplification, we included only the single category rollup column header name next to each API name. <!-- document id=d472b855b536d84b4e68d79c62589a28debdc091a9379c94e6e40fa4c4d464d0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingcolumndefinition_formula_details.md --> # ForecastingColumnDefinition Formula Field Details Use these API names, operators, and functions to construct formulas for the Formula field in the ForecastingColumnDefinition object. The API names apply to both singular and cumulative category rollups. For simplification, we included only the single category rollup column header name next to each API name. **API Column Names – General** - ForecastingQuotaAmount – Quota (currency) - ForecastingQuotaQuantity – Quota quantity (double) - DeveloperName of any custom calculated column or custom reference data column shown in the forecasts page **API Column Names for Forecast Category Columns** If the Most Likely category isn’t enabled: - ForecastAmount0 or ForecastQuantity0 – Closed - ForecastAmount1 or ForecastQuantity1 – Commit - ForecastAmount2 or ForecastQuantity2 – Best Case - ForecastAmount3 or ForecastQuantity3 – Pipeline If the Most Likely category is enabled: - ForecastAmount0 or ForecastQuantity0 – Closed - ForecastAmount1 or ForecastQuantity1 – Commit - ForecastAmount2 or ForecastQuantity2 – Most Likely - ForecastAmount3 or ForecastQuantity3 – Best Case - ForecastAmount4 or ForecastQuantity4 – Pipeline **API Column Names for Adjustment Columns – Original Forecast Value Without Adjustments** If your org shows adjustments in columns, use these API column names for the original forecast value without adjustments. Adjustment columns are available in API version 60.0 and later. If the Most Likely category isn’t enabled: - AmountWithoutAdjustments1 or QuantityWithoutAdjustments1 – Commit - AmountWithoutAdjustments2 or QuantityWithoutAdjustments2 – Best Case If the Most Likely category is enabled: - AmountWithoutAdjustments1 or QuantityWithoutAdjustments1 – Commit - AmountWithoutAdjustments2 or QuantityWithoutAdjustments2 – Most Likely - AmountWithoutAdjustments3 or QuantityWithoutAdjustments3 – Best Case **API Column Names for Adjustment Columns – Team Adjustment Value** If your org shows adjustments in columns, use these API column names for the team’s adjusted value that includes a subordinate’s owner and manager adjustments, but not a forecast manager’s owner and manager adjustments. These adjustment columns are available in API version 61.0 and later. If the Most Likely category isn’t enabled: - SubordinateOverrideAmount1 or SubordinateOverrideQuantity1 - Commit - SubordinateOverrideAmount2 or SubordinateOverrideQuantity2 - Best Case If the Most Likely category is enabled: - SubordinateOverrideAmount1 or SubordinateOverrideQuantity1 - Commit - SubordinateOverrideAmount2 or SubordinateOverrideQuantity2 - Most Likely - SubordinateOverrideAmount3 or SubordinateOverrideQuantity3 - Best Case Use these API column names for the team’s adjusted value that includes owner adjustments without manager adjustments. The adjustment value includes a subordinate’s manager adjustments that they made. These adjustment columns are available in API version 60.0 and later. If the Most Likely category isn’t enabled: - AmountWithoutManagerAdjustment1 or QuantityWithoutManagerAdjustment1 – Commit - AmountWithoutManagerAdjustment2 or QuantityWithoutManagerAdjustment2 – Best Case If the Most Likely category is enabled: - AmountWithoutManagerAdjustment1 or QuantityWithoutManagerAdjustment1 – Commit - AmountWithoutManagerAdjustment2 or QuantityWithoutManagerAdjustment2 – Most Likely - AmountWithoutManagerAdjustment3 or QuantityWithoutManagerAdjustment3 – Best Case **API Column Names for Adjustment Columns – My Adjusted Value** The column that represents the adjusted value from the forecast user viewing the page is the same as the API column name for the standard forecast category. Adjustment columns are available in API version 60.0 and later. If the Most Likely category isn’t enabled: - ForecastAmount1 or ForecastQuantity1 – My Commit - ForecastAmount2 or ForecastQuantity2 – My Best Case If the Most Likely category is enabled: - ForecastAmount1 or ForecastQuantity1 – My Commit - ForecastAmount2 or ForecastQuantity2 – My Most Likely - ForecastAmount3 or ForecastQuantity3 – My Best Case **API Column Names for Custom Reference Data** Use the appropriate field based on whether the custom reference data is of Currency or Number type. - ExtensionCurrency0 - ExtensionCurrency1 - ExtensionCurrency2 - ExtensionCurrency3 - ExtensionCurrency4 - ExtensionNumber0 - ExtensionNumber1 - ExtensionNumber2 - ExtensionNumber3 - ExtensionNumber4 **Supported Math Operators** - \+ (Add) – Calculates the sum of two values. - \- (Subtract) – Calculates the difference of two values. - \* (Multiply) – Multiplies its values. - / (Divide) – Divides its values. - () (Open Parenthesis and Closed Parenthesis) – Specifies that the expressions within the open parenthesis and close parenthesis are evaluated first. All other expressions are evaluated using standard operator precedence. **Supported Logical Operators** - \= and == (Equal) – Evaluates if two values are equivalent. The = and == operators are interchangeable. - <> and != (Not Equal) – Evaluates if two values aren’t equivalent. - < (Less Than) – Evaluates if a value is less than the value that follows this symbol. - \> (Greater Than) – Evaluates if a value is greater than the value that follows this symbol. - <= (Less Than or Equal) – Evaluates if a value is less than or equal to the value that follows this symbol. - \>= (Greater Than or Equal) – Evaluates if a value is greater than or equal to the value that follows this symbol. **Supported Functions** - IF – Determines if expressions are true or false. Returns a given value if true and another value if false. - NULL can be used as a constant. For example, IF((expression) < 0, NULL, (expression)). <!-- document id=67ace7cf35e18a886de329beee120290703ec33003d5cfc630ea7642908b5080 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingcolumndefinitionlocalization.md --> # ForecastingColumnDefinitionLocalization Represents the translated value of a custom calculated column or custom reference data column label when the Translation Workbench is enabled for your organization. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Translation Workbench must be enabled for your org. ## Fields | Field | Details | | --- | --- | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language of the translated label. Possible values are: - af—Afrikaans - am—Amharic - ar—Arabic - ar\_AE—Arabic (United Arab Emirates) - ar\_BH—Arabic (Bahrain) - ar\_DZ—Arabic (Algeria) - ar\_EG—Arabic (Egypt) - ar\_IQ—Arabic (Iraq) - ar\_JO—Arabic (Jordan) - ar\_KW—Arabic (Kuwait) - ar\_LB—Arabic (Lebanon) - ar\_LY—Arabic (Libya) - ar\_MA—Arabic (Morocco) - ar\_OM—Arabic (Oman) - ar\_QA—Arabic (Qatar) - ar\_SA—Arabic (Saudi Arabia) - ar\_SD—Arabic (Sudan) - ar\_SY—Arabic (Syria) - ar\_TN—Arabic (Tunisia) - ar\_YE—Arabic (Yemen) - bg—Bulgarian - bn—Bengali - bs—Bosnian - ca—Catalan - cs—Czech - cy—Welsh - da—Danish - de—German - de\_AT—German (Austria) - de\_BE—German (Belgium) - de\_CH—German (Switzerland) - de\_LU—German (Luxembourg) - el—Greek - el\_CY—Greek (Cyprus) - en\_AE—English (United Arab Emirates) - en\_AU—English (Australian) - en\_BE—English (Belgium) - en\_CA—English (Canadian) - en\_CY—English (Cyprus) - en\_DE—English (Germany) - en\_GB—English (UK) - en\_HK—English (Hong Kong) - en\_IE—English (Ireland) - en\_IL—English (Israel) - en\_IN—English (Indian) - en\_MT—English (Malta) - en\_MY—English (Malaysian) - en\_NL—English (Netherlands) - en\_NZ—English (New Zealand) - en\_PH—English (Philippines) - en\_SG—English (Singapore) - en\_US—English - en\_ZA—English (South Africa) - eo—Esperanto (Pseudo) - es—Spanish - es\_AR—Spanish (Argentina) - es\_BO—Spanish (Bolivia) - es\_CL—Spanish (Chile) - es\_CO—Spanish (Colombia) - es\_CR—Spanish (Costa Rica) - es\_DO—Spanish (Dominican Republic) - es\_EC—Spanish (Ecuador) - es\_GT—Spanish (Guatemala) - es\_HN—Spanish (Honduras) - es\_MX—Spanish (Mexico) - es\_NI—Spanish (Nicaragua) - es\_PA—Spanish (Panama) - es\_PE—Spanish (Peru) - es\_PR—Spanish (Puerto Rico) - es\_PY—Spanish (Paraguay) - es\_SV—Spanish (El Salvador) - es\_US—Spanish (United States) - es\_UY—Spanish (Uruguay) - es\_VE—Spanish (Venezuela) - et—Estonian - eu—Basque - fa—Farsi - fi—Finnish - fr—French - fr\_BE—French (Belgium) - fr\_CA—French (Canadian) - fr\_CH—French (Switzerland) - fr\_LU—French (Luxembourg) - fr\_MA—French (Morocco) - ga—Irish - gu—Gujarati - haw—Hawaiian - hi—Hindi - hmn—Hmong - hr—Croatian - ht—Haitian Creole - hu—Hungarian - hy—Armenian - in—Indonesian - is—Icelandic - it—Italian - it\_CH—Italian (Switzerland) - iw—Hebrew - iw\_EO—Esperanto RTL (Pseudo) - ja—Japanese - ji—Yiddish - ka—Georgian - kk—Kazakh - kl—Greenlandic - km—Khmer - kn—Kannada - ko—Korean - lb—Luxembourgish - lt—Lithuanian - lv—Latvian - mi—Te reo - mk—Macedonian - ml—Malayalam - mr—Marathi - ms—Malay - mt—Maltese - my—Burmese - nl\_BE—Dutch (Belgium) - nl\_NL—Dutch - no—Norwegian - pa—Punjabi - pl—Polish - pt\_BR—Portuguese (Brazil) - pt\_PT—Portuguese (European) - rm—Romansh - ro—Romanian - ro\_MD—Romanian (Moldova) - ru—Russian - ru\_AM—Russian (Armenia) - ru\_BY—Russian (Belarus) - ru\_KG—Russian (Kyrgyzstan) - ru\_KZ—Russian (Kazakhstan) - ru\_LT—Russian (Lithuania) - ru\_MD—Russian (Moldova) - ru\_PL—Russian (Poland) - ru\_UA—Russian (Ukraine) - sh—Serbian (Latin) - sh\_ME—Montenegrin - sk—Slovak - sl—Slovene - sm—Samoan - sq—Albanian - sr—Serbian (Cyrillic) - sv—Swedish - sw—Swahili - ta—Tamil - te—Telugu - th—Thai - tl—Tagalog - tr—Turkish - uk—Ukrainian - ur—Urdu - vi—Vietnamese - xh—Xhosa - zh\_CN—Chinese (Simplified) - zh\_HK—Chinese (Hong Kong) - zh\_MY—Chinese (Malaysia) - zh\_SG—Chinese (Singapore) - zh\_TW—Chinese (Traditional) - zu—Zulu | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related custom column definition. This field is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To ForecastingColumnDefinition | | Value | Type textarea Properties Create, Filter, Sort, Update Description The translated label of the custom calculated column or custom reference data column. | <!-- document id=8788bcfcc7711ffa6053859c21fdf732829ba0a4fcd5d48eabb285472f15a701 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingcustomcategory.md --> # ForecastingCustomCategory Represents a custom forecasting category used for forecast rollups. This object is available in API version 62.0 and later. In API version 62.0, this object is available for rollup of Manager Judgments only. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CanHaveQuotas | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether forecasts in the custom category can have quotas. The default value is false. Available in API version 63.0 and later. | | Description | Type textarea Properties Filter, Group, Nillable, Sort Description A user-defined description of the custom category. | | DeveloperName | Type string Properties Filter, Group, Sort Description The developer name of the custom category. | | DisplayPosition | Type int Properties Filter, Group, Nillable, Sort Description Indicates the placement of the custom category column among the other columns on the forecasts page. | | ForecastingSourceDefinitionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the forecasting source definition. This field is a relationship field. Relationship Name ForecastingSourceDefinition Refers To ForecastingSourceDefinition | | ForecastingTypeId | Type reference Properties Filter, Group, Sort Description The ID of the related ForecastingType. This field is a relationship field. Relationship Name ForecastingType Refers To ForecastingType | | IsAdjustable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether forecast managers can adjust forecasts in the custom category. The default value is false. | | IsAmount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a revenue amount. If false, then IsQuantity must be true. The default value is false. Available in API version 63.0 and later. | | IsHidden | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the custom category is hidden. The default value is false. Available in API version 63.0 and later. | | IsOwnerAdjustable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether all forecast users can adjust their own forecasts in the custom category, including the territory forecasts that they own. The default value is false. | | IsQuantity | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a quantity amount. If false, then IsAmount must be true. The default value is false. Available in API version 63.0 and later. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the custom category. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label for this column. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en\_US. | | MeasureFieldOverride | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The measure that this custom category supports. Possible values are: - Opportunity.Amount - Opportunity.AmountCustom\_\_c - Opportunity.AmountRSF\_\_c - Opportunity.TotalOpportunityQuantity - OpportunityLineItem.Quantity - OpportunityLineItem.TotalPrice - OpportunityLineItem.oliCustomAmount\_\_c - OpportunityLineItemSplit.SplitAmount - OpportunitySplit.SplitAmount - OpportunitySplit.customAmount\_\_c | | UnitOfMeasure | Type string Properties Filter, Group, Nillable, Sort Description The unit of measure for the specified custom category measure. Available in API version 63.0 and later. | <!-- document id=76a87d9b319edb64d42ede60c5adc645e69589ae007a2b127a5de94e7338679a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingcustomdata.md --> # ForecastingCustomData Represents forecast data from external sources to display in the forecasts page. For example, risk or last year’s revenue. This object is available in API version 58.0 and later. This object doesn’t support forecast rollups or adjustments. Number and currency columns are supported only. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Available in Enterprise Edition and above, and in Professional Edition with an add-on license. Access to this object requires the Manage Forecasts Custom Data user permission. ## Fields | Field | Details | | --- | --- | | ForecastOwnerId | Type reference Properties Create, Filter, Group, Sort Description The ID of the forecast owner. This field is a relationship field. Relationship Name ForecastOwner Relationship Type Lookup Refers To User | | ForecastingGroupItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If a forecast group is assigned to the forecast type, the ID of the group value that the custom data belongs to. This field is a relationship field. Available in API version 60.0 and later. Relationship Name ForecastingGroupItem Relationship Type Lookup Refers To ForecastingGroupItem | | ForecastingTypeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the forecast type. This field is a relationship field. Relationship Name ForecastingType Relationship Type Lookup Refers To ForecastingType | | PeriodId | Type reference Properties Filter, Group, Nillable, Sort Description Read only. Period ID for the custom data. This field is a relationship field. Relationship Name Period Relationship Type Lookup Refers To Period | | ProductFamily | Type picklist Properties Create, Filter, Group, Nillable, Sort Description The user-defined product family available to forecast on. Each product family is unique. Possible values are: - _\[user-defined\]_–For example, Electronics or Appliances. - None | | StartDate | Type date Properties Create, Filter, Group, Sort Description The start of the custom data, expressed as month and year. The date can include any day in a given month. Stored using the first date of the month. | | Territory2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the territory to forecast on. | ## Usage Each record displays as a custom column on the forecasts summary page. <!-- document id=4219d423c7dd5a711c192be7e94f538550dbf50a4d6c155f85bc8af0522a5b71 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingdisplayedfamily.md --> # ForecastingDisplayedFamily Represents the table in Forecasts Settings where an admin selects the product families that users can forecast on in Lightning Experience. This object is available in API version 40.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | DisplayPosition | Type int Properties Filter, Group, idLookup, Nillable, Sort Description The order in which product families are displayed on the forecasts page. Each value is unique to a product family. | | ProductFamily | Type picklist Properties Filter, Group, Sort Description The product family available to forecast on. Each product family is unique. | <!-- document id=345ee6d993c16d41e7dbf1702cc4a2d571d5bc40ac5dc92c83d4dfe057579f49 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingfact.md --> # ForecastingFact This object is read-only and links a ForecastingItem with its opportunities, such as opportunities that share the same owner or forecast category and have a closing date within the period of the forecasting item. Available in API versions 26 and greater. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | ForecastCategoryName | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A forecast category is the category within the sales cycle to which an opportunity is assigned based on its opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit, Omitted (not included in forecasts), and Closed. Salesforce admins can customize the forecast category names. | | ForecastedObjectId | Type reference Properties Filter, Group, Nillable, Sort Description Contains the Split ID of the forecasted OpportunitySplit object if the forecast data source is opportunity splits or the OpportunityLineItem ID of the forecasted opportunity if the data source is product families. If the data source is product families and the opportunity has no line item, this field is null. If the forecast data source is opportunities, this field is null. This field is available in API version 29 and later. Read-only. | | ForecastedSubObjectId | Type reference Properties Filter, Group, Nillable, Sort Description Possible values: - If the forecast data source is OpportunityLineItemSplit, and the opportunity has line items and line item splits, then this field contains the ID of the forecasted OpportunityLineItemSplit object. - If the forecast data source is OpportunityLineItemSplit, and the opportunity has line items but no line item splits, this field contains the ID of the forecasted OpportunitySplit object. - If the forecast data source is OpportunityLineItemSchedule, this field contains the OpportunityLineItemSchedule ID of the forecasted opportunity. - If the forecast data source is OpportunityLineItemSplit and the opportunity has no line item, this field is null. - If the forecast data source is OpportunityLineItemSchedule and the opportunity has no line item, this field is null. This field is available in API version 58.0 and later. Read-only. This field is a polymorphic relationship field. Relationship Name null Relationship Type Lookup Refers To OpportunityLineItem, OpportunityLineItemSplit | | ForecastingItemId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the ForecastingItem. | | ForecastingTypeId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related ForecastingType. | | OpportunityId | Type reference Properties Filter, Group, Sort Description The opportunity ID. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the opportunity owner. | | PeriodId | Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the forecast. | | TargetValue | Type double Properties Filter, Nillable, Sort Description Target value of the forecast amount. | | Territory2Id | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the territory to forecast on. Available in API version 43 and later. | ## Usage Use this object to get information about opportunities linked to forecasting items. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary. #### See Also - [ForecastingAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingadjustment.htm "This object represents an individual forecast manager’s adjustment for a subordinate’s or child territory’s forecast via a ForecastingItem. Available in API versions 26.0 and later. This object is different from the ForecastingOwnerAdjustment object, which represents forecast users’ adjustments of their own forecasts, including territory forecasts they own.") - [ForecastingItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingitem.htm "This object is read-only used for individual forecast amounts. Users see amounts based on their perspectives and forecast roles. The amounts users see include one of these values when forecasting in revenue: AmountWithoutAdjustments, AmountWithoutManagerAdjustment, ForecastAmount, OwnerOnlyAmount. The amounts users see include one of these values when forecasting in quantity: QuantityWithoutAdjustments, QuantityWithoutManagerAdjustment, ForecastQuantity, OwnerOnlyQuantity. Available in API version 26.0 and later.") - [ForecastingQuota](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingquota.htm "This object represents an individual user’s or territory’s quota for a specified time period. The Managed Quotas user permission is required for creating, updating, or deleting quotas. (Users can only edit their subordinates’ or child territories’ quotas, not their own.) The View All Forecasts permission is required to view any user's forecast, regardless of the forecast hierarchy. Available in API versions 25.0 and later. Forecast managers can view the forecasts of subordinates and territories below them in the forecast hierarchy.") <!-- document id=b96380dd11e45179b2507edd9dd7d25148deda9e5e731f42b35f4afb2e14c516 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingfilter.md --> # ForecastingFilter Represents the custom filter for including or excluding data from opportunity forecasts. This object is available in API version 54.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts permission OR Allow Forecasting permission OR delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer name of the forecast filter. | | FilterLogic | Type string Properties Filter, Group, Nillable, Sort Description The logic that controls the evaluation of conditions. Only AND is supported. For example, 1 AND 2 AND 3. | | ForecastingTypeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the forecast type. Can be linked only to forecast types created in Summer ’21 and later. This is a relationship field. Relationship Name ForecastingType Relationship Type Lookup Refers To ForecastingType | | ForecastingTypeSourceId | Type reference Properties Create, Filter, Group, Sort Description The ID of the forecast type source. Can be linked only to forecast type sources created in Summer ’21 or later and with a forecast source definition with source object of 'Opportunity.' This is a relationship field. Relationship Name ForecastingTypeSource Relationship Type Lookup Refers To ForecastingTypeSource | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the forecast filter. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for this object, which displays in Setup. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en\_US. | <!-- document id=277a75765b5ebb9d2cb837436e9dd82e9ce18f51ebd773cb7affcd9ac72a6fbd url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingfiltercondition.md --> # ForecastingFilterCondition Represents the custom filter condition logic for including or excluding data from opportunity forecasts. This object is available in API version 54.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts permission OR Allow Forecasting permission OR delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer name of the forecast filter condition. | | FieldName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the opportunity field to be filtered. | | ForecastingFilterId | Type reference Properties Create, Filter, Group, Sort Description The ID of the forecast filter. This is a relationship field. Relationship Name ForecastingFilter Relationship Type Lookup Refers To ForecastingFilter | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the forecast filter condition. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for this object, which displays in Setup. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en\_US. | | Operation | Type string Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The operator in the filter condition. Possible values are: - equals - greaterOrEqual – greater than or equal to - greaterThan - lessOrEqual – less than or equal to - lessThan - notEqual | | SortOrder | Type int Properties Create, Filter, Group, Sort Description The index value for the condition. This value represents the condition in the FilterLogic field in the ForecastingFilter object. For example, 1. | | Value | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the filter condition. If multiple values are specified, they must be separated by a comma delimiter. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you have multiple currencies enabled, and add a custom filter on a currency field as part of your forecast type definition, the corporate currency at the time the filter was created is used. If you have a single currency enabled, the absolute value is used in your filter condition. | ## Usage A forecast type can contain up to three filter conditions. <!-- document id=847c67ea040862f101e64f45f8ca9944f8648efc63003e8bb270ffa075bb790c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastinggroup.md --> # ForecastingGroup Represents groups used to roll up forecast totals on the forecasts page. For example, group forecasts by industry or sales type. This object is available in API version 60.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Available for forecast types created in Spring ‘24 or later and that are based on the Opportunity and Opportunity Product objects. You can only add groups to new forecast types. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer (API) name of the forecast group. | | DisplayPosition | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The order in which forecasting dimensions are displayed on the forecasts page. Each value is unique to a dimension. | | ForecastingTypeId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the forecast type associated with the forecasting group. This field is a relationship field. Relationship Name ForecastingType Refers To ForecastingType | | GroupField | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The field name of the custom picklist used as a group. Possible values include custom, single-selection picklists available in SourceObject. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the custom picklist identified as the group. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for this object, which displays in Setup. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en\_US. | | SourceObject | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The entity the picklist used for the forecast group is on. Possible values are: - Opportunity - OpportunityLineItem - Product2 | ## Usage Each forecast group can apply to only one forecast type. <!-- document id=cddcca3f70cd8f4d80d6990fa2e845f8f441551c29678bbf92b7c33f7d051bcb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastinggroupitem.md --> # ForecastingGroupItem Represents the value within the picklist that is specified as the forecasting group for a forecast type. For example, if you have a forecasting group that identifies the industry an opportunity is part of, this object represents the value in the the industry picklist that’s chosen to be part of the group. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DisplayPosition | Type int Properties Create, Filter, Group, Sort, Update Description Indicates the order in which the value displays among other values in the group on the forecasts page. | | ForecastingGroupId | Type reference Properties Create, Filter, Group, Sort Description This field is a relationship field. Relationship Name ForecastingGroup Relationship Type Lookup Refers To ForecastingGroup | | SourceValueApiName | Type string Properties Create, Filter, Nillable, Sort Description The API name that’s derived from the group value. | | SourceValueLabel | Type string Properties Filter, Nillable, Sort Description The label that’s derived from the group value. | | SourceValueTranslatedLabel | Type string Properties Filter, Nillable, Sort Description If one exists, the translated version of the group value. | ## Usage New forecast types based on opportunities or opportunity products can include a forecasting group. This group is based on a custom, single-selection picklist that’s defined on the Opportunity, OpportunityLineItem, or Product2 objects. The picklist that’s chosen for the group can contain more values than are needed for the type. <!-- document id=af85ecbb87cff32f88b0893bc93cd04b6d4080c80f2faee99e00bb915e0fce92 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingitem.md --> # ForecastingItem This object is read-only used for individual forecast amounts. Users see amounts based on their perspectives and forecast roles. The amounts users see include one of these values when forecasting in revenue: AmountWithoutAdjustments, AmountWithoutManagerAdjustment, ForecastAmount, OwnerOnlyAmount. The amounts users see include one of these values when forecasting in quantity: QuantityWithoutAdjustments, QuantityWithoutManagerAdjustment, ForecastQuantity, OwnerOnlyQuantity. Available in API version 26.0 and later. Other users can see the ForecastingItem object, but not its records. See these access guidelines. - Users with the “View All Forecasts” permission have access to all ForecastingItem fields. - Users without the “View All Forecasts” permission have access to all fields for their own subordinates and child territories. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | AmountWithoutAdjustments | Type double Properties Filter, Sort, Nillable Description The sum of a person’s owned revenue opportunities and the person's subordinates’ and child territories’ opportunities, without adjustments. Subordinates include everyone reporting up to a person in the role-based forecast hierarchy. This amount is visible only on reports. | | AmountWithoutManagerAdjustment | Type double Properties Filter, Sort, Nillable Description The forecast number as seen by the forecast owner. This number is the sum of the owner’s revenue opportunities and the owner’s subordinates’ and child territories’ opportunities, including adjustments made by the forecast owner on the owner's or subordinates’ and child territories’ forecasts. It doesn’t include adjustments made by forecast managers above the owner in the forecast hierarchy. | | AmountWithoutOwnerAdjustment | Type double Properties Filter, Sort, Nillable Description The forecast amount as seen by the forecast owner without the owner's adjustment. This amount is the sum of the subordinate's and child territories’ opportunities, including adjustments made by their manager or by the subordinate themselves, plus the rollup of the owner's own opportunities. _It doesn’t include adjustments made by the forecast owner._ | | ForecastAmount | Type double Properties Filter, Sort, Nillable Description The revenue forecast from the forecast manager’s perspective and the sum of the owner’s and subordinates’ and child territories’ opportunities, including all forecast adjustments. | | ForecastCategoryName | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description A forecast category is the category within the sales cycle to which an opportunity is assigned based on its opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit, Omitted (not included in forecasts), and Closed. Salesforce admins can add a Most Likely category and can customize the forecast category names in single category rollups. Change the forecast category name only. Changing a forecast category’s API name can have unintended results. | | ForecastQuantity | Type double Properties Filter, Sort, Nillable Description The quantity forecast from the forecast manager’s perspective and the sum of the owner’s and subordinates’ opportunities, including all forecast adjustments. This field is available in API version 28 and later. | | ForecastingGroupItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If a forecast group is assigned to the forecast type, the ID of the group value that the forecast total belongs to. This field is a relationship field. Available in API version 60.0 and later. Relationship Name ForecastingGroupItem Relationship Type Lookup Refers To ForecastingGroupItem | | ForecastingItemCategory | Type picklist Properties Filter, Group, Sort Description This field indicates which type of forecast rollup the forecasting item belongs to. Depending on whether your organization uses individual forecast category rollups or cumulative forecast rollups, you have these possible values for the ForecastingItemCategory field. _Individual forecast category rollups:_ - PipelineOnly - Rollup from Pipeline opportunities only. - BestCaseOnly - Rollup from Best Case opportunities only. Adjustable. - MostLikelyOnly - Rollup from Most Likely opportunities only. Adjustable. - CommitOnly - Rollup from Commit opportunities only. Adjustable. _Cumulative forecast rollups:_ - OpenPipeline - Rollup from Pipeline + Best Case + Most Likely + Commit opportunities. - BestCaseForecast - Rollup from Best Case + Most Likely + Commit + Closed opportunities. Adjustable. - MostLikelyForecast - Rollup from Most Likely + Commit + Closed opportunities. Adjustable. - CommitForecast - Rollup from Commit + Closed opportunities. Adjustable. _Either cumulative or individual forecast category rollups:_ - ClosedOnly - Rollup from Closed opportunities only. The ForecastingItemCategory field differs from the ForecastCategoryName field. - The ForecastCategoryName field represents the forecast category of the _underlying opportunities_ rolling up to forecast amounts. In organizations using cumulative forecast rollups, the ForecastCategoryName field can be null because the cumulative forecast amounts include opportunities from multiple forecast categories. - The new ForecastingItemCategory field represents the _type of rollup_ a forecast amount or adjustment is from. In organizations using individual forecast category columns, it contains the individual forecast rollup categories. In organizations using cumulative forecast rollups, it contains the cumulative rollup categories. | | ForecastingTypeId | Type reference Properties Filter, Group, Sort Description The ID of the related ForecastingType. | | HasAdjustment | Type boolean Properties Defaulted on create, Filter, Group, Sort Description A flag that indicates the forecasting item includes a _manager_ adjustment. This flag is true only when the item includes an adjustment and the user performing the query has read access to the adjustment. | | HasOwnerAdjustment | Type boolean Properties Defaulted on create, Filter, Group, Sort Description A flag that indicates the forecasting item includes an _owner_ adjustment. This flag is true only when the item includes an adjustment and the user performing the query has read access to the adjustment. Available in API version 33.0 and later. | | IsAmount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a revenue amount. If false, then IsQuantity must be true. This field is available in API version 28.0 and later. | | IsQuantity | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a quantity amount. If false, then IsAmount must be true. This field is available in API version 28.0 and later. | | IsUpToDate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description A flag indicating whether a specific forecasting item reflects current information. For example, if users are making adjustments that are in process, the item isn’t up to date. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the forecast owner. | | OwnerOnlyAmount | Type double Properties Filter, Sort, Nillable Description The sum of a person’s revenue opportunities, without adjustments. | | OwnerOnlyQuantity | Type double Properties Filter, Sort, Nillable Description The sum of a person’s quantity opportunities, without adjustments. This field is available in API version 28.0 and later. | | ParentForecastingItemId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the ForecastingItem that the current item rolls up to. | | PeriodId | Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the forecast. | | ProductFamily | Type picklist Properties Filter, Group, Nillable, Sort Description The product family of the forecast item. This field is available in API version 29.0 and later. Read only. | | QuantityWithoutAdjustments | Type double Properties Filter, Nillable, Sort Description The sum of a person’s owned quantity opportunities and also his or her subordinates’ opportunities, without adjustments. Subordinates include everyone reporting up to a person in the forecast hierarchy. This field is available in API version 28.0 and later. | | QuantityWithoutManagerAdjustment | Type double Properties Filter, Nillable, Sort Description The forecast number as seen by the forecast owner. This number is the sum of the owner’s quantity opportunities and subordinates’ opportunities, including adjustments made on the subordinates’ forecasts. It doesn’t include adjustments made by forecast managers above the owner in the forecast hierarchy. This field is available in API version 28 and later. | | QuantityWithoutOwnerAdjustment | Type double Properties Filter, Nillable, Sort Description The forecast quantity as seen by the forecast owner without the owner's adjustment. This number is the sum of the subordinate's opportunities, including adjustments made by their manager or by the subordinate themselves, plus the rollup of the owner's own opportunities. _It doesn’t include adjustments made by the forecast owner._ This field is available in API version 38.0 and later. | | SubordinateOverrides | Type int Properties Filter, Group, Sort Description The total number of adjustments made to a forecast down the hierarchical chain. For example, User A has a forecast without adjustments. If User A adjusts User B’s forecast, User A’s SubordinateOverrides value is 1. Then if User B adjusts User C’s forecast, User A’s SubordinateOverrides value is 2. If User A removes his adjustment from User B’s forecast, User A’s SubordinateOverrides value is 1. This field is available in API version 38.0 and later. | | Territory2Id | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the territory to forecast on. Available in API version 43.0 and later. | ## Usage Use this object to obtain individual forecast amounts, either with or without adjustments, based on a user’s perspective and forecast role. The ForecastingItem object is visible to all users, but only forecast managers and users above them in the forecast hierarchy can read or write ForecastingAdjustment records. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary. #### See Also - [ForecastingAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingadjustment.htm "This object represents an individual forecast manager’s adjustment for a subordinate’s or child territory’s forecast via a ForecastingItem. Available in API versions 26.0 and later. This object is different from the ForecastingOwnerAdjustment object, which represents forecast users’ adjustments of their own forecasts, including territory forecasts they own.") - [ForecastingFact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingfact.htm "This object is read-only and links a ForecastingItem with its opportunities, such as opportunities that share the same owner or forecast category and have a closing date within the period of the forecasting item. Available in API versions 26 and greater.") - [ForecastingQuota](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingquota.htm "This object represents an individual user’s or territory’s quota for a specified time period. The Managed Quotas user permission is required for creating, updating, or deleting quotas. (Users can only edit their subordinates’ or child territories’ quotas, not their own.) The View All Forecasts permission is required to view any user's forecast, regardless of the forecast hierarchy. Available in API versions 25.0 and later. Forecast managers can view the forecasts of subordinates and territories below them in the forecast hierarchy.") <!-- document id=d4fd41c8cbee2b35b2e75a50c8b626460d94a9a4f91891be49a7cd9bd1f66692 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingowneradjustment.md --> # ForecastingOwnerAdjustment This object represents an individual forecast user’s adjustment of their _own_ forecast, including territory forecasts they own, via a ForecastingItem. Available in API versions 33.0 and later. This object is different from the ForecastingAdjustment object, which represents managers’ adjustments of _subordinates’_ and child territories’ forecasts. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency code of the adjustment. If omitted, the default is the importing user’s personal currency. | | ForecastCategoryName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The category within the sales cycle that an opportunity is assigned to based on its opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit, Omitted, and Closed. You can add a Most Likely category and can customize forecast category names in single category rollups. The forecast categories display information for that specific category; for example, Best Case only reflects amounts in the Best Case category. | | ForecastOwnerId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the forecast owner. | | ForecastingGroupItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If a forecast group is assigned to the forecast type, the ID of the group value that the owner adjustment belongs to. This field is a relationship field. Available in API version 60.0 and later. Relationship Name ForecastingGroupItem Relationship Type Lookup Refers To ForecastingGroupItem | | ForecastingItemCategory | Type picklist Properties Create, Filter, Group, Sort Description This field indicates which type of forecast rollup the owner adjustment belongs to. Depending on whether your organization uses individual forecast category rollups or cumulative forecast rollups, you have these possible values for the ForecastingItemCategory field. _Individual forecast category rollups:_ - PipelineOnly - Rollup from Pipeline opportunities only. - BestCaseOnly - Rollup from Best Case opportunities only. Adjustable. - MostLikelyOnly - Rollup from Most Likely opportunities only. Adjustable. - CommitOnly - Rollup from Commit opportunities only. Adjustable. _Cumulative forecast rollups:_ - OpenPipeline - Rollup from Pipeline + Best Case + Most Likely + Commit opportunities. - BestCaseForecast - Rollup from Best Case + Most Likely + Commit + Closed opportunities. Adjustable. - MostLikelyForecast - Rollup from Most Likely + Commit + Closed opportunities. Adjustable. - CommitForecast - Rollup from Commit + Closed opportunities. Adjustable. _Either cumulative or individual forecast category rollups:_ - ClosedOnly - Rollup from Closed opportunities only. The ForecastingItemCategory field differs from the ForecastCategoryName field. - The ForecastCategoryName field represents the forecast category of the _underlying opportunities_ rolling up to forecast amounts. In organizations using cumulative forecast rollups, the ForecastCategoryName field can be null because the cumulative forecast amounts include opportunities from multiple forecast categories. - The new ForecastingItemCategory field represents the _type of rollup_ a forecast amount or adjustment is from. In organizations using individual forecast category columns, it contains the individual forecast rollup categories. In organizations using cumulative forecast rollups, it contains the cumulative rollup categories. When inserting owner adjustments, the values you insert for ForecastCategoryName and ForecastingItemCategory must be compatible with each other. In organizations using cumulative forecast rollups, the ForecastCategoryName is nillable. These pairs are the valid pairs. Individual forecast category rollups: - ForecastCategoryName: BestCase, ForecastingItemCategory: BestCaseOnly - ForecastCategoryName: Commit, ForecastingItemCategory: CommitOnly Cumulative forecast category rollups: - ForecastCategoryName: null, ForecastingItemCategory: BestCaseForecast - ForecastCategoryName: null, ForecastingItemCategory: CommitForecast | | ForecastingItemId | Type reference Properties Filter, Group, Sort Description The ID of the related ForecastingItem. | | ForecastingTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related ForecastingType. | | IsAmount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a revenue amount. If false, then IsQuantity must be true. | | IsQuantity | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a quantity amount. If false, then IsAmount must be true. | | OwnerAdjustedAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The revenue amount of an individual forecast item, after an adjustment. | | OwnerAdjustedQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description The quantity amount of an individual forecast item, after an adjustment. | | OwnerAdjustmentNote | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A text note providing information about the adjustment. The maximum length is 255 characters. This field does not appear in reports. | | PeriodId | Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the adjustment. Read only. | | ProductFamily | Type picklist Properties Create, Filter, Group, Nillable, Sort Description The Product Family for the adjustment. Read only. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort Description The start of the adjustment, expressed as month and year. The date can include any day in a given month. Stored using the first date of the month. | | Territory2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the territory to forecast on. Available in API version 43.0 and later. | ## Usage Use this object to obtain a user’s adjustment details for a specified ForecastingItem in their own forecast. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary. [ForecastingOwnerAdjustmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. <!-- document id=59f078eb35fc39348de2b8f6c05cce6f2a4c69b957566d49aebe4fba18298490 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingquota.md --> # ForecastingQuota This object represents an individual user’s or territory’s quota for a specified time period. The Managed Quotas user permission is required for creating, updating, or deleting quotas. (Users can only edit their subordinates’ or child territories’ quotas, not their own.) The View All Forecasts permission is required to view any user's forecast, regardless of the forecast hierarchy. Available in API versions 25.0 and later. Forecast managers can view the forecasts of subordinates and territories below them in the forecast hierarchy. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The currency code of the quota. If omitted, the default is the importing user’s personal currency. | | ForecastingGroupItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If a forecast group is assigned to the forecast type, the ID of the group value that the quota belongs to. This field is a relationship field. Available in API version 60.0 and later. Relationship Name ForecastingGroupItem Relationship Type Lookup Refers To ForecastingGroupItem | | ForecastingTypeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related ForecastingType. | | IsAmount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a revenue amount. If false, then IsQuantity must be true. This field is available in API version 28.0 and later. | | IsQuantity | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a quantity amount. If false, then IsAmount must be true. This field is available in API version 28.0 and later. | | PeriodId | Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the quota. Read only. | | ProductFamily | Type picklist Properties Create, Filter, Group, Nillable, Sort Description The product family for the quota. This field is available in API version 29.0 and later. | | QuotaAmount | Type currency Properties Create, Filter, Sort, Update Description The revenue quota amount for an individual user or territory and for a specific period. | | QuotaOwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID that identifies the quota owner. | | QuotaQuantity | Type double Properties Create, Filter, Sort, Update Description The quantity quota amount for an individual user and for a specific period. This field is available in API version 28.0 and later. | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description The start of the quota, expressed as month and year. The date can include any day in a given month. Stored using the first date of the month. | | Territory2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the territory to forecast on. Available in API version 43.0 and later. | | | | ## Usage Use this object to get an individual user’s or territory’s quota for a specified time period. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary. #### See Also - [ForecastingAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingadjustment.htm "This object represents an individual forecast manager’s adjustment for a subordinate’s or child territory’s forecast via a ForecastingItem. Available in API versions 26.0 and later. This object is different from the ForecastingOwnerAdjustment object, which represents forecast users’ adjustments of their own forecasts, including territory forecasts they own.") - [ForecastingFact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingfact.htm "This object is read-only and links a ForecastingItem with its opportunities, such as opportunities that share the same owner or forecast category and have a closing date within the period of the forecasting item. Available in API versions 26 and greater.") - [ForecastingItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingitem.htm "This object is read-only used for individual forecast amounts. Users see amounts based on their perspectives and forecast roles. The amounts users see include one of these values when forecasting in revenue: AmountWithoutAdjustments, AmountWithoutManagerAdjustment, ForecastAmount, OwnerOnlyAmount. The amounts users see include one of these values when forecasting in quantity: QuantityWithoutAdjustments, QuantityWithoutManagerAdjustment, ForecastQuantity, OwnerOnlyQuantity. Available in API version 26.0 and later.") <!-- document id=074036a9a41b77f7be7a06f3fb68b5b48e8a77a54c000488af0363749a24fc7b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingshare.md --> # ForecastingShare Represents forecasts shared between a forecast manager and a user. Available in API version 44.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Whether the user you’re sharing your forecasts with can view and adjust the forecasts or view only. This field is new since the pilot. Picklist values: - ViewAndEdit - ViewOnly | | SharedForecastManagerRoleId | Type reference Properties Create, Filter, Group, Sort Description The ID of either: - The role of the manager whose forecasts you want to share. - The territory whose forecasts you want to share. | | RoleType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of hierarchy associated with the forecast share. - R - Role-based - T - Territory-based - Y - Territory2-based | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user with whom the forecast is shared. | ## Usage Use this object to let any stakeholder at your company view and adjust forecast managers’ forecasts. <!-- document id=f0ba8afdb843e01910d40f2f1cd0b24aa4e0a5f5d007776f496ab62c3d35c37c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingsourcedefinition.md --> # ForecastingSourceDefinition Represents the object, measure, date type, and hierarchy that a forecast uses to project sales. This object is available in API version 52.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The information in this topic applies only to forecast types created in Summer ’21 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CategoryField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Name of the forecast category that is associated with the forecast type. Possible values are: - Opportunity.ForecastCategoryName | | DateField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Field that is used for the forecast type’s date type. For example, the CloseDate field on Opportunity is used for opportunity close date-based forecast types. Possible values are: - Opportunity.CloseDate - OpportunityLineItem.ServiceDate - OpportunityLineItemSchedule.ScheduleDate | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer name of the forecasting source definition. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | FamilyField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Use this field to group forecasts by product family. Possible values are: - Product2.Family | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Language of the forecasting source definition. For example, English. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Required. Controlling label for this forecasting source definition. | | MeasureField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Field that is used for the forecast type’s measure. For example, the Amount field on Opportunity is associated with revenue-based forecast types. Possible values are\*: - Opportunity.Amount - Opportunity.Custom - Opportunity.TotalOpportunityQuantity - OpportunityLineItem.Custom - OpportunityLineItem.Quantity - OpportunityLineItem.TotalPrice - OpportunityLineItemSchedule.Custom - OpportunityLineItemSchedule.Quantity - OpportunityLineItemSchedule.Revenue - OpportunitySplit.Custom - OpportunitySplit.SplitAmount \*Where Custom represents the name of the custom field that a forecast type’s measure is based on. Example: Use Megawatts\_\_c to forecast energy consumption. | | SourceObject | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Object associated with this forecasting source definition. Possible values are: - Opportunity - OpportunityLineItem - OpportunityLineItemSchedule - OpportunitySplit - Product2 | | Territory2Field | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description For a territory-based forecast type, indicates the field that is used for territory information. Possible values are: - Opportunity.Territory2Id For user role-based forecast types, this value is null. | | UserField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies who owns the forecast. Possible values are: - Opportunity.OwnerId - OpportunitySplit.SplitOwnerId | ## Usage Use ForecastingSourceDefinition to define a forecast type’s structure. A forecasting source definition is joined via ForecastingTypeSource to ForecastingType. In this example, a user role-based forecast type called Custom Amount Forecast is based on the Amount and Close Date fields on opportunities. ForecastingType type = new sforce.SObject("ForecastingType"); type.DeveloperName = "Custom\_Amount\_Forecast"; type.MasterLabel = "Custom Amount Forecast"; type.IsAmount = true; type.IsQuantity = false; type.RoleType = "R"; type.DateType = "OpportunityCloseDate"; String typeId = insert(type); ForecastingSourceDefinition sourceDefinition = new sforce.SObject("ForecastingSourceDefinition") sourceDefinition.DeveloperName = "Custom Amount Source"; sourceDefinition.MasterLabel = "Custom\_Amount\_Source"; sourceDefinition.SourceObject = "Opportunity"; sourceDefinition.MeasureField = "Opportunity.Amount"; sourceDefinition.DateField = "Opportunity.CloseDate"; sourceDefinition.UserField = "Opportunity.OwnerId"; sourceDefinition.CategoryField = "Opportunity.ForecastCategoryName"; String sourceDefinitionId = insert(sourceDefinition); ForecastingTypeSource typeSource = new sforce.SObject("ForecastingTypeSource"); typeSource.MasterLabel = "Custom Amount Type Source"; typeSource.DeveloperName = "Custom\_Amount\_Type\_Source"; typeSource.ForecastingTypeId = typeId; typeSource.ForecastingSourceDefinitionId = sourceDefinitionId; typeSource.SourceGroup = 1; insert(typeSource); <!-- document id=5cf065a72ff36ece9f91653538cde925e68ada073562318c27cb3019c9a89960 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingsrcrecjudgment.md --> # ForecastingSrcRecJudgment Represents forecast managers’ judgment of whether they consider an opportunity-related deal to be certain to close. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency code of the judgment. If omitted, the default is USD. | | JudgmentOwnerId | Type reference Properties Create, Filter, Group, Sort Description The ID of the forecast manager. This field is a relationship field. Relationship Name JudgmentOwner Relationship Type Lookup Refers To User | | JudgmentValue | Type picklist Properties Create, Filter, Group, Sort, Update Description Whether the deal is likely to close (IN) or not (OUT). | | ReferenceObjectId | Type reference Properties Create, Filter, Group, Sort Description The ID of the opportunity-related object. This field is a polymorphic relationship field. Relationship Name ReferenceObject Relationship Type Lookup Refers To Opportunity | | Territory2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the territory that the judgment is on. This field is a polymorphic relationship field. Relationship Name ReferenceObject Relationship Type Lookup Refers To Territory2 | <!-- document id=fe6afa7d338a60add72d4df7c02424154f592d5b4815180dc0dbf33f73fa2382 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingsubmission.md --> # ForecastingSubmission Represents a submitted forecast. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Available for forecast types that aren’t grouped by product family forecast. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The currency code of the forecast submission. If omitted, the default is USD. | | ForecastOwnerId | Type reference Properties Filter, Group, Sort Description The ID of the forecast owner. This field is a relationship field. Relationship Name ForecastOwner Refers To User | | ForecastingGroupItemId | Type reference Properties Filter, Group, Nillable, Sort Description Reserved for future use. Forecast submissions aren't supported in forecast types with groups. Relationship Name ForecastingGroupItem Refers To ForecastingGroupItem | | ForecastingTypeId | Type reference Properties Filter, Group, Sort Description The ID of the forecast type. This field is a relationship field. Relationship Name ForecastingType Refers To ForecastingType | | IsLatest | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the forecast submission is the most recent submission. The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. ID of this record. | | Note | Type textarea Properties Filter, Nillable, Sort Description The note attached to the submitted forecast. | | PeriodId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the period to which the submission applies. This field is a relationship field. Relationship Name Period Refers To Period | | PeriodStartDate | Type date Properties Filter, Group, Sort Description Indicates the start date of the forecast period. | | ProductFamily | Type picklist Properties Filter, Group, Nillable, Sort Description Must be set to none. Forecast submissions aren't supported in forecast types grouped by product families. | | SubmissionDateTime | Type dateTime Properties Filter, Sort Description The date and time that the forecast submission was made. Calculated internally. | | Territory2Id | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the territory to forecast on. This field is a relationship field. Relationship Name Territory2 Refers To Territory2 | ## Usage ForecastingSubmission is a detail object that contains the submitted item category values. Each record represents the values for a single item category. ForecastingSubmission is always used as a detail object for the submission, and inserted only as part of a transaction that includes all detail objects. <!-- document id=26a4828818257e494337a00cea3996fe05e952e09b103349cea911425ecf7e3a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingsubmissionitem.md --> # ForecastingSubmissionItem Represents the values for each forecast category in a submitted forecast. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Filter, Nillable, Sort Description For forecasting types that use Amount as the measure, the amount for the forecast category. Amounts must be provided in the corporate currency. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The currency code of the forecast submission. If omitted, the default is USD. | | ForecastingItemCategory | Type picklist Properties Create, Filter, Group, Sort Description The category the forecast belongs to. For individual forecast category rollups, the possible values are: - PipelineOnly—Rollup from Pipeline opportunities only. - BestCaseOnly—Rollup from Best Case opportunities only. - MostLikelyOnly—Rollup from Most Likely opportunities only. - CommitOnly —Rollup from Commit opportunities only. For cumulative forecast rollups, the possible values are: - OpenPipeline—Rollup from Pipeline, Best Case, Most Likely, and Commit opportunities. - BestCaseForecast —Rollup from Best Case, Most Likely, Commit, and Closed opportunities. - MostLikelyForecast—Rollup from Most Likely, Commit, and Closed opportunities. - CommitForecast —Rollup from Commit and Closed opportunities. For either cumulative or individual forecast category rollups, the possible values are: - ClosedOnly—Rollup from Closed opportunities only. | | ForecastingSubmissionId | Type reference Properties Filter, Group, Sort Description The ID of the forecast submission. This field is a relationship field. Relationship Name ForecastingSubmission Relationship Type Master-detail Refers To ForecastingSubmission (the master object) | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. The ID of this record. | | Quantity | Type double Properties Filter, Nillable, Sort Description For forecasting types that use Quantity as the measure, the quantity for the forecast category. Quantities must be provided in the corporate currency. | <!-- document id=0419b7ae544825302e8e2c29be6eb9962e59c8683bee46d50d037455c1fbc534 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingtype.md --> # ForecastingType Used to identify the forecast type associated with ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingQuota, ForecastingFact, and ForecastingItem objects. Available in API version 30.0 and greater. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(). delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | CanDisplayQuotas | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether a forecast type can show quota information. The default value is false. Available in API version 38.0 and later. | | DateType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The date type that forecast amounts are based on. These values are available for forecast types that were available before Summer ’21. - OpportunityCloseDate: Base forecasts on opportunity close dates. - ProductDate: Base forecasts on opportunity product line item dates, if available. - ScheduleDate: Base forecasts on opportunity product schedule dates, if available. These values are available in API version 52.0 and later in Performance Edition and in Unlimited Edition with the Sales Cloud. - OLIMeasureCloseDateOnly: Base forecasts on opportunity close dates. - ProductDateOnly: Base forecasts on opportunity product line item dates, if available. - ScheduleDateOnly: Base forecasts on opportunity product schedule dates, if available. These values to create forecasts on custom date fields are available in API version 57.0 and later in Performance, Professional, Enterprise, and Unlimited Edition with the Sales Cloud. - OLIMeasureOppCustomDateOnly: Base forecasts on custom opportunity dates, if available. - OpportunityCustomDate: Base forecasts on custom opportunity dates. The custom date field used must be on the opportunity object and based on the date type. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the forecasting type. The DeveloperName is called name in the Metadata API and Forecasting Type in custom reports. | | ForecastingGroupID | Type reference Properties Create, Filter, Group, Nillable, Sort Description Indicates whether the forecasting type has a group assignment, and if so, the name of the group. This field is a relationship field. Available in API version 60.0 and later. Relationship Name ForecastingGroup Relationship Type Lookup Refers To ForecastingGroup | | HasAdjustments | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether forecast managers can adjust forecasts of their immediate subordinates and child territories. The default value is false. Available in API version 60.0 and later. | | HasOwnerAdjustments | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether all forecast users can adjust their own forecasts, including the territory forecasts that they own. The default value is false. Available in API version 60.0 and later. | | HasProductFamily | Type boolean Properties Create, Defaulted on create, Group Description Indicates whether a forecasts view includes product families. The default value is false. Available in API version 40.0 and later. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the forecasting type is enabled. The default value is false. | | IsAmount | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the forecasting type is based on the revenue measure. The default value is false. | | IsPlatformType | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates a legacy forecast type that wasn’t available before Summer ’21. The default value is false. Available in API version 52.0 and later. | | IsQuantity | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the forecasting type is based on the quantity measure. The default value is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the forecasting type. | | LastActivatedDate | Type dateTime Properties Create, Filter, Nillable, Sort Description The date when a forecast type was activated. Read only. Available in API version 53.0 and later. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Controlling label for this forecasting type value. This display value is the internal label that doesn’t get translated. | | OpportunitySplitTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Indicates whether the forecasting type has a split type, and if so, the name of the split type. This field is a relationship field. Available in API version 41.0 and later. Relationship Name OpportunitySplitType Relationship Type Lookup Refers To OpportunitySplitType | | OpptyLineItemSplitTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Indicates whether the forecasting type has a product split type, and if so, the name of the product split type. This field is a relationship field. Available in API version 58.0 and later. Relationship Name OpptyLineItemSplitType Relationship Type Lookup Refers To OpptyLineItemSplitType | | RoleType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Indicates whether the role type has a forecasting type, and if so, which forecasting type. Available in API version 41.0 and later. Possible values are: - R—User role-based forecasting type - T—Territory1-based forecasting type; not used - Y—Territory2-based forecasting type | | Territory2ModelId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Indicates whether the forecasting type has a Territory2 model, and if so, the name of the Territory2 model. Available in API version 41.0 and later. | <!-- document id=3e903eddce730d0a7b212b0fdc7a6ca7d68c335d710777548ed0bb0fd99533bb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastingtypesource.md --> # ForecastingTypeSource Maps a forecasting source definition to a forecast type. This object is available in API version 52.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The information in this topic applies only to forecast types created in Summer ’21 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer name of the forecasting type source. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | ForecastingSourceDefinitionId | Type reference Properties Create, Filter, Group, Sort Description ID of the forecasting source definition. This field is a relationship field. Relationship Name ForecastingSourceDefinition Relationship Type Lookup Refers To ForecastingSourceDefinition | | ForecastingTypeId | Type reference Properties Create, Filter, Group, Sort Description ID of the forecast type. Can be linked only to forecast types created in Summer ’21 and later. This field is a relationship field. Relationship Name ForecastingType Relationship Type Lookup Refers To ForecastingType | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Language of the forecasting type source. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Required. Controlling label for this forecasting type source. | | ParentSourceDefinitionId | Type reference Properties Create, Filter, Group, Nillable, Sort Description For forecast types not based on the opportunity object and not based on a custom measure, this value represents the parent ForecastingSourceDefinition of the linked ForecastingSourceDefinition. This field is a relationship field. - Opportunity Product is the parent of Opportunity. - Opportunity Split is the parent of Opportunity. - Line Item Schedule is the parent of Opportunity Product. Relationship Name ParentSourceDefinition Relationship Type Lookup Refers To ForecastingSourceDefinition | | RelationField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Represents the field linking the source objects of the parent ForecastingSourceDefinition to the child ForecastingSourceDefinition. Possible values are: - OpportunityLineItem.OpportunityId - OpportunityLineItem.Product2Id - OpportunityLineItemSchedule.OpportunityLineItemId - OpportunitySplit.OpportunityId | | SourceGroup | Type int Properties Create, Filter, Group, Sort Description Required. Represents a grouping of forecasting source definitions. | ## Usage Use this object to define a forecast type’s structure. This junction object links ForecastingSourceDefinition to ForecastingType. For an example, see [ForecastingSourceDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingsourcedefinition.htm "Represents the object, measure, date type, and hierarchy that a forecast uses to project sales. This object is available in API version 52.0 and later."). <!-- document id=7d4dd2b77220be11d4fc65bd25f1a707ae2e329aec1149a833cb74c1e67a2245 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_forecastinguserpreference.md --> # ForecastingUserPreference Represents the forecasting selections that a user has made, such as display options, date range, forecasting type, and currency. ## Supported Calls create(), describeSObjects(), query(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object. ## Fields | Field Name | Details | | --- | --- | | ExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique system-generated numerical identifier for the user. | | ForecastingDisplayedTypeId | Type reference Properties Create, Group, Sort, Update Description An identifier for the forecasting type that’s displayed. | | ForecastingPeriodDuration | Type int Properties Create, Group, Nillable, Sort, Update Description How long the forecasting period lasts. | | ForecastingPeriodType | Type picklist Properties Create, Group, Nillable, Restricted picklist, Sort, Update Description The forecasting period’s type. Valid values include: Month, Quarter, Week, or Year | | ForecastingStartPeriod | Type int Properties Create, Group, Nillable, Sort, Update Description The date when the forecasting period begins. | | ForecastingViewCurrency | Type string Properties Create, Group, Nillable, Sort, Update Description The currency shown on the forecasts page. | | IsForecastingHideZeroRows | Type boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows zero-value rows. | | IsForecastingShowQuantity | Type boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows forecast quantity. | | IsHideForecastingGuidedTour | Type boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows the guided tour. | | IsHideForecastingQuotaColumn | Type boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows a quota column. | | IsShowForecastingChangeSignals | Type boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows changes in the last 7 days. | | IsShowForecastingQuotaAttainment | Type boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows quota attainment information. | <!-- document id=b7ca6118e131ac97b1216dcd7b7599119cd137a768bbd97502672a1cd93a68ad url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_formulafunction.md --> # FormulaFunction Represents a function used when building a formula, including examples and uses. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | CategoryId | Type string Properties Filter, Group, Nillable, Sort Description The ID of the FormulaFunctionCategory. This is a relationship field. Relationship Name Category Relationship Type Lookup Refers To FormulaFunctionCategory | | Description | Type string Properties Filter, Group, Nillable, Sort Description Description of the formula function. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. To simplify queries, use this field. | | ExampleString | Type string Properties Filter, Group, Nillable, Sort Description Describes the function and what arguments you can use with it. | | IsAllowedInEntityContext | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether you can use the formula function on an Entity (true) or not (false). For example, you cannot use the PRIORVALUE function in a custom Account formula field. The default value is false. This field is removed in API version 48.0 and later. Use the [FormulaFunctionAllowedType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_formulafunctionallowedtype.htm "Represents the functions that are supported in the given formula context. This object is available in API version 48.0 and later.") object instead. | | IsAllowedInFlowContext | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the formula function is allowed in a Flow (true) or not (false). The default value is false. This field is removed in API version 48.0 and later. Use the [FormulaFunctionAllowedType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_formulafunctionallowedtype.htm "Represents the functions that are supported in the given formula context. This object is available in API version 48.0 and later.") object instead. | | IsAllowedInVisualforceContext | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the formula function is allowed in Visualforce (true) or not (false). The default value is false. This field is removed in API version 48.0 and later. Use the [FormulaFunctionAllowedType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_formulafunctionallowedtype.htm "Represents the functions that are supported in the given formula context. This object is available in API version 48.0 and later.") object instead. | | Label | Type string Properties Filter, Group, Nillable, Sort Description The formula function label that appears in the user interface. | | Name | Type string Properties Filter, Group, Nillable, Sort Description The name of the formula function. | ## Usage Query FormulaFunction to search for available formula functions, such as AND(), ISBLANK(), MAX(), MIN(), and others. <!-- document id=bc6303b1e79f9ab89df7afcc51893b4480c4a0cdaa18d5fdf80098e832e481f9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_formulafunctionallowedtype.md --> # FormulaFunctionAllowedType Represents the functions that are supported in the given formula context. This object is available in API version 48.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. To simplify queries, use this field. | | FunctionId | Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the supported function. This is a relationship field. Relationship Name Function Relationship Type Lookup Refers To FormulaFunction | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The name of the formula type in which the function is supported. Possible values are: - FLOW - VALIDATION - VISUALFORCE | <!-- document id=b4672c3c757d8fa5192d890a8cf267239943351da4622110390c10596c07e881 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_formulafunctioncategory.md --> # FormulaFunctionCategory Represents the category to which a formula belongs when building a formula. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. To simplify queries, use this field. | | Label | Type string Properties Filter, Group, Nillable, Sort Description Label of the FormulaFunctionCategory that appears in the user interface. | | Name | Type string Properties Filter, Group, Nillable, Sort Description Name of the FormulaFunctionCategory. | ## Usage Query FormulaFunctionCategory to search for categories of available formula functions, such as Math, Logical, Date and Time, and others. <!-- document id=1c3696052bf0177f368af2726ca1ed27fe7095e9da85a7cf7d6bd3bceffc24df url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_frcstcustmcatgrampratesrc.md --> # FrcstCustmCatgRampRateSrc Represents the total contract value used for custom bulk adjustments. This object is available in API version 63.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BaseValueFrcstSrcDefinitionId | Type reference Properties Create, Filter, Group, Sort, Update Description The DMO that contains the field in which the total contract value exists. This field is a relationship field. Relationship Name BaseValueFrcstSrcDefinition Refers To ForecastingSourceDefinition | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | ForecastingCustomCategoryId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the forecasting custom category. This field is a relationship field. Relationship Name ForecastingCustomCategory Refers To ForecastingCustomCategory | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The combined language and locale ISO code, which controls the language of the FrcstCustmCatgRampRateSrc. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for this FrcstCustmCatgRampRateSrc value. This display value is the internal label that doesn't get translated. | <!-- document id=e7a7efb39df20256f12fb6404bc4e0cce284e6e2b1a2f1dcc95b413d0e79cb9e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_frcstcustmzadjustment.md --> # FrcstCustmzAdjustment Represents an individual forecast manager’s adjustment of a subordinate’s consumption forecast. Available in API version 63.0 and later. This object is different from the ForecastingAdjustment object, which represents managers’ adjustments of subordinates’ pipeline forecasts. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AdjustedAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The revenue amount of an individual forecast item, after an adjustment. | | AdjustedQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description The quantity amount of an individual forecast item, after an adjustment. | | AdjustmentNote | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A text note providing information about the adjustment. The maximum length is 255 characters. This field doesn’t appear in reports. | | ForecastingCustomCategoryId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the forecasting custom category. This field is a relationship field. Relationship Name ForecastingCustomCategory Refers To ForecastingCustomCategory | | ForecastingTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related forecasting type. This field is a relationship field. Relationship Name ForecastingType Refers To ForecastingType | | IsAmount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a revenue amount. If false, IsQuantity must be set to true. The default value is false. | | IsQuantity | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the adjustment is made in a quantity amount. If false, IsAmount must be set to true. The default value is false. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the forecast owner. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | PeriodId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Period ID for the adjustment. This field is a relationship field. Relationship Name Period Refers To Period | | Territory2Id | Type reference Properties Reserved for future use. Description Reserved for future use. | ## 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. [FrcstCustmzAdjustmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [FrcstCustmzAdjustmentFeed](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. [FrcstCustmzAdjustmentHistory](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. [FrcstCustmzAdjustmentOwnerSharingRule](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. [FrcstCustmzAdjustmentShare](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. <!-- document id=d3455acd4d0102a7faa8532f150679603168adf395c5a3846f9b70c64de421b9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_frcstcustmzowneradjustment.md --> # FrcstCustmzOwnerAdjustment Represents an individual forecast user’s adjustment of their own consumption forecast. Available in API version 63.0 and later. This object is different from the ForecastingOwnerAdjustment object, which represents users’ adjustments of their pipeline forecasts. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AdjustedAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The revenue amount of an individual forecast item, after an adjustment. | | AdjustedQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description The quantity amount of an individual forecast item, after an adjustment. | | AdjustmentNote | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A text note providing information about the adjustment. The maximum length is 255 characters. This field doesn’t appear in reports. | | CustomDimension | Type string Properties Create, Filter, Group, Nillable, Sort Description The ID of the additional dimension of the forecasting adjustment. For example, account ID, use case ID. Any data imported from an external source must be exactly 15 characters. | | ForecastingCustomCategoryId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the forecasting custom category. This field is a relationship field. Relationship Name ForecastingCustomCategory Refers To ForecastingCustomCategory | | ForecastingTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related forecasting type. This field is a relationship field. Relationship Name ForecastingType Refers To ForecastingType | | IsAmount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, then the adjustment is made in a revenue amount. If false, IsQuantity must be set to true. The default value is false. | | IsQuantity | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the adjustment is made in a quantity amount. If false, IsAmount must be set to true. The default value is false. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the forecast owner. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | PeriodId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Period ID for the adjustment. This field is a relationship field. Relationship Name Period Refers To Period | | Territory2Id | Type reference Properties Reserved for future use. Description Reserved for future use. | ## 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. [FrcstCustmzOwnerAdjustmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [FrcstCustmzOwnerAdjustmentFeed](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. [FrcstCustmzOwnerAdjustmentHistory](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. [FrcstCustmzOwnerAdjustmentOwnerSharingRule](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. [FrcstCustmzOwnerAdjustmentShare](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. <!-- document id=588bd3d767b002cda16e6285cbc2d964c8a731804af8b2b767afcc10a1519f3b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fequently_occurring_fields.md --> # Frequently Occurring Fields In addition to system fields, these fields are found on many objects. - OwnerId - RecordTypeId - CurrencyIsoCode ## OwnerId Objects have an ownerId field that is a reference to the user who owns that object. Ownership is an important concept that affects the security model and has other implications throughout the system. Any user can query the owner field for any record they can access. However, setting the ownerId field has the following limitations: - For most users and most objects, this field can’t be set directly upon insert. It is implicitly set to the current user when inserting an object. - When creating or updating a Case or Lead, a client application (that is logged in with sufficient permissions to transfer a record) can set this field to any valid User in the organization or to any valid queue of the appropriate type in the organization. - Updating this field via the API changes only the owner of that record. The change of ownership does not cascade to associated records as it does when you transfer record ownership in the Salesforce user interface. - Updating this field on an account deletes the existing sharing information and reapplies the organization-wide sharing defaults and sharing rules. - To update the ownerId field, the user must have the "Transfer Record" permission and Read access to the new owner. In API version 12.0 and later, if your organization has set up opportunity teams, OwnerId fields behave the same for Account and Opportunity objects as for other objects. That is, if you update the OwnerId field in either object, any AccountShare or OpportunityShare records with RowCause set to Sales Team are kept. In API version 11.0 and earlier, the sharing records are deleted. ## RecordTypeId Record types are used to offer different business processes and subsets of picklist values to different User records based on their Profile settings. (In addition, person accounts use record types to manage a number of additional elements. Record types are configured in the user interface or by creating, editing, or deleting the RecordType object in the API. Retrieve the list of valid record type IDs (String) for an object by querying the RecordType object. The RecordTypeId field in an object contains the ID of the RecordType record that is associated with a standard or custom object. You can create or update this field. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t create or update the RecordTypeId field on the CampaignMember records. Set the CampaignMember record type using the CampaignMemberRecordTypeId field on Campaign. When specified in a create or update call, the record type ID (String) must refer to a valid record type for that object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The RecordTypeId field is in your organization’s WSDL only if at least one record type is configured for your organization in the Salesforce user interface. ## CurrencyIsoCode For organizations that have multicurrency enabled, the CurrencyIsoCode field contains the string representation of the currency ISO code associated with currency values in the object. Note that the User object also has a DefaultCurrencyIsoCode field, which is the default currency for that user. For example, a user in France could have a DefaultCurrencyIsoCode set to Euros, and that would be their default currency in the application. However, the User object could have currency custom fields stored in a different currency, that correspond to the organization currency at the time the user record is created. <!-- document id=cf7245a98e8a8798ef91f6e63e444673fc8f6485269e68432d6fcc351d8adadd url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fsl__time_dependency__c.md --> # FSL\_\_Time\_Dependency\_\_c Represents a dependency between two service appointments. This object is used to define scheduling relationships between two appointments. It allows you to determine the order and timing in which dependent appointments should be scheduled. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in orgs that have the Field Service managed package installed. Records of this object are subject to standard sharing and security settings. ## Fields ### FSL\_\_Dependency\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the dependency. Possible values are: - Immediately Follow - Same Start - Start After Finish - Start After Finish And Same Day - **Default value**: Same Start ### FSL\_\_Root\_Service\_Appointment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service appointment that’s the root appointment of the entire dependency chain. The root appointment is the same service appointment for all the dependencies in the chain. This field is automatically populated by the system when creating a dependency. When creating a dependency via API, the API user must have permissions for this field. We recommend leaving this field empty when a dependency is created and avoiding any custom modifications. This field is a relationship field. - **Relationship Name**: FSL\_\_Root\_Service\_Appointment\_\_r - **Relationship Type**: Lookup - **Refers To**: ServiceAppointment ### FSL\_\_Same\_Resource\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: An indication of whether the two service appointments that share a dependency should be assigned to the same service resource. - **Default value**: false ### FSL\_\_Service\_Appointment\_1\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The first service appointment on which the second service appointment is dependent. This field is a relationship field. - **Relationship Name**: FSL\_\_Service\_Appointment\_1\_\_r - **Relationship Type**: Master-detail - **Refers To**: ServiceAppointment (the master object) ### FSL\_\_Service\_Appointment\_2\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The second service appointment that’s dependent on the first service appointment. This field is a relationship field. - **Relationship Name**: FSL\_\_Service\_Appointment\_2\_\_r - **Relationship Type**: Lookup - **Refers To**: ServiceAppointment ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated unique identifier for the appointment dependency record. <!-- document id=99e64405eeddcc4c916cd410b0c1498e09b09a1444677ac91babfeab8d8a9a36 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fulfillmentorder.md --> # FulfillmentOrder Represents a group of products, fees, and delivery charges on a single order that share the same fulfillment location, delivery method, and recipient. The FulfillmentOrderLineItems belonging to a FulfillmentOrder are associated with OrderItemSummary objects belonging to a single OrderSummary. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Account or Person Account associated with the FulfillmentOrder. It represents the shopper in the storefront. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | ActiveDate | Type datetime Properties Filter, Group, Nillable, Sort Description Date when the FulfillmentOrder becomes active. This field is available in API version 61.0 and later. | | BillToContactId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Contact associated with the FulfillmentOrder. It represents the shopper in the storefront when not using person accounts. This field is available in API version 49.0 and later. This field is a relationship field. Relationship Name BillToContact Relationship Type Lookup Refers To Contact | | ClosedDate | Type datetime Properties Filter, Group, Nillable, Sort Description Date the FulfillmentOrder closed. Automatically entered. This field is available in API version 61.0 and later. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. ISO code for the currency of the OrderSummary associated with the FulfillmentOrder. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. This field is available in API version 49.0 and later. | | DeliveryDate | Type datetime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the FulfillmentOrder was delivered. This field is a relationship field. | | DeliveryMethodId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the DeliveryMethod used for this FulfillmentOrder. This field is a relationship field. Relationship Name DeliveryMethod Relationship Type Lookup Refers To OrderDeliveryMethod | | FulfilledFromLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Location handling this FulfillmentOrder. This field is a relationship field. Relationship Name FulfilledFromLocation Relationship Type Lookup Refers To Location | | FulfilledToAddress | Type address Properties Filter, Nillable Description Address of the recipient. | | FulfilledToCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address city. | | FulfilledToCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address country. | | FulfilledToEmailAddress | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the recipient. | | FulfilledTo​GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy of the geocode for the recipient address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | FulfilledToLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with FulfilledToLongitude to specify the precise geolocation of the recipient address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | FulfilledToLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with FulfilledToLatitude to specify the precise geolocation of the recipient address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | FulfilledToName | Type string Properties Create, Filter, Group, Sort, Update Description Name on the recipient address. | | FulfilledToPhone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the recipient. | | FulfilledToPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address postal code. | | FulfilledToState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address state. | | FulfilledToStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address street. | | FulfillmentOrderNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the FulfillmentOrder. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments and tax, of the products, fees, and delivery charges on the FulfillmentOrder. This amount includes all FulfillmentOrderLineItems associated with the FulfillmentOrder. This amount is equal to TotalAmount + TotalTaxAmount. | | InvoiceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Invoice associated with the FulfillmentOrder. This field is a relationship field. Relationship Name Invoice Relationship Type Lookup Refers To Invoice | | IsReship | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the FulfillmentOrder is for a reshipment. The default value is false. This field is available in API version 53.0 and later. | | IsSuspended | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the FulfillmentOrder is suspended. The default value is false. | | ItemCount | Type double Properties Filter, Nillable, Sort Description Sum of the quantities of the FulfillmentOrderLineItems included in the FulfillmentOrder. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed this record. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed. | | OrderId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the original Order that generated the FulfillmentOrder. This field is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | | OrderSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the OrderSummary associated with the FulfillmentOrder. This field is a relationship field. Relationship Name OrderSummary Relationship Type Lookup Refers To OrderSummary | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who currently owns this FulfillmentOrder. Default value is the User logged in to the API to perform the create. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ProcessingTimeInMinutes | Type long Properties Create, Filter, Nillable, Sort, Update Description How many minutes it took to process the FulfillmentOrder, from the start of processing to completion. | | StartFulfillmentDate | Type datetime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the fulfillment process was started for the FulfillmentOrder. | | Status | Type picklist Properties Create, Filter, Group, Sort, Update Description Status of the FulfillmentOrder. Each status corresponds to one status category, shown here in parentheses. You can customize the status picklist to represent your business processes, but the status category picklist is fixed because processing is based on those values. If you customize the status picklist, include at least one status value for each status category. Default values are: - Allocated (Activated) - Assigned (Fulfilling) - Cancelled (Cancelled) - Draft (Draft) - Fulfilled (Closed) - Pick Complete (Fulfilling) This value is available in API v56.0 and later. - Pickpack (Fulfilling) - Printed (Fulfilling) This value is available in API v56.0 and later. - Rejected (Rejected) This value is available in API v56.0 and later. | | StatusCategory | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Status category of the FulfillmentOrder. Processing of the FulfillmentOrder depends on this value. Each status category corresponds to one or more statuses. Possible values are: - ACTIVATED—Activated - CANCELLED—Cancelled - CLOSED—Closed - DRAFT—Draft - FULFILLING—Fulfilling - REJECTED—Rejected This value is available in API v56.0 and later. | | TaxLocaleType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The system used to handle tax on the original Order associated with the FulfillmentOrder. Gross usually applies to taxes like value-added tax (VAT), and Net usually applies to taxes like sales tax. Possible values are: - Gross (displays most prices and taxes as combined values) - Net (displays most prices and taxes as separate values) This field is available in API version 49.0 and later. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the products on the FulfillmentOrder. This value only includes adjustments to FulfillmentOrderLineItems of type code Product, not adjustments to delivery charges or fees. | | TotalAdjustment​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the products on the Fulfillment Order, inclusive of tax. This value only includes adjustments to FulfillmentOrderLineItems of type code Product. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount. This field is available in API version 49.0 and later. | | TotalAdjustmentTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentAmount. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description Adjusted total, not including tax, of the FulfillmentOrderLineItems, including products, fees, and delivery charges, on the Fulfillment Order. | | TotalDelivery​AdjustAmount | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the delivery charges on the Fulfillment Order. This value only includes adjustments to FulfillmentOrderLineItems of type Delivery Charge. | | TotalDeliveryAdjust​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the delivery charges on the Fulfillment Order, inclusive of tax. This value only includes adjustments to FulfillmentOrderLineItems of type Delivery Charge. This amount is equal to TotalDeliveryAdjustAmount + TotalDeliveryAdjustTaxAmount. This field is available in API version 49.0 and later. | | TotalDelivery​AdjustTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalDeliveryAdjustAmount. | | TotalDeliveryAmount | Type currency Properties Filter, Nillable, Sort Description Total of the delivery charges on the FulfillmentOrder. This value only includes FulfillmentOrderLineItems of type Delivery Charge. | | TotalDelivery​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the delivery charges on the FulfillmentOrder, inclusive of tax. This value only includes FulfillmentOrderLineItems of type Delivery Charge. This amount is equal to TotalDeliveryAmount + TotalDeliveryTaxAmount. This field is available in API version 49.0 and later. | | TotalDeliveryTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalDeliveryAmount. | | TotalFeeAdjustAmount | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the fees on the FulfillmentOrder. This value only includes adjustments to FulfillmentOrderLineItems of type Fee. This field is available in API version 56.0 and later. | | TotalFeeAdjustAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the fees on the FulfillmentOrder, inclusive of tax. This value only includes adjustments to FulfillmentOrderLineItems of type Fee. This amount is equal to TotalFeeAdjustAmount + TotalFeeAdjustTaxAmount. This field is available in API version 56.0 and later. | | TotalFeeAdjustTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalFeeAdjustAmount. This field is available in API version 56.0 and later. | | TotalFeeAmount | Type currency Properties Filter, Nillable, Sort Description Total amount of the fees on the FulfillmentOrder, excluding adjustments and tax. This value only includes FulfillmentOrderLineItems of type Fee. This field is available in API version 56.0 and later. | | TotalFeeAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total price of the fees on the FulfillmentOrder, inclusive of tax. This value only includes FulfillmentOrderLineItems of type Fee. This amount is equal to TotalFeeAmount + TotalFeeTaxAmount. This field is available in API version 56.0 and later. | | TotalFeeTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalFeeAmount. This field is available in API version 56.0 and later. | | TotalProductAmount | Type currency Properties Filter, Nillable, Sort Description Total price of the products on the FulfillmentOrder, excluding order adjustments, delivery charges, and fees. This value only includes FulfillmentOrderLineItems of type code Product. | | TotalProduct​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total price of the products on the FulfillmentOrder, inclusive of tax. This value only includes FulfillmentOrderLineItems of type code Product. This amount is equal to TotalProductAmount + TotalProductTaxAmount. This field is available in API version 49.0 and later. | | TotalProductTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalProductAmount. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAmount. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Type of the FulfillmentOrder. Each type corresponds to one type category, shown here in parentheses. You can customize the type picklist to represent your business processes, but the type category picklist is fixed because processing is based on those values. If you customize the type picklist, include at least one type value for each type category. Default values are: - Download (Digital) - Email (Digital) - In Store Pickup (Physical) - Retail Store (Physical) - Supplier (Drop Ship) - Warehouse (Physical) | | TypeCategory | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type category of the FulfillmentOrder. Processing of the FulfillmentOrder depends on this value. Each type category corresponds to one or more types. Possible values are: - DIGITAL—Digital - DROPSHIP—Drop Ship - PHYSICAL—Physical | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [FulFillmentOrderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 62.0) Change events are available for the object. [FulfillmentOrderFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [FulfillmentOrderOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [FulfillmentOrderShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. #### See Also - [FulfillmentOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderlineitem.htm "Represents a product or delivery charge belonging to a FulfillmentOrder. Corresponds to an OrderItemSummary. This object is available in API version 48.0 and later.") - [Order](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_order.htm "Represents an order associated with a contract or an account.") - [OrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm "Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") <!-- document id=800694382b259efb6d136b7d299f05b59f69cb710d038ecb16de5c3d8f91a864 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fulfillmentorderitemadjustment.md --> # FulfillmentOrderItemAdjustment Represents a price adjustment on a FulfillmentOrderLineItem. Corresponds to an OrderItemAdjustmentLineSummary associated with the corresponding OrderItemSummary. This object is available in API version 48.0 and later. This object is used for calculations and doesn’t have a default record page. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort Description Amount, not including tax, of the adjustment. | | CampaignName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Campaign associated with the adjustment. | | CouponName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Coupon associated with the adjustment. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description ISO code for the currency of the FulfillmentOrderLineItem to which the adjustment applies. The default value is USD. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar This field is available in API version 49.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description Text description of the adjustment. | | FulfillmentOrderId | Type reference Properties Create, Filter, Group, Sort Description ID of the FulfillmentOrder associated with the FulfillmentOrderLineItem to which the adjustment applies. | | FulfillmentOrderItem​AdjustmentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the FulfillmentOrderLineItemAdjustment. | | FulfillmentOrder​LineItemId | Type reference Properties Create, Filter, Group, Sort Description ID of the FulfillmentOrderLineItem to which this adjustment applies. | | OrderItemAdjust​LineSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the OrderItemAdjustmentLineSummary associated with the adjustment. | | PromotionName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Promotion associated with the adjustment. | | TotalAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the adjustment, inclusive of tax. This amount is equal to Amount + TotalTaxAmount. This field is available in API version 49.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the Amount. | #### See Also - [FulfillmentOrder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorder.htm "Represents a group of products, fees, and delivery charges on a single order that share the same fulfillment location, delivery method, and recipient. The FulfillmentOrderLineItems belonging to a FulfillmentOrder are associated with OrderItemSummary objects belonging to a single OrderSummary. This object is available in API version 48.0 and later.") - [FulfillmentOrderItemTax](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderitemtax.htm "Represents the tax on a FulfillmentOrderLineItem or FulfillmentOrderItemAdjustment. Corresponds to an OrderItemTaxLineItemSummary. This object is available in API version 48.0 and later.") - [FulfillmentOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderlineitem.htm "Represents a product or delivery charge belonging to a FulfillmentOrder. Corresponds to an OrderItemSummary. This object is available in API version 48.0 and later.") - [OrderItemAdjustmentLineSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemadjustmentlinesummary.htm "Represents the current properties and state of price adjustments on an OrderItemSummary. Corresponds to one or more order item adjustment line item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") <!-- document id=b693d902cd84fe25102e09969687b41c606277de4f9bb23ebe6c970516be66c6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fulfillmentorderitemtax.md --> # FulfillmentOrderItemTax Represents the tax on a FulfillmentOrderLineItem or FulfillmentOrderItemAdjustment. Corresponds to an OrderItemTaxLineItemSummary. This object is available in API version 48.0 and later. This object is used for calculations and doesn’t have a default record page. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort Description Amount of tax represented by the FulfillmentOrderItemTax. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description ISO code for the currency of the FulfillmentOrderLineItem to which the tax applies. The default value is USD. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar This field is available in API version 49.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the FulfillmentOrderItemTax. | | FulfillmentOrderId | Type reference Properties Create, Filter, Group, Sort Description ID of the associated FulfillmentOrder. | | FulfillmentOrder​ItemAdjustId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If this object represents tax on an adjustment, this value is the ID of the FulfillmentOrderItemAdjustment to which the tax applies. If this value is null, the adjustment applies to a FulfillmentOrderLineItem. | | FulfillmentOrderItem​TaxNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the FulfillmentOrderItemTax. | | FulfillmentOrder​LineItemId | Type reference Properties Create, Filter, Group, Sort Description If this object represents tax on a FulfillmentOrderLineItem, this value is the ID of that FulfillmentOrderLineItem. If this object represents tax on an adjustment, this value is the ID of the FulfillmentOrderLineItem to which the adjustment applies. | | OrderItemTaxLineItem​SummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the OrderItemTaxLineItemSummary associated with the OrderItemSummary that corresponds to the FulfillmentOrderLineItem to which the tax applies. | | Rate | Type percent Properties Create, Filter, Nillable, Sort, Update Description Tax rate used to calculate the Amount. | | TaxEffectiveDate | Type date Properties Create, Filter, Group, Sort, Update Description Date on which the Amount was calculated. Important due to tax rate changes over time. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the Amount is actual or estimated. Possible values are: - Actual - Estimated | [FulFillmentOrderItemTaxChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. #### See Also - [FulfillmentOrder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorder.htm "Represents a group of products, fees, and delivery charges on a single order that share the same fulfillment location, delivery method, and recipient. The FulfillmentOrderLineItems belonging to a FulfillmentOrder are associated with OrderItemSummary objects belonging to a single OrderSummary. This object is available in API version 48.0 and later.") - [FulfillmentOrderItemAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderitemadjustment.htm "Represents a price adjustment on a FulfillmentOrderLineItem. Corresponds to an OrderItemAdjustmentLineSummary associated with the corresponding OrderItemSummary. This object is available in API version 48.0 and later.") - [FulfillmentOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderlineitem.htm "Represents a product or delivery charge belonging to a FulfillmentOrder. Corresponds to an OrderItemSummary. This object is available in API version 48.0 and later.") - [OrderItemTaxLineItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemtaxlineitemsummary.htm "Represents the current tax on an OrderItemSummary or OrderItemAdjustmentLineSummary. Corresponds to one or more order item tax line items, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") <!-- document id=05f32f95726c4fa4babab35ecbb0f94bbf6617f90902bf1f7f93e3a303c9ee9e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fulfillmentorderlineitem.md --> # FulfillmentOrderLineItem Represents a product or delivery charge belonging to a FulfillmentOrder. Corresponds to an OrderItemSummary. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. ISO code for the currency of the FulfillmentOrder associated with the FulfillmentOrderLineItem. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. This field is available in API version 49.0 and later. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the FulfillmentOrderLineItem. | | EndDate | Type dateTime Properties Create, Filter, Nillable, Sort Description End date of the FulfillmentOrderLineItem. | | FulfillmentOrderId | Type reference Properties Create, Filter, Group, Sort Description ID of the FulfillmentOrder associated with the FulfillmentOrderLineItem. This field is a relationship field. Relationship Name FulfillmentOrder Relationship Type Lookup Refers To FulfillmentOrder | | FulfillmentOrder​LineItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the FulfillmentOrderLineItem. | | FulfillmentAssetReference | Type string Properties Create, Filter, Group, Nillable, Sort Description Reference identifier of the fulfillment asset. | | FulfillmentAssetStartQuantity | Type double Properties Create, Filter, Nillable, Sort Description The number of fulfillment assets before assetization. | | FulfillmentAssetEndQuantity | Type double Properties Create, Filter, Nillable, Sort Description The number of fulfillment assets after assetization. | | GrossUnitPrice | Type currency Properties Create, Filter, Nillable, Sort Description Unit price, including tax, of the FulfillmentOrderLineItem. This value is equal to TotalPrice + TotalTaxAmount. This field is available in API version 49.0 and later. | | IsReship | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the FulfillmentOrderLineItem belongs to a reshipment. The default value is false. This field is available in API version 53.0 and later. | | MainFulfillmentOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the original FulfillmentOrderLineItem. This field is a relationship field. This field is available in API version 63.0 and later. Relationship Name FulfillmentOrderLineItem Relationship Type Lookup Refers To FulfillmentOrderLineItem | | OrderItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the original OrderItem for the OrderItemSummary associated with the FulfillmentOrderLineItem. This field is a relationship field. Relationship Name OrderItem Relationship Type Lookup Refers To OrderItem | | OrderItemSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the OrderItemSummary associated with the FulfillmentOrderLineItem. This field is a relationship field. Relationship Name OrderItemSummary Relationship Type Lookup Refers To OrderItemSummary | | OriginalQuantity | Type double Properties Create, Filter, Sort Description Original quantity of the FulfillmentOrderLineItem. | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the product represented by the FulfillmentOrderLineItem. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | Quantity | Type double Properties Create, Filter, Sort, Update Description Current quantity of the FulfillmentOrderLineItem. Equal to the original quantity minus any canceled quantity. | | QuantityUnitOfMeasure | Type string Properties Create, Filter, Group, Nillable, Sort Description Unit of measure of the quantity, for example: unit, gallon, ton, or case. | | RejectedQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description Used by the Distributed Order Management package and Store Fulfillment app to store the quantity that has been rejected by a fulfillment location. This field is available in API version 57.0 and later. | | RejectReason | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description If the FulfillmentOrderLineItem was rejected by a fulfillment location, the reason for the rejection. Default values are: - Damaged - Just Sold - Other - Out of Packing Supplies - Out of Stock This field is available in API version 56.0 and later. | | ReshipReason | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description If the FulfillmentOrderLineItem belongs to a reshipment, the reason for the reshipment. Default values are: - Damaged - Lost - Unknown - Wrong Item This field is available in API version 53.0 and later. | | ServiceDate | Type dateTime Properties Create, Filter, Nillable, Sort Description Service or start date of the FulfillmentOrderLineItem. | | ScopeIdentifierText | Type string Properties Create, Filter, Group, Nillable, Sort Description Unique identifier used to identify the scope in which this fulfillment order line item record is created. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description Total of any price adjustments applied to the FulfillmentOrderLineItem. | | TotalAdjustment​AmountWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the FulfillmentOrderLineItem, inclusive of tax. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount. This field is available in API version 49.0 and later. | | TotalAdjustment​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentAmount. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments and tax, of the FulfillmentOrderLineItem. | | TotalLineAmount | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort Description Total, not including adjustments or tax, of the FulfillmentOrderLineItem. | | TotalLineAmount​WithTax | Type currency Properties Filter, Nillable, Sort Description Total price of the FulfillmentOrderLineItem, inclusive of tax. This amount is equal to TotalLineAmount + TotalLineTaxAmount. This field is available in API version 49.0 and later. | | TotalLineTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalLineAmount. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of the FulfillmentOrderLineItem. Equal to UnitPrice times Quantity. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalPrice. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Type of the FulfillmentOrderLineItem. Matches the type of the associated OrderItemSummary. Delivery Charge indicates that the FulfillmentOrderLineItem represents a delivery charge. Fee indicates that it represents another type of fee, such as a return fee. Order Product indicates that it represents any other type of product, service, or charge. Each type corresponds to one type code, shown here in parentheses. Possible values are: - Delivery Charge (Charge) - Fee (Charge) This value is available in API v56.0 and later. - Order Product (Product) | | TypeCode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Type code of the FulfillmentOrderLineItem. Matches the type code of the associated OrderItemSummary. Processing depends on this value. Charge indicates that the FulfillmentOrderLineItem represents a charge or fee. Product indicates that it represents any other type of product, service, or charge. A type code can be associated with one or more types. Possible values are: - Charge - Product | | UnitPrice | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort Description Unit price of the FulfillmentOrderLineItem. | [FulFillmentOrderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. #### See Also - [FulfillmentOrder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorder.htm "Represents a group of products, fees, and delivery charges on a single order that share the same fulfillment location, delivery method, and recipient. The FulfillmentOrderLineItems belonging to a FulfillmentOrder are associated with OrderItemSummary objects belonging to a single OrderSummary. This object is available in API version 48.0 and later.") - [FulfillmentOrderItemAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderitemadjustment.htm "Represents a price adjustment on a FulfillmentOrderLineItem. Corresponds to an OrderItemAdjustmentLineSummary associated with the corresponding OrderItemSummary. This object is available in API version 48.0 and later.") - [FulfillmentOrderItemTax](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderitemtax.htm "Represents the tax on a FulfillmentOrderLineItem or FulfillmentOrderItemAdjustment. Corresponds to an OrderItemTaxLineItemSummary. This object is available in API version 48.0 and later.") - [OrderItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm "Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") <!-- document id=be51087ba5e725900e7c84254ee87f1fc2593e6284aff1dea5b15f23fb12bcd0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fulfmtroutgcriteria.md --> # FulfmtRoutgCriteria Stores individual fulfillment criteria with their metadata, actions, and activation status within a fulfillment criteria group version. This object is available in API version 66.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The create() and update() operations are restricted to internal Salesforce processes only. Users can't directly create or modify records through the API. To create or modify records, use the Fulfillment Routing Setup UI. ## Special Access Rules The Salesforce org must have: - Order Management enabled - Delivery Estimation enabled - Delivery Routing Engine enabled - User must have UseFulfillmentRoutingAPIs user permission. This permission is included in the Order Management Operations Manager permission set. ## Fields | Field | Details | | --- | --- | | ActionExpression | Type string Properties Filter, Group, Nillable, Sort Description For internal use only. | | ConditionExpression | Type string Properties Filter, Group, Nillable, Sort Description A logical expression that combines rule conditions by using identifiers. Defines the logical relationship between conditions. | | CanOverrideSplits | Type boolean Properties Filter, Group, Nillable, Sort Description Indicates whether the routing criteria can override the max splits allowed restriction (true) or not (false). Default value is false. This field is available from API version 67.0 and later. | | Description | Type string Properties Filter, Group, Nillable, Sort Description An optional description of the rule. | | EndDate | Type dateTime Properties Filter, Nillable, Sort Description An optional end date for the rule. NULL means no end date restriction. | | FulfmtRoutgCriteriaGrpVerId | Type reference Properties Filter, Group, Sort Description A foreign key reference to the rule group version that this rule belongs to. Links the rule to its parent group version. This field is a relationship field. Relationship Name FulfmtRoutgCriteriaGrpVer Relationship Type Master-detail Refers To FulfmtRoutgCriteriaGrpVer (the master object) | | FulfmtRoutgCriteriaType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Determines the criteria type of the rule. Possible values are: - Fulfillment | | FulfmtRoutgCriteriaUsageType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Determines the criteria usage type of the rule. Possible values are: - Filter - Weight | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the rule is active and included in DRL generation and execution (true) or not (false). Inactive rules are excluded from rule processing. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the criteria. Must be unique within the organization. | | RefFulfmtRoutgCriteria | Type reference Properties Filter, Group, Sort Description A foreign key that points to the parent rule version. NULL for the first version of a rule. This field is a relationship field. Relationship Name FulfmtRoutgCriteria Relationship Type Master-detail Refers To FulfmtRoutgCriteria (the master object) | | ScoringType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Determines how scores are calculated for custom weighted rules. Null for template weighted rules. This field is available in API version 67.0 and later. Possible values are: - InverseLinearRangeBased - LinearRangeBased - Static | | ScoringTypeMetadata | Type string Properties Filter, Nillable, Sort Description The metadata for scoring configuration stored as JSON for custom weighted rules. Null for template weighted rules. This field is available in API version 67.0 and later. | | StartDate | Type dateTime Properties Filter, Nillable, Sort Description An optional start date for the rule. NULL means no start date restriction. | | TemplateName | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Determines the template name for the rule. Possible values are: - InventoryMatchFilter—Inventory Availability - MarkdownAvoidanceRule—Markdown Inventory - OverstockScoreRule—Overstocked Inventory - ProximityScoreRule—Nearest Location | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Determines how the rule operates and what actions it can perform. Possible values are: - Filter - Weight | | Weight | Type double Properties Filter, Nillable, Sort Description The numeric value that determines the relative importance of this rule in scoring calculations. NULL for filter rules. | <!-- document id=eaa8c53dc20c47dd91ade928c2e88875dc66c6033b205ca56ceba5a41854b50b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fulfmtroutgcriteriaactnvar.md --> # FulfmtRoutgCriteriaActnVar Maps variable identifiers used in fulfillment criteria action expressions to entity fields. Stores the binding between symbolic variable names (e.g., $availableCapacity, $location) in action expression and the actual entity and field paths (e.g., Location.availableCapacity) used at runtime. This object is available in API version 66.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The create() and update() operations are restricted to internal Salesforce processes only. Users can't directly create or modify records through the API. To create or modify records, use the Fulfillment Routing Setup UI. ## Special Access Rules The Salesforce org must have: - Order Management enabled - Delivery Estimation enabled - Delivery Routing Engine enabled - User must have UseFulfillmentRoutingAPIs user permission. This permission is included in the Order Management Operations Manager permission set. ## Fields | Field | Details | | --- | --- | | Entity | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the object that contains the field being referenced. For example "Order" or "OrderItem". This identifies the context object that the field value is retrieved from at runtime. Must match an object name in the system. Possible values are: - Calendar - Config - FulfillmentRoutingSpec - Location - LocationProductInventory - ProductItem | | Field | Type string Properties Filter, Group, Nillable, Sort Description The name of the specific field within the object that this variable maps to. For example "availableCapacity". For filter rules where the action expression reference an object instead of a specific field, this can be null. For weighted rules with mathematical expressions, this field is required and must reference a numeric field. Must match a field name on the specified object. | | FulfmtRoutgCriteriaId | Type reference Properties Filter, Group, Sort Description A foreign key reference to the parent FulfillmentRoutingCriteria entity. Each action variable must belong to exactly one rule. This field is a relationship field. Relationship Name FulfmtRoutgCriteria Relationship Type Master-detail Refers To FulfmtRoutgCriteria (the master object) | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the variable. The name isn't required to be unique and can be customized by users. | | VariableName | Type string Properties Filter, Group, Sort Description The variable identifier that's used in the action expression. This is the symbolic name that appears in the action\_expression field of the parent rule. For example $availableCapacity, $location. Must include the $ prefix to distinguish it from numeric condition identifiers. Must be unique within a rule. | <!-- document id=ced0ff5be66bf8a4335b5302e6d67c1d1029f327bc6071868de575f3240a7db9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fulfmtroutgcriteriacond.md --> # FulfmtRoutgCriteriaCond Stores atomic conditions that make up fulfillment criteria logic, with globally unique identifiers. This object is available in API version 66.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The create() and update() operations are restricted to internal Salesforce processes only. Users can't directly create or modify records through the API. To create or modify records, use the Fulfillment Routing Setup UI. ## Special Access Rules The Salesforce org must have: - Order Management enabled - Delivery Estimation enabled - Delivery Routing Engine enabled - User must have UseFulfillmentRoutingAPIs user permission. This permission is included in the Order Management Operations Manager permission set. ## Fields | Field | Details | | --- | --- | | FulfmtRoutgCriteriaId | Type reference Properties Filter, Group, Sort Description The numeric identifier used in the rule's expression to reference this condition. Must be unique within the rule and used in logical expressions. This field is a relationship field. Relationship Name FulfmtRoutgCriteria Relationship Type Master-detail Refers To FulfmtRoutgCriteria (the master object) | | Identifier | Type int Properties Filter, Group, Sort Description An operator that determines the type of comparison performed on the left and right sides of the condition. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | LeftEntity | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A field on the left entity that specifies which property of the entity to check for comparison. Possible values are: - Calendar - Config - FulfillmentRoutingSpec - Location - LocationProductInventory - ProductItem | | LeftField | Type string Properties Filter, Group, Sort Description The target entity for comparisons when comparing two entity fields. NULL when comparing against a literal value. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the condition. | | Operator | Type picklist Properties Filter, Group, Restricted picklist, Sort Description An operator that determines the type of comparison performed on the left and right sides of the condition. Possible values are: - After - Before - Contains - Equals - Greater\_Than—Greater Than - Greater\_Than\_Or\_Equals—Greater Than Or Equals - Is\_Not\_Null—Is Not Null - Is\_Null—Is Null - Less\_Than—Less Than - Less\_Than\_Or\_Equals—Less Than Or Equals - Not\_Contains - Not\_Equals—Not Equals | | RightEntity | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The field on the right entity for comparisons when comparing two entity fields. NULL when comparing against a literal value. Possible values are: - Calendar - Config - FulfillmentRoutingSpec - Location - LocationProductInventory - ProductItem | | RightField | Type string Properties Filter, Group, Nillable, Sort Description Literal value for comparisons when comparing against a constant value. NULL when comparing two entity fields. | | RightValue | Type string Properties Filter, Group, Nillable, Sort Description Literal value for comparisons when comparing against a constant value. NULL when comparing two entity fields. | <!-- document id=f3b05a0c27289b716d8ff5cf339f7a290a8ea2e56eec4dcc2c4ddb9ca1e76d60 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fulfmtroutgcriteriagrp.md --> # FulfmtRoutgCriteriaGrp Represents a logical grouping of rules for a specific business context, for example, Fulfillment routing and Delivery estimation. This object is available in API version 66.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The create() and update() operations are restricted to internal Salesforce processes only. Users can't directly create or modify records through the API. To create or modify records, use the Fulfillment Routing Setup UI. ## Special Access Rules The Salesforce org must have: - Order Management enabled - Delivery Estimation enabled - Delivery Routing Engine enabled - User must have UseFulfillmentRoutingAPIs user permission. This permission is included in the Order Management Operations Manager permission set. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Filter, Group, Nillable, Sort Description An optional description of the rule group. | | DraftFulfmtRoutgCritGrpVerId | Type reference Properties Filter, Group, Nillable, Sort Description A reference to the draft version of the rule group. This is the unpublished version that can be edited. Only one draft version of a rule group can exist at a time. This field is a relationship field. Relationship Name DraftFulfmtRoutgCritGrpVer Refers To FulfmtRoutgCriteriaGrpVer | | ExternalReference | Type string Properties Filter, Group, idLookup, Sort Description A unique reference to the Fulfillment Criteria Group record from external callers. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the rule group is active and being executed (true) or not (false). Inactive groups are excluded from DRL generation and runtime execution, even if they have published versions. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the rule group. Must be unique within the organization. | | PubFulfmtRoutgCritGrpVerId | Type reference Properties Filter, Group, Nillable, Sort Description A reference to the published version rule group. This is the version that's active in production and being executed by the rules engine. Only one published version of a rule group can exist at a time. This field is a relationship field. Relationship Name PubFulfmtRoutgCritGrpVer Refers To FulfmtRoutgCriteriaGrpVer | | RefFulfmtRoutgCritGrpVer | Type reference Properties Filter, Group, Nillable, Sort Description A reference to the published version rule group. This is the version that's active in production and being executed by the rules engine. Only one published version of a rule group can exist at a time. This field is a relationship field. Relationship Name RefFulfmtRoutgCritGrpVer Refers To FulfmtRoutgCriteriaGrpVer | | UsageType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Business context that defines the domain where this rule group operates. Possible value is: - Fullfillment—Rules for order fulfillment and routing. | ## 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. [FulfmtRoutgCriteriaGrpHistory](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. [FulfmtRoutgCriteriaGrpOwnerSharingRule](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. [FulfmtRoutgCriteriaGrpShare](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. <!-- document id=11b50d06fc8e6c6135dc2cd54d2b4758b15edb68f974dcaea40721421dda5fe6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_fulfmtroutgcriteriagrpver.md --> # FulfmtRoutgCriteriaGrpVer Manages versioning and lifecycle states for fulfillment criteria groups, providing stable external references while supporting versioning. This object is available in API version 66.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The create() and update() operations are restricted to internal Salesforce processes only. Users can't directly create or modify records through the API. To create or modify records, use the Fulfillment Routing Setup UI. ## Special Access Rules The Salesforce org must have: - Order Management enabled - Delivery Estimation enabled - Delivery Routing Engine enabled - User must have UseFulfillmentRoutingAPIs user permission. This permission is included in the Order Management Operations Manager permission set. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Filter, Group, Nillable, Sort Description An optional description of the rule group. | | FulfmtRoutgCriteriaGrpId | Type reference Properties Filter, Group, Sort Description A foreign key reference to the parent RuleGroup entity. Links this version to its parent group and establishes the versioning relationship. This field is a relationship field. Relationship Name FulfmtRoutgCriteriaGrp Relationship Type Master-detail Refers To FulfmtRoutgCriteriaGrp (the master object) | | IsByPassSplits | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | MaxSplitsAllowed | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the rule group. Usually inherited from the parent RuleGroup, though it is customizable. | | State | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The current lifecycle state of this rule group version. Determines which operations are allowed and whether the version is active in production. Possible values are: - Archived - Draft - PendingArchive—Pending Archive - PendingPublished—Pending Published - Published | | VersionNumber | Type int Properties Filter, Group, Sort Description The sequential version number that increments automatically with each new version. This field is system-managed and can't be manually edited. | ## 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. [FulfmtRoutgCriteriaGrpVerHistory](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. <!-- document id=aa55515b1f05d11f6bc2c8a1b57f1731882990ccac5a79e517c8b250852858e3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_functionconnection.md --> # FunctionConnection Represents a connection between an org and Salesforce Functions. This object is available in API version 52.0 and later. In API version 53.0, the name of this object was changed from SfFunctionsConnection to FunctionConnection. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Error | Type string Properties Filter, Group, Nillable, Sort Description The error string, if any, for the connection between the org and Salesforce Functions. | | FunctionsAccountLoginOrg | Type string Properties Filter, Group, Nillable, Sort Description The Salesforce Functions account login org. | | FunctionsAccountName | Type string Properties Filter, Group, Nillable, Sort Description The Salesforce Functions account name. | | FunctionsAccountUuid | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique Salesforce Functions account UUID. This is a generated ID that is not in Salesforce object ID format. | | Sequence | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Sequence number for the record. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The status of the connection between the org and Salesforce Functions. Possible values are: - Attempted - None - TrustedBiDirection - TrustedUniDirection The default value is 'None'. TrustedBiDirection indicates the connection is fully established. | ## Usage FunctionConnection is not intended for direct use and should be treated as a read-only object that represents the current connection information between your org and Salesforce Functions. To create and manage connections between your org and Salesforce Functions use the steps and commands described in the [Salesforce Functions developer documentation](https://developer.salesforce.com/docs/platform/functions/guide/index.html). FunctionConnection is not supported in Trialforce templates or org snapshots. <!-- document id=8f42e15ae992398d058921b5b29677eae1196852a1e5a6a514cbc456656e1c31 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_functioninvocationrequest.md --> # FunctionInvocationRequest Represents invocation information for a Salesforce Function. This object is available in API version 51.0 and later. When a Salesforce Function is invoked using the Apex functions.Function invoke methods, a FunctionInvocationRequest record is created that contains information on the status and results of the invocation. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), undelete(), update() ## Fields | Field | Details | | --- | --- | | CallbackStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The status of the callback for asynchronous invocations. This field is new in API version 52.0. Possible values are: - Completed - Not used for the Salesforce Functions beta. - Enqueued - The Function has completed (either successfully or unsuccessfully), and the callback has been enqueued for asynchronous execution in the Salesforce org. - Failed - Not used for the Salesforce Functions beta. - PendingResponse - The Function has not yet completed, so the callback has not been called yet. The default value is 'PendingResponse'. | | ExecutionTime | Type long Properties Filter, Group, Nillable, Sort, Update Description The execution time of the Function in milliseconds. | | ExtendedResponse | Type textarea Properties Nillable, Update Description JSON object with additional information about the result of the Function execution. | | FunctionName | Type string Properties Filter, Group, idLookup, Sort Description Name of the Function that was invoked. This name is case-sensitive and uses the format “project name\-function name” | | InvokingNamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Prefix of the namespace that invokes the function. A namespace can invoke the global function using an installed package via Apex. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. This object is available in API version 53.0 and later. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | OwnerId | Type reference Properties Filter, Group, Sort, Update Description The owner of the FunctionInvocationRequest. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ResponseBody | Type base64 Properties Nillable, Update Description Response body of the invoked Function. | | ResponseContentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description Content type of the response body of the invoked Function. For example, the content type could be application/json, text/csv, or various other values depending on what the Function returned. | | ResponseLength | Type int Properties Filter, Group, Nillable, Sort Description Length of the response body. | | ResponseName | Type string Properties Filter, Group, Nillable, Sort, Update Description Name of response, not currently used. | | ResponseUncompressedLength | Type int Properties Filter, Group, Nillable, Sort, Update Description Uncompressed length of the Function response, if the response content was compressed. | | StackTrace | Type textarea Properties Nillable, Update Description If there was an error invoking the function, this field contains the Function stack trace. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Status of the invoked Function. Functions that are invoked asynchronously can be in a queued InProgress state before they are invoked. Possible values are: - Dispatched - Not used for the Salesforce Functions beta. - Error - The Function failed to execute due to either an error starting the Function, or an error while the Function was running. - FunctionInProgress - The Function invocation has been sent to the Salesforce Functions compute environment, and is running. - InProgress - The Function invocation request has been enqueued. - New - The Function invocation request has been created, but not enqueued yet. - Success - The Function has completed execution. For status on whether the callback has been called, see the CallbackStatus field. The default value is 'New'. | ## Usage Treat FunctionInvocationRequest records as read-only records used to get information about a specific Function invocation. To invoke Functions, use the Apex functions.Function class invoke methods. FunctionInvocationRequest is not supported in Trialforce templates or org snapshots. <!-- document id=1d33901aed7ac9297473fa10e603913c8452bb7216dc8667f9a8a29d9cec85f5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_functionreference.md --> # FunctionReference Represents a deployed Salesforce Function associated with an org. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Access | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The label for whether managed components can access across namespaces. Possible values are: - Global—The managed components can access across namespaces. - Public—The managed components can access within the same namespace. The default value is Public. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the Function. | | FunctionName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The developer name of the Function. This name is case sensitive and uses the format “project name\-function name”. This field is unique within your organization. | | ImageReference | Type reference Properties Filter, Group, Nillable, Sort Description Stores details about an image associated with a function. This is internal only, used by packaging only, and should not be editable or set by the customer. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language code for the Function, such as “en\_US”. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The master label for the Function. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. This object is available in API version 53.0 and later. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | ## Usage Treat FunctionReference records as read-only records used to get information about a specific Function associated with your org. To invoke Functions, use the Apex functions.Function class invoke methods. To deploy and associate Functions with your org, use Salesforce CLI commands associated with Functions, as described in the [Salesforce Functions developer documentation](https://developer.salesforce.com/docs/platform/functions/guide/index.html). FunctionReference is not supported in Trialforce templates or org snapshots. <!-- document id=8081a0686c58f712303a4b9dd7dedf5b0f519e027f6a3a938fd3ca0a80371f80 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_genaiconversationsummary.md --> # GenAIConversationSummary Represents a generated summary of a voice or video call. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To access this object, Einstein Conversation Insights and Einstein for Sales must be enabled in your org. ## Fields | Field | Details | | --- | --- | | ConversationRecordId | Type reference Properties Create, Filter, Group, Sort Description The unique ID of the related voice or video call record. This field is a polymorphic relationship field. Relationship Name ConversationRecord Relationship Type Master-detail Refers To VideoCall, VoiceCall (the master object) | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. Possible values are: - MXN—Mexican Peso - USD—U.S. Dollar The default value is USD. | | ErrorMessage | Type string Properties Filter, Group, Nillable, Sort Description An error message when there is a problem with sharing the conversation summary. | | Source | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Whether the summary shown is content generated by Einstein or subsequently edited by a user. Possible values are: - EINSTEIN\_GPT—Einstein - USER\_EDITED—User Edited | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The status of the summary. Possible values are: - ERROR—Error - GENERATING—Generating - SUCCESS—Success | | Summary | Type textarea Properties Create, Nillable, Update Description The summary text content. | ## 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. [GenAIConversationSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [GenAIConversationSummaryFeed](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. [GenAIConversationSummaryHistory](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. [GenAIConversationSummaryOwnerSharingRule](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. [GenAIConversationSummaryShare](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. <!-- document id=1551836dccd814c41242a365e05dcb415d46e2dbfb4a646440308aa5a6ad6c58 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_genaifunctiondefinition.md --> # GenAiFunctionDefinition Represents an agent action. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, Agents must be enabled in your org. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Update Description A description explaining the general purpose and domain of the action. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name for this object. | | InvocationTarget | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Target invocation used by invocation operations. | | InvocationTargetType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Invocable action types used by invocation operations. Possible values are: - apex - flow - generatePromptResponse | | IsConfirmationRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether confirmation is required for this action. The default value is false. | | IsLocal | Type boolean Properties Defaulted on create, Filter, Group, Sort Description This field is a calculated field and is set to true if this action is an edited version of a standard action. The default value is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the GenAiFunctionDefinition. The value for this field is the language value of the org. | | LocalDeveloperName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique name for this action within a topic. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The master label for the generative AI action. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace of the GenAiFunctionDefinition. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the object that owns the action. This field is a relationship field. Relationship Name Parent Refers To GenAiPlannerFunctionDef | | PlannerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The agent planner service for this action. This field is a relationship field. Relationship Name Planner Refers To GenAiPlannerDefinition | | PluginId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The agent topic for this agent action. This field is a relationship field. Relationship Name Plugin Refers To GenAiPluginDefinition | | Source | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The optional source standard or custom action from which this action's configuration, including description, input, and output, is copied. If there's no value, the action is used only within the parent topic. | <!-- document id=74a50b456405b5b03e06204de8cd5f0ea8b12808cac523969ebca55f59cbfc59 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_genaiplannerdefinition.md --> # GenAiPlannerDefinition Represents an agent planner service that uses a large language model (LLM) and a reasoning strategy to decompose a given task into smaller subtasks, identify the most suitable actions for each subtask, and invoke them. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, Agents must be enabled in your org. ## Fields | Field | Details | | --- | --- | | Capabilities | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A set of tags associated with the agent planner service definition. | | Description | Type textarea Properties Create, Filter, Group, Sort, Update Description A description explaining the general purpose and domain of the agent planner service definition. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name for this object. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the GenAiPlannerDefinition. The value for this field is the language value of the org. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The master label of the agent planner service definition. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace of the GenAiPlannerDefinition. | | PlannerType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A particular approach to problem solving that is given as prompt instructions to a large language model (LLM). Possible values are: - AiCopilot\_\_ReAct—Uses a reactive planning strategy to solve problems with the LLM. This strategy consists of prompting the LLM to generate the next step in response to an event and the current context. It differs from a sequential planner in that it doesn’t plan more than one step ahead of time. - AiCopilot\_\_SequentialPlannerIntentClassifier—Uses an intent classifier prompt and a sequential planner prompt. With each text input, the planner asks the LLM to generate a step-by-step plan to finish the goal. It plans first, then executes. | <!-- document id=75d3020f3d983771c28dcd72bec0901a3458e5b197f9eb6b943787f7ca007f20 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_genaiplannerfunctiondef.md --> # GenAiPlannerFunctionDef Represents a relationship between the agent planner service and agent actions. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, Agents must be enabled in your org. ## Fields | Field | Details | | --- | --- | | PlannerId | Type reference Properties Create, Filter, Group, Sort, Update Description This field is a relationship field. Relationship Name Planner Relationship Type Lookup Refers To GenAiPlannerDefinition | | Plugin | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A set of actions that contextualize the agent planner service. | <!-- document id=1cb413f5afa4c40b0083f678f2f191bc7d983409fe0e353fa8616d4e9d29f0d5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_genaiplugindefinition.md --> # GenAiPluginDefinition Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, Agents must be enabled in your org. ## Fields | Field | Details | | --- | --- | | CanEscalate | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this topic is eligible for escalation to a rep. The default value is false. | | Description | Type textarea Properties Create, Update Description The description of the topic. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Represents the API name of the topic. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. | | IsLocal | Type boolean Properties Defaulted on create, Filter, Group, Sort Description This field is a calculated field and is set to true if this topic is an edited version of a standard topic. The default value is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the topic. | | LocalDeveloperName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique name for this topic within an agent. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The master label for the topic. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of these values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the object that owns the topic. This field is a polymorphic relationship field. Relationship Name Parent Refers To GenAiPlannerDefinition, GenAiPlannerFunctionDef | | PlannerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The agent planner service for this topic. This field is a relationship field. Relationship Name Planner Refers To GenAiPlannerDefinition | | PluginType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Possible values are: - APICustomTopic - Topic | | Scope | Type textarea Properties Create, Nillable, Update Description A specific job description for a topic. | | Source | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The optional source standard or custom topic from which this topic's configuration, including description, instructions, and utterances, is copied. If there's no value, the topic is used only within this agent version. | <!-- document id=2f77696cff2d12a20711149d7fe2f259a0053d7f1eb541186ccf74dceab693f5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_genopplanreferencerecord.md --> # GenOpPlanReferenceRecord Represents a reference record, such as a similar case, associated with a generated operation plan. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | DisplayName | Type string Properties Filter, Group, Nillable, Sort Description The display name of the similar record only if it is configured in the Custom Retriever. If it isn’t configured, this field is blank. Available in API version 68.0 and later. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The autonumber name of the generated operation plan reference record. | | PlanId | Type reference Properties Filter, Group, Sort Description The ID of the related GenOpPlan. This field is a relationship field. Relationship Name: Plan. Refers To: GenOpPlan. This field is a relationship field. Relationship Name Plan Refers To GenOpPlan | | Ranking | Type int Properties Filter, Group, Nillable, Sort Description The relevance order of this reference record relative to other references associated with the same plan, with lower numbers indicating higher relevance. | | ReferenceRecord | Type string Properties Filter, Group, Sort Description The ID or identifier of the record being referenced, such as a similar case, that grounds the content of the generated operation plan. | | Url | Type string Properties Filter, Group, Nillable, Sort Description The URL prefix of the similar record only if it is configured in the custom retriever. If it isn’t configured, this field is blank. Available in API version 68.0 and later. | ## Usage Use this object to store and retrieve the reference records, such as similar cases, associated with a generated operation plan. Each GenOpPlanReferenceRecord is linked to its parent plan through PlanId and provides the display label, ranking, and URL used to surface citations for the plan's generated content. The DisplayName and Url fields are populated only when a custom retriever is configured for the reference source. If no custom retriever is set up, these fields remain blank. ## 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. GenOpPlanReferenceRecordChangeEvent. Change events are available for the object. GenOpPlanReferenceRecordFeed. Feed tracking is available for the object. GenOpPlanReferenceRecordHistory. History is available for tracked fields of the object. GenOpPlanReferenceRecordOwnerSharingRule. Sharing rules are available for the object. GenOpPlanReferenceRecordShare. Sharing is available for the object. <!-- document id=15101fab9c30f4cc5eda18a35f3c939b1203b5cc2355e050670c6d571c55d87e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_genopplanrequest.md --> # GenOpPlanRequest Represents a request to generate a service plan. This object is available in API version 67.0 and later. Each request is stored as record data. We support all delete operations at the record or bulk level. For example, you can [use Bulk API 2.0 to delete multiple records in Marketing Cloud Next](https://developer.salesforce.com/docs/marketing/marketing-cloud-growth/guide/mc-manage-objects-delete-bulk.html). ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules To access this object, you must have the Service Planner Access add-on license. ## Fields | Field Name | Details | | --- | --- | | CopilotId | Type reference Properties Filter, Group, Sort, Nillable Description (Optional) The ID of the Einstein Copilot associated with the plan request. This field is a relationship field. Relationship Name Copilot Refers To GenAiPlannerDefinition | | CopilotName | Type string Properties Filter, Group, Sort, Nillable Description (Optional) The name of the Einstein Copilot associated with the plan request. | | ErrorCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description (Optional) The standard error code when plan generation fails. Possible values are: - AgentNotActive - AgentNotFound - CaseGroundingNotEnabled (Service AI Grounding isn’t enabled) - InstructionsOrActionsNotFound - InsufficientData - InvalidRecordId - NoEligibilityDefined (No eligibility criteria defined) - NotEligible - RagConfigurationError - StepSummaryEmpty - TopicIdNotFound - TopicNotFound - Unknown | | ErrorMessage | Type string Properties Filter, Group, Sort, Nillable Description (Optional) The error message when plan generation fails. | | LlmModelName | Type string Properties Filter, Group, Sort, Nillable Description (Optional) The name of the large language model used for plan generation. The maximum length is 80 characters. | | LlmProviderName | Type string Properties Filter, Group, Sort, Nillable Description (Optional) The name of the LLM provider. The maximum length is 80 characters. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Required) The auto-generated name of the generated operation plan request. | | ParentId | Type reference Properties Filter, Group, Sort Description (Required) The ID of the service plan parent record. This field is a polymorphic relationship field. Relationship Name Parent Relationship Type Master-detail Refers To Case, Incident, MessagingSession, Opportunity (the master object) | | PromptTemplateDevName | Type string Properties Filter, Group, Sort, Nillable Description (Optional) The developer name of the prompt template used for plan generation. The maximum length is 80 characters. | | PromptTemplateVersionNo | Type int Properties Filter, Group, Sort, Nillable Description (Optional) The version number of the prompt template. | | Reason | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description (Required) The reason why plan generation failed or returned no steps. Possible values are: - CannotGeneratePlan - NoEligibilityConfig (no eligibility criteria set) - None (default) - NoPlanGenerated PlanEmpty - PlanEmptyInsufficientData - RagConfigurationError - ThresholdError (eligibility not met for unknown reason) - ThresholdNotMet | | RequestSource | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description (Optional) The source where the plan request originated. Possible values are: - CASE - EINSTEIN\_LEX (Einstein Chat LEX component) - INCIDENT | | RequestType | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description (Required) The type of service plan request. Possible values are: - Close - Generation - Summary (default) | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description (Required) The status of the plan generation request. Possible values are: - Error - Incomplete - InProgress (default) - Success | | Utterance | Type textarea Properties Nillable Description (Optional) The natural language input or prompt used for plan generation. The maximum length is 32,000 characters. | <!-- document id=d6fe0938ee05ab5f49660cc8a56d40bf3464150aff966525b659f8adfaae014b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_geocountry.md --> # GeoCountry Represents a country. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The GeoCountry object is available if B2B Commerce or D2C Commerce is enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of this record. | | IsoCode | Type string Properties Create, Filter, Group, idLookup, Sort Description Two-letter ISO code of the country as defined in the org’s State-Country picklist. This field is unique within your organization | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed data in this record, a record related to this record, or a list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user accessed data in this record or list view but didn't view it directly. | | Name | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The name of the country that corresponds with the ISO code. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the GeoCountry record. By default, the asset owner is the user who created the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## 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. [GeoCountryOwnerSharingRule](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. [GeoCountryShare](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. #### See Also - [GeoState](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_geostate.htm "Represents a state. This object is available in API version 57.0 and later.") - [TaxGeoConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taxgeoconfig.htm "Represents a tax configuration associated with a GeoCountry. This object is available in API version 57.0 and later.") <!-- document id=4267ca9f2339dfcc1dab2a28d199ed23ab16d553e85f4e643bf5a21430b96943 url=/legacydeveloper/current/en-us/object_reference/compound_fields_geolocation.md --> # Geolocation Compound Field Geolocation fields are accessible in the SOAP and REST APIs as a Location—a structured compound data type—or as individual latitude and longitude elements. In API versions 26.0 and later, geolocation fields are available in the SOAP and REST APIs as a compound field of type Location. This structured data type contains the following fields. - latitude - longitude ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note SOAP calls that use API versions earlier than 30.0 return geolocation compound values as strings. See “Returned Geolocation Data Types” later in this topic. Geolocation fields are provided on many standard objects, such as Account, Contact, Quote, and User, as part of their address field or fields. Geolocation fields can also be added as custom fields to standard or custom objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - A geolocation compound field is read-only, although its latitude and longitude subfields are editable. You can only access compound fields using the SOAP or REST API. For more information about working with compound fields and their subfields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). - Although geolocation fields appear as a single field in the user interface, custom geolocation fields count as _three_ custom fields towards your organization’s limits: one for latitude, one for longitude, and one for internal use. ## Retrieving Compound Geolocation Fields Using compound fields can simplify code that works with geolocations, especially for SOQL queries. SOQL SELECT clauses can reference geolocations directly, instead of the individual component fields. SELECT location\_\_c FROM Warehouse\_\_c To write code that’s compatible with API versions earlier than 26.0 and with API versions 26.0 and later, use the individual latitude and longitude fields. SELECT location\_\_latitude\_\_s, location\_\_longitude\_\_s FROM Warehouse\_\_c ## Returned Geolocation Data Types A compound geolocation field value is returned as the structured data type Location. Code that works with compound geolocation fields must reference the individual components of the returned value. See the sample code in [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm#compound_fields_example_soap_retrieve_address). In API versions earlier than 30.0, SOAP calls return compound geolocation field values as strings, instead of as a structured data type, for backward compatibility. If you plan to display your latitude and longitude values or pass them to a service that expects strings, use the values that are returned. If you plan to use the values in mathematical calculations or pass them to a map service that expects numbers, cast the results to numbers. The string value format is: API location: \[latitudeValue longitudeValue\] An example of a regular expression to parse out the latitude and longitude values is: API location: \\\[(\[-+\]?\\d{1,2}(\[.\]\\d+)?) (\[-+\]?\\d{1,3}(\[.\]\\d+)?)\] The first capture is the latitude, and the third is the longitude. <!-- document id=f5c59aa159f3b31a18bb8dfc3a32b475f4a03a7df6deb36be8fd5d91f9b515e3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_geolocationbasedaction.md --> # GeolocationBasedAction Represents a geolocation-based action, which is an action that’s triggered when a user enters, exits, or is within the area of the associated object. Available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | ActionData | Type textarea Properties Create, Nillable, Update Description The details of the selected action type. | | ActionType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of action. Possible values are: - PlatformAlert - QuickAction - ViewRecord | | Description | Type textarea Properties Create, Nillable, Update Description The description of the action. | | InitialTimeInvoked | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Captures the first time the mobile worker invoked this action. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastTimeInvoked | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Captures the last time the mobile worker invoked this action. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the action. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Radius | Type int Properties Create, Filter, Group, Sort, Update Description The distance in meters from the location of the associated object that triggers the action. | | ReferenceRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the record that the action is associated with. This field is a relationship field. Relationship Name ReferenceRecord Relationship Type Lookup Refers To ServiceAppointment | | TriggerType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The event that triggered this action. Possible values are: - GeoFenceEnter—Enter - GeoFenceExit—Exit | ## 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. [GeolocationBasedActionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. <!-- document id=ffcb1d270f5b146ec7e442f12ee976df794ff3b9988bc7c8322585ba02c0268c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_geostate.md --> # GeoState Represents a state. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The GeoState object is available if B2B Commerce or D2C Commerce is enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of this record. | | GeoCountryId | Type reference Properties Create, Filter, Group, Sort Description ID of the GeoCountry associated with this GeoState. This field is a relationship field. Relationship Name GeoCountry Relationship Type Lookup Refers To GeoCountry | | IsoCode | Type string Properties Create, Filter, Group, Sort Description Two-letter ISO code of the state as defined in the org’s State-Country picklist. This field is unique within your organization | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed data in this record, a record related to this record, or a list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user accessed data in this record or list view but didn't view it directly. | | Name | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The name of the state that corresponds with the ISO code. | #### See Also - [GeoCountry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_geocountry.htm "Represents a country. This object is available in API version 56.0 and later.") <!-- document id=f8331b38d9b4e7d637bd30002b797b1d25887329dfb8e867bd1c0d02474c84dd url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_goal.md --> # Goal The Goal object represents the components of a goal such as its name, description, and status. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | CompletionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The completion date of the goal. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the goal. The maximum length is 65,535 characters. | | DueDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the goal is due. | | ImageUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL for the goal image. The image must be stored in Documents and set as externally available. Applicable only to Goal objects of Type: Goal. | | IsKeyCompanyGoal | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the goal is a key company goal. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when a user last viewed a record that is related to this goal. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when a user last viewed this goal. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description The name of the goal. The maximum length is 255 characters. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who owns the goal. | | Progress | Type percent Properties Filter, Nillable, Sort Description The progress of the goal measured as a percentage. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the goal. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the goal. Possible values: - Draft - Published - Completed - Canceled - Not Completed | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [GoalFeed](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. [GoalHistory](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. [GoalOwnerSharingRule](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [GoalShare](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. <!-- document id=1f80fcf3660b7b74edd28dec0511cd4063d4335507498eff024886e6a4c62606 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_goallink.md --> # GoalLink Represents the relationship between two goals. This is a many-to-many relationship, meaning that each goal can link to many other goals. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The auto-generated name of the goal link. | | ParentGoalId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the parent goal. | | SubgoalId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the subgoal. | <!-- document id=ae10193c5c4c26392fd085986bb3af75743b0ca8bcf12ba668754a36711fe388 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_googledoc.md --> # GoogleDoc Represents a link to a Google Document. This object is available in API version 14.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in **All** Editions except **Database.com** for Google Apps Premier Edition accounts. See the Salesforce online help for more information. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, Sort, Update Description The name of the Google document. | | Owner | Type reference Properties Create, Defaulted on create, Filter, Nillable, Update Description The ID of the user who currently owns this Google Document. Default value is the user logged in to the API to perform the create. | | ParentId | Type reference Properties Create, Filter Description Required. ID of the attachment's parent object. The following objects are supported as parents of Google documents: Account, Asset, Campaign, Case, Contact, Contract, Custom Object Behavior, Lead, Opportunity, Product2, and Solution. | | Url | Type string Properties Create, Filter, Nillable, Update Description The URL of the Google document. | <!-- document id=8ece0014656d374141d6c5b337616d2b46354f133cfdbbff6d4820216312195f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_graphql_query.md --> # GraphQL Query Event Type GraphQL Query events contain information about executed queries, including total execution time, the number of invocations, and any reported errors. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | APP\_TYPE | Type String Description The name of the application that the user accessed. | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CPU\_TIME | Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | ELAPSED\_TIME\_MS | Type Number Description The time, in milliseconds, that it took for the GraphQL query to complete. | | EVENT\_TYPE | Type String Description The type of event. | | EXCEPTION | Type String Description Exception message if the request encountered an error. Empty indicates successful execution. | | LOGIN\_KEY | Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | OPERATION\_NAME | Type String Description The name of the GraphQL query. If the query was anonymous (i.e., no name was provided in the query string), this field will usually be empty or null in the logs. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. For example: 00D000000000123. | | QUERY | Type String Description The GraphQL JSON query. | | QUERY\_LENGTH | Type Number Description The length of the GraphQL JSON query in characters. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: TID:000000000000c00fff. | | RUN\_TIME | Type Number Description The amount of time that the request took in milliseconds. | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | TIMESTAMP | Type String Description The time that the flow was executed in GMT. For example: 20210606032436.520. | | TIMESTAMP\_DERIVED | Type CHECK Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) For example: 2015-07-27T11:32:59.555Z. The timezone is GMT. | | URI | Type String Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | URI\_ID\_DERIVED | Type String Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. | | USER\_ID | Type Id Description The 15-character ID of the user who executed the flow through the UI or the API. For example: 00530000009M943. | | USER\_ID\_DERIVED | Type String Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. For example: 00590000000I1SNIA0. | | USER\_TYPE | Type String Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | | VARIABLES | Type String Description A JSON string containing the name-value pairs of the variables used in the GraphQL operation. | <!-- document id=0ca2bafb130bfc6135f0d0f8f2859259cbd8b5cc746991b95de40b5276a13087 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_graphqlqueryeventlog.md --> # GraphQlQueryEventLog GraphQL Query events contain information about executed queries, including total execution time, the number of invocations, and any reported errors.. This object is available in API version 69.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules This object is read-only and requires access to Event Monitoring. The org must have access to event log objects (EventMonitoring.orgCanAccessEventLogObjects) and a user must have read access to event log objects (EventMonitoring.userCanReadEventLogObjects). ## Fields | Field | Details | | --- | --- | | ActualCost | Type double Properties Filter, Nillable, Sort Description The actual cost of the GraphQL query execution. | | AppType | Type string Properties Filter, Group, Nillable, Sort Description The invocation application of the GraphQL request. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description IP address of the client employing salesforce.com services. | | CpuTime | Type double Properties Filter, Nillable, Sort Description Amount of cpu cycles used by the request | | ElapsedTime | Type double Properties Filter, Nillable, Sort Description The total time taken to execute the query. | | EstimatedCost | Type double Properties Filter, Nillable, Sort Description The estimated upper-bound cost of the GraphQL query. | | Exception | Type string Properties Filter, Group, Nillable, Sort Description The exception, if one is thrown. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | OperationName | Type string Properties Filter, Group, Nillable, Sort Description The operation name for the GraphQL query. | | QueryLength | Type double Properties Filter, Nillable, Sort Description The total number of characters in a query. | | QueryString | Type string Properties Filter, Group, Nillable, Sort Description The full GraphQL query. | | RawSoqlRecordsSize | Type double Properties Filter, Nillable, Sort Description The response size, in bytes, from raw SOQL records. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | TrackedExpensiveFetcherSize | Type double Properties Filter, Nillable, Sort Description The response size, in bytes, from tracked expensive data fetchers. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | | Variables | Type string Properties Filter, Group, Nillable, Sort Description The variables supplied to the GraphQL query. | <!-- document id=de5915b504b831e382e15a7b0f35fe076e75fd477bd1df7d8348791bb2419a6a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_group.md --> # Group A set of User records. 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 the users below that role or territory in the hierarchy. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), search(), retrieve(), update(), upsert() ## Special Access Rules Authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the group. This field is available in API version 62.0 and later. | | DefaultDivision | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description This record’s default division. Only applicable if divisions are enabled. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. 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. This name is unique by group type and corresponds to **Group Name** in the user interface. This field is available in API version 24.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Only your Salesforce org’s internal users can access this field. | | DoesIncludeBosses | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether records shared with users in this group are also shared with users higher in the role hierarchy (true) or not (false). This field is only available for groups of type Regular and Queue. This field corresponds to the Grant Access Using Hierarchies checkbox on the detail pages of public groups and queues. For groups of type Regular, this field available in API version 18.0 and later and has a default value of true. For groups of type Queue, this field is available in API version 67.0 and later. The default value of this field for queues depends on the value of the org-level setting “Grant access using hierarchies by default in new queues.” | | 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, idLookup, Sort, Update Description Required. Name of the group. Corresponds to **Label** on the user interface. | | OwnerId | Type reference Properties Filter, Group, Sort Description ID of the user who owns the group. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Organization, User | | QueueRoutingConfigId | Type reference Properties Create, Delete, Query, Retrieve, Update Description The ID of the queue routing configuration associated with the queue. | | RelatedId | Type reference Properties Filter, Group, Nillable, Sort Description Represents the ID of the associated groups. For groups of type “Role,” the ID of the associated UserRole. The RelatedId field is polymorphic. This is a polymorphic relationship field. Relationship Name Related Relationship Type Lookup Refers To User, UserRole | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Required. Type of the group. One of the following values: - AllCustomerPortal—Public group that includes all Customer Portal or Customer Community Plus users. This type is only available when a Customer Portal or a Customer Site is enabled for your org. - ChannelProgramGroup—Public group for partners in a channel program. - CollaborationGroup—Chatter group. - DataAnalytics—Public group for Tableau Next and Data 360 users. - Manager—Public group that includes a user’s direct and indirect managers. This group is read-only. - ManagerAndSubordinatesInternal—Public group that includes a user and the user’s direct and indirect reports. This group is read-only. - Organization—Public group that includes all the User records in the organization. This group is read-only. - Participant—Compliant Data Sharing group that includes internal users who have the Use Compliant Data Sharing permission. A group can contain other participant groups only, or a group can contain both internal users with the Use Compliant Data Sharing permission and other participant groups. This value is only available when Compliant Data Sharing is enabled for your org. - PRMOrganization—Public group that includes all the partners in an organization that has the partner site or portal feature enabled. - Queue—Public group that includes all the User records that are members of a queue. - Regular—Standard public group. When you create() a group, its type must be Regular or DataAnalytics, unless a partner site or portal is enabled for the organization, in which case the type can be Regular, DataAnalytics, or PRMOrganization. - Role—Public group that includes all the User records in a particular UserRole. - RoleAndSubordinates—Public group that includes all the User records in a particular UserRole and all the User records in any subordinate UserRole. Only available when digital experiences is enabled for your org and Experience Cloud site users are created with external account roles other than a shared person account role. - RoleAndSubordinatesInternal—Public group that includes all the User records in an internal UserRole, excluding customer and partner roles, and all the User records in any subordinate internal UserRole. - SharingRecordCollGroup—Public group that has access to a SharingRecordCollection. - Territory—Public group that includes all the User records in an organization that has the territory feature enabled. - TerritoryAndSubordinates—Public group that includes all the User records in a particular UserRole and all the User records in any subordinateUserRole in an organization that has the territory feature enabled. Only Personal, Regular, and Queue can be used when creating a group. The other values are reserved. | ## Usage Unlike users, this object can be deleted. Only public groups are accessible via the API. Personal groups are not available. In API version 34.0 and later, you can query a group using Related.Name to retrieve the group’s name. Related.Name is supported for public groups, user roles, territories, manager groups, and user names. In API version 13.0 and later, if you delete a public group, it is 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. #### See Also - [GroupMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_groupmember.htm "Represents a User or Group that is a member of a public group.") - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=0495d088fbd4bce824974735053657e5b8257283abe17ff59ead50edad9cc825 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_groupmembership.md --> # Group Membership Event Type Group Membership events capture details about changes to public group and queue membership, such as when members are added to or removed from the public group or queue. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26 | | CPU\_TIME | Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity that took place in the app server layer. | | EVENT\_TYPE | Type String Description The type of event. The value is always GroupMembership. | | GROUP\_ID | Type Id Description ID of the group whose membership changed. Example 00GXXXXXXXXXXXX | | GROUP\_TYPE | Type String Description The type of group. Valid values are: - R—Public group - Q—Queue Example R | | LOGIN\_KEY | Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I | | MEMBER\_ID | Type Id Description The ID of the member added to or removed from the group. Public groups can contain individual users, other groups, or users in a specified role or territory. Queues can contain individual users, roles, public groups, territories, connections, or partner users. Example 005XXXXXXXXXXXX or 00GXXXXXXXXXXXX | | OPERATION | Type String Description The operation that occurred, such as a member being added to or removed from a group. Valid values are: - AddedGroupMember - DeletedGroupMember Example DeletedGroupMember | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. Example 00DXXXXXXXXXXXX | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 3nWgxWbDKWWDIk0FKfF5DV | | RUN\_TIME | Type Number Description The amount of time that the request took in milliseconds. Example 115 | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. Example d7DEq/ANa7nNZZVD | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. Example 20130715233322.670 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z | | URI | Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp | | URI\_ID\_DERIVED | Type Id Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. Example 005XXXXXXXXXYAY | | USER\_ID | Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 005XXXXXXXXXXXX | | USER\_ID\_DERIVED | Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 005XXXXXXXXXXXXIA0 | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=c940087c8eb8bde5fb8a9e93fa2a8877a55227bea40dbef2e3a90ecc909b5e69 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_groupmember.md --> # GroupMember Represents a User or Group that is a member of a public group. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | GroupId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Group. This is a relationship field. Relationship Name Group Relationship Type Lookup Refers To Group | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the User or Group that is a direct member of the group. This field is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage If your group contains more than 10,000 members, for improved performance, you can adjust group membership using the GroupMember API object instead of the group's detail page in Setup. You can also adjust membership using the public group's access summary or user access policies in Setup. A record exists for every User or Group who is a direct member of a public group whose Type field is set to Regular. User records that are indirect members of Regular public groups aren't listed as group members. A User can be an indirect member of a group if he or she is in a UserRole above the direct group member in the hierarchy, or if he or she is a member of a group that is included as a subgroup in that group. If you attempt to create a record that matches an existing record, the system simply returns the existing record. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=a4bee7228223bb9feab12cbff0e3cded8dfcb1c9a267ba692c5eb06db32ffeae url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_groupmembershipeventlog.md --> # GroupMembershipEventLog Group Membership events capture details about changes to public group and queue membership, such as when members are added to or removed from the public group or queue. This object is available in API version 64.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description IP address of the client employing salesforce.com services. | | CpuTime | Type double Properties Filter, Nillable, Sort Description Amount of cpu cycles used by the request | | GroupIdentifier | Type string Properties Filter, Group, Nillable, Sort Description ID of the group whose membership changed. | | GroupType | Type string Properties Filter, Group, Nillable, Sort Description The type of group being updated. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | MemberIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the member added to or removed from the group. Public groups can contain individual users, other groups, or users in a specified role or territory. Queues can contain individual users, roles, public groups, territories, connections, or partner users. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The type of operation that occurred, such as a group member being added or removed from a group. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. | <!-- document id=fdf93f48bec0a5fe383c4e0e7da1be33f4f852ccd14cf38d8b484a7de55a94da url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_gtwyprovpaymentmethodtype.md --> # GtwyProvPaymentMethodType The gateway provider payment method type allows integrators and payment providers to choose an active payment to receive an order's payment data rather than allowing the Salesforce Order Management platform to select a default payment method. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Comments | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Users can provide additional details about the gateway provider payment method type record. Supports a maximum of 1000 characters. | | DeveloperName | Type string Properties 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, Salesforce generates one for each record, which slows performance. | | GtwyProviderPaymentMethodType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Links the Salesforce payment method to the payment method used in the Salesforce Order Management storefront. Your payment gateway integration uses this field when finding a payment method to link to a payment. The value of GtwyProviderPaymentMethodType must match the payment method value sent to the order's Payment Instrument in Salesforce Order Management. Listed below are several examples of payment method values that Salesforce could receive from Salesforce Order Management. - CREDIT\_CARD - BASIC\_CREDIT - CreditCard - GooglePay - ApplePay | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Language of the payment gateway integration. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The gateway provider payment method type name that appears in the user interface. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Namespace of the payment gateway integration classes. | | PaymentGatewayProviderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the payment gateway provider that Salesforce Order Management should use when processing payments. One payment gateway provider can be related to multiple payment method types. This is a relationship field. Relationship Name PaymentGatewayProvider Relationship Type Lookup Refers To PaymentGatewayProvider | | PaymentMethodType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of payment method used on an order in Salesforce Order Management. Possible values are: - AlternativePaymentMethod - CardPaymentMethod - DigitalWallet | | RecordTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the record type entity related to the gateway provider payment method type. This is a relationship field. Relationship Name RecordType Relationship Type Lookup Refers To RecordType | ## Usage The Salesforce Order Management payment record must have a ProcessorId field with the same value as the payment gateway's ExternalReferenceId field. The gateway provider payment method type record must have a PaymentMethodType field that looks up to the payment method that you want to associate to your payment. Finally, the payment gateway and gateway provider payment method type must have matching PaymentGatewayProviderId fields. When you've established these relationships, the payment record can infer your payment method from the gateway provider payment method type record. ![An ERD diagram showing the relationships between Gateway Provider Payment Method Type and its related entities.](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/Sforce_gtwyprovpaymentmethod_erd.png) <!-- document id=39f56998560dd70e4a9ad1b1f990b497ea4f2630d71efb80e0d77eb004e30372 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_guestbuyerprofile.md --> # GuestBuyerProfile Represents a store's guest buyer profile, which allows unauthenticated buyers to browse the store. This object is available in API version 51.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Currency displayed to the guest buyer when they’re viewing the store. Possible values are: - USD—U.S. Dollar | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Detailed description of the profile. Includes information like which store the profile is used in. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The last date and time when one or more of the fields were modified | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The last date and time when one or more of the fields were viewed | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the guest buyer profile. Including a reference to the store helps with later identification. | <!-- document id=6110ed20eac19a9500027d2e740ee3474f4146f82611e38568fd57162b2ec7fa url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_hashtagdefinition.md --> # HashtagDefinition HashtagDefinition represents hashtag (#) topics in public Chatter posts and comments. Public posts and comments include those on profiles and in public groups, but not those on records or in private groups. This object is available in API version 26.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Starting in Spring ’16, API access to HashtagDefinition is disabled across all API versions. Any integrations relying on API queries to this object stop working. You can continue to use hashtags in posts and comments, and the hashtags continue to create corresponding topics. We recommend that you redirect all API queries and reports using the HashtagDefinition object to use the Topic object instead. For more information, see [Retiring the Legacy HashtagDefinition Object—FAQs](https://help.salesforce.com/apex/HTViewSolution?urlname=Retiring-the-Legacy-HashtagDefinition-Object "HTML (New Window)"). ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | HashtagCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times a hashtag topic is used. | | Name | Type string Properties Filter, Nillable, Sort Description The string of characters following the hashtag (#) in a hashtag topic. | | NameNorm | Type string Properties Filter, Nillable, Sort Description The string of characters following the hashtag (#) in a hashtag topic, normalized to remove capitalization and punctuation. | | NetworkId | Type reference Properties Filter, Group, Nillable, Sort Description Identifier of the community to which the HashtagDefinition belongs. This field is available only if digital experiences is enabled in your org. | ## Usage Use this object to identify public hashtag topics and see how often they’re used. #### See Also - [Topic](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_topic.htm "Represents a topic on a Chatter post or record. This object is available in API version 28.0 and later.") <!-- document id=e2e8d43989348e8a9bc436fa21d3162a8522eaa50a459dfef89d4aaaf4de710b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_healthcarediagnosis.md --> # HealthCareDiagnosis Represents information related to industry-standard healthcare diagnosis codes. Before the Spring ’21 release, the Healthcare Procedure and Healthcare Diagnosis objects stored codes specifically related to procedures and diagnoses. These codes were used for prior-authorization requests and approval processes. Since the Spring’21 release, Health Cloud uses the Code Set and Code Set Bundle objects for this purpose instead. ## Example The Code Set and Code Set Bundle objects improve on the old objects by adding support for terminology system information. This added support comes in the form of the Source System and Version fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Objects, flows, and apps that previously used Healthcare Diagnosis and Healthcare Procedure have been or will be extended to support the use of Code Set and Code Set Bundle. Healthcare Diagnosis and Healthcare Procedure are to be gradually phased out with future releases. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Category | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Indicates the category for this diagnosis such as newborn, pediatric, maternity, or adult. | | Code | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Industry-standard diagnosis code. | | CodeDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the diagnosis code. | | CodeType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Type of diagnosis code represented in the record such as ICD-9 or ICD-10. | | EffectiveDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Start date for the code. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description End date for the code. | | Gender | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Indicates whether this diagnosis is for males, females, or all genders. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the diagnosis code is available for use. | | IsComplicationOrComorbidity | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this diagnosis is used to represent a complication or comorbidity. | | IsHospitalAcquiredCondition | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this diagnosis represents a condition acquired while in the hospital. | | IsMajorComplicationOrComorbidity | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this diagnosis is used to represent a major complication or comorbidity. | | IsPresentOnAdmissionExempt | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether diagnosis code is exempt from the diagnosis present on admission requirement. | | IsPrimaryDiagnosis | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether diagnosis code can be used as primary diagnosis only, or can be used in any diagnosis sequence. | | IsUnacceptablePrincipalDxIpAdmit | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether diagnosis code is an unacceptable principal diagnosis for inpatient admission per Medicare Code Edits. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the code that displays in search and lookup fields. Salesforce recommends using the code along with the description to populate this field. For example, use <Code>: <Description> or <Code>-<Description> such as (E08.37X9 - Diabetes mellitus due to underlying condition). | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [HealthCareDiagnosisChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 60.0) Change events are available for the object. [HealthCareDiagnosisHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [HealthCareDiagnosisOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [HealthCareDiagnosisShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. <!-- document id=cf580101159b4a550d684664ab16e6f4e8d8ed2a6527b60f6999fe95bf643327 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_healthcareprocedure.md --> # HealthCareProcedure Represents information related to industry-standard healthcare procedure codes. Before the Spring ’21 release, the Healthcare Procedure and Healthcare Diagnosis objects stored codes specifically related to procedures and diagnoses. These codes were used for prior-authorization requests and approval processes. Since the Spring’21 release, Health Cloud uses the Code Set and Code Set Bundle objects for this purpose instead. ## Example The Code Set and Code Set Bundle objects improve on the old objects by adding support for terminology system information. This added support comes in the form of the Source System and Version fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Objects, flows, and apps that previously used Healthcare Diagnosis and Healthcare Procedure have been or will be extended to support the use of Code Set and Code Set Bundle. Healthcare Diagnosis and Healthcare Procedure are to be gradually phased out with future releases. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Category | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Category of the procedure code such as anesthesia, surgery, radiology, and so on. | | Code | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Industry standard procedure code such as CPT or HCPCS. | | CodeDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the procedure code. | | CodeShortDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Short description of the procedure code. | | CodeType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Type of procedure code represented in the record such as CPT or HCPCS. | | EffectiveDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Start date for the code. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description End date for the code. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the diagnosis code is available for use. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the code that displays in search and lookup fields. Salesforce recommends using the code along with the description to populate this field. For example, use <Code>: <Description> or <Code>-<Description> such as 95115: Allergy injection. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [HealthCareProcedureChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 60.0) Change events are available for the object. [HealthCareProcedureHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [HealthCareProcedureOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [HealthCareProcedureShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. <!-- document id=8e6e2dd2d996cbf7d5f1b7ae61ec4c0dadf1777fdf63ca456a19ab291c2da52d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_holiday.md --> # Holiday Represents a period of time during which your customer support team is unavailable. Business hours and escalation rules associated with business hours are suspended during any holidays with which they are affiliated. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Customer Portal users can’t access this object. All users, even those without the “View Setup and Configuration” user permission, can view holidays via the API. ## Fields | Field | Details | | --- | --- | | ActivityDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description If the Holiday IsAllDay flag is set to true (indicating that it is an all-day holiday), then the holiday due date information is contained in the ActivityDate field. This field is a date field with a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant, and you should not attempt to alter it to account for any time zone differences. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the holiday. | | EndTimeInMinutes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The end time of the holiday in minutes. | | IsAllDay | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the duration of the holiday is all day (true) or not (false). | | IsRecurrence | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the holiday is scheduled to repeat itself (true) or only occurs once (false). This is a read only field on update, but not on create. If this field value is true, then any recurrence fields associated with the given recurrence type must be populated. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the holiday. | | NextOccurrenceDate | Type date Properties Filter, Group, Nillable Description The next date of the holiday. Applies to recurring holidays only. Available in API version 58.0 and later. To access this field, you must have Field Service enabled and the Field Service Standard permission. This field isn't sortable. To compare this date to other dates, you must parse the string into a date value to compare it to other dates. | | RecurrenceDayOfMonth | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day of the month on which the holiday repeats. | | RecurrenceDayOfWeekMask | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day or days of the week on which the holiday repeats. This field contains a bitmask. For each day of the week, the values are as follows: - Sunday = 1 - Monday = 2 - Tuesday = 4 - Wednesday = 8 - Thursday = 16 - Friday = 32 - Saturday = 64 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20. | | RecurrenceEndDateOnly | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The last date on which the holiday repeats. For multiday recurring events, this is the day on which the last occurrence starts. | | RecurrenceInstance | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The frequency of the recurring holiday. For example, 2nd or 3rd. | | RecurrenceInterval | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The interval between recurring holidays. | | RecurrenceMonthOfYear | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The month of the year on which the event repeats. | | RecurrenceStartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the recurring holiday begins. Must be a date and time before RecurrenceEndDateOnly. | | RecurrenceType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how often the holiday repeats. For example, daily, weekly, or every Nth month (where “Nth” is defined in RecurrenceInstance). | | StartTimeInMinutes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The start time of the holiday in minutes. | ## Usage Use this object to view and update holidays, which specify dates and times at which associated business hours and escalation rules are suspended. <!-- document id=4d1a5014b748b951c45ac45f315b07587f415c264956e36639e40ba95a0c5d49 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_hostnameredirects.md --> # Hostname Redirects Event Type Hostname Redirect events contain details about blocked and successful redirections for your previous My Domain hostnames. The Hostname Redirects event type is available in the EventLogFile object in API version 56.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The HostnameRedirects event type is disabled by default. To enable this event type, use the logRedirections field on the MyDomainSettings Metadata API type or enable the **Log Redirections** setting in the Routing section of the My Domain Setup page. This event is free for all customers with a 24-hour data retention period. The hostname redirections event is available in the API but not in the Event Monitoring Analytics app. You can also download the latest hostname redirections event log file through a button on the My Domain page. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or the [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | EVENT\_TYPE | Type String Description The type of event. The value is always HostnameRedirects. | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. Example 20220715233322.670 | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 0000000062\_0000x8Lz- | | ORGANIZATION\_ID | Type ID Description The 15-character ID of the org. Example 00D000000000345 | | USER\_ID | Type ID Description This field is unused in the HostnameRedirects event type. The value is always null. | | RUN\_TIME | Type Number Description This field is unused in the HostnameRedirects event type. The value is always 0. | | CPU\_TIME | Type Number Description This field is unused in the HostnameRedirects event type. The value is always null. | | URI | Type String Description This field is unused in the HostnameRedirects event type. The value is always null. | | SESSION\_KEY | Type String Description This field is unused in the HostnameRedirects event type. The value is always null. | | LOGIN\_KEY | Type String Description This field is unused in the HostnameRedirects event type. The value is always null. | | MESSAGE | Type String Description This field is unused in the HostnameRedirects event type. The value is always null. | | DOMAIN | Type Url Properties Filter, Sort Description This field is unused in the HostnameRedirects event type. The value is always null. | | SOURCE\_HOSTNAME | Type String Description The hostname of the URL from which the redirection originated. Example If https://oldMyDomainName.my.salesforce.com is redirected to https://newMyDomainName.my.salesforce.com, the value of this field is oldMyDomainName.my.salesforce.com | | TARGET\_HOSTNAME | Type String Description The hostname of the URL to which the user or API was redirected. Example If https://oldMyDomainName.my.salesforce.com is redirected to https://newMyDomainName.my.salesforce.com, the value of this field is newMyDomainName.my.salesforce.com | | PATH | Type String Description The path of the originating URL request, up to the first question mark (?). The path is also used in the redirection target URL. However, this field doesn’t include the query string, if present. Example If the user is redirected from https://MyOldCompany.my.site.com/shop?q=sneakers to https://MyNewCompany.my.site.com/shop?q=sneakers, the value of this field is /shop. | | REDIRECT\_REASON | Type String Description The reason for the hostname redirect event. Possible Values - Redirected due to a hostname mismatch.—The referring hostname was redirected to the current My Domain equivalent. - Redirection suppressed to prevent Lightning Out integration failure.—The \*.force.com site URL can’t be redirected for use with [Lightning Out](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/lwc.lightning_out). To prevent issues, the original URL was processed as-is. To avoid issues after \*.force.com site hostname redirections are stopped, update hard-coded references to the hostname in your Lightning Out integrations. For a Lightning Out code example that uses a site hostname, see [Share Lightning Out Apps with Unauthenticated Users](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/lwc.lightning_out_public_apps "HTML (New Window)") in the Salesforce Lightning Component Library. - Redirection was blocked because redirections for this hostname are disabled.—Only your last set of My Domain login hostnames is redirected. Those redirections are blocked when the My Domain Routing option **Redirect previous My Domain URLs to your current My Domain** is deselected or because you removed your previous My Domain. That option applies to legacy (non-enhanced) hostnames in production orgs until Spring ’25. In non-production orgs, that option has no impact on redirections for legacy hostnames in Winter ’25 and later. Non-production orgs include sandboxes, Developer Edition orgs, demo orgs, patch orgs, scratch orgs, and Trailhead Playgrounds. For information If the SOURCE\_HOSTNAME is a legacy \*.force.com site hostname, the redirection was blocked because the **Redirect previousSiteHostnames URLs to your current My Domain site URLs** Routing option was deselected on the My Domain Setup page. That option is available in production orgs until Spring ’25. In non-production orgs, that option was removed in Winter ’25. Non-production orgs include sandboxes, Developer Edition orgs, demo orgs, patch orgs, scratch orgs, and Trailhead Playgrounds. - Redirection was blocked because redirections for the legacy SOURCE\_HOSTNAME are no longer supported.—If your org was created before June 2022, Salesforce served the org on a different set of hostnames until enhanced domains were deployed. The SOURCE\_HOSTNAME is one of those hostnames. For non-production orgs, redirections for those hostnames stopped in Winter ’25. | | IS\_BLOCKED\_REDIRECTION | Type Boolean Description Indicates whether the redirection was blocked. Possible Values - 1—The redirection was blocked and returned an HTTP 404 response. - 0—The redirection proceeded and returned an HTTP 301 or 307 response. | | REFERRER | Type String Description The absolute or partial address from which the request to the SOURCE\_HOSTNAME came. The Referrer-Policy HTTP Header of the request determines how much of the URL is shared.  For example, if a user clicked a link to the SOURCE\_HOSTNAME from a web page, and that web page is on a different domain: - if the Referrer-Policy HTTP Header is no-referrer-when-downgrade, REFERRER includes the origin, path, and query-string parameters up to the first hash (#), if present. - if the Referrer-Policy HTTP Header is strict-origin-when-cross-origin, REFERRER includes the origin only. - if the Referrer-Policy HTTP Header is same-origin, REFERRER is null. Examples - https://www.example.com - https://www.example.com/page/page/index.htm - https://www.example.com/page/index.htm?q="Salesforce" | | ORIGIN | Type String Description The origin (protocol, hostname, and port) that caused the request to the SOURCE\_HOSTNAME. For example, if a website on a different domain makes an XMLHttpRequest (XHR) to SOURCE\_HOSTNAME, ORIGIN contains the base URL of that website. The port isn’t included in the origin information with all requests. ORIGIN can be null in a number of situations, including but not limited to cross-origin requests and origins with a restrictive Referrer-Policy header. For example, if the request to the SOURCE\_HOSTNAME is sent from a site external to Salesforce with a RequestMode of no-cors, ORIGIN is null. Examples - https://www.example.com - https://www.example.com:443 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). The time zone is always GMT. Example 2022-07-27T11:32:59.555Z. | | USER\_ID\_DERIVED | Type String Description This field is unused in the HostnameRedirects event type. The value is always null. | | CLIENT\_IP | Type String Description The IP address of the client that made this request. Possible Values/Example 111.43.144.26 | | URI\_ID\_DERIVED | Type String Description This field is unused in the HostnameRedirects event type. The value is always null. | ## Usage Use the information in the Hostname Redirects event log to determine the hostnames to update in your org after you deploy a change to your My Domain name. You can also use the log to develop communications to your customers and users about the changed hostnames. For example, you can encourage users to use the new hostnames and update their bookmarks. For more information on the steps to take after a My Domain change, see [Update Your Org and Test My Domain Changes](https://help.salesforce.com/s/articleView?id=products.domain_name_deploy_update_test.htm&type=5&language=en_US) in Salesforce Help. To access the log, use the HostnameRedirects event type from the EventLogFile object. Alternatively, you can download the current hostname redirections event log by clicking **Download Redirections Log** on the My Domain Setup page. Each event, or each row in the redirection log, represents a redirection for a specific requested URL. Subsequent requests to the same URL within the hour following that request, however, aren’t logged. If your last My Domain change included enhanced domains deployment, the log includes redirections for the old hostnames listed on [My Domain URL Format Changes with Enhanced Domains Deployment](https://help.salesforce.com/s/articleView?id=products.domain_name_url_format_changes_enable_enhanced.htm&type=5&language=en_US) in Salesforce Help. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To keep the size of the log file manageable, the log includes one entry for each redirected hostname and path combination within an hour. As a result, the log includes all redirected hostname and path combinations, but only includes the first redirection within each hour. For example, if https://MyCompany.my.site.com/shop is redirected at 02:01 PM and https://MyCompany.my.site.com/shop?q=sneakers is redirected for another user at 02:02 PM, only the redirection that occurred at 02:01 PM is captured for MyCompany.my.site.com/shop for that hour. But if https://MyCompany.my.site.com/help is redirected at 2:05 PM, that redirection is captured on a new line because the MyCompany.my.site.com/help hostname and path combination differs from MyCompany.my.site.com/shop. Similarly, if the redirection of https://MyCompany.my.site.com/contactUs is blocked at 07:02 AM and https://MyCompany.my.site.com/contactUs is redirected at 07:11 AM, only the blocked redirection for MyCompany.my.site.com/contactUs is captured in the log for that hour. Only one hostname redirection log file is available at a time. When the daily incremental event log file is generated during the daily background process, the new file replaces the existing file. When you download the redirections log from the My Domain Setup page, you get the latest daily log file in CSV format. If the log file doesn’t exist, either the log generation process hasn’t run yet or there’s no redirection data to report for that 24-hour window. The log file is generated only when at least one redirection occurred for the day. To collect hostname redirection logs for multiple days, schedule a daily query of the Hostname Redirects event type via REST API. For example, you can configure a cron job in Unix or a scheduled task in Windows to run the query. ## Salesforce CLI Example To use Salesforce CLI to query the Hostname redirects log, use the sf data query command to query the HostnameRedirects EventType. First, download and install [Salesforce CLI](https://developer.salesforce.com/tools/salesforcecli). Example This Unix example authorizes Salesforce CLI to access your org and sets orgAlias to your org login URL. This method prompts you to log in to your org via a browser to grant Salesforce CLI access. To query event log files, log in as a user with the View Event Log Files and API Enabled permissions. sf org web login --alias orgAlias --instance-url https://MyDomainName.my.salesforce.com Example response After you authenticate with a user via a browser, this response confirms that Salesforce CLI is authorized for use in your org. Successfully authorized admin@mycompany.com with org ID 00D00000000000aIW Then export the HostnameRedirects log to a CSV file. Example This example exports the HostnameRedirects EventType to a CSV file in your org, where orgAlias is your org's alias within Salesforce CLI. ORGALIAS=orgAlias; QUERYRESULT=$(sf data query --target-org "$ORGALIAS" --query "SELECT LogDate, LogFile FROM EventLogFile WHERE EventType='HostnameRedirects' ORDER BY CreatedDate DESC LIMIT 1" --json); QUERYSTATUS=$(echo "$QUERYRESULT"|grep "status"|cut -d : -f 2|cut -d , -f 1); if \[\[ "$QUERYSTATUS" -eq 0 \]\]; then LOGDATE=$(echo "$QUERYRESULT"|grep LogDate|cut -d " -f 4|cut -d T -f 1); if \[\[ "$LOGDATE" == "" \]\]; then echo "No daily event log file exists for hostname redirects."; else DOWNLOADPATH=$(echo "$QUERYRESULT"|grep "url"|cut -d " -f 4); ORGDISPLAY=$(sf org display --target-org "$ORGALIAS" --json 2> /dev/null); SESSION=$(echo "$ORGDISPLAY"|grep accessToken|cut -d " -f 4); ORGURL=$(echo "$ORGDISPLAY"|grep instanceUrl|cut -d " -f 4); curl -H "Authorization: Bearer ${SESSION}" --silent ${ORGURL}${DOWNLOADPATH}/LogFile > HostnameRedirectEvent-${LOGDATE}.csv; fi; else echo "$QUERYRESULT"; fi Example CSV formatted response "EVENT\_TYPE","TIMESTAMP","REQUEST\_ID","ORGANIZATION\_ID","USER\_ID","RUN\_TIME", "CPU\_TIME","URI","SESSION\_KEY","LOGIN\_KEY","MESSAGE","DOMAIN","SOURCE\_HOSTNAME", "TARGET\_HOSTNAME","PATH","REDIRECT\_REASON","IS\_BLOCKED\_REDIRECTION","REFERRER", "ORIGIN","TIMESTAMP\_DERIVED","USER\_ID\_DERIVED","CLIENT\_IP","URI\_ID\_DERIVED" "HostnameRedirects","20220803011210","4kTkZZ1PzwSSHDkCagbl7-","00D000000000aIW", "","0","","","","","Redirection was blocked because redirections for the legacy SOURCE\_HOSTNAME are no longer supported.","","ExperienceCloudSubdomain.force.com", "","","","0","https://partner.example.com/pagename.html","", "2022-08-03T01:12:10.015Z","","198.51.100.0"," " "HostnameRedirects","20220803022225","4kTkSZ1PzwSTHDkCagbl9-","00D000000000aIW", "","0","","","","","Redirection was blocked because redirections for the legacy SOURCE\_HOSTNAME are no longer supported.","", "SalesforceSitesSubdomain.secure.force.com","","","","0","", "https://partner2.example.com","2022-08-03T02:22:25.015Z","","2001:DB8::","" "HostnameRedirects","20220803025230","4kNP4KyC\_ddbI0GxqZ8Lz-","00D000000000aIW", "","0","","","","","Redirection prevented due to a hostname mismatch.","", "oldMyDomainName.my.salesforce.com","currentMyDomainName.my.salesforce.com","", "","0","https://www.example.com/login\_hub.htm","https://www.example.com", "2022-08-03T02:52:30.015Z","","203.0.113.0","" "HostnameRedirects","20220803081241","4kTkSZ1PzwSTHDkCagbl9-","00D000000000aIW", "","0","","","","","Redirection was blocked because redirections for the legacy SOURCE\_HOSTNAME are no longer supported.","", "SalesforceSitesSubdomain.secure.force.com","","","","0", "https://myDomainName.my.site.com/store/Page1","","2022-08-03T08:12:41.015Z","", "Salesforce.com IP","" "HostnameRedirects","20220803113801","4kNQs7BYKbSbIWGxqZ8Lz-","00D000000000aIW", "","0","","","","","Redirection prevented due to a hostname mismatch.","", "oldMyDomainName.lightning.force.com","currentMyDomainName.lightning.force.com", "","","0", "https://sandboxMyDomainName--SandboxName.sandbox.lightning.force.com/r/ product\_\_c/a00000000000000IAI/view", "https://sandboxMyDomainName--SandboxName.sandbox.lightning.force.com", "2022-08-03T11:38:01.015Z","","Salesforce.com IP","" For more information on Salesforce CLI, see the Salesforce CLI Setup Guide, Salesforce CLI Command Reference, and the Salesforce DX Developer Guide. ## REST API Example To use REST API to query the Hostname Redirects event log, use the [Query](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/resources_query.htm#topic-title) resource to retrieve field values from a record. Specify the fields you want to retrieve in the fields parameter and use the GET method of the resource. Example This example retrieves the HostnameRedirects event log based on Field and EventType via a GET request. Replace token with your access token. In a production org, replace MyDomainName with your My Domain name. In a sandbox, replace MyDomainName.my.salesforce.com with your org’s My Domain login hostname. curl https://MyDomainName.my.salesforce.com/services/data/v68.0/query?q=SELECT+ LogDate%2C+LogFile+FROM+EventLogFile+WHERE+EventType%3D%27HostnameRedirects%27 +ORDER+BY+CreatedDate+DESC+LIMIT+1 -H "Authorization: Bearer token" Example raw response {"totalSize":1,"done":true,"records":\[{"attributes": {"type":"EventLogFile","url":"/services/data/v56.0/sobjects/EventLogFile/ 0AT00000003KxUSWA0"},"LogDate":"2022-08-03T00:00:00.000+0000","LogFile":" /services/data/v56.0/sobjects/EventLogFile/0AT00000003KxUSWA0/LogFile"}\]} The log file can be downloaded by using curl with the same Authorization header while setting the URL path to the LogFile value from the output. For more information on accessing event log files via REST API, see [Using Event Monitoring](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm) in the REST API Developer Guide. #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=a88e3018b8243609310ae5798e58a092ad0a73df6e7f929c3dacffad43b97522 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_icondefinition.md --> # IconDefinition Represents the icon-related metadata for a custom tab. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field Name | Details | | --- | --- | | ContentType | Type string Properties Filter, Group, Nillable, Sort Description The tab icon’s content type, for example, “image/png.” | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description A unique virtual Salesforce ID for the icon. | | Height | Type int Properties Filter, Group, Nillable, Sort Description The tab icon’s height in pixels. If the icon content type is an SVG type, height and width values are not used. | | TabDefinitionId | Type string Properties Filter, Nillable, Sort Description The TabDefinition ID. This is a relationship field. Relationship Name TabDefinition Relationship Type Lookup Refers To TabDefinition | | Theme | Type string Properties Filter, Group, Nillable, Sort Description The icon’s theme. | | Url | Type string Properties Filter, Group, Nillable, Sort Description The fully qualified URL for this icon. | | Width | Type int Properties Filter, Group, Nillable, Sort Description The tab icon’s width in pixels. If the icon content type is an SVG type, height and width values are not used. | <!-- document id=78ae529ec25250ca57e33b51e7779abb58286cd237ad15492d323bec42e33776 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_idea.md --> # Idea Represents an idea on which users are allowed to comment and vote, for example, a suggestion for an enhancement to an existing product or process. This object is available in API version 12 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For other standard objects, the describeLayout() call returns the recordTypeMappings section that contains the layout ID and picklist values for each record type. However, the recordTypeMappings section and the fields it includes are not available for the Idea object. When performing a SOSL search on Idea objects, IdeaComment objects are also searched. ## Fields | Field | Details | | --- | --- | | AttachmentBody | Type base64 Properties Create, Nillable, Update Description File data for the attachment. This field is available in API version 28.0 and later. | | AttachmentContentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of the attachment. This field is available in API version 28.0 and later. | | AttachmentLength | Type int Properties Filter, Group, Nillable, Sort Description Size of the attachment in bytes. This field is available in API version 28.0 and later. | | AttachmentName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the attachment. This field is available in API version 28.0 and later. | | Body | Type textarea Properties Create, Nillable, Update Description Description of the Idea. | | Categories | Type multipicklist Properties Create, Filter, Nillable, Update Description Customizable multi-select picklist used to organize Ideas into logical groupings. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is only available if your organization has the Categories field enabled. This field is enabled by default in organizations created after API version 14 was released. If the Categories field is enabled, API versions 13 and earlier do not have access to either the Categories or Category fields. | | Category | Type picklist Properties Create, Filter, Nillable, Update Description Customizable picklist of values used to organize Ideas into logical groupings. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is not available if your organization has the multi-select Categories field enabled. | | CommunityId | Type reference Properties Create, Filter, Group, Sort Description The zone ID associated with the idea. Once you create an idea, you can’t change the zone ID associated with that idea. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note API version 12 does not support zone ID. If you create an idea in version 12, your idea is automatically posted to the oldest zone that you have permission to access. This is a relationship field. Relationship Name Community Relationship Type Lookup Refers To Community | | CreatorFullPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo. This field is available in API version 28.0 and later. | | CreatorName | Type string Properties Filter, Group, Nillable, Sort Description Name of the user who posted the idea or commented on the idea. This field is available in API version 28.0 and later. | | CreatorSmallPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo. This field is available in API version 28.0 and later. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | IdeaThemeID | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Identifies the idea theme associated with the idea. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsHtml | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. If this value is true, your organization has the Ideas HTML editor enabled, and the Idea Body may contain HTML. If this value is false, the HTML editor is disabled and the Idea Body only contains regular text. | | IsMerged | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read only. Indicates whether the idea has been merged with a parent idea (true) or not (false). You can’t vote for or add comments to a merged idea. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note In API version 27, IsMerged replaces IsLocked. Existing formula fields that use IsLocked must be edited to use IsMerged. | | LastCommentDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time the last comment (child IdeaComment object) was added. | | LastCommentId | Type reference Properties Filter, Group, Nillable, Sort Description Read only. The ID of the last comment (child IdeaComment object). This is a relationship field. Relationship Name LastComment Relationship Type Lookup Refers To IdeaComment | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | NumComments | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of comments (child IdeaComment objects) that users have submitted for the given idea. | | ParentIdeaId | Type reference Properties Filter, Group, Nillable, Sort Description The ID associated with this idea's parent idea. When multiple ideas are merged together, one idea becomes the parent (master) of the other ideas. The ParentIdeaId is automatically set when you merge ideas. This is a relationship field. Relationship Name ParentIdea Relationship Type Lookup Refers To Idea | | RecordTypeId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the record type assigned to this object. This is a relationship field. Relationship Name RecordType Relationship Type Lookup Refers To RecordType | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Customizable picklist of values used to specify the status of an idea. | | Title | Type string Properties Create, Filter, Group, Sort, Update Description The descriptive title of the idea. | | VoteScore | Type double Properties Filter, Nillable, Sort Description The internal score of the Idea, used to sort Ideas on the Popular tab in the application user interface. The internal algorithm that determines the score gives older votes less weight than newer votes, simulating exponential decay. The score itself does not display in the application user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Unlike other fields of type double, you can't use a SOQL aggregate function with this field. | | VoteTotal | Type double Properties Filter, Nillable, Sort Description An Idea's total number of points. Each vote a user makes is worth ten points, therefore the value of this field is ten times the number of votes an idea has received. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Unlike other fields of type double, you can't use a SOQL aggregate function with this field. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you are importing Idea data and need to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself.. ## Usage Use this object to track ideas, which are written suggestions on which users can vote and comment. #### See Also - [IdeaComment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ideacomment.htm "Represents a comment that a user has submitted in response to an idea.") - [Vote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_vote.htm "Represents a vote that a user has made on a Knowledge Article, Idea, or Reply.") <!-- document id=e05dc246a064228b5eacc8c7e068d508cb7fb252962930f49f452da076f193c7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_ideacomment.md --> # IdeaComment Represents a comment that a user has submitted in response to an idea. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When performing a SOSL search on IdeaComment objects, Idea objects are also searched. ## Fields | Field | Field Type | | --- | --- | | CommentBody | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Body of the submitted comment. | | CommunityId | Type reference Properties Filter, Group, Nillable, Sort Description The zone ID associated with the idea. Once you create an idea, you can’t change the zone ID associated with that idea. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note API version 12 does not support zone ID. If you create an idea in version 12, your idea is automatically posted to the oldest zone that you have permission to access. | | CreatorFullPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo. This field is available in API version 28.0 and later. | | CreatorName | Type string Properties Filter, Group, Nillable, Sort Description Name of the user who posted the idea or commented on the idea. This field is available in API version 28.0 and later. | | CreatorSmallPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo. This field is available in API version 28.0 and later. | | IdeaId | Type reference Properties Create, Filter, Group, Sort Description ID of the idea on which this comment was made. This is a relationship field. Relationship Name Idea Relationship Type Lookup Refers To Idea | | IsHtml | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. If this value is true, your organization has the Ideas HTML editor enabled, and the CommentBody field may contain HTML. If this value is false, the HTML editor is disabled and the CommentBody field only contains regular text. | | UpVotes | Type int Properties Filter, Group, Nillable, Sort Description Total number of up votes for the question. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you import these records, and need to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself. ## Usage Use this object to track comments on ideas, which are users' text responses to ideas. #### See Also - [Idea](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_idea.htm "Represents an idea on which users are allowed to comment and vote, for example, a suggestion for an enhancement to an existing product or process. This object is available in API version 12 and later.") - [Vote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_vote.htm "Represents a vote that a user has made on a Knowledge Article, Idea, or Reply.") <!-- document id=f4dbf11fa47d740a9d69d5b439054a5643b78feae7bf6a16219a0aadda9e38b5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_ideareputation.md --> # IdeaReputation Represents a collection of statistics and scores derived from a user’s activity within an Ideas zone or internal organization. This object is available in API version 28.0 and later. ## Supported Calls query(), retrieve(), ## Fields | Field | Details | | --- | --- | | CommentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of comments a user has created in a zone or the internal organization. This number excludes comments the user creates on his or her own idea. | | CommentsReceivedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of comments a user has received in a zone or the internal organization. | | ContextId | Type reference Properties Filter, Group, Namepointing, Nillable, Sort Description The ID of the zone or internal organization. | | DownVotesGivenCount | Type int Properties Filter, Group, Nillable, Sort Description The number of down votes a user has given in a zone or the internal organization. | | DownVotesReceivedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of down votes a user has received in a zone or the internal organization. | | IdeaCount | Type int Properties Filter, Group, Nillable, Sort Description The number of ideas a user has created in a zone or the internal organization. | | ReputationLevel | Type string Properties Nillable Description The reputation level that a user has achieved based on their score in a zone or within an organization. | | Score | Type double Properties Filter, Nillable, Sort Description The total score of a user’s activity within a zone or within an organization. | | UpVotesGivenCount | Type int Properties Filter, Group, Nillable, Sort Description The number of up votes a user has given in a zone or the internal organization. This number doesn’t include the default vote the system applies when the user creates the idea. | | UpVotesReceivedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of up votes a user has received in a zone or the internal organization. | | UserId | Type reference Properties Filter, Group, Sort Description The user ID associated with the reputation. | ## Usage Use to query a user’s reputation within a zone. <!-- document id=8182e094b03f3e0f403d0c70810d58e98b48b2b86b5b4b8af45ef4703a46f514 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_ideareputationlevel.md --> # IdeaReputationLevel Represents a reputation level within an Ideas zone or internal organization and is used by the system to calculate reputation. You can create up to 25 levels per zone or internal organization. This object is available in API version 28.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ContextId | Type reference Properties Create, Filter, Group, Namepointing, Sort, Update Description The ID of the zone or internal organization. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Name of the reputation level. The name must be unique within the zone or internal organization. Maximum size is 50 characters. | | Threshold | Type int Properties Create, Filter, Group, Sort, Update Description Minimum number of points for this level. The threshold must be unique within the zone or internal organization and must be greater than or equal to zero. | ## Usage Use to create or edit reputation levels for an Ideas zone or internal organization. <!-- document id=d7b4f86000d549959c47698eea11c0713d0868e5bd59b95688034a434218e837 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_ideatheme.md --> # IdeaTheme Represents an invitation to zone members to submit ideas that are focused on a specific topic. This object is available in API version 26 and later. ## Supported Calls create(), delete(), describeLayout(), query(), retrieve(), search(), undelete(), update(), ## Fields | Field Name | Details | | --- | --- | | Categories | Type multipicklist Properties Create, Filter, Nillable, Update Description Customizable multi-select picklist used to organize ideas and idea themes into logical groupings. | | CommunityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Description The zone ID associated with the idea theme. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the idea theme. | | EndDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date marking the end of the idea theme. | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record. | | StartDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date that the idea theme begins. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Customizable picklist of values used to specify the status of the idea theme. | | Title | Type string Properties Create, Filter, Group, idLookup, Namefield, Sort, Update Description Title of the idea theme. | ## Usage Use the object to track ideas that are submitted to an idea theme. <!-- document id=3b906e10855e4e411b4db7f284613ddb4c596e03675efd33fc973e7580630b4f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_idpeventlog.md --> # IdpEventLog Represents the Identity Provider Event Log. This log records both problems and successes with inbound SAML or OpenID Connect authentication requests from another app provider. It also records outbound SAML responses when Salesforce is acting as an identity provider. This object is available in API version 39.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AppId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the app provider seeking authentication. | | AuthSessionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the authentication session. | | ErrorCode | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The error code for the authentication issue. Possible values are: - AppAccessDenied—Error: App access denied - AppBlocked—Error: App blocked - ClientUnapproved—Error: Invalid grant - CodeExpired—Error: Expired authorization code - ForceAuthNLogout—User logged out due to forced authentication request - InternalError—Error: Internal Error - InvalidAuthnRequest—Error: Unable to parse AuthnRequest from service provider - InvalidClientCredentials—Error: Invalid client credentials - InvalidCode—Error: Invalid authorization code - InvalidDeviceId—Error: Invalid device ID - InvalidIdpEndpoint—Error: Invalid Identity Provider Endpoint URL - InvalidIssuer—Error: Invalid Issuer - InvalidScope—Error: Invalid scope(s) - InvalidSessionLevel—Error: Invalid session level - InvalidSettings—Error: IdP certificate is invalid or does not exist - InvalidSignature—Error: Invalid Signature - InvalidSp—Error: Misconfigured or invalid service provider - InvalidSpokeSp—Error: Invalid spoke SP settings - InvalidUserCredentials—Error: Invalid user credentials - NoAccess—Error: User does not have access to this service provider - NoCustomAttrValue—Error: User does not have a value for the subject custom attribute - NoCustomField—Error: Custom field not found - NoSpokeId—Error: No Spoke ID found - NoSubdomain—Error: No My Domain deployed in the org - NoUserFedId—Error: User does not have a Federation Identifier selected - OauthError—OAuth Error - Success - UnableToResolve—Error: Unable to resolve request into a Service Provider - UnknownError—Unknown Error | | IdentityUsed | Type string Properties Filter, Nillable, Sort Description The identity (username) of the user being authenticated. | | InitiatedBy | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The code describing how the authentication request was initiated. Possible values are: - IdP—IdP-Initiated SAML - OauthAuthorize—OAuth Authorization - OauthTokenExchange—OAuth Token Exchange - SP—SP-Initiated SAML | | OptionsHasLogoutUrl | Type boolean Properties Filter Description Whether a logout URL has been assigned to the app. This URL is where users are redirected when they log out. | | SamlEntityUrl | Type string Properties Filter, Sort Description The authentication URL of the SAML provider. | | SsoType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of SSO. Options are: - 0–SAML - 1–OpenID Connect | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The date and time on which the event occurred. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user seeking authentication. | <!-- document id=f81995ae12da2fd5fa41e01b8d3bf16e0345d5c13944109b999a2abfb884f0cc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_iframewhitelisturl.md --> # IframeWhiteListUrl Represents a list of trusted external domains that you allow to frame your Embedded Service, Surveys, and Visualforce pages. This object is available in API version 45.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Context | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of content in the iframe. Valid values are: - Surveys - VisualforcePages - DisclosureAndComplianceHubConnector | | Url | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique domain that is allowed to frame your Visualforce pages, surveys, or Disclosure and Compliance Hub Connector. Accepts these formats: example.com, \*example.com, and https://example.com. | ## Usage To use this object for framing Visualforce pages, on Session Settings in Setup, select **Enable clickjack protection for customer Visualforce pages** either **with headers disabled** or **with standard headers**. These options both allow framing of Visualforce pages on trusted external domains and provide clickjack protection. Alternatively, you can customize session settings via the SecuritySettings Metadata API type. To use the IframeWhiteListUrl object, set either the enableClickjackNonsetupUser or enableClickjackNonsetupUserHeaderless field to true. For more information, see [SecuritySettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_securitysettings.htm) in the Metadata API Developer Guide. <!-- document id=32c55b7df6cf59f59881bdde19ee166c7f674a1eb1f380b9bea2ea14d14ff462 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_image.md --> # Image Represents the details of an image. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AlternateText | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Accessibility text to explain the image in words. | | CapturedAngle | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Angle at which the image was captured. | | ContentDocumentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Unique identifier of the content document where image is stored. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | ImageClass | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The image category. Possible values are: - FOOD - LOGOS - OBJECTS - SCENES | | ImageClassObjectType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of image. Used in Einstein Object Detection to identify whether the image is used to detect objects or build a model. Possible values are: - DETECTION—Actual Image - FEEDBACK - TRAINING | | ImageViewType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Orientation of the image. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if an image is active. The default value is False. An active image can be used for building or updating a model in Einstein Object Detection. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date on which the image was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date on which the image was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Name of the record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Unique identifier of the record owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Title | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Title of the image. | | Url | Type url Properties Create, Filter, Nillable, Sort, Update Description Public URL of the image file. | <!-- document id=d4de34cadeb66471dedae754b6a5a51313a6003af5b86556233a2a526eaa4af7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_incident.md --> # Incident An Incident is any unplanned business interruption that has wide-sweeping impacts and requires an urgent fix. This object contains the details of the incident, documenting the history of the incident from registration to closure. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Category | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of incident. | | Description | Type textarea Properties Create, Nillable, Update Description A description of the incident. This field can store up to 32 KB of data, but only the first 255 characters appear in reports. | | DetectedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time (in UTC) when the incident was first detected. | | EndDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time (in UTC) when the incident ended. | | Impact | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The incident's impact. Possible values are: - High - Low - Medium The default value is 'High'. | | IncidentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique, system-generated number for the incident. | | IsMajorIncident | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the incident is business-critical. If set to true, the incident is widespread and business-critical. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time (in UTC) when the current user last accessed this record, a list view, or another related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time (in UTC) 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. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description A polymorphic relationship field that represents the user or group assigned to resolve the incident. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentIncidentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique ID of an incident above one or more related incidents in an incident hierarchy. This is a relationship field. Relationship Name ParentIncident Relationship Type Lookup Refers To Incident | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The impact and urgency of the incident. Possible values are: - Critical - High - Low - Moderate The default value is 'Critical'. | | PriorityOverrideReason | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason why a priority should be changed or edited. | | ReportedMethod | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates how the incident was reported to customer service. | | ResolutionDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time (in UTC) when the incident was resolved. | | ResolutionSummary | Type textarea Properties Create, Nillable, Update Description A description of possible steps to resolve the incident. | | ResolvedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique ID of the user who resolved the incident. This is a relationship field. Relationship Name ResolvedBy Relationship Type Lookup Refers To User | | StartDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time (in UTC) when the incident began. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Any custom or granular stages a customer may want to track. Possible values are: - Completed - In Progress - New - Open - Problem Created - Resolved The default value is 'New'. | | StatusCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The incident's status. Possible values are: - Completed - InProgress - New - Open - ProblemCreated - Resolved The default value is 'New'. | | SubCategory | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of incident. One level deeper than Category. Administrators set field values. | | Subject | Type string Properties Create, Filter, Group, Sort, Update Description A brief description of the incident. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of incident, for example, question or problem. Administrators set field values. | | Urgency | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description A measure of how long the resolution can be delayed until an incident, problem, or change has a significant business impact. Possible values are: - High - Low - Medium The default value is 'High'. | ## 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. [IncidentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [IncidentFeed](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. [IncidentHistory](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. [IncidentOwnerSharingRule](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. [IncidentShare](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. <!-- document id=030476ae9ae357aaef7480f7684d453f2ff4de7847ce0bfc5342f9d1388b4954 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_incidentrelateditem.md --> # IncidentRelatedItem Represents a junction object that relates an Incident to an Asset or Product. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The Asset ID that's linked to the Incident. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | Comment | Type textarea Properties Create, Nillable, Update Description A description of the incident as it relates to the item. | | ImpactLevel | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The related item’s impact on the incident. Possible values are: - High - Low - Medium The default value is High. | | ImpactType | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The effect of the related item on business operations. Possible values are: - Business-Blocking - Not Business-Blocking - Partially Business-Blocking The default value is Business-Blocking. | | IncidentId | Type reference Properties Create, Filter, Group, Sort Description The Incident ID that's linked to the Asset. This field is a relationship field. Relationship Name Incident Relationship Type Lookup Refers To Incident | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated ID of the incident-related item. | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description The product (Product2) ID that's linked to the Incident.. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | ## 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. [IncidentRelatedItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [IncidentRelatedItemFeed](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. [IncidentRelatedItemHistory](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. <!-- document id=4d279b82ae049a5cc10b0528e895a635fbcb62afbdb520920f2e4ce645d99ba2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_individual.md --> # Individual Represents a customer’s data privacy and protection preferences. Data privacy records based on the Individual object store your customers’ preferences. Data privacy records are associated with related leads, contacts, person accounts, and users. This object is available in API version 42.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), merge(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - This object is available if Data Protection and Privacy is enabled. ## Fields | Field Name | Details | | --- | --- | | BirthDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The customer’s birthdate. | | CanStorePiiElsewhere | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indication that you can store the customer’s personally identifiable information (PII) outside of their legislation area. For example, you could store an EU citizen’s PII data in the US. | | ChildrenCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of children the customer has. | | ConsumerCreditScore | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The person's credit score (for example, 740). | | ConsumerCreditScoreProviderName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the company that provided the credit score. | | ConvictionsCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of convictions for the customer. | | DeathDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The customer’s death date. | | FirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The customer’s first name. Maximum size is 40 characters. | | HasOptedOutGeoTracking | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Preference to not track geolocation on mobile devices. | | HasOptedOutProcessing | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Preference to not process personal data, which can include collecting, storing, and sharing personal data. | | HasOptedOutProfiling | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Preference to not process data for predicting personal attributes, such as interests, behavior, and location. | | HasOptedOutSolicit | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Preference to not solicit products and services. | | HasOptedOutTracking | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Preference to not track customer web activity and whether the customer opens email sent through Salesforce. | | HasPrivacyHold | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates the Privacy Hold status. | | IndividualsAge | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates whether the customer is considered to be a minor. | | InfluencerRating | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description A measure of the person's influence, irrespective of how we do business with them. | | IsHomeOwner | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the customer owns a home. | | LastName | Type string Properties Create, Filter, Group, Sort, Update Description Required. The customer’s last name. Maximum size is 80 characters. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. | | MasterRecordId | Type reference Properties Filter, Group, Nillable, Sort Description If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or hasn’t been deleted, the value is null. This is a relationship field. Relationship Name MasterRecord Relationship Type Lookup Refers To Individual | | MilitaryService | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates whether the customer has served in the military. | | Name | Type string Properties Filter, Group, Sort Description Concatenation of FirstName and LastName. Maximum size is 203 characters, including whitespaces. | | Occupation | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The customer’s occupation. Maximum size is 150 characters. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | Salutation | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The title for addressing the customer, such as Dr. or Mrs. | | SendIndividualData | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Preference to export personal data for delivery to the customer. | | ShouldForget | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Preference to delete records and personal data related to this customer. | | Website | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL for the customer’s website. | ## 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. [IndividualChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 47.0) Change events are available for the object. [IndividualHistory](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. [IndividualShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_individualshare.htm "Represents a list of access levels to a data privacy record along with an explanation of the access level. For example, if you have access to a record because you own it, the IndividualAccessLevel is All and RowCause is Owner. This object is available in API version 42.0 and later.") Sharing is available for the object. <!-- document id=014836de369841281b51796b31137a2f896b61ef21817b63c8df7def306971b6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_individualapplicationitem.md --> # IndividualApplicationItem Captures individual application input data that is used during run-time. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only with the EAndU Cloud Program Access permission set. ## Fields | Field | Details | | --- | --- | | IndividualApplicationId | Type reference Properties Create, Filter, Group, Sort, Update Description The Individual Application parent object associated with the Individual Application Item. This field is a relationship field. Relationship Name IndividualApplication Relationship Type Lookup Refers To IndividualApplication | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the object related to the Individual Application. | | RelatedItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The related object associated with the Individual Application Item. This field is a polymorphic relationship field. Relationship Name RelatedItem Relationship Type Lookup Refers To Benefit, ProgramProduct | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the approval status of the Individual Application. Possible values are: - Approved - Declined - In Progress - Pending | ## 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. [IndividualApplicationItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [IndividualApplicationItemFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [IndividualApplicationItemHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [IndividualApplicationItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [IndividualApplicationItemShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. <!-- document id=0abcaf5cf686038c66d86e2b2e8de0979a1f2f2da7ce35cb07e01c2ecacea815 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_individualhistory.md --> # IndividualHistory Represents the history of changes to values in the fields of a data privacy record, based on the Individual object. This object is available in versions 42.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules - This object is available if Data Protection and Privacy is enabled. - The Individual object isn’t available to Customer Community, Partner Community, and Customer Portal users. ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the changed field. | | IndividualId | Type reference Properties Filter, Group, Sort Description ID of the data privacy record. Label is **Individual ID**. This is a relationship field. Relationship Name Individual Relationship Type Lookup Refers To Individual | | NewValue | Type anyType Properties Nillable, Sort Description The updated value of the changed field. | | OldValue | Type anyType Properties Nillable, Sort Description The previous value of the changed field. | ## Usage Use this object to identify changes to data privacy records. This object respects field-level security on the parent object. <!-- document id=6a37ddbb29298523bd0cfe5701c510d504238d84a69aae7e613c93868e95f20a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_individualshare.md --> # IndividualShare Represents a list of access levels to a data privacy record along with an explanation of the access level. For example, if you have access to a record because you own it, the IndividualAccessLevel is All and RowCause is Owner. This object is available in API version 42.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules - This object is available if Data Protection and Privacy is enabled. - The Individual object isn’t available to Customer Community, Partner Community, and Customer Portal users. ## Fields | Field Name | Details | | --- | --- | | IndividualAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the data privacy record. The possible values include: - Read - Edit - All (Except for create or update.) Set this field to an access level that’s higher than your default access level for individuals. | | IndividualId | Type reference Properties Create, Filter, Group, Sort Description ID of the Individual associated with this sharing entry. This field isn’t available for updates. This is a relationship field. Relationship Name Individual Relationship Type Lookup Refers To Individual | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Manual—The User or Group has access because a user with “All” access manually shared the data privacy record with them. - Owner—The User is the owner of the data privacy record. - Rule—The User or Group has access to the data privacy record via an Individual sharing rule. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the data privacy record. This field isn’t available for updates. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object lets you determine which users and groups can view or edit Individual records owned by other users. <!-- document id=3169bd8973fbcabe47083c82798d0e950a641eda55960941608b05300e611998 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_insecureexternalassets.md --> # Insecure External Assets Event Type Insecure External Assets events contain information about external assets. External assets include images or videos accessed by users over an insecure HTTP protocol. The event lists all your Salesforce pages that contain assets hosted insecurely on third-party sites that users loaded with a Chrome, Firefox, Microsoft Edge, or Safari browser. The INSECURE\_URI field contains the URI being used to load the asset insecurely. The Insecure External Assets event type is available in the EventLogFile object in API version 42.0 and later. Assets over HTTP can be manipulated through man-in-the-middle and other types of attacks. These attacks can trick users into sending their Salesforce credentials to malicious sites. Always use HTTPS in your custom code and templates for any asset you’re loading from external sites. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Because HTTPS connections are required to load external assets, Insecure External Assets events no longer apply. In Spring ’25 and later, this event type captures no data. To view blocked redirections and content security policy (CSP) violations for your org, use the [BrowserPolicyViolation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_browserpolicyviolation.htm "Represents a violation that occurred within the last seven days related to the Trusted URLs and Trusted URLs for External Redirects allowlists. These violations include blocked resource requests based on your content security policy (CSP) and blocked redirections. This object is available in API version 61.0 and later.") object. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or the [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ASSET\_TYPE | Type String Description Type of insecure asset. Possible Values - Base URI - Connect - Font - Frame Ancestor: External page that embeds the Salesforce page in an iframe - Frame - Image - Media - Object - Other - Plugin Types - Script - Style | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CPU\_TIME | Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DISPOSITION | Type String Description If the insecure external asset is related to your content security policy (CSP), the HTTP header that identified the insecure asset. Available in API version 61.0 and later. Possible Values - enforce—The Content-Security-Policy header identified the insecure external asset. - report—The Content-Security-Policy-Report-Only header identified the insecure external asset. | | DOCUMENT\_URI | Type String Description URL of the page that contains the insecure asset, excluding the query parameter. Example https://company.my.salesforce.com/00XXXXXXXXX | | EVENT\_TYPE | Type String Description The type of event. The value is always InsecureExternalAssets. | | INSECURE\_URI | Type String Description Insecure external asset URL being used to load an asset insecurely. For example, loading Javascript libraries using **http:**//ajax.googleapis.com/  in your custom code logs an Insecure External Asset Event with the INSECURE\_URI  field set to this URL. Find this reference in your code and update it to use **https:**//ajax.googleapis.com/  instead. Example http://pbs.twimg.com/profile\_images/5699091412070816/Z4Stwts\_normal.jpeg | | LOGIN\_KEY | Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | NETWORK\_ID | Type String Description The ID of the Experience Cloud site related to the request, if applicable. Available in API version 61.0 and later. | | ORGANIZATION\_ID | Type String Description The 15-character ID of the org. Example 00D000000000123 | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RUN\_TIME | Type Number Description The amount of time that the request took in milliseconds. | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | TYPE | Type String Description Type of Salesforce page. Possible Values - Appserver—Page without My Domain subdomain (for example, https://na44.salesforce.com) - Communities—Customer Experience Cloud site - Email—Email preview - Login—Login page (for example, https://login.salesforce.com) - Mydomain—Page on My Domain subdomain (for example, https://mycompany.my.salesforce.com) - Sites—Customer site - Static—Static content (for example, https://sfdcstatic.com) - Unknown—other type of page | | UNIQUE\_ID | Type String Description The 32-character ID of the event log file in which the insecure external asset event data is found. Example 44e128a5-ac7a-4c9a-be4c-224b6bf81b20 | | URI | Type String Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | URI\_ID\_DERIVED | Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. | | USER\_ID | Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. For example: 00590000000I1SNIA0. | ## Usage UNIQUE\_ID is used by Salesforce Customer Support to troubleshoot any issues that occur. #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=94417b6b0453b2c13769dc24693e137544d90cb53a0a8349dc156b1e30bd98de url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_insufficientaccess.md --> # Insufficient Access Event Type Insufficient Access events contain details about errors relating to insufficient account, case, contact, and opportunity record access, so that you can troubleshoot and resolve access issues for your users. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The Insufficient Access event type is disabled by default. You can enable this event type for a period of 24 hours by contacting Salesforce Customer Support. These insufficient access error scenarios are logged: - The user can’t share a case, contact, or opportunity because the user doesn’t have permission to share the parent account or the recipient of the share doesn’t currently have read access to the parent account. - The user can’t change ownership of a case, contact, or opportunity because the user doesn’t have permission to share the parent account or the new owner doesn’t currently have read access to the parent account. - The user can’t change the parent account of a case, contact, or opportunity because the user doesn’t have permission to share the new parent account or the owner of the case, contact, or opportunity doesn’t have read access to the new parent account. Insufficient access errors resulting from bulk operations involving two or more records aren’t logged. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). For more information on interpreting Insufficient Access events, see this [knowledge article](https://help.salesforce.com/s/articleView?id=000396437&type=1&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ACCESS\_ERROR | Type String Description The type of insufficient access error that the user received. Valid values are: - DATA\_NOT\_AVAILABLE—The record is no longer accessible. For example, a record was deleted and moved to the Recycle Bin. - INVALID\_TYPE—The record type doesn’t exist. - NO\_ACCESS—The user doesn’t have the required access level to complete the attempted action on the record. Example NO\_ACCESS | | ACTUAL\_LOGGED\_IN\_USER\_ID | Type Id Description The 15-character ID of the user who initiated the action that caused the insufficient access error. For example, a user attempts to transfer ownership of a record to a teammate, but the operation fails because the teammate doesn’t have the required access. In this scenario, the ACTUAL\_LOGGED\_IN\_USER\_ID is the user who attempted to transfer access, and the USER\_ID is their teammate. Example 005XXXXXXXXXXXX | | ENTITY\_TYPE | Type String Description The object for which the user received the insufficient access error. Access errors for the account, case, contact, and opportunity objects are supported. Example Account | | ERROR\_DESCRIPTION | Type String Description Description of the insufficient access error that the user received. Example User 005XXXXXXXXXXXX doesn't have full access for the record 001XXXXXXXXXXXX. | | ERROR\_TIMESTAMP | Type String Description The time in GMT that the insufficient access error occurred. Example 20130715233322.670 | | EVENT\_TYPE | Type String Description The type of event. The value is always InsufficientAccess. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. Example 00DXXXXXXXXXXXX | | RECORD\_ID | Type String Description The ID of the record that the user doesn’t have access to. Example 001XXXXXXXXXXXX | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 3nWgxWbDKWWDIk0FKfF5DV | | REQUESTED\_ACCESS\_LEVEL | Type String Description The access level required by the user’s attempted action on the record. Valid values are: - DELETE - FULL - READ - TRANSFER - WRITE Example FULL | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. Example 20130715233322.670 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z | | USER\_ID | Type Id Description The 15-character ID of the user for whom the insufficient access error occurred, either when the user couldn’t access a record, the user couldn’t complete an operation, or the user was the intended recipient of a record transfer that failed because the user didn’t have the required access. Example 005XXXXXXXXXXXX | | USER\_ID\_DERIVED | Type Id Description The 18-character case-insensitive ID of the user for whom the insufficient access error occurred, either when the user couldn’t access a record or the user was the intended recipient of a record transfer that wasn’t completed. Example 005XXXXXXXXXXXXIA0 | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") - [_Knowledge Article_: Interpret Insufficient Access Event Logs](https://help.salesforce.com/s/articleView?id=000396437&type=1&language=en_US "Knowledge Article: Interpret Insufficient Access Event Logs - HTML (New Window)") <!-- document id=8cc068c0a9d81db4409ac231270f19295f99e2f55044bb33de57f059a9f85d04 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_insufficientaccesseventlog.md --> # InsufficientAccessEventLog Insufficient Access event logs contain details about errors relating to insufficient account, case, contact, and opportunity record access. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The Insufficient Access event type is disabled by default. You can enable this event type for a period of 24 hours by contacting Salesforce Customer Support. These insufficient access error scenarios are logged: - The user can’t share a case, contact, or opportunity because the user doesn’t have permission to share the parent account or the recipient of the share doesn’t currently have read access to the parent account. - The user can’t change ownership of a case, contact, or opportunity because the user doesn’t have permission to share the parent account or the new owner doesn’t currently have read access to the parent account. - The user can’t change the parent account of a case, contact, or opportunity because the user doesn’t have permission to share the new parent account or the owner of the case, contact, or opportunity doesn’t have read access to the new parent account. Insufficient access errors resulting from bulk operations involving two or more records aren’t logged. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AccessError | Type string Properties Filter, Group, Nillable, Sort Description The type of insufficient access error that the user received. Valid values are: - DATA\_NOT\_AVAILABLE—The record is no longer accessible. For example, a record was deleted and moved to the Recycle Bin. - INVALID\_TYPE—The record type doesn’t exist. - NO\_ACCESS—The user doesn’t have the required access level to complete the attempted action on the record. Example NO\_ACCESS | | ActualLoggedInUserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who initiated the action that caused the insufficient access error. For example, a user attempts to transfer ownership of a record to a teammate, but the operation fails because the teammate doesn’t have the required access. Example 005XXXXXXXXXXXX | | ErrorDescription | Type string Properties Filter, Group, Nillable, Sort Description Description of the insufficient access error that the user received. Example User 005XXXXXXXXXXXX doesn't have full access for the record 001XXXXXXXXXXXX. | | ObjectType | Type string Properties Filter, Group, Nillable, Sort Description The object for which the user received the insufficient access error. | | RecordIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the record that the user doesn’t have access to. Example 001XXXXXXXXXXXX | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Example 3nWgxWbDKWWDIk0FKfF5DV | | RequestedAccessLevel | Type string Properties Filter, Group, Nillable, Sort Description The access level required by the user’s attempted action on the record. Valid values are: - DELETE - FULL - READ - TRANSFER - WRITE Example FULL | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. Example 20130715233322.670 | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user for whom the insufficient access error occurred, either when the user couldn’t access a record, the user couldn’t complete an operation, or the user was the intended recipient of a record transfer that failed because the user didn’t have the required access. Example 005XXXXXXXXXXXX | <!-- document id=5e4b59796417c0fe98fbd12c007611a30e6491bb03a197a506718afa08ec2592 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_internalorganizationunit.md --> # InternalOrganizationUnit Represents an organization that an Employee belongs to. This object is available in API version 48.0 and later. In API version 49.0 and later, this object supports reports, criteria-based sharing rules, and history tracking, plus you can exclude individual fields from custom page layouts. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, you have either a Workplace Command Center permission set license and the Provides access to Workplace Command Center features system permission, or the Employee Management and Employee User add-on licenses. This object is also available with the Referral Marketing license. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A description of the organization the Employee is working in. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | OrganizationCode | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The code of the organization the Employee is working in. | | OrganizationName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the organization the Employee is working in. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this record. Default value is the user logged in to the API to perform the create operation. | | ParentOrganizationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the parent organization. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether the record is for an internal or an external organization. This field is available in API version 60.0 and later. Possible values are: - EXTERNAL\_BUSINESS\_UNIT - INTERNAL\_ORGANIZATION | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [InternalOrganizationUnitHistory](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.") (API version 49.0) History is available for tracked fields of the object. [InternalOrganizationUnitOwnerSharingRule](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. [InternalOrganizationUnitShare](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.") (API version 49.0) Sharing is available for the object. #### See Also - [_Workplace Command Center for Work.com Developer Guide_: Extend Work.com with Custom Solutions](https://developer.salesforce.com/docs/atlas.en-us.264.0.ajax.meta/workdotcom_dev_guide/wdc_cc_overview.htm " Workplace Command Center for Work.com Developer Guide: Extend Work.com with Custom Solutions - HTML (New Window)") <!-- document id=fcf63783ad22822f9e7a3fce9dde392772745b8da1d2c23e8c8a4a66bf93dee6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_inventoryitemreservation.md --> # InventoryItemReservation Used to store inventory item reservation information for a specific product and location. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available only if a B2B Commerce, D2C Commerce, B2C Commerce or Salesforce Order Management license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. ISO code for the currency of the inventory items. Possible values are: - EUR—Euro - USD—U.S. Dollar The default value is USD. | | ErrorCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The error code if the reservation isn’t successful. | | ErrorMessage | Type textarea Properties Create, Nillable, Update Description If an error occurred, this field contains the error message. | | InventoryItemReservationName | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the inventory item reservation (autogenerated, for example: PIR-0033). | | InventoryReservationId | Type reference Properties Create, Filter, Group, Sort Description The ID of the inventory reservation. This field is a relationship field. Relationship Name InventoryReservation Relationship Type Lookup Refers To InventoryReservation | | ItemReservationSourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the entity associated with the inventory item reservation. This field is a relationship field. Relationship Name ItemReservationSource Relationship Type Lookup Refers To CartItem | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | ProductId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the product on the inventory item reservation. This field is unique within your organization. This field is a relationship field. Relationship Name Product Relationship Type Lookup Refers To Product2 | | Quantity | Type double Properties Create, Filter, Sort, Update Description Number of products on the inventory item reservation. | | ReservedAtLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location or location group where the inventory item reservation originated. This field is a polymorphic relationship field. Relationship Name ReservedAtLocation Relationship Type Lookup Refers To Location, LocationGroup | | StockKeepingUnit | Type string Properties Create, Filter, Group, Nillable, Sort Description The stock keeping unit (SKU) of the reserved item. | <!-- document id=e5a59ddcd6e9682ae8d988c42da218c153607b7acb9f243755ee4ee261260be6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_inventoryreservation.md --> # InventoryReservation Stores information about the status of cart inventory reservations in B2B and D2C Commerce. This object is available in API version 60.0 and later. This object only applies to cart inventory reservation APIs in B2B and D2C Commerce. It isn't related to inventory reservation Connect APIs used with Omnichannel Inventory and Order Management. If your org is using Omnichannel Inventory as its inventory system, the inventory reservation record related to the cart also represents a reservation in Omnichannel Inventory. If the org uses a different inventory system, the inventory reservation record related to the cart represents a reservation in that inventory system. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available only if a B2B Commerce, D2C Commerce, B2C Commerce, or Salesforce Order Management license is enabled. ## Fields | Field | Details | | --- | --- | | ErrorCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The error code if the reservation isn’t successful. | | ErrorMessage | Type textarea Properties Create, Nillable, Update Description If an error occurred, this field contains the error message. | | InventoryReservationName | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the inventory reservation (autogenerated, for example: PIR-0033). | | IsAsyncOperationInProgress | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if there’s an async operation in progress that could affect the reservation. The default value is false. | | IsSuccess | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the most recent inventory system operation was successful. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user could have only accessed this record or list view (LastReferencedDate) but not viewed it. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who owns the inventory reservation. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ReservationDate | Type dateTime Properties Create, Filter, Sort, Update Description The timestamp when the inventory reservation was created. | | ReservationDurationInSeconds | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total duration of the inventory reservation in seconds. | | ReservationIdentifier | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier (text value) for the reservation. | | ReservationSourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the entity associated with the inventory reservation. This field is a polymorphic relationship field. Relationship Name ReservationSource Relationship Type Lookup Refers To Export\_FOI\_\_c, WebCart | ## Associated Objects This object has these 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. [InventoryReservationOwnerSharingRule](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. [InventoryReservationShare](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. <!-- document id=1baf8f009bc76f5e10b5bff8fc134e3cf8ac2fda075d80c292f7edb4738430ad url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_invocableaction.md --> # Invocable Action Event Type Invocable Action events capture the calls to Salesforce Invocable Actions. This is particularly useful to monitor actions invoked during Agentforce flows. This event type is available in API versions 64.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">ACTION_NAME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">Name of the action.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ACTION_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">InvocableActionType being referenced.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ACTION_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The invocable action version.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">AGENT_ACTION</span></td><td class="entry"><a name="dl_oh4_jgv_p3c"></a><dl class="dl detailList" id="dl_oh4_jgv_p3c"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The API name of the agent action that invoked the action. This field is available in API version 66.0 or later.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">API_CALLER</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">Identifier of the API caller. This is only populated when the action is invoked from a REST API call. This field is available in API version 66.0 or later.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">BOT_IDENTIFIER</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">string</dd><dt class="dt dlterm">Description</dt><dd class="dd">The ID of the bot.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">BOT_SESSION_IDENTIFIER</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">string</dd><dt class="dt dlterm">Description</dt><dd class="dd">The bot session ID.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DURATION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">Time (in nanos) taken to process this set of requests.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The type of event. The value is always <samp class="codeph nolang">InvocableAction</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">FLOW_PROCESS_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The process type of the calling flow.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">FLOW_VERSION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The ID of the version of the calling flow.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">INVOCATION_SOURCE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">Indicates the source type that invoked the action. Valid values are:<ul class="ul bulletList"><li class="li">Agent Action</li><li class="li">Apex</li><li class="li">Bot</li><li class="li">Flow</li><li class="li">Internal</li><li class="li">Prompt Template</li><li class="li">REST</li></ul><p class="p">This field is available in API version 66.0 or later.</p></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">INVOKING_APEX_CLASS_NAME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The fully qualified name of the Apex class that invoked the action. This field is available in API version 66.0 or later.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The number of invoked requests.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">PLANNER_IDENTIFIER</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">string</dd><dt class="dt dlterm">Description</dt><dd class="dd">The ID of the agent planner.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">PROMPT_TEMPLATE</span></td><td class="entry"><a name="dl_vpq_c2w_p3c"></a><dl class="dl detailList" id="dl_vpq_c2w_p3c"><dt class="dt dlterm">Type</dt><dd class="dd">string</dd><dt class="dt dlterm">Description</dt><dd class="dd">The API name of the prompt template that invoked the action. This field is available in API version 66.0 or later.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_COUNT</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The number of invoked requests.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">ID of the user employing salesforce.com services, whether through the user interface or API</dd></dl></td></tr></tbody></table> <!-- document id=01e533be82c325a60b1d2b7df80957adf8a92e0e4957dbba088c6b2830c8c1b8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_invocableactioneventlog.md --> # InvocableActionEventLog Invocable Action events capture the calls to Salesforce Invocable Actions. This is particularly useful to monitor actions invoked during Agentforce flows. This object is available in API version 64.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ActionName | Type string Properties Filter, Group, Nillable, Sort Description Name of the action. | | ActionType | Type string Properties Filter, Group, Nillable, Sort Description InvocableActionType being referenced. | | ActionVersion | Type string Properties Filter, Group, Nillable, Sort Description The invocable action version. | | ApiCaller | Type string Properties Filter, Group, Nillable, Sort Description Identifier of the API caller. This is only populated when the action is invoked from a REST API call. This field is available in API version 66.0 or later. | | BotIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the bot. | | BotSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The bot session ID. | | Duration | Type double Properties Filter, Nillable, Sort Description Time (in nanos) taken to process this set of requests. | | FlowProcessType | Type string Properties Filter, Group, Nillable, Sort Description The process type of the calling flow. | | FlowVersionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the version of the calling flow. | | InternalInvoker | Type string Properties Filter, Group, Nillable, Sort | | PlannerIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the agent planner. | | RequestCount | Type int Properties Filter, Group, Nillable, Sort Description The number of invoked requests. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description ID of the user employing salesforce.com services, whether through the user interface or API. | <!-- document id=d16272bf146681da93ecd496d6b03348f40e3d6171e97d24e8653f71beba2c42 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_invoice.md --> # Invoice Represents a financial document describing the total amount a buyer must pay for goods or services provided. This object is available in API version 48.0 and later. Users can edit non-posted invoices. Posted invoices can’t be deleted. After an invoice is posted, users can make payments against it to reduce its balance. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Special Access Rules This object is available with Salesforce Order Management or D2C Commerce license, and Billing (Revenue Cloud). A few fields require Commerce Subscriptions to be enabled. These fields are available only in Lightning Experience. For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_invoice.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Balance | Type currency Properties Filter, Nillable, Sort Description The outstanding balance for this invoice. Equal to the invoice’s total amount with tax, ignoring payments and adjustments. | | BillToContactId | Type reference Properties Filter, Group, Nillable, Sort, Update Description Inherited from the account’s Bill to Account. This field is a relationship field. Relationship Name BillToContact Relationship Type Lookup Refers To Contact | | BillingAccountId | Type reference Properties Filter, Group, Sort, Update Description The customer account for this invoice. This field is a relationship field. Relationship Name BillingAccount Relationship Type Lookup Refers To Account | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The three-letter ISO 4217 currency code associated with the invoice. The default value is USD. This field is available in API version 55.0 and later. | | DaysInvoiceOpen | Type int Properties Filter, Group, Nillable, Sort Description Number of days since the invoice was created before it was paid. This field is a calculated field. This field is available in API version 55.0 and later. | | DaysInvoiceOverdue | Type int Properties Filter, Group, Nillable, Sort Description Number of days since the date when payment was due. This field is a calculated field. This field is available in API version 55.0 and later. | | Description | Type string Properties Filter, Group, Nillable, Sort, Update Description Users can add more information about this invoice. Maximum of 1,000 characters. | | DocumentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The system-generated number that is used to organize financial documents. The number can be sequential or random. | | DueDate | Type date Properties Filter, Group, Sort, Update Description The customer must pay the invoice by the due date. Unpaid invoices past the due date can be sent to collections. | | FullSettlementDate | Type date Properties Filter, Group, Nillable, Sort Description Date when the invoice is paid in full. This field is available in API version 55.0 and later. | | InvoiceBatchRunId | Type reference Properties Filter, Group, Nillable, Sort Description Id of the invoice batch run that generated this invoice. This field is a relationship field. This field is available in API version 55.0 and later. Relationship Name InvoiceBatchRun Relationship Type Lookup Refers To InvoiceBatchRun | | InvoiceDate | Type date Properties Filter, Group, Sort, Update Description The date that the invoice was posted. Used with payment terms to determine the invoice’s DueDate. For example, an invoice with an InvoiceDate of 04/01 and Net 30 payment terms has a DueDate of 05/01. | | InvoiceNumber | Type string Properties Filter, Group, Nillable, Sort, Update Description System-created unique ID for this invoice. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. This field is available in API version 55.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. If this value is null, it's possible the user accessed this record or list view (LastReferencedDate) but didn't view it. This field is available in API version 55.0 and later. | | NetCreditsApplied | Type currency Properties Filter, Nillable, Sort Description Represents the net credits applied to an invoice. Calculated by subtracting the sum of all unapplied lines from the sum of all applied lines. This field is a calculated field. This field is available in API version 55.0 and later. | | NetPaymentsApplied | Type currency Properties Filter, Nillable, Sort Description Represents net payments applied to an invoice. Calculated by subtracting the sum of unapplied payments from the sum of payments applied to the invoice. This field is a calculated field. This field is available in API version 55.0 and later. | | OwnerId | Type reference Properties Filter, Group, Sort, Update Description The user who owns an invoice record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaymentExclusionReason | Type string Properties Filter, Group, Nillable, Sort Description The reason for skipping creation of payment schedules and payment schedule items for the invoice. This field is only available if Commerce Subscriptions is enabled for your org. Available in API version 63.0 and later. | | PaymentTermId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the payment term used on this invoice. This field is a relationship field. This field is available in API version 55.0 and later. Relationship Name PaymentTerm Relationship Type Lookup Refers To PaymentTerm | | PostedDate | Type date Properties Filter, Group, Nillable, Sort Description The date the invoice was posted. This field is available in API version 60.0 and later. | | ReferenceEntityId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The ID of the order or order summary that created this invoice. This field is a polymorphic relationship field. Relationship Name ReferenceEntity Relationship Type Lookup Refers To Order, OrderSummary | | SettlementStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The state of the invoice's payment. Possible values are: - Not Applicable - Not Settled - Partially Settled - Settled This field is available when Subscription Management is enabled. This field is available in API version 55.0 and later. | | ShouldExcludePayment | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates whether to skip creating payment schedules and payment schedule items for the invoice (true) or not (false). The default value is false. This field is only available if Commerce Subscriptions is enabled for your org. Available in API Version 63.0 and later. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The state of the invoice. Possible values are: - Canceled— Indicates that the invoice was generated and later canceled. - Draft— Indicates that the invoice is a draft. Available in API version 60.0 and later. - Draft In Progress— Indicates that the draft invoice is in progress. Available in API version 60.0 and later. - Error— Indicates that an error occurred when processing the invoice. - Pending— Indicates that the invoice is being processed. - Posted— Indicates that the invoice has been generated and sent to the customer. - Posting In Progress—Indicates that the invoice posting is in progress. Available in API version 60.0 and later. - Void In Progress— Indicates that the invoice is pending a status change. - Voided— The invoice’s status after the API successfully voids the invoice. | | TaxLocaleType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The system used to handle tax on the original Order associated with the Invoice. Gross usually applies to taxes like value-added tax (VAT), and Net usually applies to taxes like sales tax. This field is available when Order Management or B2B Commerce is enabled. Possible values are: - Gross: Displays most prices and taxes as combined values - Net: Displays most prices and taxes as separate values This field is available in API version 56.0 and later. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description The sum of the invoice’s adjustment line amounts. | | TotalAdjustmentAmountWithTax | Type currency Properties Filter, Nillable, Sort Description The sum of the amount fields on the invoice's adjustment-type invoice lines, including tax. This field is available in API version 55.0 and later. | | TotalAdjustmentTaxAmount | Type currency Properties Filter, Nillable, Sort Description The total amount of tax applied to the invoice line's adjustment lines. This field is available in API version 55.0 and later. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description The sum TotalAmount values on the invoice’s lines. This field is a calculated field. | | TotalAmountWithTax | Type currency Properties Filter, Nillable, Sort Description The sum of TotalAmountWithTax values on the invoice’s lines. | | TotalChargeAmount | Type currency Properties Filter, Nillable, Sort Description The sum of the invoice’s charges. This field is a calculated field. | | TotalChargeAmountWithTax | Type currency Properties Filter, Nillable, Sort Description The sum of the amount fields on the invoice's charge-type invoice lines, including tax. This field is available in API version 55.0 and later. | | TotalChargeTaxAmount | Type currency Properties Filter, Nillable, Sort Description The total amount of tax applied to the invoice's charge lines. This field is available in API version 55.0 and later. | | TotalConvertedNegAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all negative invoice lines that were converted to a credit memo. For example, if one negative invoice line was for -$10 and one was for -$15, the total amount that’s converted to a credit memo is -$25. This field is a calculated field. This field is available when Subscription Management is enabled. This field is available in API version 56.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description The sum of TaxAmount values on the invoice lines. This field is a calculated field. | ## 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. [InvoiceFeed](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. [InvoiceHistory](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. [InvoiceOwnerSharingRule](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. [InvoiceShare](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. <!-- document id=39c1848de9b8db4f2226255913e512c49a63d7e13cf0bf451377f8a99b69148b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_invoiceaddressgroup.md --> # InvoiceAddressGroup Stores the buyer's address information. This object is available in API version 50.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_invoiceaddressgroup.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Address | Type address Properties Filter, Nillable Description Buyer's address. Compound field that summarizes the invoice address group's address component fields. | | City | Type string Properties Filter, Group, Nillable, Sort Description The buyer's city. | | Country | Type string Properties Filter, Group, Nillable, Sort Description The buyer's country. | | | | | GeocodeAccuracy | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The accuracy rating for the geocode of the address group. The accuracy rating contains information about the location of a latitude and longitude. | | InvoiceAddressGroupNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number, such as DOC-000001. | | InvoiceId | Type reference Properties Filter, Group, Sort Description ID of the invoice associated with the address group. This field is a relationship field. Relationship Name Invoice Relationship Type Lookup Refers To Invoice | | Latitude | Type double Properties Filter, Nillable, Sort Description The buyer's latitude. | | Longitude | Type double Properties Filter, Nillable, Sort Description The buyer's longitude. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort Description The buyer's postal code or ZIP code. | | State | Type string Properties Filter, Group, Nillable, Sort Description The buyer's state. | | Street | Type textarea Properties Filter, Group, Nillable, Sort Description The buyer's street. | ## 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. [InvoiceAddressGroupHistory](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. <!-- document id=3aefd33f19117c7bee16fa58d9b0b01c85cdad42c826004972b36eadd9e4845f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_invoicebatchrun.md --> # InvoiceBatchRun Represents a batch processing job in Subscription Management or Billing (Revenue Cloud). During an invoice batch run, all billing schedules that meet the specified criteria are processed, resulting in the generation of invoices. This object is available in API version 55.0 and later. An invoice batch run, controlled by a scheduler, tells the system to start the run at a scheduled date and time. The scheduler also includes matching criteria, which are used to evaluate the billing schedules. Billing schedules that meet the specified criteria are included for processing in the invoice batch run. When an invoice batch run is started, Subscription Management or Billing (Revenue Cloud): - Evaluates the billing schedule to see if it meets the criteria for inclusion in the batch invoice run. - Generates an invoice record with a pending state. - Makes calls to an external tax provider. - Adds the tax to the invoice. - Summarizes information about the billing schedules that were included in the invoice batch run and displays this information in the Invoice Batch Run record. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_invoicebatchrun.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | BillingBatchSchedulerId | Type reference Properties Filter, Group, Sort Description The ID of the related billing batch scheduler. This field is a relationship field. Relationship Name BillingBatchScheduler Relationship Type Lookup Refers To BillingBatchScheduler | | Comments | Type textarea Properties Filter, Nillable, Sort, Update Description Optional user-defined information about the scheduler. | | CompletionTime | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the invoice batch run finished processing. | | InvoiceBatchRunNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated sequential number. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the invoice batch run was last modified. Its UI label is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the invoice batch run was last viewed. | | OwnerId | Type reference Properties Filter, Group, Sort, Update Description System-generated field. The ID of the user who created the BillingBatchScheduler record. Its UI label is Owner. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RecoveryStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the state of the invoice batch run recovery process. This field is available in API version 56.0 and later. Possible values are: - CompletelyRecovered—All billing schedules included in the recovery run were reset to Ready for Invoicing. These billing schedules are included in the next scheduled invoice batch run. - PartiallyRecovered—Some, but not all, billing schedules that were part of the recovery run were reset to Ready for Invoicing. The billing schedules that were recovered are included in the next scheduled invoice batch run. The billing schedules that weren’t successfully recovered must be manually reset to Ready for Invoicing so they can be processed. - RecoveryFailed—The recovery job was unsuccessful. This value is available in API version 57.0 and later. - RecoveryStarted—The recovery job is in process. | | StartTime | Type dateTime Properties Filter, Sort Description Timestamp when the invoice batch run started processing. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The state of the invoice batch run. Possible values are: - Canceled—This value is available in API version 57.0 and later. - Completed - Failed - Started - Stopped—This value is available in API version 57.0 and later. The default value is Started. | | TotalBillSchedRecovered | Type int Properties Filter, Group, Nillable, Sort Description The number of billing schedules that were part of the recovery run that were reset to Ready for Invoicing. These billing schedules are included in the next scheduled invoice batch run. This field is available in API version 57.0 and later. | | TotalBillSchedUnrecovered | Type int Properties Filter, Group, Nillable, Sort Description The number of billing schedules that were part of the recovery run that weren't reset to Ready for Invoicing. These billing schedules that weren’t successfully recovered must be manually reset to Ready for Invoicing so they can be processed. This field is available in API version 57.0 and later. | | TotalBillingSchedulesFailed | Type int Properties Filter, Group, Nillable, Sort Description The total number of billing schedules that weren’t successfully processed. When a billing schedule isn’t successfully processed, then the system doesn’t generate an invoice for it. For details about errors, check the Revenue Transaction Error Log. This field is available in API version 56.0 and later. | | TotalBsSuccessfullyProcessed | Type int Properties Filter, Group, Nillable, Sort Description The total number of billing schedules for which the system was able to generate and process invoices. This field is available in API version 56.0 and later. | | TotalDraftInvoiceAmount | Type currency Properties Filter, Nillable, Sort Description The sum of the invoice amounts for invoices in Draft status. This field is available when Billing (Revenue Cloud) is enabled. This field is available in API version 62.0 and later. | | TotalDraftInvoices | Type int Properties Filter, Group, Nillable, Sort Description The total number of invoices in Draft status generated in the batch run. This field is available when Billing (Revenue Cloud) is enabled. This field is available in API version 62.0 and later. | | TotalFilteredBillingSchedules | Type int Properties Filter, Group, Nillable, Sort Description The total number of billing schedules that met the invoice run scheduler’s matching criteria. The matching criteria specify which billing schedules are included in the invoice batch run. Its field label is Total Matching Billing Schedules. This field is available in API version 56.0 and later. | | TotalInvSuccessfullyProcessed | Type int Properties Filter, Group, Nillable, Sort Description The total number of invoices that were successfully processed. When Billing (Revenue Cloud) is enabled, the field's value is either the same as TotalPostedInvoices or TotalDraftInvoices based on the Invoice Status selected when the Invoice Scheduler is set up. This field is available in API version 56.0 and later. | | TotalInvoicedAmount | Type currency Properties Filter, Nillable, Sort Description The total amount of income including taxes represented by the successfully processed invoices. This field is available in API version 56.0 and later. | | TotalInvoicesCanceled | Type int Properties Filter, Group, Nillable, Sort Description The total number of invoices that weren't processed. To find out what went wrong, check the Revenue Transaction Error Log. Fix the errors, then run the invoice batch run recovery process. This field is available in API version 57.0 and later. | | TotalInvoicesFailed | Type int Properties Filter, Group, Nillable, Sort Description The total number of invoices that weren’t processed successfully. To find out what went wrong, check the Revenue Transaction Error Log. Then fix the errors and run the invoice batch run recovery process. This field is available in API version 56.0 and later. | | TotalInvoicesGenerated | Type int Properties Filter, Group, Nillable, Sort Description The total number of invoices that were generated from the billing schedules processed by the invoice batch run. This field is available in API version 56.0 and later. | | TotalPostedInvoices | Type int Properties Filter, Group, Nillable, Sort Description The total number of invoices in Posted status generated during the batch run. This field is available when Billing (Revenue Cloud) is enabled. This field is available in API version 62.0 and later. | | TotBillSchdUpdtDurDrftToPost | Type int Properties Filter, Group, Nillable, Sort Description The total billing schedules updated during the draft to posted run. This field is available when Billing (Revenue Cloud) is enabled. This field is available in API version 62.0 and later. | ## 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. [InvoiceBatchRunChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [InvoiceBatchRunFeed](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. [InvoiceBatchRunHistory](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. [InvoiceBatchRunOwnerSharingRule](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. [InvoiceBatchRunShare](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. <!-- document id=aeceda5406e5df1549b38f755a3f3c65dd285c757a968edbae8ef338e57bceda url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_invoicebatchruncriteria.md --> # InvoiceBatchRunCriteria Represents a batch processing job and its required criteria in Subscription Management. During an invoice batch run, all billing schedules that meet the specified criteria are processed, resulting in the generation of invoices. This object is available in API version 55.0 and later. A scheduled invoice batch run tells the system to start the run at a scheduled date and time by using certain criteria. The scheduler includes the matching criteria, which are used to evaluate the billing schedules. Billing schedules that meet the specified criteria are included for processing in the invoice batch run. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_invoicebatchruncriteria.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Comments | Type textarea Properties Filter, Nillable, Sort Description Optional user-defined information about the batch run criteria. | | CriteriaExpression | Type textarea Properties Filter, Nillable, Sort Description The formula that specifies criteria for filtering the billing schedules. For example, we can filter billing schedules by currency code. | | CriteriaMatchType | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of matching criteria required for the batch. Valid value is MatchAll. The default value is MatchAll. | | ExpectedInvoiceStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of invoice a batch run generates. Valid values are: - Draft - Posted This field is available in API version 60.0 and later. | | InvoiceBatchRunCriteriaNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated sequential number. | | OwnerId | Type reference Properties Filter, Group, Sort Description System-generated field. The ID of the user who created the BillingBatchScheduler record. Its UI label is Owner. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | <!-- document id=b71ecb64ce016cb8a573000b60f3fa056a18f70f6fbf018a37f0cf6a50d5bfcb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_invoicebatchrunrecovery.md --> # InvoiceBatchRunRecovery Provides information about an invoice batch run recovery procedure. This object is available in API version 57.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_invoicebatchrunrecovery.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Comments | Type textarea Properties Filter, Nillable, Sort, Update Description Optional user-defined information about the scheduler. | | CompletionTime | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the invoice batch run recovery procedure was completed. | | InvoiceBatchRunId | Type reference Properties Filter, Group, Sort Description The unique identifier of the invoice batch run related to this recovery run. This field is a relationship field. Relationship Name InvoiceBatchRun Relationship Type Lookup Refers To InvoiceBatchRun | | InvoiceBatchRunRecoveryNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique identifier of the invoice batch run recovery process. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user indirectly accessed this record (LastReferencedDate), but did not view it. | | StartTime | Type dateTime Properties Filter, Sort Description The timestamp when the invoice batch run recovery started. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The final state of the invoice batch run recovery process. Possible values are: - Completed—The recovery run successfully reset all billing schedules to Ready for Invoicing. - CompletedWithErrors—Some, but not all, billing schedules included in the recovery run were reset to Ready for Invoicing. The billing schedules that were recovered are included in the next scheduled invoice batch run. The billing schedules that weren’t successfully recovered must be manually reset to Ready for Invoicing so they can be processed. - Failed—The recovery run was unable to complete the reset process. - Started—Indicates that the recovery run reset process began, is ongoing, and has not yet produced a result. The default value is Started. | ## 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. [InvoiceBatchRunRecoveryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [InvoiceBatchRunRecoveryFeed](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. [InvoiceBatchRunRecoveryHistory](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. [InvoiceBatchRunRecoveryOwnerSharingRule](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. [InvoiceBatchRunRecoveryShare](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. <!-- document id=77de579877a6773284058dad11ca6c5f71a1457b45fb84a949f99aaa94450c8c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_invoicedocument.md --> # InvoiceDocument Tracks and displays the status of documents generated for invoices. Invoice documents are available in the related lists of invoice entity records. This object is available in API version 61.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules This object is available with Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_invoicedocument.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the generated PDF document. This field is a relationship field. Relationship Name ContentDocument Refers To ContentDocument | | DateGenerated | Type date Properties Filter, Group, Nillable, Sort Description The date on which the PDF is generated. | | DocumentGenerationProcessId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the entity that contains the information used to create the PDF invoice. This field is a relationship field. Relationship Name DocumentGenerationProcess Refers To DocumentGenerationProcess | | DocumentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The ID of the generated document. | | ErrorMessage | Type string Properties Filter, Group, Nillable, Sort Description Errors that occur during PDF generation. | | InvoiceId | Type reference Properties Filter, Group, Sort Description The ID of the invoice entity to which the invoice document is attached. This field is a relationship field. Relationship Name Invoice Relationship Type Master-detail Refers To Invoice (the master object) | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the PDF generation process. Possible values are: - Blocked - Cancelled - Failure - Pending - Success | <!-- document id=9c9261326dbd8f35f03304da771d3f16d614720a933f0baf2a6261abcde7e259 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_invoiceline.md --> # InvoiceLine Represents the amount that a buyer must pay for a product, service, or fee. Invoice lines are created based on the amount of an order line. This object is available in API version 48.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Special Access Rules This object is available with Order Management, Subscription Management, and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_invoiceline.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | AdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description Sum of adjustments made to the invoice line. | | AdjustmentAmountWithTax | Type currency Properties Filter, Nillable, Sort Description Sum of adjustment amounts, including associated taxes related to the invoice line. | | AdjustmentTaxAmount | Type currency Properties Filter, Nillable, Sort Description Sum of tax adjustments to the invoice line. This field is available in API version 55.0 and later. | | Balance | Type currency Properties Filter, Nillable, Sort Description The outstanding balance for an invoice line. This is equal to the invoice’s total amount with tax after deducting the payments made. | | BillingAddressId | Type reference Properties Filter, Group, Nillable, Sort Description Lookup field to an InvoiceAddressGroup containing the billing address for the invoice line. Assign one InvoiceAddressGroup to the invoiceLine's BillingAddressID, and another InvoiceAddressGroup to the invoiceLine's ShippingAddressId. This field is a relationship field. This field is available in API version 55.0 and later. Relationship Name BillingAddress Relationship Type Lookup Refers To InvoiceAddressGroup | | BillingScheduleGroupId | Type reference Properties Filter, Group, Nillable, Sort, Update Description This field is a relationship field. Relationship Name BillingScheduleGroup Refers To BillingScheduleGroup | | BillingScheduleId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the billing schedule for the invoice line. This field is a relationship field. This field is available in API version 55.0 and later. Relationship Name BillingSchedule Relationship Type Lookup Refers To BillingSchedule | | ChargeAmount | Type currency Properties Filter, Nillable, Sort, Update Description Sum of charges made to the invoice line. | | ChargeAmountWithTax | Type currency Properties Filter, Nillable, Sort Description Amount on a charge invoice line, including tax. This field is available in API version 55.0 and later. | | ChargeTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax to be applied on a charge invoice line. This field is available in API version 55.0 and later. | | ConvertedNegAmount | Type currency Properties Filter, Nillable, Sort Description The amount from an invoice line that is converted to credit. This field is available in API version 56.0 and later. | | Description | Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the invoice line. | | GroupReferenceEntityItemId | Type reference Properties Filter, Group, Nillable, Sort, Update Description Grouping field for adjustment line items. This field is a polymorphic relationship field. Relationship Name GroupReferenceEntityItem Relationship Type Lookup Refers To OrderItem, OrderItemAdjustmentLineItem | | HasMultipleItems | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this field merges items from the same billing period. The default value is false. | | InvoiceId | Type reference Properties Filter, Group, Sort Description The invoice that contains this invoice line. This field is a relationship field. Relationship Name Invoice Relationship Type Lookup Refers To Invoice | | InvoiceLineEndDate | Type date Properties Filter, Group, Sort, Update Description For invoice lines made from a time-based service, the end date of the billing for the service. | | InvoiceLineStartDate | Type date Properties Filter, Group, Sort, Update Description For invoice lines made from a time-based service, the first date of the billing for the service. | | InvoiceStatus | Type string Properties Filter, Group, Nillable, Sort Description State of the invoice line. Inherited from the invoice’s status. | | LegalEntityAccountingPeriodId | Type reference Properties Filter, Group, Nillable, Sort, Update Description This field is a relationship field. Relationship Name LegalEntityAccountingPeriod Refers To LegalEntyAccountingPeriod | | LegalEntityId | Type reference Properties Filter, Group, Nillable, Sort, Update Description This field is a relationship field. Relationship Name LegalEntity Refers To LegalEntity | | LineAmount | Type currency Properties Filter, Nillable, Sort Description The amount of the invoice line. This field is a calculated field. This field is available in API version 55.0 and later. | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description Name of the invoice line. | | NetCreditsApplied | Type currency Properties Filter, Nillable, Sort Description The total credit memo line amount applied to the invoice line. This amount is calculated by subtracting the unapplied credit memo line amount from the applied credit memo line amount. This field is a calculated field. | | NetPaymentsApplied | Type currency Properties Filter, Nillable, Sort Description The total payment applied to the invoice line. This amount is calculated by subtracting the unapplied payment amount from the applied payment amount. This field is a calculated field. | | Product2Id | Type reference Properties Filter, Group, Nillable, Sort, Update Description The product that was charged or ordered to create the invoice line. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | Quantity | Type double Properties Filter, Nillable, Sort, Update Description Number of units of the order product that created the invoice line. | | ReferenceEntityItemId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The order item or adjustment item that created the invoice line. This field is a polymorphic relationship field. Relationship Name ReferenceEntityItem Relationship Type Lookup Refers To OrderItem, OrderItemAdjustmentLineItem | | ReferenceEntityItemType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of transaction that created the invoice line. Possible values are: - DeliveryCharge—Charge - Fee—Charge. This value is available in API version 56.0 and later. - OrderProduct—Product | | ReferenceEntityItemTypeCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of object that created the invoice line. Possible values are: - Charge - Product | | RelatedLineId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The original invoice line that was adjusted or taxed. This field is a relationship field. Relationship Name RelatedLine Relationship Type Lookup Refers To InvoiceLine | | ShippingAddressId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the shipping address associated with the invoice line. This field is a relationship field. This field is available in API version 55.0 and later. Relationship Name ShippingAddress Relationship Type Lookup Refers To InvoiceAddressGroup | | TaxAmount | Type currency Properties Filter, Nillable, Sort, Update Description Total tax for the invoice line. | | TaxCode | Type string Properties Filter, Group, Nillable, Sort, Update Description The code used to calculate tax rate for the invoice line. | | TaxDocumentNumber | Type string Properties Filter, Group, Nillable, Sort Description Represents the latest record in the external tax engine in which this invoice line item is included. This field is available in API version 55.0 and later. | | TaxEffectiveDate | Type date Properties Filter, Group, Nillable, Sort, Update Description The date used to calculate the invoice line’s TaxAmount. | | TaxName | Type string Properties Filter, Group, Nillable, Sort, Update Description User-defined name for the applied tax. | | TaxRate | Type percent Properties Filter, Nillable, Sort, Update Description Percentage value used for calculating tax. | | TaxTransactionNumber | Type string Properties Filter, Group, Nillable, Sort Description Represents the transaction in the external tax engine in which the taxes for the line were calculated for the invoice line. This field is available in API version 55.0 and later. | | TaxTreatmentId | Type reference Properties Filter, Group, Nillable, Sort Description The tax treatment used on this invoice line. This field is a relationship field. This field is available in API version 55.0 and later. Relationship Name TaxTreatment Relationship Type Lookup Refers To TaxTreatment | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Shows the type of transaction for the invoice line. Possible values are: - Adjustment - Charge - Tax | | UnitPrice | Type currency Properties Filter, Nillable, Sort, Update Description Price for one unit of the item on the invoice line. | ## 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. [InvoiceLineFeed](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. [InvoiceLineHistory](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. [InvoiceLineOwnerSharingRule](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. [InvoiceLineShare](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. <!-- document id=1683beaa8d72ade65516c6b2e0a88f8127b63dbba90a77e7909f931b13656464 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_jobprofile.md --> # JobProfile Represents a job profile used for shift scheduling. This object is available in API versions 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service or Workforce Engagement must be enabled. ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the current user last viewed a related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the current user last viewed this record. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the job profile. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the job profile. | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [JobProfileFeed](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. [JobProfileHistory](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. [JobProfileOwnerSharingRule](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. [JobProfileShare](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. <!-- document id=409f6dbeb0bb85243cb75f54f681fdedc74705e5cbf007a8d1076138cd721abe url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_jobprofilequeuegroup.md --> # JobProfileQueueGroup JobProfileQueueGroup defines the mapping between Queue and JobProfile and configurations for capacity plans in Workforce Engagement. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Org must have the Workforce Engagement, Workforce Engagement Configuration, and Omni org preferences enabled. User must have the Workforce Engagement Analyst or Planner user permission set. ## Fields | Field | Details | | --- | --- | | AnswerTime | Type int Properties Create, Filter, Group, Sort, Update Description The answer time (in seconds) for a specific group. | | CapacityPerJobProfile | Type int Properties Create, Filter, Group, Sort, Update Description The max number of work units that an agent can handle for a specific job profile. | | GroupCapacity | Type int Properties Create, Filter, Group, Sort, Update Description The distributed number of work units among groups to which a specific job profile is associated. | | GroupId | Type reference Properties Create, Filter, Group, Sort, Update Description Identifies the group or queue record. This is a relationship field. Relationship Name Group Relationship Type Lookup Refers To Group | | JobProfileId | Type reference Properties Create, Filter, Group, Sort, Update Description Identifies the job profile record. This is a relationship field. Relationship Name JobProfile Relationship Type Lookup Refers To JobProfile | | JobProfileShrinkage | Type double Properties Create, Filter, Sort, Update Description The shrinkage for a specific job profile. | | Priority | Type int Properties Create, Filter, Group, Sort, Update Description The priority of a group per job profile. | | ServiceLevelAgreementPerc | Type double Properties Create, Filter, Sort, Update Description The expected SLA percentage for a specific group. | | WorkType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description A type of group, indicating whether a queue is synchronous or asynchronous. Possible values are: - A—Async - S—Sync The default value is 'S'. | <!-- document id=58ef78612256355cbdaf1c1e444b6851e4011accd91aad8152b5e3aeb03a18f3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_knowledgearticleview.md --> # Knowledge Article View Event Type Knowledge Article View events contain user activity with your knowledge base. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">ARTICLE_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the article.</dd><dd class="dd">For example: <samp class="codeph nolang">00Dxx0000001gEb</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ARTICLE_STATUS</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Character</dd><dt class="dt dlterm">Description</dt><dd class="dd">Possible values are:<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">D</samp>—Draft</li><li class="li"><samp class="codeph nolang">O</samp>—Online</li><li class="li"><samp class="codeph nolang">A</samp>—Archived</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ARTICLE_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">Article version number.</dd><dd class="dd">For example: <samp class="codeph nolang">2</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ARTICLE_VERSION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the article version.</dd><dd class="dd">For example: <samp class="codeph nolang">ka0R00000005rt6</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CONTEXT</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">Context of the request.</dd><dt class="dt dlterm">Description</dt><dd class="dd">Possible values are:<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">Apex</samp></li><li class="li"><samp class="codeph nolang">API</samp></li><li class="li">empty string</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ENTITY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">Entity requested.</dd><dd class="dd">For example: <samp class="codeph nolang">Knowledge__kav</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="event-type-desc"><a name="event-type-desc"></a>The type of event.</span> The value is always <samp class="codeph nolang">KnowledgeArticleView</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LANGUAGE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">iso-code of the language.</dd><dd class="dd">For example: <samp class="codeph nolang">en_US</samp>/</dd><dt class="dt dlterm">Example</dt><dd class="dd"></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LARGE_LANGUAGE_MODEL</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The name of the large language model (LLM) that generated the knowledge article version.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LAST_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Boolean</dd><dt class="dt dlterm">Description</dt><dd class="dd"><samp class="codeph nolang">True</samp> if it is the last version.</dd><dd class="dd">Possible values are:<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">True</samp></li><li class="li"><samp class="codeph nolang">False</samp></li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the organization.</dd><dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">Session ID of the request.</dd><dd class="dd">For example: <samp class="codeph nolang">gV7pCSW2vGaaJNFi3GSpuPIjNbKVbSxRvx34LJsIvuc=</samp>.</dd><dt class="dt dlterm">Example</dt><dd class="dd"></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd><dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. The timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00530000009M943</samp></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00590000000I1SNIA0</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Character</dd><dt class="dt dlterm">Description</dt><dd class="dd">User type of the request.</dd><dd class="dd">Possible values are:<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">A</samp>—App</li><li class="li"><samp class="codeph nolang">C</samp>—Customer Portal</li><li class="li"><samp class="codeph nolang">P</samp>—Partner Portal</li><li class="li"><samp class="codeph nolang">G</samp>—guest</li><li class="li"></li></ul></dd></dl></td></tr></tbody></table> <!-- document id=a7a99853b0c61fee0e8c5cd31133e6cc58ad23172426f2b511445eb307061fd2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledge__datacategoryselection.md --> # Knowledge\_\_DataCategorySelection Represents a data category that classifies an article. This object is available in API version 39.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note By default, the prefix for this object name is Knowledge and that is the value shown in this reference. However, this prefix can be modified by changing the **Object Name** for the Knowledge\_\_kav object in Object Manager. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Lightning Knowledge must be enabled in your org. ## Fields | Field | Details | | --- | --- | | DataCategoryGroupName | Type datacategorygroupreference Properties Create Description Unique name of the data category group which has categories associated with the article. | | DataCategoryName | Type datacategorygroupreference Properties Create Description Unique name of the data category associated with the article. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the article associated with the data category selection. | ## Usage Every article in Salesforce Knowledge can be categorized. A data category selection represents a category that has been selected to classify an article. You can use this object to query and manage article categorization in your organization. Client applications can create a categorization for an article with a Draft status. They can also delete and query article categorizations. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When using this object to classify an article, you can't select both a category (for example USA) and one of its descendants (California) or ascendant categories (North America). In this case, only the first category is selected. <!-- document id=d8e2341aa6a641f0187b0dd1878a799c206d5e3670d89e7777e63e63cfef4b7f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledge__feed.md --> # Knowledge\_\_Feed Represents the feed for a knowledge article. This object is available in API version 39.0 and later. For additional information about feeds, see [FeedItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feeditem.htm "FeedItem represents an entry in the feed, such as changes in a record feed, including text posts, link posts, and content posts. This object is available in API version 21.0 and later. This object replaces FeedPost."). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note By default, the prefix for this object name is Knowledge and that is the value shown in this reference. However, this prefix can be modified by changing the **Object Name** for the Knowledge\_\_kav object in Object Manager. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Lightning Knowledge must be enabled in your org. ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d1080307e118">Field</th> <th class="featureTableHeader " id="d1080307e121">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">BestCommentId</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The ID of the comment marked as best answer on a question post.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">Body</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The body of the feed item. <span class="ph" id="BodyDescReqWhenTextPost"><a name="BodyDescReqWhenTextPost"><!-- --></a>Required when <span class="keyword parmname">Type</span> is <samp class="codeph nolang">TextPost</samp> or <samp class="codeph nolang">AdvancedTextPost</samp>. Optional when <span class="keyword parmname">Type</span> is <samp class="codeph nolang">ContentPost</samp> or <samp class="codeph nolang">LinkPost</samp>.</span> </dd> <dd class="dd">Although a value for <span class="keyword parmname">Body</span> is not required for the <samp class="codeph nolang">ContentPost</samp> type, an attachment is required. If an attachment isn’t present, the type changes to <samp class="codeph nolang">TextPost</samp> or <samp class="codeph nolang">AdvancedTextPost</samp>, depending on the API version. <samp class="codeph nolang">TextPost</samp> and <samp class="codeph nolang">AdvancedTextPost</samp> do require a value for <span class="keyword parmname">Body</span>.<div class="box message confirm"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png" alt="Tip"> <div class="mediaBd"> <h4 class="mbs">Tip</h4> <p>See the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feeditem.htm#isRichTextDes"><span class="keyword parmname">IsRichText</span></a> field for a list of HTML tags supported in the body of rich text posts.</p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">CommentCount</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The number of comments associated with this feed item.</dd> </dl> <div class="box message confirm"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png" alt="Tip"> <div class="mediaBd"> <h4 class="mbs">Tip</h4> <p>In a feed that supports pre-moderation, <span class="keyword parmname">CommentCount</span> isn’t updated until a comment is published. For example, say that you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, comments aren’t counted until approved by an admin or someone with Can Approve Feed Post and Comment or Modify All Data. </p><p class="p">Feed moderation has implications on how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through <span class="keyword parmname">CommentCount</span>, go through pagination until the end of comments is returned.</p> <p></p> </div> </div> </div> </div> </div> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">InsertedById</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the <span class="keyword parmname">InsertedBy</span> value is set to the ID of the context user.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">IsRichText</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether the feed item <span class="keyword parmname">Body</span> contains rich text. If you post a rich text feed comment using SOAP API, set <span class="keyword parmname">IsRichText</span> to <samp class="codeph nolang">true</samp> and escape HTML entities from the body. Otherwise, the post is rendered as plain text.<p class="p">Rich text supports the following HTML tags:</p> <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang"><p></samp> <div class="box message confirm"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png" alt="Tip"> <div class="mediaBd"> <h4 class="mbs">Tip</h4> <p>Though the <samp class="codeph nolang"><br></samp> tag isn’t supported, you can use <samp class="codeph nolang"><p>&nbsp;</p></samp> to create lines. </p> </div> </div> </div> </div> </div> </li> <li class="li"><samp class="codeph nolang"><a></samp></li> <li class="li"><samp class="codeph nolang"><b></samp></li> <li class="li"><samp class="codeph nolang"><code></samp></li> <li class="li"><samp class="codeph nolang"><i></samp></li> <li class="li"><samp class="codeph nolang"><u></samp></li> <li class="li"><samp class="codeph nolang"><s></samp></li> <li class="li"><samp class="codeph nolang"><ul></samp></li> <li class="li"><samp class="codeph nolang"><ol></samp></li> <li class="li"><samp class="codeph nolang"><li></samp></li> <li class="li"> <samp class="codeph nolang"><img></samp> <p class="p">The <samp class="codeph nolang"><img></samp> tag is accessible only through the API and must reference files in Salesforce similar to this example: <span class="ph filepath"><img src="sfdc://069B0000000omjh"></img></span> </p> </li> </ul> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation.</p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">LikeCount</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The number of likes associated with this feed item.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">LinkUrl</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">url</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The URL of a <samp class="codeph nolang">LinkPost</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">ParentId</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">ID of the Knowledge article to which the feed item is related.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">RelatedRecordId</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="relatedrecordid_descrip_short"><a name="relatedrecordid_descrip_short"><!-- --></a>ID of the ContentVersion record associated with a <samp class="codeph nolang">ContentPost</samp>. For WDC thanks posts, it’s the ID of the WorkThanks object associated with a <samp class="codeph nolang">RypplePost</samp>. This field is typically null for all posts except <samp class="codeph nolang">ContentPost</samp> and <samp class="codeph nolang">RypplePost</samp>.</span> <p class="p"><span class="ph" id="relatedrecordid_descrip2"><a name="relatedrecordid_descrip2"><!-- --></a>For example, set this field to an existing ContentVersion ID and post it to a feed with <span class="keyword parmname">Type</span> set to <samp class="codeph nolang">ContentPost</samp>.</span></p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">Title</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The title of the feed item. When the <span class="keyword parmname">Type</span> is <samp class="codeph nolang">LinkPost</samp>, the <span class="keyword parmname">LinkUrl</span> is the URL and this field is the link name. The <span class="keyword parmname">Title</span> field can be updated on posts of <span class="keyword parmname">Type</span> <samp class="codeph nolang">QuestionPost</samp>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1080307e118" data-title="Field"> <span class="keyword parmname">Type</span> </td> <td class="entry" headers="d1080307e121" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of feed item. Except for <samp class="codeph nolang">ContentPost</samp>, <samp class="codeph nolang">LinkPost</samp>, and <samp class="codeph nolang">TextPost</samp>, don’t create feed items of other types directly from the API.<a name="TypePicklist"><!-- --></a> <ul class="ul bulletList" id="TypePicklist"> <li class="li"> <p class="p"><samp class="codeph nolang">ActivityEvent</samp>—indirectly generated event when a user or the API adds a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm#sforce_api_objects_task" title="Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities.">Task</a> associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_event.htm#sforce_api_objects_event" title="Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities.">Event</a> associated with a case record (excluding email and call logging).</p> <p class="p">For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence.</p> </li> <li class="li"> <samp class="codeph nolang" id="advancedTextPost"><a name="advancedTextPost"><!-- --></a>AdvancedTextPost</samp>—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. </li> <li class="li"> <samp class="codeph nolang">AnnouncementPost</samp>—Not used. </li> <li class="li"> <samp class="codeph nolang">ApprovalPost</samp>—generated when a user submits an approval. </li> <li class="li"> <samp class="codeph nolang">BasicTemplateFeedItem</samp>—Not used. </li> <li class="li"> <samp class="codeph nolang">CanvasPost</samp>—a post made by a canvas app posted on a feed. </li> <li class="li"> <samp class="codeph nolang">CollaborationGroupCreated</samp>—generated when a user creates a public group. </li> <li class="li"> <samp class="codeph nolang">CollaborationGroupUnarchived</samp>—Not used. </li> <li class="li"> <samp class="codeph nolang" id="contentPost"><a name="contentPost"><!-- --></a>ContentPost</samp>—a post with an attached file. </li> <li class="li"> <samp class="codeph nolang">CreatedRecordEvent</samp>—generated when a user creates a record from the publisher. </li> <li class="li"> <samp class="codeph nolang">DashboardComponentAlert</samp>—generated when a dashboard metric or gauge exceeds a user-defined threshold. </li> <li class="li"> <samp class="codeph nolang">DashboardComponentSnapshot</samp>—created when a user posts a dashboard snapshot on a feed. </li> <li class="li"> <samp class="codeph nolang" id="linkPost"><a name="linkPost"><!-- --></a>LinkPost</samp>—a post with an attached URL. </li> <li class="li"> <samp class="codeph nolang">PollPost</samp>—a poll posted on a feed. </li> <li class="li"> <samp class="codeph nolang">ProfileSkillPost</samp>—generated when a skill is added to a user’s Chatter profile. </li> <li class="li"> <samp class="codeph nolang" id="questionPost"><a name="questionPost"><!-- --></a>QuestionPost</samp>—generated when a user posts a question. </li> <li class="li"> <samp class="codeph nolang">ReplyPost</samp>—generated when Chatter Answers posts a reply. </li> <li class="li"> <samp class="codeph nolang">RypplePost</samp>—generated when a user creates a Thanks badge in WDC. </li> <li class="li"> <samp class="codeph nolang" id="textPost"><a name="textPost"><!-- --></a>TextPost</samp>—a direct text entry on a feed. </li> <li class="li"> <samp class="codeph nolang" id="type_trackedchange"><a name="type_trackedchange"><!-- --></a>TrackedChange</samp>—a change or group of changes to a tracked field. </li> <li class="li"> <samp class="codeph nolang">UserStatus</samp>—automatically generated when a user adds a post. Deprecated. </li> </ul> <div class="p" id="case_feed_type_values"> <a name="case_feed_type_values"><!-- --></a>The following values appear in the <span class="keyword parmname">Type</span> picklist for all feed objects but apply only to CaseFeed: <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">AttachArticleEvent</samp>—generated event when a user attaches an article to a case. </li> <li class="li"> <samp class="codeph nolang">CallLogPost</samp>—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. </li> <li class="li"> <samp class="codeph nolang">CaseCommentPost</samp>—generated event when a user adds a case comment for a case object. </li> <li class="li"> <samp class="codeph nolang">ChangeStatusPost</samp>—generated event when a user changes the status of a case. </li> <li class="li"> <samp class="codeph nolang">ChatTranscriptPost</samp>—generated event when Chat transcript is saved to a case. </li> <li class="li"> <samp class="codeph nolang">EmailMessageEvent</samp>—generated event when an email related to a case object is sent or received. </li> <li class="li"> <samp class="codeph nolang">FacebookPost</samp>—generated when a Facebook post is created from a case. Deprecated. </li> <li class="li"> <samp class="codeph nolang">MilestoneEvent</samp>—generated when a case milestone is completed or reaches violation status. </li> <li class="li"> <samp class="codeph nolang">SocialPost</samp>—generated when a social post is created from a case. </li> </ul> </div> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>If you set <span class="keyword parmname">Type</span> to <samp class="codeph nolang">ContentPost</samp>, also specify <span class="keyword parmname">ContentData</span> and <span class="keyword parmname">ContentFileName</span>. </p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> </tbody> </table> <!-- document id=0d450b984f7000a8e7f7a4e9201b992ffd5fafd1376864fb2a9260d51efd246d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledge__ka.md --> # Knowledge\_\_ka Provides access to the concrete object that represents a Knowledge article, the parent object for article versions. This object is available in API version 39.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note By default, the prefix for this object name is Knowledge and that is the value shown in this reference. However, this prefix can be modified by changing the **Object Name** for the Knowledge\_\_kav object in Object Manager. This object is derived from [KnowledgeArticle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticle.htm "Provides read-only access to an article and the ability to delete the primary article. This object is available in API version 19.0 and later."). ## Supported Calls delete(), describeLayout(), describeSObjects(), query(), retrieve(), undelete() ## Special Access Rules Lightning Knowledge must be enabled in your org. A user must have the View Articles permission enabled. Salesforce Knowledge users, unlike customer and partner users, must also be granted the Knowledge User feature license. ## Fields | Field | Details | | --- | --- | | ArchivedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who archived the article. | | ArchivedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was archived. | | ArticleNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique number automatically assigned to the article when it's created. You can't change the format or value for this field. | | CaseAssociationCount | Type int Properties Filter, Group, Sort Description The number of cases attached to the article. | | FirstPublishedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was first published. | | LastPublishedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was last published. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | MasterLanguage | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The article's original language. Only accessible if your knowledge base supports multiple languages. | | MigratedToFromArticle | Type string Properties Filter, Group, Nillable, Sort Description The ID for the corresponding pre- or post-migration article. Contains values only in orgs that migrate from Knowledge in Salesforce Classic to Lightning Knowledge. This field is available in API version 45.0 and later. | | TotalViewCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of views for this article. This field is available in API version 39.0 and later. | <!-- document id=73cf8cdbf3df409b81d706293c86b7ac90afe9dab0844b1f8f57cbac531b747e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledge__kav.md --> # Knowledge\_\_kav Provides access to the concrete object that represents a Knowledge article version. This object is available in API version 39.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note By default, the prefix for this object name is Knowledge and that is the value shown in this reference. However, this prefix can be modified by changing the **Object Name** for the Knowledge\_\_kav object in Object Manager. This object is derived from [KnowledgeArticleVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleversion.htm "Provides a global view of standard article fields across all types of articles depending on their version. This object is available in API version 18.0 and later."). ## Supported Calls create(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert() This object doesn’t retrieve <ActionOverrides>. ## Special Access Rules Lightning Knowledge must be enabled in your org. A user must have the View Articles permission enabled. Salesforce Knowledge users, unlike customer and partner users, must also be granted the Knowledge User feature license. ## Considerations Although delete() isn't listed as a supported API call for Knowledge\_\_kav, record-triggered flows can delete Knowledge\_\_kav records. This behavior is working as designed. ## Fields | Field | Details | | --- | --- | | ArchivedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who archived the article. | | ArchivedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the article version was archived. | | ArticleArchivedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who archived the article. | | ArticleArchivedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the article was archived. | | ArticleCaseAttachCount | Type int Properties Filter, Group, Nillable, Sort Description The number of cases where this article is attached. | | ArticleCreatedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who created the article. | | ArticleCreatedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the article was created. | | ArticleMasterLanguage | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The article's original language. Only accessible if your knowledge base supports multiple languages. | | ArticleNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The unique number automatically assigned to the article when it's created. You can't change the format or value for this field. | | ArticleTotalViewCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of views for the article. | | AssignedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who assigned the article. | | AssignedToId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user assigned to the article. | | AssignmentDate | Type dateTime Properties Filter, Nillable, Sort Description The date the article was assigned to a user. | | AssignmentDueDate | Type dateTime Properties Filter, Nillable, Sort Description The due date when an article is assigned. | | AssignmentNote | Type textarea Properties Filter, Nillable, Sort Description Notes to the assignee from the user who assigned the article. | | ExternalRef | Type string Properties Filter, Group, Nillable, Sort Description The ID of the item being referenced on the external system. For example, the ID of a document on a Google Drive or a page on Confluence. | | ExternalSourceId | Type reference Properties Filter, Group, Nillable, Sort Description Reference to the external Knowledge data source object. | | ExternalUrl | Type url Properties Filter, Nillable, Sort Description The URL of the knowledge content referenced in an external system. For example, the ID of a document in Google Drive or a page in Confluence. | | FirstPublishedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was first published. | | IsExternalData | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the data is external to the customer’s knowledge base (true) or not (false). | | IsLatestVersion | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the article is the most current version. (true) or not (false). This field can be true on the online or published version, a draft version in the primary language, a draft version in a translation, and the latest archived version. However, you can’t filter by (PublishState=’Online’) and (IsLatestVersion=false) because the online version is also the latest version. This field is available in API version 24.0 and later. | | IsMasterLanguage | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the article has one or more translations associated with it (true) or not (false). | | IsOutOfDate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the source article has been updated since this translated version was created (true) or not (false). | | IsVisibleInApp | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates whether the article is visible in the Articles tab (true) or not (false). | | IsVisibleInCsp | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates whether the article is visible in the Customer Portal (true) or not (false). | | IsVisibleInPkb | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates whether the article is visible in the public knowledge base (true) or not (false). | | IsVisibleInPrm | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates whether the article is visible in the partner portal (true) or not (false). | | KnowledgeArticleId | Type reference Properties Filter, Group, Sort Description The ID of the article independent from its version. The value for this field is retrieved from the Id field of the KnowledgeArticle object. | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language that the article is written in, such as French or Chinese (Traditional). Querying or searching articles in SOSL require that you specify the Language field in the WHERE clause. The language must be the same for all article types. Before API version 47.0, you must include the Language field to filter queries on Knowledge article versions. In API version 47.0 and later, you can filter queries on Knowledge article versions with or without Language depending on what you are querying. | | LastPublishedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was last published. | | MasterVersionId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the source article, if the article is the translation of a source article. Only accessible if your knowledge base supports multiple languages. | | MigratedToFromArticleVersion | Type string Properties Filter, Group, Nillable, Sort Description The ID for the corresponding pre- or post-migration article version. Contains values only in orgs that migrate from Classic to Lightning Knowledge. Available in API version 43.0 and later. | | NextReviewDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article must next be reviewed for accuracy. Available in API version 58.0 and later. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the article's owner. | | PublishStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The publication status for the article: - Draft: any draft articles. - Online: articles published in Salesforce Knowledge. - Archived: archived articles. A user must have the “Manage Articles” permission enabled to use Online. Article queries and searches in SOQL or SOSL require that you specify either the PublishStatus or the Id field in the WHERE clause. You can search for only one publication status per article type in a single SOSL query. When searching for articles with a PublishStatus of Archived, also check that IsLatestVersion equals false in your WHERE clause. | | RecordTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the API Name that describes the type of article. Use the record type to determine the article structure and other settings for different types of content. | | SourceId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the source from which the article was created (Case or Reply). This field is only accessible from the API and isn’t visible in the Salesforce UI. | | Summary | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Summary of the article. Maximum size is 1000 characters. | | Title | Type string Properties Create, Defaulted on create, Filter, Group, idLookup, Sort, Update Description Required. Article's title. Maximum size is 255 characters. | | TranslationCompletedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the article was last translated. Only accessible if your knowledge base supports multiple languages. | | TranslationExportedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the article was last exported for translation. Only accessible if your knowledge base supports multiple languages. | | TranslationImportedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the article was last imported for translation. Only accessible if your knowledge base supports multiple languages. | | UrlName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Represents the article's URL. Can contain alphanumeric characters and hyphens but can't begin or end with a hyphen. Use a unique value regardless of context. (For example, a unique value allows you to get expected results when running an Apex test with SeeAllData set to false.) UrlName is case-sensitive and its maximum size is 255 characters. | | ValidationStatus | Type picklist Properties Defaulted on create, Filter, Group Description Shows whether the content of the article has been validated. Possible values are Validated and Not Validated. The default value is Not Validated. This field is available in API version 24.0 or later. | | VersionNumber | Type int Properties Group, Sort Description The number assigned to a version of an article. This field is available in API version 24.0 and later. | <!-- document id=72143915e635868490ae5a7835086fbc12bf16d1dfbbc1eb0bc95305ffcc6d8b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledgeableuser.md --> # KnowledgeableUser Represents a user identified as knowledgeable about a specific topic, and ranks them relative to other knowledgeable users. This object is available in API version 31.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | NetworkId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Experience Cloud site the topic exists in. This field is available only if digigal experiences is enabled for your org. | | RawRank | Type int Properties Filter, Group, Nillable, Sort Description Rank of this user’s knowledge on the topic relative to other users. | | TopicId | Type reference Properties Filter, Group, Sort Description Unique ID for the topic in Salesforce. | | UserId | Type reference Properties Filter, Group, Sort Description Unique ID for the user in Salesforce. | <!-- document id=44b9bd3c1e3fc6b45ed74a14c7781a28fb98c64ecd185654095492c3fe71f64d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledgearticle.md --> # KnowledgeArticle Provides read-only access to an article and the ability to delete the primary article. This object is available in API version 19.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. Unlike KnowledgeArticleVersion, the ID of a KnowledgeArticle record is identical irrespective of the article's version (status). [Knowledge\_\_ka](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledge__ka.htm "Provides access to the concrete object that represents a Knowledge article, the parent object for article versions. This object is available in API version 39.0 and later.") is derived from this object. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Knowledge must be enabled in your org. A user must have the View Articles permission enabled. Salesforce Knowledge users, unlike customer and partner users, must also be granted the Knowledge User feature license. ## Fields | Field Name | Details | | --- | --- | | ArchivedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who archived the article. | | ArchivedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was archived. | | ArticleNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique number automatically assigned to the article when it's created. You can't change the format or value for this field. | | CaseAssociationCount | Type int Properties Filter, Group, Sort Description The number of cases attached to the article. | | FirstPublishedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was first published. | | IsGeneratedByLlm | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if the first version of an article was created with an LLM. This object is available in API version 59.0 and later. | | LastPublishedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was last published. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, the user has not viewed this record or list view, though they might have accessed it (LastReferencedDate) | | MasterLanguage | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The article's original language. Only accessible if your knowledge base supports multiple languages. | | MigratedToFromArticle | Type string Properties Filter, Group, Nillable, Sort Description The ID for the corresponding pre- or post-migration article. Contains values only in orgs that migrate from Knowledge in Salesforce Classic to Lightning Knowledge. This field is available in API version 45.0 and later. | | TotalViewCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of views for this article. This field is available in API version 39.0 and later. | ## Usage Use this object to query or retrieve articles. KnowledgeArticle can be used in a SOQL clause, but doesn’t provide access to the fields from the article. Provides read-only access to an article and the ability to delete the primary article. ## Usage for SOQL with KnowledgeArticle To expose the migrated\_to\_from\_id column on KnowledgeArticle and KnowledgeArticleVersion to the sObject API: expose MigratedToFromArticle in KnowledgeArticle. For SOQL: - To filter by MigratedToFromArticle, remove any other filters. - When filtering by MigratedToFromArticle, use the '=' or 'IN' operator. - When filtering by MigratedToFromArticle, the value can't be null or empty. #### See Also - [KnowledgeArticleVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleversion.htm "Provides a global view of standard article fields across all types of articles depending on their version. This object is available in API version 18.0 and later.") <!-- document id=b626fe5812d27577e9f2ab20aa2216bc29b15ad9025828351ca9e813a9da9115 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledgearticleeventlog.md --> # KnowledgeArticleEventLog Knowledge Article View event logs contain user activity with your knowledge base. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ArticleIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The id of the article. For example: 00Dxx0000001gEb. | | ArticleStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the article. Possible values are: - D—Draft - O—Online - A—Archived | | ArticleVersion | Type double Properties Filter, Nillable, Sort Description The article version number. For example: 2. | | ArticleVersionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the article version. For example: ka0R00000005rt6. | | Context | Type string Properties Filter, Group, Nillable, Sort Description Context of the request. | | IsLargeLanguageModel | Type string Properties Filter, Group, Nillable, Sort Description Whether the article was written with an LLM. | | IsLastVersion | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if it is the last version of the article. The default value is false. | | Language | Type string Properties Filter, Group, Nillable, Sort Description The ISO code of the language. For example: en\_US/ | | ObjectType | Type string Properties Filter, Group, Nillable, Sort Description The object requested. For example: Knowledge\_\_kav. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | SessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Session ID of the request. For example: gV7pCSW2vGaaJNFi3GSpuPIjNbKVbSxRvx34LJsIvuc=. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description User type of the request. Possible values are: - A—App - C—Customer Portal - P—Partner Portal - G—Guest | <!-- document id=37add0aaaad8baa9594903925588e6e9c3ac207aee4d9abbba40fdf42c79937c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledgearticlefeedback.md --> # KnowledgeArticleFeedback Represents information about feedback from users on Knowledge articles and details about assignment of feedback to the article owner or team to take action. This object is available in API version 64.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), query(), retrieve(), delete(), update() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note A KnowledgeArticleFeedback record is created only when a user submits ‌feedback. ## Special Access Rules Knowledge must be enabled in your org. A user must have the View Articles permission enabled. Salesforce Knowledge users, unlike customer and partner users, must also be granted the Knowledge User feature license. Knowledge Article Feedback Org Preference should also be enabled. ## Fields | Field Name | Details | | --- | --- | | AssignedToId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The queue name or user ID of the feedback assignee, who reviews and takes action on the feedback. This field is a polymorphic relationship field. **Relationship Name** AssignedTo **Refers To** Queue, User | | FeedbackResponseId | Type reference Properties Filter, Group, Sort Description The unique ID of the feedback response associated with the feedback record. This field is a relationship field. **Relationship Name** FeedbackResponse ****Refers To**** SurveyResponse | | FeedbackSource | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The source of feedback. Possible values are: - Internal - Community | | FeedbackSubmitterId | Type reference Properties Filter, Group, Sort Description The ID of the user who submitted feedback. This field is a relationship field. Relationship Name FeedbackSubmitter Refers To User | | IsLiked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The answer to the Article Liked question in the feedback form. The default value is false | | KnowledgeArticle | Type string Properties Filter, Group, Sort Description The ID of the article associated with the feedback response. | | KnowledgeArticleUrl | Type url Properties Filter, Sort Description The URL of the article version associated with the feedback response. | | KnowledgeArticleVersion | Type string Properties Filter, Group, idLookup, Sort Description The version of the article associated with the feedback response. | | KnowledgeArticleVersionTitle | Type string Properties Filter, Group, Nillable, Sort Description The title of the article version associated with the feedback response. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the feedback record was last accessed or referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the feedback record was last viewed. | | LinkedArticleEntityId | Type reference Properties Filter, Group, Nillable, Sort Description Internal entity that links a Knowledge article version and survey invitation. This field is a relationship field. **Relationship Name** LinkedArticleEntity ****Refers To**** LinkedArticle | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique name automatically assigned to the Knowledge article feedback when it's created. You can't change the format or value of this field. | | OwnerId | Type reference Properties Filter, Group, Sort, Update Description The user ID of the article feedback owner. This field is a polymorphic relationship field. **Relationship Name** Owner **Refers To** Group, User | | ReviewActionTaken | Type picklist Properties Filter, Group, Sort, Nillable, Update Description The review action taken to address the feedback. You can configure the possible values for this picklist field. | | ReviewComment | Type textArea Properties Filter, Nillable, Sort, Update Description The review comment provided by the feedback assignee. This is optional. The maximum length is 1,212 characters. | | ReviewCompletionDate | Type dateTime Properties Filter, Nillable, Sort, Update Description The date when the review was completed. | | ReviewDueDate | Type dateTime Properties Filter, Nillable, Sort, Update Description The due date for completing the feedback review. | | ReviewStatus | Type picklist Properties Filter, Group, Sort, Nillable, Update Description The review status of the feedback. You can configure the possible values for this picklist field. | ## Usage Use this object to query, retrieve, or search for article feedback based on your access level to the articles. You can filter feedback records by Knowledge article, article version, or other criteria. ## SOQL Samples The SOQL clause queries KnowledgeArticleFeedback records which aren't reviewed. SELECT FeedbackResponseId, IsLiked, KnowledgeArticleVersion FROM KnowledgeArticleFeedback WHERE ReviewCompletionDate = NULL The SOQL clause queries KnowledgeArticleFeedback records for a specific article version. SELECT FeedbackResponseId, IsLiked, KnowledgeArticleVersion, AssignedToId, ReviewStatus FROM KnowledgeArticleFeedback WHERE KnowledgeArticleVersion = 'ka0SG00000KSjjRYAT' <!-- document id=34829cd684fbfa46e212fa8c8bdb55879a9c69398d57d012a8eecccc2d46a8e9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledgearticleversion.md --> # KnowledgeArticleVersion Provides a global view of standard article fields across all types of articles depending on their version. This object is available in API version 18.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. Use this object to: - Query or search generically across multiple types of articles. - Filter on a specific version. - Update standard fields in draft versions. When you query on the archived article, the results include both the article and the article’s archived versions. [Knowledge\_\_kav](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledge__kav.htm "Provides access to the concrete object that represents a Knowledge article version. This object is available in API version 39.0 and later.") is derived from this object. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve(), search() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - You can only update draft versions. - You can't update draft translations with the knowledgeManagement REST API. - For Lightning Knowledge, to create, update, or delete a Knowledge article version, use the call on Knowledge\_\_kav. For example, to delete, use Knowledge\_\_kav.delete(). - For Knowledge in Salesforce Classic, to create, update, or delete a Knowledge article version, use the call on ArticleType\_\_kav, where ArticleType is the name of the article’s type. For example, to delete, use ArticleType\_\_kav.delete(). ## Special Access Rules Knowledge must be enabled in your org. A user must have the View Articles permission enabled. Salesforce Knowledge users, unlike customer and partner users, must also be granted the Knowledge User feature license. ## Fields | Field Name | Details | | --- | --- | | ArchivedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who archived the article. | | ArchivedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the article version was archived. | | ArticleArchivedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who archived the article. | | ArticleArchivedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the article was archived. | | ArticleCaseAttachCount | Type int Properties Filter, Group, Nillable, Sort Description The number of cases where this article is attached. | | ArticleCreatedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who created the article. | | ArticleCreatedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the article was created. | | ArticleMasterLanguage | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The article's original language. Only accessible if your knowledge base supports multiple languages. | | ArticleNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The unique number automatically assigned to the article when it's created. You can't change the format or value for this field. | | ArticleTotalViewCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of views for the article. | | ArticleType | Type string Properties Defaulted on createFilter Description Indicates the API Name of the article type. The ArticleType is assigned to the article when it's created. You can't change the value of this field. This field is available in orgs using Knowledge in Salesforce Classic in API version 26.0 and later. | | AssignedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who assigned the article. | | AssignedToId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user assigned to the article. | | AssignmentDate | Type dateTime Properties Filter, Nillable, Sort Description The date the article was assigned to a user. | | AssignmentDueDate | Type dateTime Properties Filter, Nillable, Sort Description The due date when an article is assigned. | | AssignmentNote | Type textarea Properties Filter, Nillable, Sort Description Notes to the assignee from the user who assigned the article. | | FirstPublishedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was first published. | | IsLatestVersion | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the article is the most current version. (true) or not (false). This field can be true on the online or published version, a draft version in the primary language, a draft version in a translation, and the latest archived version. However, you can’t filter by (PublishState=’Online’) and (IsLatestVersion=false) because the online version is also the latest version. This field is available in API version 24.0 and later. | | IsMasterLanguage | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the article has one or more translations associated with it (true) or not (false). Only accessible if your knowledge base supports multiple languages. | | IsOutOfDate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the source article has been updated since this translated version was created (true) or not (false). Only accessible if your knowledge base supports multiple languages. | | IsVisibleInApp | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates whether the article is visible in the Articles tab (true) or not (false). | | IsVisibleInCsp | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates whether the article is visible in the Customer Portal (true) or not (false). | | IsVisibleInPkb | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates whether the article is visible in the public knowledge base (true) or not (false). | | IsVisibleInPrm | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates whether the article is visible in the partner portal (true) or not (false). | | KnowledgeArticleId | Type reference Properties Filter, Group, Sort Description The ID of the article independent from its version. The value for this field is retrieved from the Id field of the KnowledgeArticle object. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language that the article is written in, such as French or Chinese (Traditional). Querying or searching articles in SOSL require that you specify the Language field in the WHERE clause. The language must be the same for all article types. Before API version 47.0, you must include the Language field to filter queries on Knowledge article versions. In API version 47.0 and later, you can filter queries on Knowledge article versions with or without Language depending on what you are querying. | | LargeLanguageModel | Type string Properties Filter, Group, Nillable, Sort Description Shows the LLM used to create an article version. This object is available in API version 59.0 and later. | | LastPublishedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article was last published. | | MasterVersionId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the source article, if the article is the translation of a source article. Only accessible if your knowledge base supports multiple languages. | | MigratedToFromArticleVersion | Type string Properties Filter, Group, Nillable, Sort Description The ID for the corresponding pre- or post-migration article version. Contains values only in orgs that migrate from Classic to Lightning Knowledge. Available in API version 43.0 and later. | | NextReviewDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the article must next be reviewed for accuracy. Available in API version 58.0 and later. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the article's owner. | | PublishStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The publication status for the article: - Draft: any draft articles. - Online: articles published in Salesforce Knowledge. - Archived: archived articles. A user must have the “Manage Articles” permission enabled to use Online. Article queries and searches in SOQL or SOSL require that you specify either the PublishStatus or the Id field in the WHERE clause. You can search for only one publication status per article type in a single SOSL query. When searching for articles with a PublishStatus of Archived, also check that IsLatestVersion equals false in your WHERE clause. | | SourceId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the source from which the article was created (Case or Reply). | | Summary | Type textarea Properties Filter, Nillable, Sort Description Summary of the article. Maximum size is 1000 characters. | | Title | Type string Properties Filter, Group, idLookup, Sort Description Required. Article's title. Maximum size is 255 characters. | | TranslationCompletedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the article was last translated. Only accessible if your knowledge base supports multiple languages. | | TranslationExportedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the article was last exported for translation. Only accessible if your knowledge base supports multiple languages. | | TranslationImportedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the article was last imported for translation. Only accessible if your knowledge base supports multiple languages. | | UrlName | Type string Properties Filter, Group, idLookup, Sort Description Required. Represents the article's URL. Can contain alphanumeric characters and hyphens but can't begin or end with a hyphen. This value must be unique regardless of context. (For example, a unique value allows you to get expected results when running an Apex test with SeeAllData set to false.) UrlName is case-sensitive and its maximum size is 255 characters. | | ValidationStatus | Type picklist Properties Defaulted on create, Filter, Group Description Shows whether the content of the article has been validated. Possible values are Validated and Not Validated. The default value is Not Validated. This field is available in API version 24.0 or later. | | VersionNumber | Type int Properties Group, Sort Description The number assigned to a version of an article. This field is available in API version 24.0 and later. | ## Usage Use this object to query, retrieve, or search for articles across all types of articles depending on their version. You can update draft primary articles. Also, you can delete articles that aren’t drafts. Client applications can use KnowledgeArticleVersion with describeDataCategoryGroups() and describeDataCategoryGroupStructures() to return the category groups and the category structure associated with Salesforce Knowledge. To access an article independent of its version, use the KnowledgeArticle object. In Lightning Knowledge, the type of article is determined by the RecordType field on the concrete derived object (for example, [Knowledge\_\_kav](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledge__kav.htm "Provides access to the concrete object that represents a Knowledge article version. This object is available in API version 39.0 and later.")). For Knowledge in Salesforce Classic, the type of article is determined by the ArticleType field and the concrete derived object uses the prefix of the article type name (for example, FAQ\_\_kav for the FAQ article type). ## SOQL Samples The following SOQL clause uses KnowledgeArticleVersion to query all published articles from all articles complying with the classification specified in the WITH DATA CATEGORY clause: SELECT Title, Summary FROM KnowledgeArticleVersion WHERE PublishStatus='Online' AND Language = 'en\_US' WITH DATA CATEGORY Geography\_\_c ABOVE\_OR\_BELOW europe\_\_c AND Product\_\_c BELOW All\_\_c The following SOQL clause for Lightning Knowledge uses the Offer record type to limit the query to all draft articles: SELECT Id, Title FROM Knowledge\_\_kav WHERE PublishStatus='Draft' AND Language = 'en\_US' AND RecordTypeId = '<specify RecordTypeId for Offer here>' WITH DATA CATEGORY Geography\_\_c AT (france\_\_c,usa\_\_c) AND Product\_\_c ABOVE dsl\_\_c The following SOQL clause for Salesforce Classic uses the Offer article type to limit the query to all draft articles: SELECT Id, Title FROM Offer\_\_kav WHERE PublishStatus='Draft' AND Language = 'en\_US' WITH DATA CATEGORY Geography\_\_c AT (france\_\_c,usa\_\_c) AND Product\_\_c ABOVE dsl\_\_c The following SOQL clause uses KnowledgeArticleVersion to query the IDs of all archived versions of a particular article: SELECT Id FROM KnowledgeArticleVersion WHERE PublishStatus='Archived' AND IsLatestVersion=false AND KnowledgeArticleId='kA1D00000001PQ6KAM' ## SOQL and SOSL with KnowledgeArticleVersion - Filter on a single value of PublishStatus for best results. To find all versions of each article, omit the PublishStatus filter, but do filter on one or more master key IDs. To retrieve all archived versions for a given article, specify a SOQL filter where IsLatestVersion is false. - In API version 46.0 and earlier, queries without a filter on PublishStatus return published articles by default. In API version 47.0 and later, draft, published, and archived articles are returned when Lightning Knowledge is enabled. - To support security, only users with the “View Draft Articles” permission see articles whose PublishStatus value is Draft. Similarly, only users with the “View Archived Articles” permission see articles whose PublishStatus value is Archived - Archived article versions are stored in the Knowledge\_\_kav object. To query archived article versions, specify the article Id and set IsLatestVersion='0'. - You can’t use binding variables in Apex SOQL statements with KnowledgeArticleVersion objects. For example, the following SOQL statement causes a compilation error. final String PUBLISH\_STATUS\_ONLINE = 'Online'; List<Knowledge\_\_kav> articles = \[ SELECT Id FROM Knowledge\_\_kav WHERE PublishStatus = :PUBLISH\_STATUS\_ONLINE \]; Instead, use dynamic SOQL as follows. See [Dynamic SOQL](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_dynamic_soql.htm "HTML (New Window)") in Apex Developer Guide. final String PUBLISH\_STATUS\_ONLINE = 'Online'; final String q = 'SELECT Id, PublishStatus FROM Knowledge\_\_kav WHERE PublishStatus = :PUBLISH\_STATUS\_ONLINE'; List<Knowledge\_\_kav> articles = Database.query(q); ## Other Usage for SOQL and SOSL with KnowledgeArticleVersion To expose the _migrated\_to\_from\_id_ on **KnowledgeArticle** and **KnowledgeArticleVersion** to the sObject API: expose **MigratedToFromArticleVersion** in **KnowledgeArticleVersion**. - For SOQL: - To filter by **MigratedToFromArticleVersion**, remove any other filters. - When filtering by **MigratedToFromArticleVersion**, use the '=' or 'IN' operator. - When filtering by **MigratedToFromArticleVersion**, the value can't be null or empty. - SOSL doesn’t support **MigratedToFromArticleVersion**. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [KnowledgeArticleVersionHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleversionhistory.htm "Enables read-only access to the full history of an article. This object is available in API version 25.0 and later.") History is available for tracked fields of the object. #### See Also - [KnowledgeArticle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticle.htm "Provides read-only access to an article and the ability to delete the primary article. This object is available in API version 19.0 and later.") - [KnowledgeArticleViewStat](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleviewstat.htm#sforce_api_objects_knowledgearticleviewstat "Provides certain statistics related to the number of views for the specified article across all article types. The view count statistics are for published and archived articles only. View counts for draft articles aren’t tracked. This object is read-only and available in API version 20.0 and later.") - [KnowledgeArticleVoteStat](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticlevotestat.htm#sforce_api_objects_knowledgearticlevotestat "Provides the weighted rating for the specified article on a scale of 1 to 5 across all article types. This object is read-only and available in API version 20.0 and later.") <!-- document id=6c5e78d55c716d12d028ffbe12bf97a0153c2dcd51916fd7701bccbde6293522 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledgearticleversionhistory.md --> # KnowledgeArticleVersionHistory Enables read-only access to the full history of an article. This object is available in API version 25.0 and later. Knowledge\_\_VersionHistory is derived from this object. To access this derived object, [turn on field history tracking](https://help.salesforce.com/articleView?id=tracking_field_history_for_custom_objects.htm&type=5&language=en_US) for Knowledge objects. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules Knowledge must be enabled in your org. This object respects field, entity, and record-level security. You must have at least “Read” permission on the article type or the field to access its history. For data category security, Salesforce determines access based on the categorization of the online version of an article. If there’s no online version, then security is applied based on the archived version, followed by the security of the draft version. ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data that is tracked in the history table. This field is available in API version 50.0 and later. | | EventType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of event that is tracked in the history table. | | FieldName | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Name of the tracked field. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language that the article is written in, such as French or Chinese (Traditional). Querying or searching articles in SOSL requires that you specify the Language field in the WHERE clause. The language must be the same for all article types. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The most recent value of the field before it was changed. | | ParentId | Type reference Properties Filter, Group, Sort Description The ID of the article. | | ParentSobjectType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of object that contains the field. | | VersionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID assigned to a version of the article. This is a polymorphic relationship field. | | VersionNumber | Type int Properties Filter, Group, Sort Description The number assigned to a version of an article. This field is available in API version 24.0 and later. | ## Usage Use this object to query events in the history of an article. For example, you can retrieve the number of edits a particular user has made to an article, how many times the article has been published, and so on. <!-- document id=fd36cd5249ec259ecfd4d1a738096698856871c47bb4352ccc998ec82d7383bb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledgearticleviewstat.md --> # KnowledgeArticleViewStat Provides certain statistics related to the number of views for the specified article across all article types. The view count statistics are for published and archived articles only. View counts for draft articles aren’t tracked. This object is read-only and available in API version 20.0 and later. Knowledge\_\_ViewStat is derived from this object. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Knowledge must be enabled in your org. Users must have access to the published and archived versions of an article to retrieve its views. For more information on published and archived article versions, see the PublishStatus field in KnowledgeArticleVersion. ## Fields | Field Name | Details | | --- | --- | | Channel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The channel where the article is viewed: - AllChannels for article views across all channels. - App for the internal Salesforce Knowledge application. - Pkb for article views in the public knowledge base. - Csp for Customer Portal. - Prm for article view in partner portal. | | NormalizedScore | Type double Properties Filter, Nillable, Sort Description Article's weighted views in the selected channel. The article with most views has a score of 100. Other article views are then calculated relative to this highest view score. For example, if the best read article has 2000 views and another has 1000. The first one gets a score of 100 while the second gets 50. | | ParentId | Type reference Properties Filter, Group, Sort Description ID of the viewed article. This corresponds to a KnowledgeArticle record. | | ViewCount | Type int Properties Filter, Group, Sort Description The number of unique views a published or archived article has received in the selected channel. An article with a high number of views may not always have a high normalized score. The normalized score for an article is calculated based on views over time, with more recent views earning a higher score. This field is available in API version 27.0 and later. | ## Usage Use this object to query or retrieve certain statistics for article views. Alternatively, client applications can use the article type API Name followed by \_\_ViewStat to query or retrieve most viewed articles from a specific article type. ## SOQL Samples The following SOQL clause uses KnowledgeArticleViewStat to query all the article views in Salesforce Knowledge and return the related articles: SELECT Id, NormalizedScore, Parent.Id FROM KnowledgeArticleViewStat where Channel = 'App' ORDER BY NormalizedScore Use the following clause to restrict your query to Offer articles for the Offer article type: SELECT Id, NormalizedScore, Parent.Id FROM Offer\_\_ViewStat where Channel = 'App' ORDER BY NormalizedScore #### See Also - [KnowledgeArticle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticle.htm "Provides read-only access to an article and the ability to delete the primary article. This object is available in API version 19.0 and later.") - [KnowledgeArticleVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleversion.htm "Provides a global view of standard article fields across all types of articles depending on their version. This object is available in API version 18.0 and later.") - [KnowledgeArticleVoteStat](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticlevotestat.htm "Provides the weighted rating for the specified article on a scale of 1 to 5 across all article types. This object is read-only and available in API version 20.0 and later.") <!-- document id=145553fe073911235e8ad2ca789dcc0826e91c7746fcb746d32654e32531c947 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knowledgearticlevotestat.md --> # KnowledgeArticleVoteStat Provides the weighted rating for the specified article on a scale of 1 to 5 across all article types. This object is read-only and available in API version 20.0 and later. Knowledge\_\_VoteStat is derived from this object. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Knowledge must be enabled in your org. Users must have access to the published version of an article to retrieve its votes. For more information on published article version, see the PublishStatus field in KnowledgeArticleVersion ## Fields | Field Name | Details | | --- | --- | | Channel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The channel where the article is rated: - AllChannels for article views across all channels. - App for the internal Salesforce Knowledge application. - Pkb for article views in public knowledge base. - Csp for Customer Portal. - Prm for article view in partner portal. | | NormalizedScore | Type double Properties Filter, Nillable, Sort Description Article's weighted score on a scale of 1 to 5. A higher score means more votes. Articles without recent votes trend towards an average rating of three stars. | | ParentId | Type reference Properties Filter, Group, Sort Description The rated article. This corresponds to a KnowledgeArticle record. | ## Usage Use this object to query or retrieve the rating for an article. Alternatively, client applications can use the article type API Name followed by \_\_VoteStat to query or retrieve the rating for an article for a specific article type. ## SOQL Samples See KnowledgeArticleViewStat. #### See Also - [KnowledgeArticle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticle.htm "Provides read-only access to an article and the ability to delete the primary article. This object is available in API version 19.0 and later.") - [KnowledgeArticleVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleversion.htm "Provides a global view of standard article fields across all types of articles depending on their version. This object is available in API version 18.0 and later.") - [KnowledgeArticleViewStat](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleviewstat.htm "Provides certain statistics related to the number of views for the specified article across all article types. The view count statistics are for published and archived articles only. View counts for draft articles aren’t tracked. This object is read-only and available in API version 20.0 and later.") <!-- document id=889163374ec3c4a0497f6002bd237df4b967dd4e2d36f67a77d0270c993f27ff url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_knwlgblockarticlereffield.md --> # KnwlgeBlockArticleRefField Represents the association between a specific knowledge block version and its corresponding article version. This object is available in API version 68.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | CreatedById | Type reference Properties Filter, Group, Sort Description The ID of the user who created the Knowledge Block Article Reference Field record. Relationship Name CreatedBy Relationship Type Lookup Refers To User | | CreatedDate | Type datetime Properties Filter, Sort Description The date and time when the Knowledge Block Article Reference Field record was created. | | Id | Type id Properties Filter, Group, Sort Description The unique identifier for the Knowledge Block Article Reference Field record. | | IsDeleted | Type boolean Properties Filter, Group, Sort Description Indicates whether the Knowledge Block Article Reference Field record is deleted (true) or not (false). | | KnowledgeArticleVersionId | Type reference Properties Filter, Group, Sort Description The ID of the Knowledge Article Version that references the Knowledge Block. Relationship Name KnowledgeArticleVersion Relationship Type Lookup Refers To Knowledge\_\_kav | | KnowledgeBlockId | Type reference Properties Filter, Group, Sort Description The ID of the Knowledge Block referenced in the Knowledge Article Version. Relationship Name KnowledgeBlock Relationship Type Lookup Refers To KnowledgeBlock | | KnowledgeBlockVersionId | Type reference Properties Filter, Group, Sort Description The ID of the Knowledge Block Version that corresponds to the article reference. Relationship Name KnowledgeBlockVersion Relationship Type Lookup Refers To KnowledgeBlockVersion | | LastModifiedById | Type reference Properties Filter, Group, Sort Description The ID of the user who last modified this Knowledge Block Article Reference Field record. Relationship Name LastModifiedBy Relationship Type Lookup Refers To User | | LastModifiedDate | Type datetime Properties Filter, Sort Description The date and time when a user last modified the Knowledge Block Article Reference Field record. | | Name | Type string Properties Filter, Sort Description The name of the Knowledge Block Article Reference Field record. | | ReferencingFieldId | Type reference Properties Filter, Group, Sort Description The ID of the Rich Text field in the Knowledge Article where the Knowledge Block is added. | | ReferenceCount | Type int Properties Filter, Group, Sort Description The number of times the Knowledge Block is referenced within a Rich Text field of a Knowledge Article Version. | | SystemModstamp | Type datetime Properties Filter, Sort Description The date and time when a user or an automated process last modified the Knowledge Block Article Reference Field record. | ## Usage Use this object to query Knowledge Block Article Reference Fields in your org. Client applications can query records associated with Knowledge Block Article Reference Field via the API. <!-- document id=b7f8e70613511543bcb6eb64b1f7c8932e812ac8c182020dbfe7bc4b55af21d4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_landingpage.md --> # LandingPage Represents an Account Engagement landing page. A landing page is a web page that a visitor reaches after clicking a link or advertisement. Landing pages can be created in Account Engagement and synced to Salesforce or created on the Landing Page object in Account Engagement Lightning App. This object is available in API version 42.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To access this object, your org must use Account Engagement and users need the CRM User or Sales User permission set. To create, update, or delete a builder landing page, the Use Account Engagement Content Experience permission set is required. ## Fields | Field Name | Details | | --- | --- | | CampaignId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related campaign. | | ContentLastSaved | Type dateTime Properties Filter, Nillable, Sort Description The date and time of the last time someone changed and saved the landing page Name, Campaign, Content, IsHideFromSearchEngineIndex, or Vanity URL fields. This field is available in API version 53.0 and later. | | ContentLastSavedById | Type reference Properties Filter, Group, Nillable, Sort Description The user who last changed and saved the Content body. This is a relationship field. This field is available in API version 53.0 and later. Relationship Name ContentLastSaved Relationship Type Lookup Refers To User | | FallbackUrl | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The URL used to redirect viewers after the landing page is unpublished. This field is available in API version 54.0 and later. | | FooterCode | Type textarea Properties Create, Nillable, Update Description <Script\>, <style\>, and <link\> code added before the landing page’s closing body tag. This field is available in API version 54.0 and later. | | FormErrorRate | Type percent Properties Filter, Group, Sort Description The percentage of errors made on the landing page form. Calculated as total errors divided by total views. | | FormSubmissionRate | Type percent Properties Filter, Nillable, Sort Description The percentage of form submissions based on the total number of landing page views. | | HeaderCode | Type textarea Properties Create, Nillable, Update Description <Script\>, <style\>, and <link\> code added to the head tag of the landing page. This field is available in API version 54.0 and later. | | IsHideFromSearchEngineIndex | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the landing page is hidden from search engine indexing. The default value is false. This field is available in API version 53.0 and later. | | LastPublished | Type dateTime Properties Filter, Nillable, Sort Description The date and time of the last time someone published the landing page. This field is available in API version 53.0 and later. | | LastPublishedById | Type reference Properties Filter, Group, Nillable, Sort Description The user who last published the landing page. This is a relationship field. This field is available in API version 53.0 and later. Relationship Name LastPublished Relationship Type Lookup Refers To User | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the current user last viewed this record. If this value is null, this record might only have been referenced (see LastReferencedDate) and not viewed. This field is available in API version 53.0 and later. | | Name | Type string Properties Filter, Group, Sort Description The name of the landing page. | | PublicLink | Type string Properties Filter, Group, Nillable, Sort Description The URL where the landing page is available. This field is available in API version 53.0 and later. | | Source | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates where the landing page was created. The default value is Salesforce. This field is available in API version 53.0 and later. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the state of the landing page: Draft, Published, or Published (Changes Pending). The default value is Draft. This field is available in API version 53.0 and later. | | TotalFormErrors | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of times a visitor or prospect enters an invalid email address or leaves a required field blank on a landing page form. | | TotalFormSubmissions | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of times a form on the landing page has been submitted. | | TotalTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of times prospects clicked a link on the landing page’s thank you page. | | TotalViews | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of times visitors and prospects viewed your landing page. This total includes multiple views from the same person. | | UniqueFormErrors | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of individual visitors and prospects who made an error on the form. This metric doesn’t include multiple errors from the same person. | | UniqueFormSubmissions | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of individual visitors who submitted a form on the landing page. This metric doesn’t include multiple submissions from the same person. | | UniqueTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of times a prospect clicked a link on the landing page’s thank you page. This metric doesn’t include multiple clicks of the same link. | | UniqueViews | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of individual visitors and prospects who viewed your landing page. This metric doesn’t include multiple views from the same person. | | VanityUrl | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The custom path that’s appended to tracker domains to create a vanity URL. This field doesn’t support scheme or domain values. This field is available in API version 53.0 and later. | ## Associated Objects This object has the following associated objects. Unless otherwise noted, they’re available in the same API version as this object. [LandingPageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [LandingPageFeed](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. <!-- document id=f611512819007707a8e0347151c3d9ce696a4a2f453d62dc9919674bc8332b49 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lead.md --> # Lead Represents a prospect or lead. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), merge(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActionCadenceAssigneeId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the sales rep designated to work the lead through their assigned cadence. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. | | ActionCadenceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the lead’s assigned cadence. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. | | ActionCadenceState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The state of the current action cadence tracker. This field is available in API version 50.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. Possible values are: - Complete - Error - Initializing - Paused - Processing - Running | | ActiveTrackerCount | Type int Properties Filter, Group, Nillable, Sort Description The number of cadences that are actively running on this lead. This field is available in API version 57.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. | | ActivityMetricId | Type reference Properties Filter, Group, Nillable, Sort Description When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric. This field is a relationship field. This field is available in API version 41.0 and later. Relationship Name ActivityMetric Refers To ActivityMetric | | ActivityMetricRollupId | Type reference Properties Filter, Group, Nillable, Sort Description When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup. This field is a relationship field. This field is available in API version 41.0 and later. Relationship Name ActivityMetricRollup Refers To ActivityMetricRollup | | Address | Type address Properties Filter, Nillable Description The compound form of the address. Read-only. For details on compound address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | AnnualRevenue | Type currency Properties Create, Filter, Nillable, Sort, Update Description Annual revenue for the lead’s company. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the lead’s address. | | CleanStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the record's clean status compared with Data.com. . Several values for CleanStatus appear with different labels on the lead record. Values include: - Acknowledged - Reviewed - Different - Inactive - Matched - In Sync - NotFound - Not Found - Pending - Not Compared - SelectMatch - Select Match Skipped | | Company | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The lead’s company. If person account record types have been enabled, and if the value of Company is null, the lead converts to a person account. | | CompanyDunsNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Data Universal Numbering System (D-U-N-S) number, which is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. Industries and companies use D-U-N-S numbers as a global standard for business identification and tracking. Maximum size is 9 characters. This field is only available to organizations that use Data.com Prospector or Data.com Clean. | | ConvertedAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Object reference ID that points to the account into which the lead converted. This is a relationship field. Relationship Name ConvertedAccount Relationship Type Lookup Refers To Account | | ConvertedContactId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Object reference ID that points to the contact into which the lead converted. This is a relationship field. Relationship Name ConvertedContact Relationship Type Lookup Refers To Contact | | ConvertedDate | Type date Properties Create, Filter, Group, Nillable, Sort Description Date on which this lead was converted. | | ConvertedOpportunityId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Object reference ID that points to the opportunity into which the lead has been converted. This is a relationship field. Relationship Name ConvertedOpportunity Relationship Type Lookup Refers To Opportunity | | ConnectionReceivedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your org. This field is available when Salesforce to Salesforce is enabled. | | ConnectionSentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that this record is shared with. This field is available Salesforce to Salesforce is enabled. In API version 16.0 and later, this value is null. Use PartnerNetworkRecordConnection object to forward records to connections. | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The lead’s country. | | CountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the lead’s address. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | DandBCompanyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference ID to a Dun & Bradstreet® company record, associated with an account added from Data.com. Relationship Name DandbCompany Refers To DandbCompany | | Description | Type textarea Properties Create, Nillable, Update Description The lead’s description. | | Division | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as North America, Healthcare, or Consulting. Available only when the Division permission is enabled. | | Email | Type email Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The lead’s email address. | | EmailBouncedDate | Type dateTime Properties Filter, Nillable, Sort, Update Description If bounce management is activated and an email sent to the lead bounced, the date and time of the bounce. Email bounce functionality isn't triggered by record updates, including updates to this field. | | EmailBouncedReason | Type string Properties Filter, Group, Nillable, Sort, Update Description If bounce management is activated and an email sent to the lead bounced, the reason for the bounce. Email bounce functionality isn't triggered by record updates, including updates to this field. | | ExportStatus | Type picklist Properties Filter, Restricted picklist, Sort Description Derived field for the record map for Partner Connect. The export status of this opportunity to the partner’s connected org. To see this field, enable Partner Connect and add the Export Vendor Records to an Authorized Partner Org user permission to the cosell export user. See [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. Available in API version 62.0 and later. | | Fax | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The lead’s fax number. | | FirstCallDateTime | Type datetime Properties Filter, Nillable, Sort Description The date and time of the first call placed to the lead. This field is available in API version 48.0 when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. | | FirstEmailDateTime | Type datetime Properties Filter, Nillable, Sort Description The date and time of the first email sent to the lead. This field is available in API version 48.0 when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. | | FirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The lead’s first name up to 40 characters. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | GenderIdentity | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The lead’s internal experience of their gender, which may or may not correspond to their designated sex at birth. | | HasOptedOutOfEmail | Type boolean Properties Create, Defaulted on create, Filter, Update Description Indicates whether the lead doesn’t want to receive email from Salesforce (true) or does (false). Label is **Email Opt Out**. | | HasOptedOutOfFax | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the lead doesn’t want to receive faxes from Salesforce (true) or does (false). Label is **FaxOpt Out**. | | IndividualId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the data privacy record associated with this lead. This field is available if you enabled Data Protection and Privacy in Setup. Relationship Name Individual Relationship Type Lookup Refers To Individual | | Industry | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Industry in which the lead works. | | IsConverted | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the lead has been converted (true) or not (false). Label is **Converted**. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsPriorityRecord | Type boolean Properties Defaulted on create, Group Description Shows whether the user has marked the lead as important (True) or not (False). The default value is false. Available in API version 59.0 and later. | | IsUnreadByOwner | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, lead has been assigned, but not yet viewed. See Unread Leads for more information. Label is **Unread By Owner**. | | Jigsaw | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description References the ID of a contact in Data.com. If a lead has a value in this field, it means that a contact was imported as a lead from Data.com. If the contact (converted to a lead) wasn’t imported from Data.com, the field value is null. Maximum size is 20 characters. Available in API version 22.0 and later. Label is **Data.com Key**. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Don’t modify the value in the Jigsaw field. | | JigsawContactId | Type string Properties Filter, Group, Nillable, Sort Description The ID of the contact in reference to Jigsaw. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Don’t modify the value in the Jigsaw field. | | LastActivityDate | Type date Properties Filter, Group, Nillable, Sort Description Value is the most recent of either: - Due date of the most recent event logged against the record. - Due date of the most recently closed task associated with the record. | | LastName | Type string Properties Create, Filter, Group, Sort, Update Description Required. Last name of the lead up to 80 characters. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The 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. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") | | LeadSource | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The origin or source of the lead. | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | MasterRecordId | Type reference Properties Filter, Group, Nillable, Sort Description If this record was deleted as the result of a merge, this field contains the ID of the record that was kept. If this record was deleted for any other reason, or hasn’t been deleted, the value is null. When using Apex triggers to determine which record was deleted in a merge event, this field’s value is the ID of the record that remains in Trigger.old. In Trigger.new, the value is null. This is a relationship field. Relationship Name MasterRecord Relationship Type Lookup Refers To Lead | | MiddleName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The lead’s middle name. Maximum size is 40 characters. | | MobilePhone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The lead’s mobile phone number. | | Name | Type string Properties Filter, Group, Sort Description Concatenation of FirstName, MiddleName, LastName, and Suffix up to 203 characters, including whitespaces. | | NumberOfEmployees | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of employees at the lead’s company. Label is **Employees**. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the lead’s owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PartnerAccountId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the partner account for the partner user that owns this lead. Available if Partner Relationship Management is enabled or if digital experiences is enabled and you have partner portal licenses. In API version 16.0 and later, the Partner Account field is set to the appropriate account for the partner user that owns the lead. If the owner of the lead isn’t a partner user, this field has no value. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The lead’s phone number. | | PhotoUrl | Type url Properties Filter, Group, Nillable, Sort Description Path to be combined with the URL of a Salesforce instance (_Example:_ https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the lead. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the lead. | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal code for the address of the lead. Label is **Zip/Postal Code**. | | Pronouns | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The lead’s personal pronouns, reflecting their gender identity. Others can use these pronouns to refer to the lead in the third person. The entry is selected from a picklist of available values, which the administrator sets. Maximum 40 characters. Possible values are: - He/Him - He/They - Not Listed - She/Her - She/They - They/Them | | Rating | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Rating of the lead. | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to this object. | | Salutation | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Salutation for the lead. | | ScheduledResumeDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the action cadence tracker is going to resume after it’s paused or on a wait step. This field is available in API version 54.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set. | | ScoreIntelligenceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the intelligent field record that contains lead score. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the address of the lead. | | StateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the lead’s address. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Status code for this converted lead. Status codes are defined in Status and represented in the API by the LeadStatus object. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street number and name for the address of the lead. | | Suffix | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The lead’s name suffix. Maximum size is 40 characters. | | Title | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Title for the lead, such as CFO or CEO. The maximum size is 128 characters. When converting a lead to a person account, the conversion fails if the lead Title field contains more than 80 characters. | | Website | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Website for the lead. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When importing lead data, users need the Set Audit Fields upon Record Creation permission to assign values to audit fields such as CreatedDate. Audit fields are automatically updated during API operations unless you set these fields yourself. ## Converted Leads Leads have a special state to indicate that they’ve been converted into an account, a contact, and an opportunity. Your client application can convert leads via the convertLead() call. Users can also convert leads in Salesforce. After a lead has been converted, it’s read only. However, you can query converted lead records. Only users with the View and Edit Converted Leads permission can update converted lead records. Leads have several fields that indicate their converted status. These special fields are set when converting the lead in the user interface. - ConvertedAccountId - ConvertedContactId - ConvertedDate - ConvertedOpportunityId - IsConverted - Status ## Unread Leads Leads have a special state to indicate that they haven’t been viewed or edited by the lead owner. In Salesforce, it’s helpful for users to know which leads have been assigned to them but that they haven’t touched yet. IsUnreadByOwner is true if the lead owner hasn’t yet viewed or edited the lead, and false if the lead owner has viewed or edited the lead at least one time. ## Lead Status Picklist Each Status value corresponds to either a converted or unconverted status in the lead status picklist, as defined in the user interface. To obtain the lead status values in the picklist, a client application can query LeadStatus. You can't convert a lead via the API by changing Status to one of the converted lead status values. When you convert qualified leads into an account, contact, and opportunity, you can select one of the converted status types for the lead. Leads with a converted status type are no longer available in the Leads tab, although you can include them in reports. ## Usage If lead data is imported and you need to set the value for an audit field, such as CreatedDate, contact Salesforce Support. Audit fields are automatically updated during API operations unless you request to set these fields yourself. To update a lead or to convert one with convertLead(), log in to your client application with the Edit permission on leads. When you create, update, or upsert a lead, your client application can have the lead assigned to multiple user records based on assignment rules that have been configured in Salesforce. To use this feature, your client application needs to set either of these options (but not both) in the AssignmentRuleHeader used in create or update: <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d1100926e3840">Field</th> <th class="featureTableHeader " id="d1100926e3843">Field Type</th> <th class="featureTableHeader " id="d1100926e3846">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d1100926e3840" data-title="Field"><span class="keyword parmname">assignmentRuleId</span></td> <td class="entry" headers="d1100926e3843" data-title="Field Type">reference </td> <td class="entry" headers="d1100926e3846" data-title="Details">ID of the assignment rule to use. Can be an inactive assignment rule. If unspecified and <span class="keyword parmname">useDefaultRule</span> is <samp class="codeph nolang">true</samp>, then the default assignment rule is used. <p class="p">To find the ID for a given assignment rule, query the AssignmentRule object (specifying <samp class="codeph nolang">RuleType="leadAssignment"</samp>), iterate through the returned AssignmentRule records, find the one you want to use, retrieve its ID, and then specify its ID in this field in the AssignmentRuleHeader.</p> </td> </tr> <tr> <td class="entry" headers="d1100926e3840" data-title="Field"> <span class="keyword parmname" id="i1453138"><a name="i1453138"><!-- --></a>useDefaultRule</span> </td> <td class="entry" headers="d1100926e3843" data-title="Field Type">boolean </td> <td class="entry" headers="d1100926e3846" data-title="Details">Specifies whether to use the default rule for rule-based assignment (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Default rules are assigned in the user interface.</td> </tr> </tbody> </table> ## Java Sample The following Java sample shows how to automatically assign a newly created lead. package wsc; import com.sforce.soap.enterprise.Connector; import com.sforce.soap.enterprise.EnterpriseConnection; import com.sforce.ws.ConnectionException; import com.sforce.ws.ConnectorConfig; import com.sforce.soap.enterprise.sobject.Lead; import com.sforce.soap.enterprise.QueryResult; import com.sforce.soap.enterprise.SaveResult; import com.sforce.soap.enterprise.sobject.SObject; public class LeadAssignment { static final String USERNAME = "REPLACE USER NAME"; static final String PASSWORD = "REPLACE PASSWORD"; static EnterpriseConnection connection; static LeadAssignment \_leadAssignment; // Main public static void main(String\[\] args) { // Establish connection and login ConnectorConfig config = new ConnectorConfig(); config.setUsername(USERNAME); config.setPassword(PASSWORD); try { connection = Connector.newConnection(config); System.out.println("Logged in, endpoint: " + config.getAuthEndpoint()); } catch (ConnectionException e1) { e1.printStackTrace(); } // Create lead \_leadAssignment = new LeadAssignment(); try { \_leadAssignment.CreateLead(); } catch (Exception e) { e.printStackTrace(); } // Logout try { connection.logout(); System.out.println("Logged out"); } catch (ConnectionException ce) { ce.printStackTrace(); } } public void CreateLead() throws ConnectionException { // Create a new Lead and assign various properties Lead lead = new Lead(); lead.setFirstName("Joe"); lead.setLastName("Smith"); lead.setCompany("ABC Corporation"); lead.setLeadSource("API"); // The lead assignment rule will assign any new leads that // have "API" as the LeadSource to a particular user // In this sample we will look for a particular rule and if found // use the id for the lead assignment. If it is not found we will // instruct the call to use the current default rule. You can't use // both of these values together. QueryResult qr = connection.query("SELECT Id FROM AssignmentRule WHERE Name = " + "'Mass Mail Campaign' AND SobjectType = 'Lead'"); if (qr.getSize() == 0) { connection.setAssignmentRuleHeader(null, true); } else { connection.setAssignmentRuleHeader(qr.getRecords()\[0\].getId(), false); } // Every operation that results in a new or updated lead will // use the specified rule until the header is removed from the // connection. SaveResult\[\] sr = connection.create(new SObject\[\] {lead}); for (int i=0;i<sr.length;i++) { if (sr\[i\].isSuccess()) { System.out.println("Successfully created lead with id of: " + sr\[i\].getId() + "."); } else { System.out.println("Error creating lead: " + sr\[i\].getErrors()\[0\].getMessage()); } } // This call effectively removes the header, the next lead will // be assigned to the default lead owner. connection.clearAssignmentRuleHeader(); } } ## C# Sample The following C# sample shows how to automatically assign a newly created lead. using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using System.ServiceModel; using LeadSample.sforce; namespace LeadSample { class LeadAssignment { private static SoapClient client; private static SoapClient apiClient; private static SessionHeader header; private static LoginResult loginResult; private static readonly string Username = "REPLACE USERNAME"; private static readonly string Password = "REPLACE PASSWORD AND SECURITY TOKEN"; // Create the proxy binding and login private LeadAssignment() { client = new SoapClient(); try { loginResult = client.login(null, Username, Password); } catch (Exception e) { Console.WriteLine("Unexpected login error: " + e.Message); Console.WriteLine(e.StackTrace); return; } // Access API endpoint and create new client header = new SessionHeader(); header.sessionId = loginResult.sessionId; apiClient = new SoapClient("Soap", loginResult.serverUrl); } \[STAThread\] static void Main(string\[\] args) { LeadAssignment leadAssignment = new LeadAssignment(); try { leadAssignment.CreateLead(); } catch (Exception e) { Console.WriteLine(e.Message); Console.WriteLine(e.StackTrace); Console.WriteLine(e.InnerException); } // logout client.logout(header); } public void CreateLead() { // Create a new Lead and assign various properties Lead lead = new Lead(); lead.FirstName = "John"; lead.LastName = "Brown"; lead.Company = "ABC Corporation"; lead.LeadSource = "Advertisement"; // Setting the lead source for a pre-existing lead assignment rule. This // rule was created outside of this sample and will assign any new leads // that have "Advertisement" as the LeadSource to a particular user. // Create the assignment rule header and add it to the proxy binding AssignmentRuleHeader arh = new AssignmentRuleHeader(); // In this sample we will look for a particular rule and if found // use the id for the lead assignment. If it is not found we will // instruct the call to use the current default rule. Both these // values can't be used together. QueryResult qr = null; string query = "SELECT Id FROM AssignmentRule WHERE Name = " + "'Mass Mail Campaign' AND SobjectType = 'Lead'"; try { LimitInfo\[\] limitArray = apiClient.query( header, // sessionheader null, // queryoptions null, // mruheader null, // packageversionheader query, // SOQL query out qr); } catch (Exception e) { Console.WriteLine("Unexpected query error: " + e.Message); Console.WriteLine(e.StackTrace); } if (qr.size == 0) { arh.useDefaultRule = true; } else { arh.assignmentRuleId = qr.records\[0\].Id; } // Create the lead using our Assignment Rule header LimitInfo\[\] li; SaveResult\[\] sr; apiClient.create( header, // sessionheader arh, // assignmentruleheader null, // mruheader null, // allowfieldtrunctionheader null, // disablefeedtrackingheader null, // streamingenabledheader null, // allornoneheader null, // duplicateruleheader null, // localeoptions null, // debuggingheader null, // packageversionheader null, // emailheader new sObject\[\] { lead }, out li, out sr); foreach (SaveResult s in sr) { if (s.success) { Console.WriteLine("Successfully created Lead with ID: {0}", s.id); } else { Console.WriteLine("Error creating Lead: {0}", s.errors\[0\].message); } } } } } ## Associated Objects This object has these 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. [LeadChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 44.0) Change events are available for the object. [LeadFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) (API version 18.0) Feed tracking is available for the object. [LeadHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [LeadOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadownersharingrule.htm "Represents the rules for sharing a lead with users other than the owner.") Sharing rules are available for the object. [LeadShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadshare.htm "Represents a sharing entry on a Lead.") Sharing is available for the object. #### See Also - [LeadOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadownersharingrule.htm "Represents the rules for sharing a lead with users other than the owner.") - [LeadShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadshare.htm "Represents a sharing entry on a Lead.") - [LeadStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadstatus.htm "Represents the status of a Lead record, such as Open, Qualified, or Converted.") - [PartnerNetworkConnection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnernetworkconnection.htm "Represents a Salesforce to Salesforce connection between Salesforce organizations.") <!-- document id=855e5ece7ff002752c3565833a9202a72820500877afbb33282ce3cc216c85c3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_leadcleaninfo.md --> # LeadCleanInfo Stores the metadata Data.com Clean uses to determine a lead record’s clean status. Helps you automate the cleaning or related processing of lead records. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When your Data.com Prospector or Data.com Clean contract expires, Data.com features, objects, and fields will be removed from your org. To support customers’ needs around compliance and to remain a leader in trust and privacy, Salesforce removed all contact data from the Data.com service on February 1, 2021. For more information, see [Data.com Prospector and Clean Retirement](https://help.salesforce.com/articleView?id=000270376&language=en_US&type=1 "HTML (New Window)"). Lead Clean Info provides a snapshot of the data in your Salesforce lead record and its matched Data.com record at the time the Salesforce record was cleaned. Lead Clean Info includes a number of bit vector fields, whose component fields each correspond to individual object fields and provide related data or status information about those fields. For example, the bit vector field IsDifferent has an IsDifferentTitle field. If the IsDifferentTitle field’s value is False, that means the Title field value is _the same_ on the Salesforce lead record and its matched Data.com record. LeadCleanInfo bit vector fields include: - CleanedBy indicates who (a user) or what (a Clean job) cleaned the lead record. - IsDifferent indicates whether or not a field on the lead record has a value that differs from the corresponding field on the matched Data.com record. - IsFlaggedWrong indicates whether or not a field on the lead record has a value that is flagged as wrong to Data.com. - IsReviewed indicates whether or not a field on the lead record is in a Reviewed state, which means that the value was reviewed but not accepted.. Their individual bits are defined here ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Fields | Field Name | Details | | --- | --- | | Address | Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | AnnualRevenue | Type currency Properties Filter, Nillable, Sort Description Estimated annual revenue of the lead. | | City | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the lead. | | CleanedByJob | Type boolean Properties Filter Description Indicates whether the lead record was cleaned by a Data.com Clean job (true) or not (false). | | CleanedByUser | Type boolean Properties Filter Description Indicates whether the lead record was cleaned by a Salesforce user (true) or not (false). | | CompanyDunsNumber | Type string Properties Filter, Group, Nillable, Sort Description The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. | | CompanyName | Type string Properties Filter, Group, Nillable, Sort Description The name of the company. | | ContactStatusDataDotCom | Type picklist Properties Filter, Group, Nillable, Sort Description The status of the contact associated with the lead per Data.com. Values are: Contact is Active per Data.com, Phone is Wrong per Data.com , Email is Wrong per Data.com, Phone and Email are Wrong per Data.com, Contact Not at Company per Data.com, Contact is Inactive per Data.com, Company this contact belongs to is out of business per Data.com, Company this contact belongs to never existed per Data.com or Email address is invalid per Data.com. | | Country | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the lead. | | DandBCompanyDunsNumber | Type string Properties Filter, Group, Nillable, Sort Description The D-U-N-S Number on the D&B Company record (if any) that is linked to the lead. | | DataDotComCompanyId | Type string Properties Filter, Group, Nillable, Sort Description The ID Data.com maintains for the company associated with the lead. | | DataDotComId | Type string Properties Filter, Group, Nillable, Sort Description The ID Data.com maintains for the contact associated with the lead. | | Email | Type email Properties Filter, Group, Nillable, Sort Description The lead’s email address. | | FirstName | Type string Properties Filter, Group, Nillable, Sort Description The lead’s first name. | | Industry | Type picklist Properties Filter, Group, Nillable, Sort Description The industry the lead belongs to. | | IsDifferentAnnualRevenue | Type boolean Properties Filter Description Indicates whether the lead’s AnnualRevenue field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCity | Type boolean Properties Filter Description Indicates whether the lead’s City field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCompanyDunsNumber | Type boolean Properties Filter Description Indicates whether the lead’s Company D-U-N-S Number field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCompanyName | Type boolean Properties Filter Description Indicates whether the lead’s Company Name field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCountry | Type boolean Properties Filter Description Indicates whether the lead’s Country field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentCountryCode | Type boolean Properties Filter Description Indicates whether the account’s Country Code field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentDandBCompanyDunsNumber | Type boolean Properties Filter Description Indicates whether the lead’s D&B Company D-U-N-S Number field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentEmail | Type boolean Properties Filter Description Indicates whether the lead’s Email field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentFirstName | Type boolean Properties Filter Description Indicates whether the lead’s First Name field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentIndustry | Type boolean Properties Filter Description Indicates whether the lead’s Industry field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentLastName | Type boolean Properties Filter Description Indicates whether the lead’s Last Name field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentNumberOfEmployees | Type boolean Properties Filter Description Indicates whether the lead’s No. of Employees field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentPhone | Type boolean Properties Filter Description Indicates whether the lead’s Phone field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentPostalCode | Type boolean Properties Filter Description Indicates whether the lead’s Postal Code field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentState | Type boolean Properties Filter Description Indicates whether the lead’s State field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentStateCode | Type boolean Properties Filter Description Indicates whether the account’s State Code field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentStreet | Type boolean Properties Filter Description Indicates whether the lead’s Street field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsDifferentTitle | Type boolean Properties Filter Description Indicates whether the lead’s Title field value is different from the corresponding value on its matched Data.com record (true) or not (false). | | IsFlaggedWrongAddress | Type boolean Properties Filter, Update Description Indicates whether the lead’s Address field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongAnnualRevenue | Type boolean Properties Filter, Update Description Indicates whether the lead’s Annual Revenue field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongCompanyDunsNumber | Type boolean Properties Filter, Update Description Indicates whether the lead’s Company D-U-N-S Number field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongCompanyName | Type boolean Properties Filter, Update Description Indicates whether the lead’s Company Name field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongEmail | Type boolean Properties Filter, Update Description Indicates whether the lead’s Email field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongIndustry | Type boolean Properties Filter, Update Description Indicates whether the lead’s Industry field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongName | Type boolean Properties Filter, Update Description Indicates whether the lead’s Name field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongNumberOfEmployees | Type boolean Properties Filter, Update Description Indicates whether the lead’s No. of Employees field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongPhone | Type boolean Properties Filter, Update Description Indicates whether the lead’s Phone field value is flagged as wrong to Data.com (true) or not (false). | | IsFlaggedWrongTitle | Type boolean Properties Filter, Update Description Indicates whether the lead’s Title field value is flagged as wrong to Data.com (true) or not (false). | | IsInactive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the lead has been reported to Data.com as Inactive (true) or not (false). | | IsReviewedAddress | Type boolean Properties Filter, Update Description Indicates whether the lead’s Address field value is in a Reviewed state (true) or not (false). | | IsReviewedAnnualRevenue | Type boolean Properties Filter, Update Description Indicates whether the lead’s Annual Revenue field value is in a Reviewed state (true) or not (false). | | IsReviewedCompanyDunsNumber | Type boolean Properties Filter, Update Description Indicates whether the lead’s Company D-U-N-S Number field value is in a Reviewed state (true) or not (false). | | IsReviewedCompanyName | Type boolean Properties Filter, Update Description Indicates whether the lead’s Company Name field value is in a Reviewed state (true) or not (false). | | IsReviewedDandBCompanyDunsNumber | Type boolean Properties Filter, Update Description Indicates whether the lead’s D&B Company D-U-N-S Number field value is in a Reviewed state (true) or not (false). | | IsReviewedEmail | Type boolean Properties Filter, Update Description Indicates whether the lead’s Email field value is in a Reviewed state (true) or not (false). | | IsReviewedIndustry | Type boolean Properties Filter, Update Description Indicates whether the lead’s Industry field value is in a Reviewed state (true) or not (false). | | IsReviewedName | Type boolean Properties Filter, Update Description Indicates whether the lead’s Name field value is in a Reviewed state (true) or not (false). | | IsReviewedNumberOfEmployees | Type boolean Properties Filter, Update Description Indicates whether the lead’s No. of Employees field value is in a Reviewed state (true) or not (false). | | IsReviewedPhone | Type boolean Properties Filter, Update Description Indicates whether the lead’s Phone field value is in a Reviewed state (true) or not (false). | | IsReviewedTitle | Type boolean Properties Filter, Update Description Indicates whether the lead’s Title field value is in a Reviewed state (true) or not (false). | | LastMatchedDate | Type dateTime Properties Filter, Sort Description The date the lead record was last matched and linked to a Data.com record. | | LastName | Type string Properties Filter, Group, Nillable, Sort Description The lead’s last name. | | LastStatusChangedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of who or what last changed the record’s Clean Status field value: a Salesforce user or a Clean job. | | LastStatusChangedDate | Type dateTime Properties Filter, Nillable, Sort Description The date on which the record’s Clean Status field value was last changed. | | Latitude | Type double Properties Filter, Nillable, Sort Description Used with Longitude to specify the precise geolocation of a billing address. Data not currently provided. | | LeadId | Type reference Properties Filter, Group, Sort Description The unique, system-generated ID assigned when the lead record was created. | | Longitude | Type double Properties Filter, Nillable, Sort Description Used with Latitude to specify the precise geolocation of a billing address. Data not currently provided. | | Name | Type string Properties Filter, Group, Sort, Update Description Field label is **Lead Clean Info Name**. The name of the lead. Maximum size is 255 characters. | | NumberOfEmployees | Type int Properties Filter, Group, Nillable, Sort Description The number of employees working at the lead. | | Phone | Type phone Properties Filter, Group, Nillable, Sort Description The phone number for the lead. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the lead. | | State | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of the lead. | | Street | Type textarea Properties Filter, Group, Nillable, Sort Description Details for the billing address of the lead. | | Title | Type string Properties Filter, Group, Nillable, Sort Description The lead’s title. | ## Usage Developers can create triggers that read the Lead Clean Info fields to help automate the cleaning or related processing of lead records. <!-- document id=a90ddb8715059ef1164c597b70621d1723b941a63253814b3d81c03e2ccfdc98 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_leaddailymetric.md --> # LeadDailyMetric Represents the daily engagement metrics for a lead. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Inbox must be enabled. ## Fields | Field | Details | | --- | --- | | AllCallsCallBackLater | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this lead with the call result Call Back Later. | | AllCallsLeftVoicemail | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this lead with the call result Left Voicemail. | | AllCallsMeaningfulConnect | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this lead with the call result Meaningful Connect. | | AllCallsNotInterested | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this lead with the call result Not Interested. | | AllCallsUncategorized | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this lead with no call result specified. | | AllCallsUnqualified | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this lead with the call result Unqualified. | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total of hard and soft bounced emails for this lead in the day. This is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of successfully delivered emails for this lead in the day. This is a calculated field. | | AllEmailsDeliveredRate | Type percent Properties Filter, Nillable, Sort Description The percentage of tracked emails sent that were successfully delivered to this lead. This field is a calculated field. Available in API version 54.0 and later. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of hard bounced emails for this lead in the day. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that triggered an out of office reply for this lead in the day. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead in the day. This is a calculated field. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails soft bounced for this lead in the day. | | AllEmailsTrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with engagement tracking enabled in the day. | | AllEmailsUntrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead without engagement tracking enabled in the day. | | AllTotalCallsCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of calls to this lead with all call results in the day. This is a calculated field. | | DailyCutOffTimeStamp | Type dateTime Properties Filter, Sort Description The time of day when each 24-hour metrics period starts and ends. | | Date | Type date Properties Filter, Group, Sort Description The date on which the engagement occurred. | | DateInt | Type int Properties Filter, Group, idLookup, Sort Description The date on which the engagement occurred, in yyyymmdd format. | | HardBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with hard bounce tracking. Available in API version 54.0 and later. | | InboundEngagementsCount | Type int Properties Filter, Group, Nillable, Sort Description The number of inbound engagements for this lead in the day. This field is a calculated field. The value is the sum of UniqueEmailsOpenedCount, UniqueEmailsRepliedCount, and UniqueEmailsLinkClickedCount. Available in API version 58.0 and later. | | LeadId | Type reference Properties Filter, Group, Sort Description The ID of the related lead. This is a relationship field. Relationship Name Lead Relationship Type Lookup Refers To Lead | | LinkClickTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with link click tracking. Available in API version 54.0 and later. | | OpenTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with open tracking. Available in API version 54.0 and later. | | OutOfOfficeTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with out-of-office tracking. Available in API version 54.0 and later. | | OutboundEngagementsCount | Type int Properties Filter, Group, Nillable, Sort Description The number of outbound engagements for this lead in the day. This field is a calculated field. The value is the sum of AllTotalCallsCount and AllEmailsDeliveredCount. Available in API version 58.0 and later. | | ReplyTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with reply tracking. Available in API version 54.0 and later. | | SoftBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with soft bounce tracking. Available in API version 54.0 and later. | | TrackableSendHardBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with hard bounce tracking that hard bounced. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendLinkClickRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with link tracking that had link clicks. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendOpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with open tracking that were opened by the recipient. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendOutOfOfficeRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with out-of-office tracking that received out-of-office replies. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendReplyRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with reply tracking that received replies. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendSoftBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with soft bounce tracking that soft bounced. This field is a calculated field. Available in API version 54.0 and later. | | UniqueEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails in which the lead clicked a link in the day. | | UniqueEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails opened by the lead in the day. | | UniqueEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails replied to by the lead in the day. | <!-- document id=c36b4abe3e257fe7a72cb3d06847bbbedecf5803fb7e3881052c09e13880dca7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_leadmonthlymetric.md --> # LeadMonthlyMetric Represents the monthly engagement metrics for a lead. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Inbox must be enabled. ## Fields | Field | Details | | --- | --- | | AllCallsCallBackLater | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this lead with the call result Call Back Later. | | AllCallsLeftVoicemail | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this lead with the call result Left Voicemail. | | AllCallsMeaningfulConnect | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this lead with the call result Meaningful Connect. | | AllCallsNotInterested | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this lead with the call result Not Interested. | | AllCallsUncategorized | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this lead with no call result specified. | | AllCallsUnqualified | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this lead with the call result Unqualified. | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total of hard and soft bounced emails for this lead in the month. This is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of successfully delivered emails for this lead in the month. This is a calculated field. | | AllEmailsDeliveredRate | Type percent Properties Filter, Nillable, Sort Description The percentage of tracked emails sent that were successfully delivered to this lead. This field is a calculated field. This is a calculated field. Available in API version 54.0 and later. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of hard bounced emails for this lead in the month. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that triggered an out of office reply for this lead in the month. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead in the month. This is a calculated field. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails soft bounced for this lead in the month. | | AllEmailsTrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with engagement tracking enabled in the month. | | AllEmailsUntrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead without engagement tracking enabled in the month. | | AllTotalCallsCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of calls to this lead with all call results in the month. This is a calculated field. | | HardBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with hard bounce tracking. Available in API version 54.0 and later. | | LeadId | Type reference Properties Filter, Group, Sort Description The ID of the related lead. This is a relationship field. Relationship Name Lead Relationship Type Lookup Refers To Lead | | LinkClickTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with link click tracking. Available in API version 54.0 and later. | | Month | Type date Properties Filter, Group, Sort Description The month in which the engagement occurred. | | MonthInt | Type int Properties Filter, Group, idLookup, Sort Description The month in which the engagement occurred, in yyyymm format. | | OpenTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with open tracking. Available in API version 54.0 and later. | | OutOfOfficeTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with out-of-office tracking. Available in API version 54.0 and later. | | ReplyTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with reply tracking. Available in API version 54.0 and later. | | SoftBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent to this lead with soft bounce tracking. Available in API version 54.0 and later. | | TrackableSendHardBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with hard bounce tracking that hard bounced. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendLinkClickRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with link tracking that had link clicks. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendOpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with open tracking that were opened by the recipient. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendOutOfOfficeRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with out-of-office tracking that received out-of-office replies. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendReplyRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with reply tracking that received replies. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendSoftBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to this lead with soft bounce tracking that soft bounced. This field is a calculated field. Available in API version 54.0 and later. | | UniqueEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails in which the lead clicked a link in the month. | | UniqueEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails opened by the lead in the month. | | UniqueEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of individual emails replied to by the lead in the month. | <!-- document id=eed22a1ab5ffecde3323bf866188ef988b9e0692a185fbfbcd37c38da8d20790 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_leadownersharingrule.md --> # LeadOwnerSharingRule Represents the rules for sharing a lead with users other than the owner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. This field is available in API version 24.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. Leads owned by users in the source group trigger the rule to give access. | | LeadAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. The possible values are: - Read - Edit | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the target user or group. The target user or group is being given access. | ## Usage Use these objects to manage the sharing rules for leads. General sharing and Territory-related sharing use this object. #### See Also - [Lead](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lead.htm "Represents a prospect or lead.") - [LeadShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadshare.htm "Represents a sharing entry on a Lead.") - [LeadStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadstatus.htm "Represents the status of a Lead record, such as Open, Qualified, or Converted.") - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") <!-- document id=e02bb57997b62512b394d339ed892e9f13504eb904a155b33fb52e704fa74b58 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_leadprspagntrsrch.md --> # LeadProspectingAgentResearch Represents research done by a prospecting agent on a lead record. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | IsQualified | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The default value is false. | | LeadId | Type reference Properties Filter, Group, Sort Description This field is a relationship field. Relationship Name Lead Relationship Type Master-detail Refers To Lead (the master object) | | Rationale | Type textarea Properties Nillable Description The explanation of why the account qualified or not. The rationale provides extra context to guide human users in their decision making. | | RelatedResearchId | Type reference Properties Filter, Group, Nillable, Sort Description This field is a polymorphic relationship field. Relationship Name RelatedResearch Refers To AccountPrspAgntRsrch, PrspAgntExtlCoRsrch | | ResearchRunKey | Type string Properties Filter, Group, Nillable, Sort Description The date and time the research was complete. | <!-- document id=5dff6b9f6aec83ae0b320e8befe295172ddecd27db2c2ad92fc361e43fca09f0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_leadshare.md --> # LeadShare Represents a sharing entry on a Lead. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only users with access to the Lead object can access this object. ## Fields The properties available for some fields depend on the default org-wide sharing settings. The properties listed are true for the default settings of such fields. | Field | Details | | --- | --- | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | LeadAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the Lead. The possible values are: - Read - Edit - All This value is not valid when creating or updating these records. This field must be set to an access level that is higher than the organization’s default access level for leads. | | LeadId | Type reference Properties Create, Filter, Group, Sort Description ID of the Lead associated with this sharing entry. This field can’t be updated. This is a relationship field. Relationship Name Lead Relationship Type Lookup Refers To Lead | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Values include: - Manual—The User or Group has access because a user with “All” access manually shared the Lead with them. - Owner—The User is the owner of the Lead. - Rule—The User or Group has access via a Lead sharing rule. - GuestRule—The User or Group has access via a Lead guest user sharing rule. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. - ARImplicit—The User, who belongs to a partner or customer account, has access to the Lead via an account relationship data sharing rule. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the Lead. This field can’t be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object allows you to determine which users and groups can view or edit leads owned by other users. If you attempt to create a record that matches an existing record, the existing record is returned. #### See Also - [AccountShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm "Represents a sharing entry on an account.") - [Case](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm "Represents a case, which is a customer issue or problem.") - [CaseShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseshare.htm "Represents a sharing entry on a Case.") - [OpportunityShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityshare.htm "Represents a sharing entry on an Opportunity.") <!-- document id=9d5e8f00857e3dfc5c3ccd9f9c6b80af086b775a3d6711b914a093ce50171455 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_leadstatus.md --> # LeadStatus Represents the status of a Lead record, such as Open, Qualified, or Converted. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an id or primary label. | | IsConverted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this lead status value represents a converted lead (true) or not (false). Multiple lead status values can represent a converted lead. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default lead status value (true) or not (false) in the picklist. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Label for this lead status value. This display value is the internal label that does not get translated. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the lead status picklist. These numbers are not guaranteed to be sequential, as some previous lead status values might have been deleted. | ## Usage This object represents a value in the lead status picklist (see [Lead](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lead.htm "Represents a prospect or lead.")). The lead status picklist provides additional information about the status of a [Lead](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lead.htm "Represents a prospect or lead."), such as whether a given status value represents a converted [Lead](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lead.htm "Represents a prospect or lead."). Query this object to retrieve the set of values in the lead status picklist, and then use that information while processing [Lead](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lead.htm "Represents a prospect or lead.") objects to determine more information about a given lead. For example, the application could test whether a given lead is converted based on its Status value and the value of the IsConverted property in the associated LeadStatus record. #### See Also - [LeadOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadownersharingrule.htm "Represents the rules for sharing a lead with users other than the owner.") - [LeadShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadshare.htm "Represents a sharing entry on a Lead.") <!-- document id=1295aec8a1da40cd10483454e72cc86b8649ebd0fca9ef2d5235ef52a118348d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_leadtag.md --> # LeadTag Associates a word or short phrase with a Lead. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage LeadTag stores the relationship between its parent TagDefinition and the Lead being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. <!-- document id=754acfd374fb35e4f6019ede67d88a03c6b974e9fda6c0504a43cd4e2977290f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_learningcontent.md --> # LearningContent Represents a Trailhead or enablement site (myTrailhead) module assigned to a user in Workforce Engagement or Learning Paths. This object also represents a Trailhead module or video in an Enablement program exercise. This object is available in API version 54.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules - The org must have a Workforce Engagement license. - The user must have at least one Workforce Engagement permission set assigned to them: Workforce Engagement Admin, Workforce Engagement Analyst, Workforce Engagement Planner, Workforce Engagement Agent. - For an enablement site (myTrailhead) module, the org must have a Sales Enablement license. - For a Trailhead module or video in an Enablement program, the org must have an Enablement license. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, Nillable Description The module's human-readable API name, such as pure-aloe-sales-strategies. | | AvailablePointCount | Type int Properties Group, Nillable Description The maximum points that a user can earn on their profile by completing the module. This value is the sum of points that the content creator assigns to the module’s units. | | ContainsAssessmentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist Description Specifies the type of assessment that the content’s units include. Possible values are: - MultipleChoiceQuiz—All the content’s units have multiple-choice quizzes. - HandsOnChallenge—At least one unit has a hands-on challenge. | | ContentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist Description The type of content assigned to the user. Possible values are: - All—The content is any supported type. - Module—The content is a Trailhead or enablement site (myTrailhead) module. - VideoLesson—The content is a video that's specified in the Enablement workspace in Digital Experiences and is used in an Enablement program. | | ContentUrl | Type url Properties Group, Nillable Description The absolute URL to the content, such as https://purealoe.my.trailhead.com/en/content/sales-team-enablement/modules/pure-aloe-sales-strategies. | | Description | Type string Properties Nillable Description The module’s description. | | DurationCount | Type int Properties Group, Nillable Description The total time, in minutes, for a learner to complete all units in the module. This value is the sum of the estimated times that the content creator assigns to the module’s units. | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description The GUID that Trailhead uses to reference the module. | | ImageUrl | Type url Properties Group, Nillable Description The absolute URL to the module’s badge art image file. | | IsPublic | Type boolean Properties Defaulted on create, Filter, Group Description Indicates whether the content is public Trailhead content (true) or private enablement site (myTrailhead) content (false). The default value is false. | | Title | Type string Properties Filter, Group, Nillable, Sort Description The module’s title. | #### See Also - [PersonTraining](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_persontraining.htm "Represents an assignment of a learning module in Workforce Engagement. This object is available in API version 54.0 and later.") <!-- document id=bb44ac98ac1b516eeb1c0b458b3b873aa79473ae58d10e3682d1361f68efa5b3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_learningitem.md --> # LearningItem Represents an item that requires users to take action, including a Learning Paths entry, an Enablement program, or an exercise with linked content in an Enablement program. For Learning Paths, users are assigned a learning item to complete. For Enablement programs and exercises, users are assigned a program or can self-enroll in shared programs. This object is available in API version 58.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - For partner users who take Partner Enablement programs, the Take Partner Enablement Programs permission is required. This permission is enabled by default as part of the Use Partner Enablement Programs permission set, which comes with the Enablement add-on license. Partner Enablement also requires a [supported Partner Relationship Management (PRM) add-on license](https://help.salesforce.com/s/articleView?id=slack.prm_support_license_template.htm&type=5&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | CustomLearningItemTypeId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of a learning item type record if this learning item represents a custom exercise type in an Enablement program. This field is required when the Type field’s value is CustomContent. This field is a relationship field. Available in API version 62.0 and later. Relationship Name CustomLearningItemType Relationship Type Lookup Refers To LearningItemType | | EnablementProgramId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of an Enablement program that contains the outcome, milestone, or exercise. This field is a relationship field. Relationship Name EnablementProgram Relationship Type Lookup Refers To EnablementProgram | | LearningContentId | Type string Properties Filter, Group, Nillable, Sort Description The ID of the record that represents a Trailhead module or video in a sales program exercise. This field is a relationship field. Relationship Name LearniningContent Refers To LearningContent | | OwnerId | Type reference Properties Filter, Group, Sort Description ID of the owner of the program. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | StandardCustomContentMetadata | Type textarea Properties Nillable Description Reserved for future use. | | StandardCustomLearningItemType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Reserved for future use. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of learning item. Possible values are: - CustomContent—Custom exercise content in an Enablement program, such as a screen flow, content from external repositories, or other custom content sources. Available in API version 62.0 and later. - EnablementProgram - LearningContent—Trailhead module - LearningLesson—Lesson exercise in an Enablement program - LearningLink—Audio Recording, Document, Scheduled Event, or Other exercise in an Enablement program - LearningPractice—Feedback Request exercise in an Enablement program - StandardCustomContent—Standard Custom exercise content in an Enablement program. Reserved for future use. | ## 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. [LearningItemOwnerSharingRule](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.") (API version 60.0) Sharing rules are available for the object. [LearningItemShare](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.") (API version 60.0) Sharing is available for the object. <!-- document id=8a64600488028ca764e373cd35cc4728e2742650046c19ed0cfc6d98ffb93b20 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_learningitemassignment.md --> # LearningItemAssignment Represents the assignment of a Learning Paths entry to users or groups or the enrollment of an Enablement program for a specific user. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - For partner users who take Partner Enablement programs, the Take Partner Enablement Programs permission is required. This permission is enabled by default as part of the Use Partner Enablement Programs permission set, which comes with the Enablement add-on license. Partner Enablement also requires a [supported Partner Relationship Management (PRM) add-on license](https://help.salesforce.com/s/articleView?id=slack.prm_support_license_template.htm&type=5&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | AssigneeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user or group assigned to the learning item. This field is a relationship field. Relationship Name Assignee Relationship Type Lookup Refers To User | | AssignmentStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of assigning an Enablement program to a user. Possible values are: - Failed - InProgress - Succeeded | | DueDate | Type date Properties Filter, Group, Nillable, Sort Description The date that the assignment is due for the user or group. | | EnrollmentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of enrollment for a user in an Enablement program. Possible values are: - Assigned - SelfEnrolled | | IsOverdue | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the assigned learning item is overdue (true) or not (false). The default value is false. This field is a calculated field. | | LearningItemId | Type reference Properties Create, Filter, Group, Sort Description The ID of the learning item. This field is a relationship field. Relationship Name LearningItem Relationship Type Lookup Refers To LearningItem | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort Description ID of the user who assigned the learning item. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ProgressId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of record that represents a user's progress towards completing an assigned learning item, such as a Learning Paths entry or sales program. This field is a relationship field. Relationship Name Progress Refers To LearningItemProgress | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort Description The date that the learning item was assigned to the user or group. | ## Usage You can assign a learning item to a user programmatically by querying the program and user, and then inserting a record into LearningItemAssignment. ## 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. [LearningItemAssignmentOwnerSharingRule](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.") (API version 60.0) Sharing rules are available for the object. [LearningItemAssignmentShare](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.") (API version 60.0) Sharing is available for the object. <!-- document id=4d2787032dec4659c38a2dbea48702cdc2ca1ed7184a64844fe924e0c73fe6b9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_learningitemprogress.md --> # LearningItemProgress Represents the progress that a user has made towards completing an assigned learning item, such as a Learning Paths entry or Enablement program. This object is available in API version 60.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - For partner users who take Partner Enablement programs, the Take Partner Enablement Programs permission is required. This permission is enabled by default as part of the Use Partner Enablement Programs permission set, which comes with the Enablement add-on license. Partner Enablement also requires a [supported Partner Relationship Management (PRM) add-on license](https://help.salesforce.com/s/articleView?id=slack.prm_support_license_template.htm&type=5&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | CompletedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the user completed the learning item. | | CompletedOnDay | Type int Properties Filter, Group, Nillable, Sort Description Number of days that the user took to complete the learning item. | | CompletedPercent | Type percent Properties Filter, Sort Description Percentage of the learning item that’s complete. | | DaysInProgress | Type int Properties Nillable Description Number of days that have elapsed since the learning item was assigned. | | LearningItemId | Type reference Properties Filter, Group, Sort Description The ID of the learning item. This field is a relationship field. Relationship Name LearningItem Relationship Type Lookup Refers To LearningItem | | OwnerId | Type reference Properties Filter, Group, Sort Description ID of the owner of the learning item. This field is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | ProgressStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of the learning item assignment. Possible values are: - Behind - Completed - CompletedLate - CompletedOnTime - InProgress - NoLongerTracking - NotStarted - OnTrack - Overdue For details, see [Completion Statuses in Enablement Analytics](https://help.salesforce.com/s/articleView?id=sales.enablement_analytics_completion_statuses.htm&type=5&language=en_US "HTML (New Window)"). | | StartDate | Type dateTime Properties Filter, Nillable, Sort Description The date when a user starts a Trailhead exercise in a sales program. | ## 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. [LearningItemProgressChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [LearningItemProgressOwnerSharingRule](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. [LearningItemProgressShare](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. <!-- document id=efa28fa6934a18e711f5e402478e1a635511eebae1008f5dc503b1369a106ff2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_learningitemsubmission.md --> # LearningItemSubmission Represents a link to a resource, such as a video recording, that a user submits as part of a Feedback Request exercise in an Enablement program. For peer and manager feedback, this resource can be a recording of a user’s sales patch. For Einstein Coach feedback, this resource can be a video call, and Einstein generates feedback from the call’s transcription. This object is available in API version 59.0 and later, but Einstein Coach is available only in API version 61.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules A learning item submission record is created when users take an Enablement program that includes a Feedback Request exercise for peer and manager feedback. - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - To access exercises that use Einstein Coach, the Use Einstein Coach permission is required. This permission is enabled by default as part of the Access Einstein Coach permission set, which comes with the Enablement add-on license. ## Fields | Field | Details | | --- | --- | | CallId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the video call that a user submits for Einstein Coach feedback. Einstein generates feedback for the user based on the call’s transcription. This field is a polymorphic relationship field. Available in API version 61.0 and later. Relationship Name Call Relationship Type Lookup Refers To VideoCall | | LearningItemId | Type reference Properties Filter, Group, Sort Description The ID of the LearningItem record for the Feedback Request exercise, where the Type of the learning item is LearningPractice. This field is a relationship field. Relationship Name LearningItem Relationship Type Lookup Refers To LearningItem | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the owner of the learning item submission. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Url | Type url Properties Filter, Nillable, Sort Description URL of the content that a user submits for peer and manager feedback. For example, a link to a video recording of a sales rep’s practice pitch. | ## 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. [LearningItemSubmissionOwnerSharingRule](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. [LearningItemSubmissionShare](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. <!-- document id=7240804cd83538b5352d7192bd36cc0efa692a81c9ccd8f10c4bd7a557e76ef3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_learningitemtype.md --> # LearningItemType Represents a custom exercise type that an Enablement user takes in an Enablement program in the Guidance Center. A custom exercise type also requires a corresponding LearningItem record for the Guidance Center and corresponding EnblProgramTaskDefinition and EnblProgramTaskSubCategory records for when admins create a program in Program Builder. This object is available in API version 62.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Custom exercises aren’t compatible with Partner Enablement programs. ## Fields | Field | Details | | --- | --- | | ApexEvaluationHandlerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Apex class that specifies how progress and completion of the custom exercise is assessed when users take the program in the Guidance Center. This field is a relationship field. Relationship Name ApexEvaluationHandler Refers To ApexClass | | ApexSerializerDeserializerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Apex class that specifies how data related to the custom exercise type is retrieved and deployed with change sets or managed packages. This field is a relationship field. Relationship Name ApexSerializerDeserializer Refers To ApexClass | | CustomField | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The programmatic name of a custom lookup field on the [LearningItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_learningitem.htm "Represents an item that requires users to take action, including a Learning Paths entry, an Enablement program, or an exercise with linked content in an Enablement program. For Learning Paths, users are assigned a learning item to complete. For Enablement programs and exercises, users are assigned a program or can self-enroll in shared programs. This object is available in API version 58.0 and later.") object that references the custom object used with this custom exercise. Add values to this picklist when you implement a custom exercise type. For example, if a custom exercise type shows a screen flow, maybe the custom object’s name is ScreenFlow\_Object\_\_c and the custom field on LearningItem is named ScreenFlow\_Field\_\_c. For details, see [Implement Custom Exercise Types for Enablement Programs](https://developer.salesforce.com/docs/sales/enablement/guide/enablement-custom-exercises-intro.html "HTML (New Window)") in the _Sales Programs and Partner Tracks with Enablement Developer Guide_. This field is unique within your organization. | | CustomObject | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The programmatic name of the custom object used with this custom exercise. Add values to this picklist when you implement a custom exercise type. For example, if a custom exercise type shows a Quip document, maybe the custom object’s name is ScreenFlow\_Object\_\_c. For details, see [Implement Custom Exercise Types for Enablement Programs](https://developer.salesforce.com/docs/sales/enablement/guide/enablement-custom-exercises-intro.html "HTML (New Window)") in the _Sales Programs and Partner Tracks with Enablement Developer Guide_. This field is unique within your organization. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | Icon | Type textarea Properties Create, Update Description The icon to use for the custom exercise type in the Guidance Center. Use the format iconType:iconName, where the values correspond to icon categories and names from the [Salesforce Lightning Design System](https://www.lightningdesignsystem.com/icons/ "HTML (New Window)"). - iconType is the type of icon, such as standard or doctype. - iconName is the icon name, such as flow or slide. For example, to use the Standard type Flow icon, this value is standard:flow. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reserved for future use. Don’t edit this field. | | LightningComponentName | Type string Properties Filter, Nillable, Sort Description The name, including the namespace, of the Lightning Web Component (LWC) used to show the custom exercise’s content when a user opens the exercise in the Guidance Center. For example, if the LWC for a screen flow custom exercise is named screenFlowViewer, this value is c:screenFlowViewer. This field can only be accessed from Metadata API and its value is derived from the lightningComponentDefinition field on the [LearningItemType metadata type](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_learningitemtype.htm "HTML (New Window)"). | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for this LearningItemType value. This display value is the internal label that doesn't get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | <!-- document id=14062e34276d534b98586e7dd7a7fe0f3b8f0179f18091d4eadcc75a42cf860f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_learningpractice.md --> # LearningPractice Represents a Feedback Request exercise in an Enablement program. Users can submit a sample of their work and request feedback from their peers and managers. Or, users can submit a video call and Einstein Coach generates feedback from the call’s transcription. This object is available in API version 59.0 and later, but Einstein Coach feedback is available only in API version 61.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules - For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license. - For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license. - To access exercises that use Einstein Coach, the Use Einstein Coach permission is required. This permission is enabled by default as part of the Access Einstein Coach permission set, which comes with the Enablement add-on license. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Filter, Sort Description Instructions to the user to provide context for completing the Feedback Request exercise. For example, Record yourself giving a sales pitch and request feedback from your peers. | | InviteeQuantity | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of peers or managers that the user is required to invite for giving feedback when Type is PeerFeedback. Each peer or manager receives an invitation to the assessment survey associated with the Feedback Request exercise. When Type is AIFeedback, this value is always 1. | | LearningItemId | Type reference Properties Filter, Group, Sort Description The ID of the LearningItem record for the Feedback Request exercise. The value must be unique. This field is a relationship field. Relationship Name LearningItem Relationship Type Lookup Refers To LearningItem | | Name | Type string Properties Filter, Group, idLookup, Sort Description The title of the Feedback Request exercise. For example, Practice Your Sales Pitch. | | PromptTemplate | Type string Properties Filter, Group, Nillable, Sort Description The prompt template to use with this exercise when Type is AIFeedback. Available in API version 61.0 and later. | | SurveyId | Type reference Properties Filter, Group, Sort Description The ID of the assessment survey that’s sent to peers and managers when Type is PeerFeedback. This field is a relationship field. Relationship Name Survey Relationship Type Lookup Refers To Survey | | Type | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of feedback used with this exercise. Possible values are: - AIFeedback—Users submit a video call, and Einstein Coach generates feedback from the call’s transcription. With this type, PromptTemplate is required. Available in API version 61.0 and later. - PeerFeedback—Users submit a URL to a sample of their work, and select peers and managers to review their work. Selected peers and managers complete an assessment survey. With this type, SurveyId is required. Available in API version 61.0 and later. - Survey—Users complete a survey as part of their enrolled employee enablement program. Available in API version 64.0 and later. | <!-- document id=b307adc10279e638de428ce79f0e47ef2dd9b0f8df37169b416ee63b7776b0b3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_legalentity.md --> # LegalEntity Represents the way an organization is structured. An organization can be a single legal entity or it can comprise more than one legal entity. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available with the Salesforce Billing managed package and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_legalentity.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | CompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the company that this legal entity represents. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the legal entity. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | LegalEntityAddress | Type address Properties Filter, Nillable Description The address of the company that this legal entity represents. This field is a compound field of type Address and combines these fields: LegalEntityCity, LegalEntityCountry, LegalEntityGeocodeAccuracy, LegalEntityLatitude, LegalEntityLongitude, LegalEntityPostalCode, LegalEntityState, and LegalEntityStreet. For more information, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_address.htm). | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the legal entity. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the record owner. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the legal entity. Possible values are: - Active - Inactive | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [LegalEntityFeed](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. [LegalEntityHistory](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. [LegalEntityOwnerSharingRule](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. [LegalEntityShare](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. <!-- document id=ebf9aa08c22c468ecceda98b94f3703c70b1843e871f85e58eaf70eb1892a518 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_licensedefinitioncustompermission.md --> # LicenseDefinitionCustomPermission Represents a licensed custom permission that controls access to a license's features when included in a custom permission set license definition. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CreatedById | Type reference Properties Defaulted on create, Filter Description ID of the [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm "HTML (New Window)") who created this record. | | CreatedDate | Type dateTime Properties Defaulted on create, Filter Description Date and time when this record was created. | | Id | Type id Properties Create, Filter, Group, Sort, Update Description Unique record ID. | | IsDeleted | Type boolean Properties Create, Filter, Group, Sort, Update Description When true, the record has been deleted. | | LastModifiedById | Type reference Properties Defaulted on create, Filter Description ID of the [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm "HTML (New Window)") who last updated this record. | | LastModifiedDate | Type dateTime Properties Defaulted on create, filter Description Date and time when a user last modified this record. | | LicenseDefinitionId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the custom permission set license definition that contains the licensed custom permission. This is a relationship field. Relationship Name LicenseDefinition Relationship Type Lookup Refers To PermissionSetLicenseDefinition | | LicensedCustomPermissionId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the licensed custom permission that you're including in the permission set license definition. On the [CustomPermission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custompermission.htm "Represents a permission created to control access to a custom process or app, such as sending email. This object is available in API version 31.0 and later.") object, the isLicensed field must equal true. This is a relationship field. Relationship Name LicensedCustomPermission Relationship Type Lookup Refers To CustomPermission | | SystemModstamp | Type dateTime Properties Defaulted on create, filter Description In general, SystemModstamp shows the date and time when a user or automated process last modified the record. However, in certain cases, SystemModstamp doesn’t capture every field change. For example, if object A retrieves values from object B, then the changes to field values in records on object B are reflected in the SystemModstamp field for records on object B, but not on object A. | <!-- document id=1bb7cce24de577bc3c70c1da922cb99f4f6f9b2b02b4899d89f14d5b20a197ad url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_lightningerror.md --> # Lightning Error Event Type Lightning Error events represent errors that occurred during user interactions with Lightning Experience and the Salesforce mobile app. This event type is available in the EventLogFile object in API version 39.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Event Monitoring logs are a source of truth but are not durable. Data loss can occur during Salesforce site switches, instance refreshes, or unplanned outages. For more information, see [Using Event Monitoring](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | APP\_NAME | Type String Description The name of the application that the user accessed. | | BROWSER\_NAME | Type String Description The name of the browser that the user accessed. Example Chrome, Safari | | BROWSER\_VERSION | Type String Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | CLIENT\_GEO | Type String Description The geolocation of the client in the form of <Country>/<State|Province>. Example United States/California | | CLIENT\_ID | Type String Description The API client ID. | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. Example 96.43.144.26 | | COMPONENT\_NAME | Type String Description The internal name of the standard component that generated the error. The Salesforce developer assigned the name when the standard component was created. Example SaveEdit, Lead.CCPM\_sendSMS, ChangeOwnerOne | | CONNECTION\_TYPE | Type String Description The type of connection. Possible Values - CDMA1x - CDMA - EDGE - EVDO0 - EVDOA - EVDOB - GPRS - HRPD - HSDPA - HSUPA - LTE - WIFI | | DEVICE\_ID | Type String Description The unique identifier used to identify a device when tracking events. DEVICE\_ID is a generated value that’s created when the mobile app is initially run after installation. | | DEVICE\_MODEL | Type String Description The name of the device model. Example iPad, iPhone | | DEVICE\_PLATFORM | Type String Description The type of application experience in name:experience:form format. Possible Values - name: APP\_BUILDER, CUSTOM, S1, SFX - experience: BROWSER, HYBRID - form: DESKTOP, PHONE, TABLET | | DEVICE\_SESSION\_ID | Type Id Description The unique identifier of the user’s session based on page load time. If the user reloads a page, it starts a new session. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0 | | EVENT\_TYPE | Type String Description The type of event. The value is always LightningError. | | LOGIN\_KEY | Type String Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I | | MESSAGE | Type String Description The error message generated. | | ORGANIZATION\_ID | Type String Description The 15-character ID of the org. Example 00D000000000123 | | OS\_NAME | Type String Description The operating system name, derived from USER\_AGENT. Example Android, iOS, OSX, Windows | | OS\_VERSION | Type String Description The operating system version, derived from USER\_AGENT. | | PAGE\_APP\_NAME | Type String Description The internal name of the application that the user accessed from the App Launcher. Example LightningSales | | PAGE\_CONTEXT | Type String Description Context of the page where the event occurred. Example clients:cardsContainer | | PAGE\_ENTITY\_ID | Type Id Description The unique entity identifier of the event. Example 0013000000I3zJAAAZ | | PAGE\_ENTITY\_TYPE | Type String Description The entity type of the event. Example Task, Account | | PAGE\_START\_TIME | Type Number Description The time when the page was initially loaded, measured in milliseconds. Example 1471564788642 | | PAGE\_URL | Type String Description Relative URL of the top-level Lightning Experience or Salesforce mobile app page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PAGE\_URL. Example /sObject/0064100000JXITSAA5/view | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 3nWgxWbDKWWDIk0FKfF5DV | | SDK\_APP\_TYPE | Type String Description The mobile SDK application type. Possible Values - HYBRID - HYBRIDLOCAL - HYBRIDREMOTE - NATIVE - REACTNATIVE | | SDK\_APP\_VERSION | Type String Description The mobile SDK application version number. Example 5.0 | | SDK\_VERSION | Type String Description The mobile SDK version number. Example 2.1.0 | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When a user logs out and logs in again, a new session is started. Example cdd09305cb6babf34059e27f70e47f1b11dec868 | | STACK\_TRACE | Type String Description The stack trace contains the location in the code where the error occurred along with the calling frames that led to the error. | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. Example 20130715233322.670 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z. The timezone is GMT. | | UI\_EVENT\_ID | Type String Description ID of the Lightning event type. Possible Values - ltng:error - ltng:interaction - ltng:pageView - ltng:performance | | UI\_EVENT\_SEQUENCE\_NUM | Type Number Description An auto-incremented sequence number of the current event since the session started. | | UI\_EVENT\_SOURCE | Type String Description The source of the error event. Examples Here are some examples of error flags returned in this field. - AuraError - Error - InvalidStateError - RangeError - ReferenceError - SecurityError - SyntaxError - TypeError - unknown | | UI\_EVENT\_TIMESTAMP | Type Number Description The time at which this event occurred, measured in milliseconds. Example 1479769912796 | | UI\_EVENT\_TYPE | Type String Description The type of error event. Example error, info, warn | | USER\_AGENT | Type String Description The numeric code for the type of client used to make the request (for example, browser, application, or API) as a string. | | USER\_ID | Type String Description The 15-character ID of the user accessing Salesforce services through the UI or API. Example 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0 | | USER\_TYPE | Type String Description The category of user license of the user accessing Salesforce services through the UI or API. Possible Values - A: Automated Process - b: High Volume Portal - C: Customer Portal User - D: External Who - F: Self Service - G: Guest - L: Package License Manager - N: Salesforce to Salesforce - n: CSN Only - O: Power Custom - o: Custom - P: Partner - p: Customer Portal Manager - S: Standard - X: Salesforce Administrator | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=45021f7d61a6fe72c55920a1a2fd6f2fe558a80cc6eb67bf41bf826394b3d4b5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_lightninginteraction.md --> # Lightning Interaction Event Type Lightning Interaction events track user actions in Lightning Experience and the Salesforce mobile app, such as the user clicking, tapping, or scrolling on a page. This event type is available in the EventLogFile object in API version 39.0 and later. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning The Lightning Interaction Event type is a best effort logging of user interactions but is not intended to meet privacy and security audit requirements. Not all interactions or CRUD operations are tracked and data loss may occur. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d804868e77">Field</th> <th class="featureTableHeader " id="d804868e80">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">APP_NAME</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The name of the application that the user accessed.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">BROWSER_NAME</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The name of the browser that the user accessed.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"> <samp class="codeph nolang">Chrome</samp>, <samp class="codeph nolang">Safari</samp> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">BROWSER_VERSION</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The version of the browser that the user accessed in <span class="keyword parmname">major.minor version</span> format. Some browsers don’t provide a minor version. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">CLIENT_GEO</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The geolocation of the client in the form of <span class="keyword parmname"><Country>/<State|Province></span>. </dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">United States/California</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"></td> <td class="entry" headers="d804868e80" data-title="Details"></td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">CLIENT_ID</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The API client ID.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">CLIENT_IP</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">96.43.144.26</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">COMPONENT_NAME</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The internal name of the standard component that the user interacted with. The Salesforce developer assigned the name when the standard component was created.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"> <samp class="codeph nolang">SaveEdit</samp>, <samp class="codeph nolang">Lead.CCPM_sendSMS</samp>, <samp class="codeph nolang">ChangeOwnerOne</samp> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">CONNECTION_TYPE</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of connection.</dd> <dt class="dt dlterm">Possible Values</dt> <dd class="dd"> <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">CDMA1x</samp></li> <li class="li"><samp class="codeph nolang">CDMA</samp></li> <li class="li"><samp class="codeph nolang">EDGE</samp></li> <li class="li"><samp class="codeph nolang">EVDO0</samp></li> <li class="li"><samp class="codeph nolang">EVDOA</samp></li> <li class="li"><samp class="codeph nolang">EVDOB</samp></li> <li class="li"><samp class="codeph nolang">GPRS</samp></li> <li class="li"><samp class="codeph nolang">HRPD</samp></li> <li class="li"><samp class="codeph nolang">HSDPA</samp></li> <li class="li"><samp class="codeph nolang">HSUPA</samp></li> <li class="li"><samp class="codeph nolang">LTE</samp></li> <li class="li"><samp class="codeph nolang">WIFI</samp></li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">DEVICE_ID</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The unique identifier used to identify a device when tracking events. <span class="keyword parmname">DEVICE_ID</span> is a generated value that’s created when the mobile app is initially run after installation.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">DEVICE_MODEL</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The name of the device model.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"> <samp class="codeph nolang">iPad</samp>, <samp class="codeph nolang">iPhone</samp> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">DEVICE_PLATFORM</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of application experience in <span class="keyword parmname">name:experience:form</span> format. </dd> <dt class="dt dlterm">Possible Values</dt> <dd class="dd"> <ul class="ul bulletList"> <li class="li"> <span class="keyword parmname">name</span>: <samp class="codeph nolang">APP_BUILDER</samp>, <samp class="codeph nolang">CUSTOM</samp>, <samp class="codeph nolang">S1</samp>, <samp class="codeph nolang">SFX</samp> </li> <li class="li"> <span class="keyword parmname">experience</span>: <samp class="codeph nolang">BROWSER</samp>, <samp class="codeph nolang">HYBRID</samp> </li> <li class="li"> <span class="keyword parmname">form</span>: <samp class="codeph nolang">DESKTOP</samp>, <samp class="codeph nolang">PHONE</samp>, <samp class="codeph nolang">TABLET</samp> </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">DEVICE_SESSION_ID</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Id</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">321a1ddfaf924803a075f1e69fc87bc06f53ccd0</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">DURATION</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Number</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The duration in milliseconds since the page start time.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">EVENT_TYPE</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="event-type-desc"><a name="event-type-desc"><!-- --></a>The type of event.</span> The value is always <samp class="codeph nolang">LightningInteraction</samp>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">GRANDPARENT_UI_ELEMENT</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Grandparent scope of the page element where the event occurred.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">LOGIN_KEY</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="login-key-desc"><a name="login-key-desc"><!-- --></a>The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.</span></dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang"><span class="ph" id="login-key-ex"><a name="login-key-ex"><!-- --></a>GeJCsym5eyvtEK2I</span></samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">ORGANIZATION_ID</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The 15-character ID of the org.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">00D000000000123</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">OS_NAME</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The operating system name, derived from <span class="keyword parmname">USER_AGENT</span>. </dd> <dt class="dt dlterm">Example</dt> <dd class="dd"> <samp class="codeph nolang">Android</samp>, <samp class="codeph nolang">iOS</samp>, <samp class="codeph nolang">OSX</samp>, <samp class="codeph nolang">Windows</samp> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">OS_VERSION</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The operating system version, derived from <span class="keyword parmname">USER_AGENT</span>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">PAGE_APP_NAME</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The internal name of the application that the user accessed from the App Launcher.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">LightningSales</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">PAGE_CONTEXT</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Context of the page where the event occurred.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">clients:cardsContainer</samp></dd> <dd class="dd"> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>A value of <samp class="codeph nolang">UNKNOWN</samp> means that the page hasn't finished loading, so the context can't be identified.</p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">PAGE_ENTITY_ID</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Id</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The unique entity identifier of the event.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">0013000000I3zJAAAZ</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">PAGE_ENTITY_TYPE</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The entity type of the event.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"> <samp class="codeph nolang">task</samp>, <samp class="codeph nolang">contacts</samp> </dd> <dd class="dd"> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>A value of <samp class="codeph nolang">UNKNOWN</samp> means that the page hasn't finished loading or the page isn't displaying a record, so the entity type can't be identified.</p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">PAGE_START_TIME</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Number</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The time when the page was initially loaded, measured in milliseconds.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">1471564788642</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">PAGE_URL</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Relative URL of the top-level Lightning Experience or Salesforce mobile app page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with <span class="keyword parmname">PAGE_URL</span>. </dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">/sObject/0064100000JXITSAA5/view</samp></dd> <dd class="dd"> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>A value of <samp class="codeph nolang">UNKNOWN</samp> means that the page hasn't finished loading, so the URL can't be identified.</p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">PARENT_UI_ELEMENT</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Parent scope of the page element where the event occurred.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">RECORD_ID</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String array</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The IDs of one or more records that the user interacted with. For more information on the user interaction, see <span class="keyword parmname">UI_EVENT_TYPE</span> and <span class="keyword parmname">UI_EVENT_SOURCE</span> fields. </dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">["5004100000JaGGLAA3", "5004100000Dn79CAAR", "50041000007KeugAAC"]</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">RECORD_TYPE</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of record object that the user interacted with.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"> <samp class="codeph nolang">Account</samp>, <samp class="codeph nolang">Opportunity</samp> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">RELATED_LIST</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of related list that the user clicked.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">Opportunity</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">REQUEST_ID</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>. </dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">SDK_APP_TYPE</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The mobile SDK application type.</dd> <dt class="dt dlterm">Possible Values</dt> <dd class="dd"> <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">HYBRID</samp></li> <li class="li"><samp class="codeph nolang">HYBRIDLOCAL</samp></li> <li class="li"><samp class="codeph nolang">HYBRIDREMOTE</samp></li> <li class="li"><samp class="codeph nolang">NATIVE</samp></li> <li class="li"><samp class="codeph nolang">REACTNATIVE</samp></li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">SDK_APP_VERSION</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The mobile SDK application version number.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">5.0</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">SDK_VERSION</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The mobile SDK version number.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">2.1.0</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">SESSION_KEY</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session is started.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">cdd09305cb6babf34059e27f70e47f1b11dec868</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">TARGET_UI_ELEMENT</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The target page element where the event occurred.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">tabitem-link</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">TIMESTAMP</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The access time of Salesforce services in GMT.</dd> <dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd> </dl> </td> <td class="entry" headers="d804868e77" data-title="Field"></td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">DateTime</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"> <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. The timezone is GMT. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">UI_EVENT_ID</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Id of the Lightning event type.</dd> <dt class="dt dlterm">Possible Values</dt> <dd class="dd"> <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">ltng:error</samp></li> <li class="li"><samp class="codeph nolang">ltng:interaction</samp></li> <li class="li"><samp class="codeph nolang">ltng:pageView</samp></li> <li class="li"><samp class="codeph nolang">ltng:performance</samp></li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">UI_EVENT_SEQUENCE_NUM</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Number</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">An auto-incremented sequence number of the current event since the session started.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">UI_EVENT_SOURCE</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The user action on the record or records in <span class="keyword parmname">RECORD_ID</span>. This field’s value indicates whether the user’s action was on a single record or multiple records. For example, <samp class="ph systemoutput">read</samp> indicates that one record was read (such as on a record detail page); <samp class="ph systemoutput">reads</samp> indicates that multiple records were read (such as in a list view). </dd> <dt class="dt dlterm">Examples</dt> <dd class="dd"> <ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">click</samp></li> <li class="li"><samp class="codeph nolang">create</samp></li> <li class="li"><samp class="codeph nolang">delete</samp></li> <li class="li"><samp class="codeph nolang">hover</samp></li> <li class="li"><samp class="codeph nolang">read</samp></li> <li class="li"><samp class="codeph nolang">update</samp></li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">UI_EVENT_TIMESTAMP</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Number</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The time at which this event occurred, measured in milliseconds.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">1479769912796</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">UI_EVENT_TYPE</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of interaction with the records in <span class="keyword parmname">RECORD_ID</span>. </dd> <dt class="dt dlterm">Example</dt> <dd class="dd"> <samp class="codeph nolang">crud</samp>, <samp class="codeph nolang">system</samp>, <samp class="codeph nolang">user</samp>, <samp class="codeph nolang">userInteraction</samp> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">USER_AGENT</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The numeric code for the type of client used to make the request (for example, the browser, application, or API) as a string.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">USER_ID</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The 15-character ID of the user accessing Salesforce services through the UI or API.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang">00530000009M943</samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">USER_ID_DERIVED</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Id</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API. </dd> <dt class="dt dlterm">Example</dt> <dd class="dd"><samp class="codeph nolang"><span class="ph" id="user-id-derived-ex"><a name="user-id-derived-ex"><!-- --></a>00590000000I1SNIA0</span></samp></dd> </dl> </td> </tr> <tr> <td class="entry" headers="d804868e77" data-title="Field"><span class="keyword parmname">USER_TYPE</span></td> <td class="entry" headers="d804868e80" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The category of user license of the user accessing Salesforce services through the UI or API.</dd> <dt class="dt dlterm">Possible Values</dt> <dd class="dd"> <ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">A</samp>: Automated Process </li> <li class="li"> <samp class="codeph nolang">b</samp>: High Volume Portal </li> <li class="li"> <samp class="codeph nolang">C</samp>: Customer Portal User </li> <li class="li"> <samp class="codeph nolang">D</samp>: External Who </li> <li class="li"> <samp class="codeph nolang">F</samp>: Self Service </li> <li class="li"> <samp class="codeph nolang">G</samp>: Guest </li> <li class="li"> <samp class="codeph nolang">L</samp>: Package License Manager </li> <li class="li"> <samp class="codeph nolang">N</samp>: Salesforce to Salesforce </li> <li class="li"> <samp class="codeph nolang">n</samp>: CSN Only </li> <li class="li"> <samp class="codeph nolang">O</samp>: Power Custom </li> <li class="li"> <samp class="codeph nolang">o</samp>: Custom </li> <li class="li"> <samp class="codeph nolang">P</samp>: Partner </li> <li class="li"> <samp class="codeph nolang">p</samp>: Customer Portal Manager </li> <li class="li"> <samp class="codeph nolang">S</samp>: Standard </li> <li class="li"> <samp class="codeph nolang">X</samp>: Salesforce Administrator </li> </ul> </dd> </dl> </td> </tr> </tbody> </table> #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=11ccf12230b61fe7c44f5a65069e48fcdace538541ca6dce23f02f04b2bb78dc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_lightninglogger.md --> # Lightning Logger Event Type Lightning Logger events contain information from observed Lightning component logs. This event type is available in the EventLogFile object in API version 58.0 and later. To enable Lightning Logger events, from Setup, in the Quick Find box, enter event, and then select **Event Monitoring Settings**. Turn on Lightning Logger Events. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The browser sends Lightning Logger event logs to the server in batches. Batches are sent when the user interacts with the page and when the page closes or refreshes. If the user experiences connectivity issues or if their login session expires due to browser inactivity, any pending Lightning Logger event logs on the browser are erased. There isn’t a way to retrieve these lost logs. The limit for Lightning Logger events is 30,000 events per minute per organization. Burst capacity may support up to 45,000-50,000 events per minute, but this is not guaranteed. The MESSAGE field shows details about what's logged when the limit is hit. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Event Monitoring logs are a source of truth but are not durable. Data loss can occur during Salesforce site switches, instance refreshes, or unplanned outages. For more information, see [Using Event Monitoring](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">APP_NAME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The name of the application the user accessed.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">BROWSER_NAME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The name of the browser that the user accessed.</dd><dt class="dt dlterm">Example</dt><dd class="dd">Chrome, IE, Safari, Gecko</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">BROWSER_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The user’s browser version in <samp class="codeph nolang">major.minor</samp> format. Some browsers don’t provide a minor version.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_GEO</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The geolocation of the client in the form of <Country>/<State|Province>.</dd><dt class="dt dlterm">Example</dt><dd class="dd">United States/California</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The API client ID.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_IP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The IP address of the client that’s using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as “Salesforce.com IP”.</dd><dt class="dt dlterm">Example</dt><dd class="dd"><samp class="codeph nolang">96.43.144.26</samp></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CONNECTION_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The type of connection.</dd><dt class="dt dlterm">Possible Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><samp class="codeph nolang">CDMA1x</samp></li><li class="li"><samp class="codeph nolang">CDMA</samp></li><li class="li"><samp class="codeph nolang">EDGE</samp></li><li class="li"><samp class="codeph nolang">EVDO0</samp></li><li class="li"><samp class="codeph nolang">EVDOA</samp></li><li class="li"><samp class="codeph nolang">EVDOB</samp></li><li class="li"><samp class="codeph nolang">GPRS</samp></li><li class="li"><samp class="codeph nolang">HRPD</samp></li><li class="li"><samp class="codeph nolang">HSDPA</samp></li><li class="li"><samp class="codeph nolang">HSUPA</samp></li><li class="li"><samp class="codeph nolang">LTE</samp></li><li class="li"><samp class="codeph nolang">WIFI</samp></li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DEVICE_MODEL</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The name of the device model.</dd><dt class="dt dlterm">Example</dt><dd class="dd">iPad, iPhone</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DEVICE_PLATFORM</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The type of application experience in <span class="keyword parmname">name:experience:form</span> format.</dd><dt class="dt dlterm">Possible Values</dt><dd class="dd">Name<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">APP_BUILDER</samp></li><li class="li"><samp class="codeph nolang">CUSTOM</samp></li><li class="li"><samp class="codeph nolang">S1</samp></li><li class="li"><samp class="codeph nolang">SFX</samp></li></ul>Experience<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">BROWSER</samp></li><li class="li"><samp class="codeph nolang">HYBRID</samp></li></ul>Form<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">DESKTOP</samp></li><li class="li"><samp class="codeph nolang">PHONE</samp></li><li class="li"><samp class="codeph nolang">TABLET</samp></li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DEVICE_SESSION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started.</dd><dt class="dt dlterm">Example</dt><dd class="dd">321a1ddfaf924803a075f1e69fc87bc06f53ccd0</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The type of event. The value is always <span class="keyword parmname">LightningLogger</span>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LOGIN_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.</dd><dt class="dt dlterm">Example</dt><dd class="dd"><span class="ph" id="login-key-ex"><a name="login-key-ex"></a>GeJCsym5eyvtEK2I</span></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">MESSAGE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The message passed to the <samp class="codeph nolang">lightning/logger</samp> <samp class="codeph nolang">log()</samp> method. The message can be a JSON object or a string. String length is limited to 4 KB (4096 characters).</dd><dd class="dd">If you hit the logger limit, subsequent events are muted for a minute. During this time, the message field is replaced with this text: <samp class="codeph nolang">Rate limiting hit for this organization.</samp> Lightning Logger events resume when the limit resets in the next minute.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the org.</dd><dt class="dt dlterm">Example</dt><dd class="dd">00D000000000123</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">OS_NAME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The operating system name, derived from the User Agent.</dd><dt class="dt dlterm">Example</dt><dd class="dd">Android, iOS, OSX, Windows</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">OS_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The operating system version, derived from the User Agent.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">PAGE_CONTEXT</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The name of the component hosting the main page content.</dd><dt class="dt dlterm">Example</dt><dd class="dd">clients:cardsContainer</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">PAGE_ENTITY_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The entity ID (if any) of the record being displayed.</dd><dt class="dt dlterm">Example</dt><dd class="dd">0013000000I3zJAAAZ</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">PAGE_ENTITY_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The entity type of the page being displayed.</dd><dt class="dt dlterm">Example</dt><dd class="dd">Task, contacts</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">PAGE_URL</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">Relative URL of the top-level Lightning Experience or Salesforce mobile app page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with <span class="keyword parmname">PAGE_URL</span>.</dd><dt class="dt dlterm">Example</dt><dd class="dd">/sObject/0064100000JXITSAA5/view</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</dd><dt class="dt dlterm">Example</dt><dd class="dd">3nWgxWbDKWWDIk0FKfF5DV</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SDK_APP_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The mobile SDK application type.</dd><dt class="dt dlterm">Possible Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><samp class="codeph nolang">HYBRID</samp></li><li class="li"><samp class="codeph nolang">HYBRIDLOCAL</samp></li><li class="li"><samp class="codeph nolang">HYBRIDREMOTE</samp></li><li class="li"><samp class="codeph nolang">NATIVE</samp></li><li class="li"><samp class="codeph nolang">REACTNATIVE</samp></li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SDK_APP_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The mobile SDK application version number.</dd><dt class="dt dlterm">Example</dt><dd class="dd">5.0</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SDK_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The mobile SDK version number.</dd><dt class="dt dlterm">Example</dt><dd class="dd">2.1.0</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SEQUENCE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">An auto-incremented sequence number of the current event since the session started.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The user’s unique session ID. Use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session is started.</dd><dt class="dt dlterm">Example</dt><dd class="dd">cdd09305cb6babf34059e27f70e47f1b11dec868</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dt class="dt dlterm">Example</dt><dd class="dd">20130715233322.670</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).</dd><dt class="dt dlterm">Example</dt><dd class="dd">2015-07-27T11:32:59.555Z. The timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">UI_EVENT_RELATIVE_TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">Difference in milliseconds between when the message was logged and when the browser tab was opened.</dd><dt class="dt dlterm">Example</dt><dd class="dd">29322.23</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">UI_EVENT_TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The time at which this event occurred, measured in milliseconds.</dd><dt class="dt dlterm">Example</dt><dd class="dd">1479769912796</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the user accessing Salesforce services through the UI or API.</dd><dt class="dt dlterm">Example</dt><dd class="dd">00530000009M943</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API.</dd><dt class="dt dlterm">Example</dt><dd class="dd">00590000000I1SNIA0</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The category of user license of the user accessing Salesforce services through the UI or API.</dd><dt class="dt dlterm">Possible Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><samp class="codeph nolang">A</samp>: Automated Process</li><li class="li"><samp class="codeph nolang">b</samp>: High Volume Portal</li><li class="li"><samp class="codeph nolang">C</samp>: Customer Portal User</li><li class="li"><samp class="codeph nolang">D</samp>: External Who</li><li class="li"><samp class="codeph nolang">F</samp>: Self-Service</li><li class="li"><samp class="codeph nolang">G</samp>: Guest</li><li class="li"><samp class="codeph nolang">L</samp>: Package License Manager</li><li class="li"><samp class="codeph nolang">N</samp>: Salesforce to Salesforce</li><li class="li"><samp class="codeph nolang">n</samp>: CSN Only</li><li class="li"><samp class="codeph nolang">O</samp>: Power Custom</li><li class="li"><samp class="codeph nolang">o</samp>: Custom</li><li class="li"><samp class="codeph nolang">P</samp>: Partner</li><li class="li"><samp class="codeph nolang">p</samp>: Customer Portal Manager</li><li class="li"><samp class="codeph nolang">S</samp>: Standard</li><li class="li"><samp class="codeph nolang">X</samp>: Salesforce Administrator</li></ul></dd></dl></td></tr></tbody></table> <!-- document id=0e24de2acf4be69c6976b43c7970303c92c8b015a53e107f5a96cd40c5e1087b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_lightningpageview.md --> # Lightning Page View Event Type Lightning Page View events represent information about the page on which the event occurred in Lightning Experience and the Salesforce mobile app, such as the page's load time. This event type is available in the EventLogFile object in API version 39.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Event Monitoring logs are a source of truth but are not durable. Data loss can occur during Salesforce site switches, instance refreshes, or unplanned outages. For more information, see [Using Event Monitoring](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | APP\_NAME | Type String Description The name of the application that the user accessed. | | BROWSER\_NAME | Type String Description The name of the browser that the user accessed. Example Chrome, Safari | | BROWSER\_VERSION | Type String Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | CLIENT\_GEO | Type String Description The geolocation of the client in the form of <Country>/<State|Province>. Example United States/California | | CLIENT\_ID | Type String Description The API client ID. | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as Salesforce.com IP. Example 96.43.144.26 | | CONNECTION\_TYPE | Type String Description The type of connection. Possible Values - CDMA1x - CDMA - EDGE - EVDO0 - EVDOA - EVDOB - GPRS - HRPD - HSDPA - HSUPA - LTE - WIFI | | DEVICE\_ID | Type String Description The unique identifier used to identify a device when tracking events. DEVICE\_ID is a generated value that’s created when the mobile app is initially run after installation. | | DEVICE\_MODEL | Type String Description The name of the device model. Example iPad, iPhone | | DEVICE\_PLATFORM | Type String Description The type of application experience in name:experience:form format. Possible Values - name: APP\_BUILDER, CUSTOM, S1, SFX - experience: BROWSER, HYBRID - form: DESKTOP, PHONE, TABLET | | DEVICE\_SESSION\_ID | Type Id Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0 | | DURATION | Type Number Description If the page completes loading, then DURATION indicates the duration of time in milliseconds between PAGE\_START\_TIME and when the loading completes. In this case, DURATION corresponds to EFFECTIVE\_PAGE\_TIME. If the page doesn't complete loading, then DURATION indicates the duration of time in milliseconds between PAGE\_START\_TIME and when the user navigates to another page. | | EFFECTIVE\_PAGE\_TIME | Type Double Description Indicates how many milliseconds it takes for the page to load before a user can interact with the page. Multiple factors can affect effective page time (EPT), such as network speed, hardware performance, or page complexity. | | EFFECTIVE\_PAGE\_TIME\_DEVIATION | Type Boolean Description When a deviation is detected, EFFECTIVE\_PAGE\_TIME\_DEVIATION records true. The default value is false. | | EFFECTIVE\_PAGE\_TIME\_DEVIATION\_ERROR\_TYPE | Type String Description Indicates the origin of an error. This field is populated when EFFECTIVE\_PAGE\_TIME\_DEVIATION\_REASON contains the PAGE\_HAS\_ERROR value. Possible Values - CUSTOM—An error originating from the customer's system or network. - SYSTEM—An error originating in Salesforce. | | EFFECTIVE\_PAGE\_TIME\_DEVIATION\_REASON | Type String Description The reason for deviation in page loading time. Possible Values - PageHasError—An undefined page loading error occurred. - PageNotLoaded—If a customer navigates away from a page while loading processes are in progress, the page doesn't finish loading. - PreviousPageNotLoaded—When navigating to a new page, and the previous page hasn't completed loading, the next page is considered to have a deviation. Incomplete loading processes on a previous page can affect how the next page loads. - InteractionsBeforePageLoaded—A user interacts with a page element before the page is fully loaded. - PageInBackgroundBeforeLoaded—A background loading process runs on a page. Background processes run when a user navigates away from a page to another browser tab. The browser de-prioritizes the page in the background until the user activates the page’s tab. Because a user can leave a page in the background for a long time, the page is expected to have a high Effective Page Time (EPT). | | EVENT\_TYPE | Type String Description The type of event. The value is always LightningPageView. | | GRANDPARENT\_UI\_ELEMENT | Type String Description The grandparent scope of the page element where the event occurred. | | LOGIN\_KEY | Type String Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I | | ORGANIZATION\_ID | Type String Description The 15-character ID of the org. Example 00D000000000123 | | OS\_NAME | Type String Description The operating system name, derived from USER\_AGENT. Example Android, iOS, OSX, Windows | | OS\_VERSION | Type String Description The operating system version, derived from USER\_AGENT. | | PAGE\_APP\_NAME | Type String Description The internal name of the application that the user accessed from the App Launcher. Example LightningSales | | PAGE\_CONTEXT | Type String Description The name of the component hosting the main content of the page. Example clients:cardsContainer | | PAGE\_ENTITY\_ID | Type Id Description The ID of the record that the user accessed which triggered the event on the page. Example 0013000000I3zJAAAZ | | PAGE\_ENTITY\_TYPE | Type String Description The entity type of the event. Example Task, contacts | | PAGE\_FLEXI\_PAGE\_NAME\_OR\_ID | Type String Description The page name or identifier. Example runtime\_sales\_seller\_home\_\_SellerHome\_L | | PAGE\_FLEXI\_PAGE\_TYPE | Type String Description The page type. Example HomePage | | PAGE\_START\_TIME | Type Number Description The time when the page starts loading, measured in milliseconds. Example 1471564788642 | | PAGE\_URL | Type String Description Relative URL of the top-level Lightning Experience or Salesforce mobile app page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PAGE\_URL. Example /sObject/0064100000JXITSAA5/view | | PARENT\_UI\_ELEMENT | Type String Description The parent scope of the page element where the event occurred. | | PREVPAGE\_APP\_NAME | Type String Description The internal name of the previous application that the user accessed from the App Launcher. Example LightningSales | | PREVPAGE\_CONTEXT | Type String Description The context of the previous page where the event occurred. Example clients:cardsContainer | | PREVPAGE\_ENTITY\_ID | Type Id Description The unique previous page entity identifier of the event. | | PREVPAGE\_ENTITY\_TYPE | Type String Description The previous page entity type of the event. Example Task, contacts | | PREVPAGE\_URL | Type String Description The relative URL of the previous Lightning Experience or Salesforce mobile app page that the user opened. Example /sObject/006410000 | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 3nWgxWbDKWWDIk0FKfF5DV | | SDK\_APP\_TYPE | Type String Description The mobile SDK application type. Possible Values - HYBRID - HYBRIDLOCAL - HYBRIDREMOTE - NATIVE - REACTNATIVE | | SDK\_APP\_VERSION | Type String Description The mobile SDK application version number. Example 5.0 | | SDK\_VERSION | Type String Description The mobile SDK version number. Example 2.1.0 | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session is started. Example cdd09305cb6babf34059e27f70e47f1b11dec868 | | TARGET\_UI\_ELEMENT | Type String Description The target page element where the event occurred. Example tabitem-link | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. The timezone is GMT. | | UI\_EVENT\_ID | Type String Description Id of the Lightning event type. Possible Values - ltng:error - ltng:interaction - ltng:pageView - ltng:performance | | UI\_EVENT\_SEQUENCE\_NUM | Type Number Description An auto-incremented sequence number of the current event since the session started. | | UI\_EVENT\_SOURCE | Type String Description This field is being deprecated and is mostly null, except in mobile app views where it indicates the page type of views where the context is “native.” | | UI\_EVENT\_TIMESTAMP | Type Number Description The time at which this event occurred, measured in milliseconds. Example 1479769912796 | | USER\_AGENT | Type String Description The type of client used to make the request (for example, the browser, application, or API) as a string. | | USER\_ID | Type String Description The 15-character ID of the user accessing Salesforce services through the UI or API. Example 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0 | | USER\_TYPE | Type String Description The category of user license of the user accessing Salesforce services through the UI or API. Possible Values - A: Automated Process - b: High Volume Portal - C: Customer Portal User - D: External Who - F: Self-Service - G: Guest - L: Package License Manager - N: Salesforce to Salesforce - n: CSN Only - O: Power Custom - o: Custom - P: Partner - p: Customer Portal Manager - S: Standard - X: Salesforce Administrator | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=b7c1b3320a93c0cf49dd3e6f427273ea6a0152ae77a9f997528607bcd83179a8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_lightningperformance.md --> # Lightning Performance Event Type Lightning Performance events track trends in Lightning Experience and Salesforce mobile app performance. This event type is available in the EventLogFile object in API version 39.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Event Monitoring logs are a source of truth but are not durable. Data loss can occur during Salesforce site switches, instance refreshes, or unplanned outages. For more information, see [Using Event Monitoring](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | APP\_NAME | Type String Description The name of the application that the user accessed. | | BROWSER\_NAME | Type String Description The name of the browser that the user accessed. Example Chrome, Safari | | BROWSER\_VERSION | Type String Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | CLIENT\_GEO | Type String Description The geolocation of the client in the form of <Country>/<State|Province>. Example United States/California | | CLIENT\_ID | Type String Description The API client ID. | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CONNECTION\_TYPE | Type String Description The type of connection. Possible Values - CDMA1x - CDMA - EDGE - EVDO0 - EVDOA - EVDOB - GPRS - HRPD - HSDPA - HSUPA - LTE - WIFI | | DEVICE\_ID | Type String Description The unique identifier used to identify a device when tracking events. DEVICE\_ID is a generated value that’s created when the mobile app is initially run after installation. | | DEVICE\_MODEL | Type String Description The name of the device model. Example iPad, iPhone | | DEVICE\_PLATFORM | Type String Description The type of application experience in name:experience:form format. Possible Values - name: APP\_BUILDER, CUSTOM, S1, SFX - experience: BROWSER, HYBRID - form: DESKTOP, PHONE, TABLET | | DEVICE\_SESSION\_ID | Type Id Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0 | | DURATION | Type Number Description The duration in milliseconds since the page start time. | | EVENT\_TYPE | Type String Description The type of event. The value is always LightningPerformance. | | LOGIN\_KEY | Type String Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I | | ORGANIZATION\_ID | Type String Description The 15-character ID of the org. Example 00D000000000123 | | OS\_NAME | Type String Description The operating system name, derived from USER\_AGENT. Example Android, iOS, OSX, Windows | | OS\_VERSION | Type String Description The operating system version, derived from USER\_AGENT. | | PAGE\_START\_TIME | Type Number Description The time when the page was initially loaded, measured in milliseconds. Example 1471564788642 | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 3nWgxWbDKWWDIk0FKfF5DV | | SDK\_APP\_TYPE | Type String Description The mobile SDK application type. Possible Values - HYBRID - HYBRIDLOCAL - HYBRIDREMOTE - NATIVE - REACTNATIVE | | SDK\_APP\_VERSION | Type String Description The mobile SDK application version number. Example 5.0 | | SDK\_VERSION | Type String Description The mobile SDK version number. Example 2.1.0 | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session is started. Example cdd09305cb6babf34059e27f70e47f1b11dec868 | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. Example 20130715233322.670 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z. The timezone is GMT. | | UI\_EVENT\_ID | Type String Description Id of the Lightning event type. Possible Values - ltng:error - ltng:interaction - ltng:pageView - ltng:performance ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Any other value, such as ltng:bootstrap, is for internal usage only. | | UI\_EVENT\_SOURCE | Type String Description The user action on the record or records. This field’s value indicates whether the user’s action was on a single record or multiple records. For example, read indicates that one record was read (such as on a record detail page); reads indicates that multiple records were read (such as in a list view). Example - click - create - delete - hover - read - update | | UI\_EVENT\_TIMESTAMP | Type Number Description The time at which this event occurred, measured in milliseconds. Example 1479769912796 | | UI\_EVENT\_TYPE | Type String Description The type of performance event. Example bootstrap, defs, performance | | USER\_AGENT | Type String Description The numeric code for the type of client used to make the request (for example, browser, application, or API) as a string. | | USER\_ID | Type String Description The 15-character ID of the user accessing Salesforce services through the UI or API. Example 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0 | | USER\_TYPE | Type String Description The category of user license of the user accessing Salesforce services through the UI or API. Possible Values - A: Automated Process - b: High Volume Portal - C: Customer Portal User - D: External Who - F: Self Service - G: Guest - L: Package License Manager - N: Salesforce to Salesforce - n: CSN Only - O: Power Custom - o: Custom - P: Partner - p: Customer Portal Manager - S: Standard - X: Salesforce Administrator | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=483fd5962e9a38ba9caa7b549e278f535e039ea23cfb055a91f058054bda6e7a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningerroreventlog.md --> # LightningErrorEventLog Lightning Error events represent errors that occurred during user interactions with Lightning Experience and the Salesforce mobile app. This object is available in API version 64.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AppName | Type string Properties Filter, Group, Nillable, Sort Description The name of the application that the user accessed. | | BrowserName | Type string Properties Filter, Group, Nillable, Sort Description The name of the browser that the user accessed. Example Chrome, Safari | | BrowserVersion | Type string Properties Filter, Group, Nillable, Sort Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | ClientGeolocation | Type string Properties Filter, Group, Nillable, Sort Description The geolocation of the client in the form of <Country>/<State|Province>. Example United States/California | | ClientIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The API client ID. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. | | ComponentName | Type string Properties Filter, Group, Nillable, Sort Description The internal name of the standard component that generated the error. The Salesforce developer assigned the name when the standard component was created. | | ConnectionType | Type string Properties Filter, Group, Nillable, Sort Description The type of connection. | | DeviceIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier used to identify a device when tracking events. DEVICE\_ID is a generated value that’s created when the mobile app is initially run after installation. | | DeviceModel | Type string Properties Filter, Group, Nillable, Sort Description The name of the device model. Example iPad, iPhone | | DevicePlatform | Type string Properties Filter, Group, Nillable, Sort Description The type of application experience in name:experience:form format. | | DeviceSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the user’s session based on page load time. If the user reloads a page, it starts a new session. | | ErrorMessage | Type string Properties Filter, Group, Nillable, Sort Description The error message generated. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | MobileSdkAppType | Type string Properties Filter, Group, Nillable, Sort Description The mobile application type. | | MobileSdkVersion | Type string Properties Filter, Group, Nillable, Sort Description Mobile SDK version number. | | OperatingSystemName | Type string Properties Filter, Group, Nillable, Sort Description The operating system name. Example Android, iOS, OSX, Windows | | OperatingSystemVersion | Type string Properties Filter, Group, Nillable, Sort Description The operating system version. | | PageAppName | Type string Properties Filter, Group, Nillable, Sort Description The internal name of the application that the user accessed from the App Launcher. | | PageContext | Type string Properties Filter, Group, Nillable, Sort Description Context of the page where the event occurred. | | PageObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Unique entity ID of event. | | PageObjectType | Type string Properties Filter, Group, Nillable, Sort Description The entity type of event | | PageStartTime | Type dateTime Properties Filter, Nillable, Sort Description Time when page was initially loaded | | PageUrl | Type string Properties Filter, Group, Nillable, Sort Description Relative URL of the top-level Lightning Experience or Salesforce mobile app page that the user opened. The page can contain one or more Lightning components. | | PreviousPageUrl | Type string Properties Filter, Group, Nillable, Sort Description The relative URL of the previous Lightning Experience or Salesforce mobile app page that the user opened | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | SdkAppVersion | Type string Properties Filter, Group, Nillable, Sort Description The mobile SDK application version number. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When a user logs out and logs in again, a new session is started. | | StackTrace | Type string Properties Filter, Group, Nillable, Sort Description The stack trace contains the location in the code where the error occurred along with the calling frames that led to the error. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Example 20130715233322.670 | | UiEventIdentifier | Type string Properties Filter, Group, Nillable, Sort Description ID of the Lightning event type. | | UiEventSequenceNumber | Type double Properties Filter, Nillable, Sort Description The sequence number of current event since start of session. | | UiEventSource | Type string Properties Filter, Group, Nillable, Sort Examples Here are some examples of error flags returned in this field. - AuraError - Error - InvalidStateError - RangeError - ReferenceError - SecurityError - SyntaxError - TypeError - unknown | | UiEventTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The time at which this event occurred, measured in milliseconds. | | UiEventType | Type string Properties Filter, Group, Nillable, Sort Description The type of error event. | | UserAgent | Type string Properties Filter, Group, Nillable, Sort Description The numeric code for the type of client used to make the request (for example, browser, application, or API) as a string. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user accessing Salesforce services through the UI or API. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license of the user accessing Salesforce services through the UI or API. | <!-- document id=699b7b03145f38b41bb8c2736ac3866fe2d8526ff3022931b415bf20df681153 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningexitbypagemetrics.md --> # LightningExitByPageMetrics Represents frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic. This object is available in API version 44.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Not available in sandbox orgs. ## Fields | Field Name | Details | | --- | --- | | MetricsDate | Type date Properties Filter, Group, Sort Description The date that the data was recorded. | | PageName | Type string Properties Filter, Group, Nillable, Sort Description The name of the page from which the user switched from Lightning Experience to Salesforce Classic. | | RecordCount | Type int Properties Filter, Group, Nillable, Sort Description The number of records per user and page. | | UserId | Type reference Properties Filter, Group, Sort Description UserId of the user who views page. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | <!-- document id=eaf2edcc04e16224c9cf342bd5d335d0b064b74a3e3fe2c02563e7e91f2fe853 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningexperiencetheme.md --> # LightningExperienceTheme Represents information for a theme in Lightning Experience. This object is available in API Version 42.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DefaultBrandingSetId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the default branding set. This is a relationship field. Relationship Name DefaultBrandingSet Relationship Type Lookup Refers To BrandingSet | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the theme. Limit: 1,000 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the theme 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. The label corresponds to the theme name in the user interface. Limit: 70 characters. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Language of the label. Possible values are: - da (Danish) - de (German) - en\_US (English) - es (Spanish) - es\_MX (Spanish - Mexico) - fi (Finnish) - fr (French) - it (Italian) - ja (Japanese) - ko (Korean) - nl\_NL (Dutch) - no (Norwegian) - pt\_BR (Portuguese (Brazil)) - ru (Russian) - sv (Swedish) - th (Thai) - zh\_CN (Chinese - Simplified) - zh\_TW (Chinese - Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Required. The name of the theme. Specify up to 70 characters. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ShouldOverrideLoadingImage | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a custom image overrides the Salesforce loading image (true) or not (false). | <!-- document id=a00900f33131d3269013f00bf369bca89b9fb6686b0a101a35ac1179526021ee url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningloggereventlog.md --> # LightningLoggerEventLog Lightning Logger Event Log provides information from observed Lightning component logs. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Event Monitoring logs are a source of truth but are not durable. Data loss can occur during Salesforce site switches, instance refreshes, or unplanned outages. For more information, see [Using Event Monitoring](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AppName | Type string Properties Filter, Group, Nillable, Sort Description The name of the application the user accessed. | | BrowserName | Type string Properties Filter, Group, Nillable, Sort Description The name of the browser the user accessed. | | BrowserVersion | Type string Properties Filter, Group, Nillable, Sort Description The user’s browser version in major.minor format. Some browsers don’t provide a minor version. | | ClientGeolocation | Type string Properties Filter, Group, Nillable, Sort Description The geolocation of the client in the form of <Country>/<State|Province>. | | ClientIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The API client ID. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | ConnectionType | Type string Properties Filter, Group, Nillable, Sort Description The type of connection.Possible values are: - CDMA1x - CDMA - EDGE - EVDO0 - EVDOA - EVDOB - GPRS - HRPD - HSDPA - HSUPA - LTE - WIFI | | DeviceModel | Type string Properties Filter, Group, Nillable, Sort Description The name of the device model. For example: iPad, iPhone. | | DevicePlatform | Type string Properties Filter, Group, Nillable, Sort Description The type of application experience in name:experience:form format. Possible values are: Name - APP\_BUILDER - CUSTOM - S1 - SFX Experience - BROWSER - HYBRID Form - DESKTOP - PHONE - TABLET | | DeviceSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the user’s session is based on page load time. When the user reloads a page, a new session starts. For example: 321a1ddfaf924803a075f1e69fc87bc06f53ccd0 | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | Message | Type string Properties Filter, Nillable, Sort Description The message is passed to the lightning/logger log() method. The message can be a JSON object or a string. | | MobileSdkAppType | Type string Properties Filter, Group, Nillable, Sort Description The mobile SDK application type. Possible Values: - HYBRID - HYBRIDLOCAL - HYBRIDREMOTE - NATIVE - REACTNATIVE | | MobileSdkVersion | Type string Properties Filter, Group, Nillable, Sort Description The mobile SDK application version number. For example, 5.0. | | OperatingSystemName | Type string Properties Filter, Group, Nillable, Sort Description The operating system name, derived from the User Agent. For example: - Android - iOS - OSX - Windows | | OperatingSystemVersion | Type string Properties Filter, Group, Nillable, Sort Description The operating system version, derived from the User Agent. | | PageContext | Type string Properties Filter, Group, Nillable, Sort Description The name of the component hosting the main content of the page. For example: clients:cardsContainer. | | PageObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique entity identifier of the event. For example: 0013000000I3zJAAAZ. | | PageObjectType | Type string Properties Filter, Group, Nillable, Sort Description The object type of the event. For example: task, contacts. | | PageUrl | Type string Properties Filter, Group, Nillable, Sort Description Relative URL of the top-level Lightning Experience or Salesforce mobile app page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PageUrl. For example: /sObject/0064100000JXITSAA5/view. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | SdkAppVersion | Type string Properties Filter, Group, Nillable, Sort Description The app version used in this request. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | UiRootActivityIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID for the root activity, if any, when this message was logged. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description Type of user employing Salesforce services, whether through the UI or API. | <!-- document id=ee40f1861c7d28996015b7de3334417237c1a6c4b099b8c345e43621eca0e959 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningonboardingconfig.md --> # LightningOnboardingConfig Represents the feedback provided when users switch from Lightning Experience to Salesforce Classic. Admins can customize the question, how frequently the form appears, and where the feedback is stored in Chatter from the Adoption Assistance page in Lightning Experience Setup. Available in API version 47.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. See [Switch to Salesforce Classic Feedback Form](https://help.salesforce.com/articleView?id=lex_encourage_work_feedback.htm&language=en_US) in Salesforce Help for more details. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CollaborationGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Chatter Group where the user feedback is posted. This is a relationship field. Relationship Name CollaborationGroup Relationship Type Lookup Refers To CollaborationGroup | | CustomQuestion | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Text of the custom question added by the admin. Maximum of 1,000 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | FeedbackFormDaysFrequency | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of days between showing the feedback form when a user switches. A value of 0 indicates that the form is shown for every switch. Maximum of 30. | | IsCustom | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if a feedback form includes a custom question yes or not no. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the language used in the org where the feedback form was created. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for the prompt. Maximum of 80 characters. | | PromptDelayTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the amount of time in seconds to delay between instances of all prompts, both org- and Salesforce-created. Minimum of 0 hours and 0 minutes. Maximum of 99 hours and 59 minutes. | | SendFeedbackToSalesforce | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the user feedback can be shared with Salesforce. If yes, share the feedback with Salesforce. If no, the feedback is only shared in the Chatter Group chosen when customizing the form. The default value is false. | <!-- document id=5df3b434c3681940b47f3fc59c5cb99ec2aff5f88773c824cd7c89137e53272d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningpagevieweventlog.md --> # LightningPageViewEventLog Lightning Page View event logs represent information about the page on which the event occurred in Lightning Experience and the Salesforce mobile app. A Lightning Page View event log tracks the page a user visited, how long the user spent on the page, and the load time for the page. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Event Monitoring logs are a source of truth but are not durable. Data loss can occur during Salesforce site switches, instance refreshes, or unplanned outages. For more information, see [Using Event Monitoring](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AppName | Type string Properties Filter, Group, Nillable, Sort Description The name of the application that the user accessed. | | BrowserName | Type string Properties Filter, Group, Nillable, Sort Description The name of the browser that the user accessed. For example: Chrome, IE, Safari, Gecko. | | BrowserVersion | Type string Properties Filter, Group, Nillable, Sort Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | ClientGeolocation | Type string Properties Filter, Group, Nillable, Sort Description The geolocation of the client in the form of <Country>/<State|Province>. For example: United States/California. | | ClientIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The API client ID. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description IP address of the client employing salesforce.com services. | | ConnectionType | Type string Properties Filter, Group, Nillable, Sort Description The type of connection. Possible values are: - CDMA1x - CDMA - EDGE - EVDO0 - EVDOA - EVDOB - GPRS - HRPD - HSDPA - HSUPA - LTE - WIFI | | DeviceIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier used to identify a device when tracking events. DeviceIdentifier is a generated value that’s created when the mobile app is initially run after installation. | | DeviceModel | Type string Properties Filter, Group, Nillable, Sort Description The name of the device model. For example: iPad, iPhone. | | DevicePlatform | Type string Properties Filter, Group, Nillable, Sort Description The type of application experience in name:experience:form format. Possible values are: Name - APP\_BUILDER - CUSTOM - S1 - SFX Experience - BROWSER - HYBRID Form - DESKTOP - PHONE - TABLET | | DeviceSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. For example: 321a1ddfaf924803a075f1e69fc87bc06f53ccd0. | | DoesEffectivePageTimeDeviate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description When a deviation is detected, DoesEffectivePageTimeDeviate records true. The default value is false. | | Duration | Type double Properties Filter, Nillable, Sort Description The duration in milliseconds since the page start time. This field is being deprecated. Use EffectivePageTime instead. | | EffectivePageTime | Type double Properties Filter, Nillable, Sort Description Indicates how many milliseconds it took for the page to load before a user could interact with the page’s functionality. Multiple factors can affect effective page time, such as network speed, hardware performance, or page complexity. If an effective page time greater than 60 seconds is detected, the value of this field is set to null or 0. | | EffectivePageTimeErrorType | Type string Properties Filter, Group, Nillable, Sort Description Indicates the origin of an error. This field is populated when EFFECTIVE\_PAGE\_TIME\_DEVIATION\_REASON contains the PAGE\_HAS\_ERROR value. | | EffectivePageTimeReason | Type string Properties Filter, Group, Nillable, Sort Description The reason for deviation in page loading time. Examples of possible values include: - PageInDom\- The page was loaded from a cache - PageHasError\- An undefined page loading error occurred. | | GrandparentUiElement | Type string Properties Filter, Group, Nillable, Sort Description The grandparent scope of the page element where the event occurred. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | MobileSdkAppType | Type string Description The mobile SDK application type. Possible Values - HYBRID - HYBRIDLOCAL - HYBRIDREMOTE - NATIVE - REACTNATIVE | | MobileSdkVersion | Type String Description The mobile SDK application version number. Example 5.0 | | OperatingSystemName | Type string Properties Filter, Group, Nillable, Sort Description The operating system name, derived from UserAgent. For example: Android, iOS, OSX, Windows. | | OperatingSystemVersion | Type string Properties Filter, Group, Nillable, Sort Description The operating system version, derived from UserAgent. | | PageAppName | Type string Properties Filter, Group, Nillable, Sort Description The internal name of the application that the user accessed from the App Launcher. For example: LightningSales. | | PageContext | Type string Properties Filter, Group, Nillable, Sort Description The name of the component hosting the main content of the page. For example: clients:cardsContainer. | | PageObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique entity identifier of the event. For example: 0013000000I3zJAAAZ. | | PageObjectType | Type string Properties Filter, Group, Nillable, Sort Description The object type of the event. For example: task, contacts. | | PageStartTime | Type dateTime Properties Filter, Nillable, Sort Description The time when the page was initially loaded, measured in milliseconds. For example: 1471564788642. | | PageUrl | Type string Properties Filter, Group, Nillable, Sort Description Relative URL of the top-level Lightning Experience or Salesforce mobile app page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PageUrl. For example: /sObject/0064100000JXITSAA5/view. | | ParentUiElement | Type string Properties Filter, Group, Nillable, Sort Description The parent scope of the page element where the event occurred. | | PreviousPageAppName | Type string Properties Filter, Group, Nillable, Sort Description The internal name of the previous application that the user accessed from the App Launcher. For example: LightningSales. | | PreviousPageContext | Type string Properties Filter, Group, Nillable, Sort Description The context of the previous page where the event occurred. For example: clients:cardsContainer. | | PreviousPageObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique previous page object identifier of the event. | | PreviousPageObjectType | Type string Properties Filter, Group, Nillable, Sort Description The previous page object type of the event. For example: task, contacts. | | PreviousPageUrl | Type string Properties Filter, Group, Nillable, Sort Description The relative URL of the previous Lightning Experience or Salesforce mobile app page that the user opened. For example: /sObject/006410000. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | SdkAppVersion | Type string Properties Filter, Group, Nillable, Sort Description The SDK application version number. For example: 5.0. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session is started. For example: cdd09305cb6babf34059e27f70e47f1b11dec868. | | TargetUiElement | Type string Properties Filter, Group, Nillable, Sort Description The target page element where the event occurred. For example: label bBody truncate, tabitem-link. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | UiEventSequenceNumber | Type double Properties Filter, Nillable, Sort Description An auto-incremented sequence number of the current event since the session started. | | UiEventTimestamp | Type dateTime Properties Filter, Nillable, Sort Description An auto-incremented sequence number of the current event since the session started. | | UserAgent | Type string Properties Filter, Group, Nillable, Sort Description The numeric code for the type of client used to make the request (for example, the browser, application, or API) as a string. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user accessing Salesforce services through the UI or API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license of the user accessing Salesforce services through the UI or API. Possible values are: - A: Automated Process - b: High Volume Portal - C: Customer Portal User - D: External Who - F: Self Service - G: Guest - L: Package License Manager - N: Salesforce to Salesforce - n: CSN Only - O: Power Custom - o: Custom - P: Partner - p: Customer Portal Manager - S: Standard - X: Salesforce Administrator | <!-- document id=8586ddc432d6d0c2870923461f2c2203ea57424b3a8cb90d6ef2ec5897b26f0a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningprfmeventlog.md --> # LightningPrfmEventLog Lightning Performance events track trends in Lightning Experience and Salesforce mobile app performance. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AppName | Type string Properties Filter, Group, Nillable, Sort Description The name of the application that the user accessed. | | BrowserName | Type string Properties Filter, Group, Nillable, Sort Description The name of the browser that the user accessed. Example Chrome, Safari | | BrowserVersion | Type string Properties Filter, Group, Nillable, Sort Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | ClientGeolocation | Type string Properties Filter, Group, Nillable, Sort Description The geolocation of the client in the form of <Country>/<State|Province>. Example United States/California | | ClientIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The API client ID. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | ConnectionType | Type string Properties Filter, Group, Nillable, Sort Description The type of connection. Possible Values - CDMA1x - CDMA - EDGE - EVDO0 - EVDOA - EVDOB - GPRS - HRPD - HSDPA - HSUPA - LTE - WIFI | | DeviceIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier used to identify a device when tracking events. DEVICE\_ID is a generated value that’s created when the mobile app is initially run after installation. | | DeviceModel | Type string Properties Filter, Group, Nillable, Sort Description The name of the device model. Example iPad, iPhone | | DevicePlatform | Type string Properties Filter, Group, Nillable, Sort Description The type of application experience in name:experience:form format. Possible Values - name: APP\_BUILDER, CUSTOM, S1, SFX - experience: BROWSER, HYBRID - form: DESKTOP, PHONE, TABLET | | DeviceSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0 | | Duration | Type double Properties Filter, Nillable, Sort Description The duration in milliseconds since the page start time. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I | | MobileSdkAppType | Type string Properties Filter, Group, Nillable, Sort Description The mobile SDK application type. Possible Values - HYBRID - HYBRIDLOCAL - HYBRIDREMOTE - NATIVE - REACTNATIVE | | MobileSdkVersion | Type string Properties Filter, Group, Nillable, Sort Description The mobile SDK application version number. | | OperatingSystemName | Type string Properties Filter, Group, Nillable, Sort Description The operating system name, derived from USER\_AGENT. | | OperatingSystemVersion | Type string Properties Filter, Group, Nillable, Sort Description The operating system version, derived from USER\_AGENT. | | PageStartTime | Type dateTime Properties Filter, Nillable, Sort Description The time when the page was initially loaded, measured in milliseconds. | | PageUrl | Type string Properties Filter, Group, Nillable, Sort Description Relative URL of the top-level Lightning Experience or Salesforce mobile app page that the user opened. The page can contain one or more Lightning components. | | PreviousPageUrl | Type string Properties Filter, Group, Nillable, Sort Description The relative URL of the previous Lightning Experience or Salesforce mobile app page that the user opened. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | SdkAppVersion | Type string Properties Filter, Group, Nillable, Sort Description Mobile SDK application version. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The hash of the session ID to allow tracking of all events in a session. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | UiEventIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Id of the Lightning event type. | | UiEventSource | Type string Properties Filter, Group, Nillable, Sort Description The source of the performance event. | | UiEventTimestamp | Type dateTime Properties Filter, Nillable, Sort Description Timestamp of when event occurred. | | UiEventType | Type string Properties Filter, Group, Nillable, Sort Description The type of performance event. | | UserAgent | Type string Properties Filter, Group, Nillable, Sort Description The client user agent string. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license of the user accessing Salesforce services through the UI or API. | <!-- document id=ebddc76bc39349b597190dd64054d9e4ed93ea070f361af6c0bfcb0ed58a565d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningtogglemetrics.md --> # LightningToggleMetrics Represents users who switched from Lightning Experience back to Salesforce Classic. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Not available in sandbox orgs. ## Fields | Field Name | Details | | --- | --- | | Action | Type string Properties Filter, Group, Nillable, Sort Description User switched from Lightning Experience to Salesforce Classic or from Salesforce Classic to Lightning Experience. | | MetricsDate | Type date Properties Filter, Group, Sort Description Date user switched. | | RecordCount | Type int Properties Filter, Group, Nillable, Sort Description Number of user switches. | | UserId | Type reference Properties Filter, Group, Sort Description UserId of user who switched. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | <!-- document id=3dec774f9b49e3b98d9b0ca92665db0190a7714eabe0fde645d96cfbc8c202be url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningusagebyapptypemetrics.md --> # LightningUsageByAppTypeMetrics Represents number of users on Lightning Experience and Salesforce Mobile. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Not available in sandbox orgs. ## Fields | Field Name | Details | | --- | --- | | AppExperience | Type string Properties Filter, Group, Nillable, Sort Description User’s app (Lightning Experience or Salesforce Mobile). | | MetricsDate | Type date Properties Filter, Group, Sort Description Date user accessed Lightning Experience or Salesforce Mobile. | | UserId | Type reference Properties Filter, Group, Sort Description UserId for user accessing Lightning Experience or Salesforce Mobile. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | <!-- document id=ab4b51da15d5a3f3a9fede121da54efbe947b450fd5d459a98f02fce5db7f88f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningusagebybrowsermetrics.md --> # LightningUsageByBrowserMetrics Represents Lightning Experience usage grouped by user’s browser. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Not available in sandbox orgs. ## Fields | Field Name | Details | | --- | --- | | Browser | Type string Properties Filter, Group, Nillable, Sort Description Browser used to access Lightning Experience. | | MetricsDate | Type date Properties Filter, Group, Sort Description Date user accessed Lightning Experience. | | PageName | Type string Properties Filter, Group, Sort Description Page user viewed in Lightning Experience. | | TotalCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of pages accessed in Lightning Experience. | <!-- document id=0a7b1bd8426809747c43c736a4cf76d5578a1509ef4c4eacb33b87df8ba45bc4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningusagebyflexipagemetrics.md --> # LightningUsageByFlexiPageMetrics Represents custom pages users viewed most frequently in Lightning Experience. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Not available in sandbox orgs. ## Fields | Field Name | Details | | --- | --- | | FlexiPageNameOrId | Type string Properties Filter, Group, Nillable, Sort Description Name or Id of custom page user viewed in Lightning Experience. | | FlexiPageType | Type string Properties Filter, Group, Sort Description Custom page type. | | MetricsDate | Type date Properties Filter, Group, Sort Description Date user viewed page in Lightning Experience. | | TotalCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of custom pages viewed. | <!-- document id=373782d334d5a9ba0e7b5b3e902afea4e9069c75d23eb31a10fd9d3fa18e62b7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lightningusagebypagemetrics.md --> # LightningUsageByPageMetrics Represents standard pages users viewed most frequently in Lightning Experience. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Not available in sandbox orgs. ## Fields | Field Name | Details | | --- | --- | | MetricsDate | Type date Properties Filter, Group, Sort Description Date user viewed page in Lightning Experience. | | PageName | Type string Properties Filter, Group, Nillable, Sort Description Name of page user viewed. | | TotalCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of pages viewed. | | UserId | Type reference Properties Filter, Group, Sort Description UserId of user who viewed page. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## See Also For more information about LightningUsageByPageMetrics syntax and considerations, see [REST API Developer Guide: Lightning Usage by Page](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/resources_lightning_usagebypagemetrics.htm). <!-- document id=27ae1b3fbb7ab8684540702ee6e1f4956695a48324c22345c25e111aee027dac url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_linkedarticle.md --> # LinkedArticle Represents a knowledge article that is attached to a work order, work order line item, or work type. This object is available in API version 37.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Knowledge must be enabled in your org. Field Service must be enabled. Only users that have access to the Knowledge article and the parent record linked to it can access this object. In Knowledge in Salesforce Classic, only Field Service objects such as Work Order, Work Type, and Work Order Line Item are supported for linked articles. In Lightning Knowledge, other social objects such as Chat, Messaging, Voice Call, and Social Post are supported for linked articles. To call update() to attach or detach articles, enable the Read user permission on the Knowledge object and the Edit user permission on the object whose article you update. Available in API version 58.0 and later. ## Fields | Field Name | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | KnowledgeArticleId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the Knowledge article attached to the record. The label in the user interface is Knowledge Article ID. | | KnowledgeArticleVersionId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The version of the Knowledge article attached to the record. This field lists the title of the attached version and links to the version. The label in the user interface is Article Version. When you attach an article to a work order, that version of the article stays associated with the work order, even if later versions are published. If needed, you can detach and reattach an article to a work order to link the latest version. | | LinkedEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the record that the Knowledge article is attached to. The label in the user interface is Linked Record ID. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The title of the article. The label in the user interface is Article Title. | | RecordTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the article’s record type, if used. This field is only available for Lightning Knowledge. | | Type | Type string Properties Filter, Group, Nillable, Sort Description (Read only) The type of record that the Knowledge article is attached to. For example, work order. The label in the user interface is Linked Object Type. | ## Usage Admins can customize linked articles’ page layouts, fields, validation rules, and more from the Linked Articles page in Setup. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [LinkedArticleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [LinkedArticleFeed](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. [LinkedArticleHistory](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. <!-- document id=26fe5710d4638bc9fa3f623e07bdcf669f370135c4859a8a8bd7f16991877af8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_linkedarticlefeed.md --> # LinkedArticleFeed Represents the comment feed on a linked article. This object is available in API version 39.0 and later. For additional information about feeds, see [FeedItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feeditem.htm "FeedItem represents an entry in the feed, such as changes in a record feed, including text posts, link posts, and content posts. This object is available in API version 21.0 and later. This object replaces FeedPost."). ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Knowledge must be enabled in your org. ## Fields | Field | Details | | --- | --- | | BestCommentId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the comment marked as best answer on a question post. | | Body | Type textarea Properties Nillable, Sort Description The body of the feed item. Required when Type is TextPost or AdvancedTextPost. Optional when Type is ContentPost or LinkPost. Although a value for Body is not required for the ContentPost type, an attachment is required. If an attachment isn’t present, the type changes to TextPost or AdvancedTextPost, depending on the API version. TextPost and AdvancedTextPost do require a value for Body. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip See the [IsRichText](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feeditem.htm#isRichTextDes) field for a list of HTML tags supported in the body of rich text posts. | | CommentCount | Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item. | | InsertedById | Type reference Properties Group, Nillable, Sort Description ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user. | | IsRichText | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. If you post a rich text feed comment using SOAP API, set IsRichText to true and escape HTML entities from the body. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: - <p> ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip Though the <br> tag isn’t supported, you can use <p> </p> to create lines. - <a> - <b> - <code> - <i> - <u> - <s> - <ul> - <ol> - <li> - <img> The <img> tag is accessible only through the API and must reference files in Salesforce similar to this example: <img src="sfdc://069B0000000omjh"></img> ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. | | LikeCount | Type int Properties Filter, Group, Sort Description The number of likes associated with this feed item. | | LinkUrl | Type url Properties Nillable, Sort Description The URL of a LinkPost. | | ParentId | Type reference Properties Filter, Group, Sort Description ID of the object type to which the feed item is related. For example, set this field to a UserId to post to someone’s profile feed, or an AccountId to post to a specific account. | | RelatedRecordId | Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion record associated with a ContentPost. For WDC thanks posts, it’s the ID of the WorkThanks object associated with a RypplePost. This field is typically null for all posts except ContentPost and RypplePost. For example, set this field to an existing ContentVersion ID and post it to a feed with Type set to ContentPost. | | Title | Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name. The Title field can be updated on posts of Type QuestionPost. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed items of other types directly from the API. - ActivityEvent—indirectly generated event when a user or the API adds a [Task](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm#sforce_api_objects_task "Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities.") associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or [Event](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_event.htm#sforce_api_objects_event "Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities.") associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. - AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. - AnnouncementPost—Not used. - ApprovalPost—generated when a user submits an approval. - BasicTemplateFeedItem—Not used. - CanvasPost—a post made by a canvas app posted on a feed. - CollaborationGroupCreated—generated when a user creates a public group. - CollaborationGroupUnarchived—Not used. - ContentPost—a post with an attached file. - CreatedRecordEvent—generated when a user creates a record from the publisher. - DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. - DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. - LinkPost—a post with an attached URL. - PollPost—a poll posted on a feed. - ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. - QuestionPost—generated when a user posts a question. - ReplyPost—generated when Chatter Answers posts a reply. - RypplePost—generated when a user creates a Thanks badge in WDC. - TextPost—a direct text entry on a feed. - TrackedChange—a change or group of changes to a tracked field. - UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: - AttachArticleEvent—generated event when a user attaches an article to a case. - CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. - CaseCommentPost—generated event when a user adds a case comment for a case object. - ChangeStatusPost—generated event when a user changes the status of a case. - ChatTranscriptPost—generated event when Chat transcript is saved to a case. - EmailMessageEvent—generated event when an email related to a case object is sent or received. - FacebookPost—generated when a Facebook post is created from a case. Deprecated. - MilestoneEvent—generated when a case milestone is completed or reaches violation status. - SocialPost—generated when a social post is created from a case. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you set Type to ContentPost, also specify ContentData and ContentFileName. | <!-- document id=24423214d92563f66f4f262926fe20ba7ae2a95f54f33754152e0d30ab9db142 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_linkedarticlehistory.md --> # LinkedArticleHistory Represents the history of changes made to tracked fields on a linked article. This object is available in API version 37.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules Knowledge must be enabled in your org. ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | LinkedArticleId | Type reference Properties Filter, Group, Sort Description The ID of the tracked linked article. The history is displayed on the detail page for this record. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The value of the field before it was changed. | <!-- document id=acdfbbe7a9513583ed493c27ca19d9e4f5dc36dcc29e25490d603bf1a0296439 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_listemail.md --> # ListEmail Represents a list email sent from Salesforce, or sent from Account Engagement and synced to Salesforce. When the list email is sent, the recipients are generated by combining recipients in ListEmailIndividualRecipients and ListEmailRecipientSource. Duplicate and other invalid recipients are removed. The result is the recipients sent any given list email. ListEmail has a one-to-many relationship with ListEmailRecipientSource and ListEmailIndividualRecipient. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActionCadenceStepId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the action cadence step that generated a list email record. Used for automated emails in Sales Engagement. Users must have the Sales Engagement Cadence Creator or Sales Engagement User permission enabled. Available in API version 53.0 and later. Relationship Name ActionCadenceStep Relationship Type Lookup Refers To ActionCadenceStep | | CampaignId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related campaign. This is a relationship field. Available in API version 42.0 and later. Relationship Name Campaign Relationship Type Lookup Refers To Campaign | | CcAddress | Type textarea Properties Create, Filter, Nillable, Update Description The list of carbon copy (CC) addresses set on the generated emails. Multiple addresses are separated by commas. Available in API version 67.0 and later. | | ClickThroughRate | Type percent Properties Filter, Nillable, Sort Description The percentage of visitors who click links contained in emails delivered (sent minus bounces) to them. Multiple clicks for a same link are counted. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | ClickToOpenRatio | Type percent Properties Filter, Nillable, Sort Description The number of unique clicks divided by unique HTML opens. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | DeliveryRate | Type percent Properties Filter, Nillable, Sort Description The percentage of the emails that were delivered compared to the number that bounced (soft and hard). Note: this data includes emails that were delivered to the recipient's spam folder. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | EmailContentId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the email content record associated with the list email. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. Available in API version 50.0 or later. | | FromAddress | Type textarea Properties Create, Filter, Update Description Read-only except when the list email is in a draft state. Validated against user’s addresses. | | FromName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Read-only except when the list email is in a draft state. Validated against user’s addresses. This field is null for emails sent from Account Engagement. | | HasAttachment | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Defaulted on create and update. Value is true if the list email has an attachment. This field is null for emails sent from Account Engagement. | | HtmlBody | Type textarea Properties Create, Nillable, Update Description The body of the list email. This field is null for emails sent from Account Engagement. List emails can contain up to 32,000 characters for the body. These limits include visible characters and other characters in the email, including markup. | | IsEmailArchiveRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether email archiving is required. Available in API version 67.0 and later. | | IsSyntheticCcEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether synthetic carbon copy (CC) is enabled. Available in API version 67.0 and later. | | IsTracked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if email tracking was on when the list email was sent. This field is blank for emails sent from Account Engagement and synced to Salesforce. This field is null for emails sent from Account Engagement. Available in API version 44.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when the current user last viewed a record that is related to this list email. This field is null for emails sent from Account Engagement. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. This field is null for emails sent from Account Engagement. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Read-only except when the list email is in a draft state. | | OpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of unique HTML opens compared to the total number of emails delivered (sent minus bounces). To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | OptOutRate | Type percent Properties Filter, Nillable, Sort Description The percentage of users that have opted out compared to the total number of emails sent. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description References Group and User. This field is null for emails sent from Account Engagement. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ProgramName | Type string Properties Filter, Group, Nillable Description The name of an Engagement Studio program where an automated email originates. Reserved for future use. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. Available in API version 46.0 and later. | | RelatedToId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related record. Supported related records include Case, Contact, Lead, Opportunity, Product2, and User. Available in API version 60.0 and later. Relationship Name RelatedTo Relationship Type Lookup Refers To Case, Contact, Lead, Opportunity, Product2, User | | ReplyToName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name associated with the reply-to address for the list email. Available in API version 67.0 and later. | | ScheduledDate | Type dateTime Properties CreateFilter, Nillable, Sort, Update Description Read-only. If null and Status is set to Scheduled\`defaults to created time. | | SentVia | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the email was sent from Salesforce or Account Engagement. Valid values: - Distributed Marketing– Available in API 66.0 - Messaging Service - Pardot - Salesforce– Default To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | SpamComplaintRate | Type percent Properties Filter, Nillable, Sort Description The percentage of spam complaints compared to the total number of emails sent. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Read-only except when the list email is in a draft state. Changing the status to Scheduled causes the list email to be sent. Valid values: - Draft - Scheduled - Sent - Limit Error - Canceled - Running | | Subject | Type textarea Properties Create, Filter, Nillable, Update Description Read-only except when the list email is in a draft state. This field is null for emails sent from Account Engagement. List emails can contain up to 3,000 characters for the subject. These limits include visible characters and other characters in the email, including markup. | | TextBody | Type textarea Properties Create, Nillable, Update Description Read-only except when the list email is in a draft state. This field is null for emails sent from Account Engagement. | | TotalDelivered | Type int Properties Filter, Group, Nillable, Sort Description The total number of emails minus hard and soft bounces. Note: this data includes emails that were delivered to the recipient's spam folder. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | TotalHardBounced | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of emails that permanently bounced back to the sender because the address is invalid. A hard bounce can occur because the domain name doesn't exist or because the recipient is unknown. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | TotalOpens | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of times a prospect’s email client loaded the images in the HTML version of the email. We also record an open if the prospect clicks a link within the HTML or text email without downloading images. A click indicates that they viewed the message. Some email clients (Outlook, Apple Mail, Thunderbird) don’t display images by default. Account Engagement counts an open each time the images load. To access this field. users need the Sales Engagement User permission set or your org must use Account Engagement and users need the CRM User or Sales User permission set. | | TotalOutOfOffice | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of replies received with an out-of-office message. This field is available in API version 50.0 and later. To access this field, your org must use Account Engagement and users need the Salesforce Engage permission set. | | TotalReplies | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of replies received. This field is available in API version 50.0 and later. To access this field, your org must use Account Engagement and users need the Salesforce Engage permission set. | | TotalSent | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Read-only. The total number of list emails sent, including bounced, opted-out, and invalid To: addresses. | | TotalSoftBounced | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of times a recipient’s mail server acknowledged the email, but returned it to the sender. Sometimes it is because the recipient's mailbox is full or the mail server is temporarily unavailable. A soft bounce message can sometimes be deliverable at another time. After 5 soft bounces, Account Engagement opts the prospect out of emails. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | TotalSpamComplaints | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of prospects that reported the email as spam. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | TotalTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of times prospects clicked a link in the email. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist Description The type of email sent: list email or automated email. Reserved for future use. o access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. This field is available in API version 46.0 and later. | | UniqueClickThroughRate | Type percent Properties Filter, Nillable, Sort Description The percentage of visitors who clicked a link contained in an email. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | UniqueOpens | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of prospects who loaded the images in the HTML version of the email. The Unique Opens category counts each recipient one time only, even if the prospect loaded images several times. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | UniqueOptOuts | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Unique opt-outs represent the total number of prospects that have clicked the link to unsubscribe or opted out of all emails in the Email Preference Center. These prospects are removed from future email sends. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | | UniqueReplies | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of unique replies. To access this field, your org must use Account Engagement and users need the Salesforce Engage permission set. This field is available in API version 50.0 and later. | | UniqueTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of times a prospect clicked a link in the email. This metric doesn’t include multiple clicks of the same link. To access this field, your org must use Account Engagement and users need the CRM User or Sales User permission set. | ## Associated Objects This object has these 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. [ListEmailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [ListEmailOwnerSharingRule](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. [ListEmailShare](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. <!-- document id=f834ead0aa923133d7c8acb0b7a5861051b3f8acfcce19aedee034279a56e021 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_listemail_individual_recipient.md --> # ListEmailIndividualRecipient For a list email in Salesforce, represents a recipient. Each record represents a link from a list email to exactly one recipient for that list email. Recipients can be contacts, leads, or campaign members. Has a one-to-many relationship with ListEmail. This object is available in API version 44.0 and later. The visibility and accessibility of this object is inherited from the related list email. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActionCadenceStepTrackerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Understand which action cadence step tracker the list email individual recipient is related to. Used for automated emails in Sales Engagement. Users must have the Sales Engagement Cadence Creator or Sales Engagement User permission enabled. This field is available in API version 54.0 and later. Relationship Name ActionCadenceStepTracker Relationship Type Lookup Refers To ActionCadenceStepTracker | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: - EUR (Euro) - INR (Indian Rupee) - USD (US Dollars) | | ListEmailId | Type reference Properties Create, Filter, Group, Sort Description The related list email record. Required on record creation; read-only otherwise. This is a relationship field. Relationship Name ListEmail Relationship Type Lookup Refers To ListEmail | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated name of the list email recipient source. | | RecipientId | Type reference Properties Create, Filter, Group, Sort, Update Description the contact, lead, person account, or campaign member ID of the individual list email recipient. This is a relationship field. Relationship Name Recipient Relationship Type Lookup Refers To CampaignMember, Contact, Lead | <!-- document id=9a031b67570ead4c5b579b241556cdf8c294557301fc5e0fd1befe6f4cf44efd url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_listemailmonthlymetric.md --> # ListEmailMonthlyMetric Represents the monthly engagement metrics for a single list email. This object is available in API version 49.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Sales Engagement must be enabled. ## Fields | Field | Details | | --- | --- | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total hard and soft bounces that were triggered for this list email in the month. This field is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who successfully received this list email in the month. This field is a calculated field. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total hard bounces that were triggered for this list email in the month. | | AllEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of link clicks by the recipients of this list email in the month. | | AllEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who opened this list email in the month. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of out-of-office replies that were triggered for this list email in the month. | | AllEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of replies to this list email in the month. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients to whom this list email was sent in the month. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total soft bounces that were triggered for this list email in the month. | | HardBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent this list email with hard bounce tracking in the month. Available in API version 53.0 and later. | | LinkClickTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent this list email with link click tracking in the month. Available in API version 53.0 and later. | | ListEmailId | Type reference Properties Filter, Group, Sort Description The ID of the related list email. This field is a relationship field. Relationship Name ListEmail Relationship Type Lookup Refers To ListEmail | | Month | Type date Properties Filter, Group, Sort Description The month in which the engagement occurred. | | MonthInt | Type int Properties Filter, Group, idLookup, Sort Description The month in which the engagement occurred, in yyyymm format. | | OpenTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent this list email with open tracking in the month. Available in API version 53.0 and later. | | OutOfOfficeTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent this list email with out-of-office tracking in the month. Available in API version 53.0 and later. | | ReplyTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent this list email with reply tracking in the month. Available in API version 53.0 and later. | | SoftBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent this list email with soft bounce tracking in the month. Available in API version 53.0 and later. | | TrackableSendHardBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of recipients for whom this list email, sent with hard bounce tracking, resulted in a hard bounce in the month. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendLinkClickRate | Type percent Properties Filter, Nillable, Sort Description The percentage of recipients who clicked on a link in this list email that was sent with link click tracking in the month. Available in API version 53.0 and later. This field is a calculated field. | | TrackableSendOpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of recipients who opened this list email that was sent with open tracking in the month. Available in API version 53.0 and later. This field is a calculated field. | | TrackableSendOutOfOfficeRate | Type percent Properties Filter, Nillable, Sort Description The percentage of recipients for whom the list email, sent with out-of-office tracking, resulted in an out-of-office reply in the month. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendReplyRate | Type percent Properties Filter, Nillable, Sort Description The percentage of recipients for whom this list email, sent with reply tracking, resulted in a reply in the month. Available in API version 53.0 and later. This field is a calculated field. | | TrackableSendSoftBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of recipients for whom this list email, sent with soft bounce tracking, resulted in a soft bounce in the month. Available in API version 54.0 and later. This field is a calculated field. | | UniqueEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who clicked a link in this list email in the month. | | UniqueEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who opened this list email in the month. | | UniqueEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who replied to this list email in the month. | <!-- document id=a8f2c778283dafa358700202241a5d47d3f7a47fd1ec44677765fa1673779469 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_listemail_recipient_source.md --> # ListEmailRecipientSource For a list email in Salesforce, represents the dynamically defined sources of recipient email addresses. Each record represents a link to a single list view or campaign that is examined when the list email is sent. Has a one-to-many relationship with ListEmail. This object is available in API version 41.0 and later. The visibility and accessibility of this object is inherited from the related list email. ## Supported Calls create(), delete(), describeSObjects(), query(), getDeleted(), getUpdated(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ListEmailId | Type reference Properties Create, Filter, Group, Sort Description The related list email record. Required on record creation; read-only otherwise. This is a relationship field. Relationship Name ListEmail Relationship Type Lookup Refers To ListEmail | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated name of the list email recipient source. | | SourceListId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The id of a list view to send the list email to. Read-only except when list email is in draft state. This is a polymorphic relationship field. Relationship Name SourceList Relationship Type Lookup Refers To Campaign, ListView, Topic | | SourceType | Type reference Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Read-only except when list email is in draft state. Valid values: - Include | <!-- document id=c4fa0894a117728f48a563711bee51c84604659f153bd1bd9ca8f22922f23e6e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_listemailsentresult.md --> # ListEmailSentResult Represents the results of a list email sent from Salesforce, or sent from Account Engagement and synced to Salesforce. It contains transport headers and information specific to the associated send action. This object is available in API version 67.0 and later. ## Example ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActionCadenceStepTrackerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the action cadence step tracker related to the individual recipient of the list email. Used for automated emails in Sales Engagement. Users must have the Sales Engagement Cadence Creator or Sales Engagement User permission enabled. Relationship Name ActionCadenceStepTracker Refers To ActionCadenceStepTracker | | ActivityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The task representation of the sent email. Relationship Name Activity Refers To Task | | EmailAdress | Type textarea Properties Create, Nillable, Update Description The email address of the recipient. | | FirstClickedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The timestamp for when the email link was first clicked. | | FirstOpenedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The timestamp for when the email was first opened. | | HasReply | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the email has a reply (true) or not (false) The default value is false. | | Headers | Type textarea Properties Create, Nillable, Update Description The internet message headers of the email used for debugging and email threading purposes. | | isClicked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the individual copy of the list email is clicked true or false. The default value is false. | | IsLinkTracked | Type boolean Properties Create, Defaulted on Create, Filter, Group, Sort, Update Description Indicates whether there are any URLs in the email that can be tracked (true) or not (false). The default value is false. | | IsOpenTracked | Type boolean Properties Create, Defaulted on Create, Filter, Group, Sort, Update Description Indicates whether the email is trackable (true) or not (false). The default value is false. | | IsOpened | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the email has been opened (true) or not (false). The default value is false. | | LastClickedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The timestamp when the email was last clicked. | | LastOpenedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The timestamp when the email was last opened. | | ListEmailId | Type reference Properties Create, Filter, Group, Sort Description The ID of the list email that's associated with the email. Relationship Name ListEmail Relationship Type Master-detail Refers To ListEmail (the master object) | | MessageIdentifier | Type string Properties Create, Filter, idLookup, Nillable, Sort, Update Description The internet ID of an email. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the list email sent result. | | Reason | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the reason why a list email failed to send. Possible values are: - Bounced - DomainUnauthorized\- Unauthorized Domain - NoEmail - No Email Address - OptedOut - Opted Out - OutOfOffice - Out of Office - Restricted - Restricted Address - SoftBounced - Soft Bounced | | RecipientId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the individual list email recipient. This field is a polymorphic relationship field. Relationship Name Recipient Refers To Contact, Lead | | Result | Type picklist Properties Create, Filter, Group, Restricted Picklist, Sort, Update Description Indicates the result of the sent list email. Possible values are: - Failed - NotSent - Sent | | ThreadIdentifier | Type string Properties Create, Filter, idLookup, Nillable, Sort, Update Description The thread ID of the email. | <!-- document id=8f14302948a983c9c68c0afcbb957a260cb308e0baa3a5a8490cffcfae370f95 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_listview.md --> # ListView Represents a list view. A list view shows a set of records for an object, based on specific criteria. This object is available in API version 32.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), search() ## Fields | Name | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The fully qualified developer name of the list view. | | IsSoqlCompatible | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the list view can be used with SOQL.. | | LastModifiedById | Type User Properties Filter, Sort Description The ID of the user who last modified the list view. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the list view was last referenced, with a precision of one second. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the list view was last viewed, with a precision of one second. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the list view. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace of the list view. | | SobjectType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The API name of the sObject for the list view. | ## Usage Use this object to retrieve the metadata for a pipeline inspection view. <!-- document id=18eaa3d1863a5860f95bab5ce51231ba73aa30ce2cfbb9086fc90c3ac2767de9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_listviewchart.md --> # ListViewChart Represents a graphical chart that’s displayed on Salesforce for Android, iOS, and mobile web list views. The chart aggregates data that is filtered based on the list view that’s currently displayed. This object is available in API version 33.0 and later and is accessible by portal users. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Name | Description | | --- | --- | | AggregateField | Type picklist Properties Create, Filter, Group, Nillable, Query, Restricted picklist, Retrieve, Sort, Update Description The field that’s used for calculating data on each group. AggregateField can’t be the same as GroupingField. | | AggregateType | Type picklist Properties Create, Filter, Group, Query, Restricted picklist, Retrieve, Sort, Update Description The type of calculations to run on each group. The supported AggregateType values are Count, Sum, and Avg. | | ChartType | Type picklist Properties Create, Filter, Group, Query, Restricted picklist,Retrieve, Sort, Update Description The type of chart to create. The supported chart types are horizontal bar chart, vertical bar chart, and donut chart. | | DeveloperName | Type string Properties Create, Filter, Group, Query, Retrieve, Sort, Update Description The fully qualified developer name of the chart. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | GroupingField | Type picklist Properties Create, Filter, Group, Nillable, Query, Restricted picklist, Retrieve, Sort, Update Description The field that’s used to divide the data into collections. The field must be supported by SOQL GROUP BY functionality. GroupingField can’t be the same as AggregateField. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the MasterLabel. | | MasterLabel | Type string Properties Create, Filter, Group, Query, Retrieve, Sort, Update Description The label for the chart. | | OwnerId | Type reference Properties Create, Filter, Group, Query, Retrieve, Sort, Update Description The ID of the user who owns the chart. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | SobjectType | Type picklist Properties Create, Filter, Group, Query, Restricted picklist, Retrieve, Sort Description The API name of the sObject for the chart. | <!-- document id=5b1f77e76544e3e76cfbc1035a351aee82acd6c975656132974cc93253049b2e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_listviewchartinstance.md --> # ListViewChartInstance Retrieves metadata for all standard and custom charts for a given entity in context of a given list view. This object is available in API versions 34.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field Name | Details | | --- | --- | | AggregateField | Type string Properties Filter, Group, Sort Description The field that’s used for calculating data on each group. AggregateField can’t be the same as GroupingField. | | AggregateType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of calculations to run on each group. The supported AggregateType values are Count, Sum, and Avg. | | ChartType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of chart to create. The supported chart types are horizontal bar chart, vertical bar chart, and donut chart. | | DataQuery | Type textarea Properties Filter, Nillable, Sort Description The SOQL query that can be executed to fetch the data for drawing a chart. | | DataQueryWithoutUserFilters | Type textarea Properties Filter, Nillable, Sort Description The SOQL query that can be executed to fetch the data for drawing a chart, without user filters. Available in API v43.0 and later. | | DeveloperName | Type string Properties Filter, Group, Sort Description API name of the chart. This name can contain only underscores and alphanumeric characters, and must be unique in your org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description Reserved for future use. | | GroupingField | Type string Properties Filter, Group, Sort Description The field that’s used to divide the data into collections. The field has to be supported by SOQL GROUP BY functionality. GroupingField can’t be the same as AggregateField. | | IsDeletable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the chart can be deleted. | | IsEditable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the chart can be edited. Standard charts are not editable. | | IsLastViewed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if a chart is the last viewed by a user. | | Label | Type string Properties Filter, Group, Sort Description The display name of the chart. | | ListViewChartId | Type reference Properties Filter, Group, Sort Description ID of the chart created by a user. For standard charts, this is null. This is a relationship field. Relationship Name ListViewChart Relationship Type Lookup Refers To ListViewChart | | ListViewContextId | Type reference Properties Filter, Group, Sort Description ID of the list view in context of which the chart is generated. Required to query ListViewChartInstance. This is a relationship field. Relationship Name ListViewContext Relationship Type Lookup Refers To ListView | | SourceEntity | Type string Properties Filter, Group, Sort Description API name of the entity to which the chart is related. Required to query ListViewChartInstance. | ## Usage Example 1. Retrieve all custom and standard charts for Account entity for All Accounts list view SELECT AggregateField, AggregateType, ChartType, DataQuery, DeveloperName, ExternalId, GroupingField, Id, IsDeletable, IsEditable, IsLastViewed, Label, ListViewChartId, ListViewContextId, SourceEntity FROM ListViewChartInstance WHERE SourceEntity=’Account’ and ListViewContextId=’00BR0000000U8Hr’ Example 2. Retrieve metadata for a specific custom chart by ID for Account entity and All Accounts list view SELECT AggregateField, AggregateType, ChartType, DataQuery, DeveloperName, ExternalId, GroupingField, Id, IsDeletable, IsEditable, IsLastViewed, Label, ListViewChartId, ListViewContextId, SourceEntity FROM ListViewChartInstance WHERE SourceEntity=’Account’ and ListViewContextID=’00BR0000000U8Hr’ and ListViewChartId=’0DdR00000004CBxKAM’ Example 3. Retrieve metadata for a specific standard chart by its developer name for Account entity and All Accounts list view SELECT AggregateField, AggregateType, ChartType, DataQuery, DeveloperName, ExternalId, GroupingField, Id, IsDeletable, IsEditable, IsLastViewed, Label, ListViewChartId, ListViewContextId, SourceEntity FROM ListViewChartInstance WHERE SourceEntity=’Account’ and ListViewContextID=’00BR0000000U8Hr’ and DeveloperName=’AccountsByIndustry’ <!-- document id=07b51e71f3c08a16a56660f9d74fecdf17b433d54d1abfea8478dae2a41d6dce url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_liveagentsession.md --> # LiveAgentSession This object is automatically created for each Chat session and stores information about the session. This object is available in API versions 28.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Standard fields for the LiveAgentSession object can only be modified if your administrator has given you editing permissions for these records. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update() ## Fields | Field Name | Details | | --- | --- | | AgentId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the agent associated with the session. | | ChatReqAssigned | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of chat requests that were assigned to an agent during a session. | | ChatReqDeclined | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of chat requests that were declined by an agent during a session. | | ChatReqEngaged | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of chats in which an agent was engaged during a session. | | ChatReqTimedOut | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of chat requests that timed out in an agent’s queue during a session. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the session record was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the session record was last viewed. | | LoginTime | Type dateTime Properties Create, Filter, Sort, Update Description The date and time an agent logged in during the session. | | LogoutTime | Type dateTime Properties Create, Filter, Sort, Update Description The date and time an agent logged out during a session. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookupSort Description The name of the session. | | NumFlagLoweredAgent | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of assistance flags lowered by the agent. | | NumFlagLoweredSupervisor | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of assistance flags lowered by the supervisor. | | NumFlagRaised | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of assistance flags raised by the agent. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the session record. | | TimeAtCapacity | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The amount of time an agent spent with the maximum number of chats in his or her queue. | | TimeIdle | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The amount of time an agent spent idle during the session. | | TimeInAwayStatus | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The amount of time an agent spent with a status of “Away” during a session. | | TimeInChats | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The amount of time an agent spent engaged in chats during a session. | | TimeInOnlineStatus | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The amount of time an agent spent with a status of “Online” during a session. | ## Usage Use this object to query and manage chat session records. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [LiveAgentSessionHistory](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. [LiveAgentSessionOwnerSharingRule](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. [LiveAgentSessionShare](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. <!-- document id=2718759696aa3971e1be3774d6ec753a798f5e7b62334de3a7a772b4ea6b1966 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_liveagentsessionhistory.md --> # LiveAgentSessionHistory This object is automatically created for each Chat session and stores information about changes made to the session. This object is available in API versions 28.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Standard fields for the LiveAgentSession object can only be modified if your administrator has given you editing permissions for these records. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed in a session record. | | LiveAgentSessionId | Type reference Properties Filter, Group, Sort Description ID of the session record that was changed. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The original value of the field that was changed. | ## Usage Use this object to identify changes to chat session records. <!-- document id=a52f55692ca87c2495d635056086dc9996482e982941d3125f36622753181a68 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_liveagentsessionshare.md --> # LiveAgentSessionShare This object is automatically created for each Chat session and stores information about the session. This object is available in API versions 28.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Standard fields for the LiveAgentSession object can only be modified if your administrator has given you editing permissions for these records. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field Name | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the LiveAgentSession. The possible values are: - Read - Edit - All (This value is not valid for create() or update() calls.) This value must be set to an access level that is higher than the organization’s default access level for chat transcripts. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent object, if any. | | RowCause | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Values can include: - Manual—The User or Group has access because a user with “All” access manually shared the LiveAgentSession with them. - Owner—The User is the owner of the LiveAgentSession or is in a role above the LiveAgentSession owner in the role hierarchy. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that has been given access to the LiveAgentSession. | ## Usage This object lets you determine which users and groups can view and edit LiveAgentSession records owned by other users. If you attempt to create a new record that matches an existing record, the create() call updates any modified fields and returns the existing record. <!-- document id=b530c398cdf571425d920b7fabdb56b1822a656762b9666e3540b1b62e7434bb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatblockingrule.md --> # LiveChatBlockingRule Represents a rule for blocking chat visitors’ IP addresses from starting new chats with agents. This object is available in API version 34.0 and later. ## Supported Calls create(), delete(), query(), update(), retrieve() ## Special Access Rules To create a new rule, you must be logged in with the “Customize Application” permission or as a system administrator. ## Fields | Field Name | Details | | --- | --- | | Description | Type string Properties Create, Nillable Description The description of the blocking rule—for example, the reason why the given IP address or range of addresses is being banned from starting new chats. | | DeveloperName | Type string Properties Create, Filter, Group, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | FromIpAddress | Type string Properties Create, Filter, Group, Sort Description The IP address of the user that you want to block, or the beginning of the range of IP addresses you want to block. If you want to block a range of IP addresses, indicate the end of the range in the ToIpAddress field. If you don’t indicate an IP address in the ToIpAddress field, the only IP address that will be blocked is the IP address in the FromIpAddress field. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the blocking rule. | | MasterLabel | Type string Properties Create, Filter, Group, Sort Description Label for the blocking rule. | | ToIpAddress | Type string Properties Create, Filter, Group, Nillable, Sort Description (Optional) The end of the range of IP addresses that you want to block. The range begins with and includes the IP address in the FromIpAddress field, and it ends with and includes the IP address in the ToIpAddress field. | ## Usage Use this object to query and manage rules for blocking customers from starting new chats with agents. <!-- document id=e9e4f4db56a3437a9a38b3966459ea047bcedd543167a107aea731e2c715c0cf url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatbutton.md --> # LiveChatButton Represents a button that allows visitors to request chats with Chat users. This object is available in API version 24.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Animation | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of animation used when an automated chat invitation appears on-screen. For automated chat invitations only. Available in API version 29.0 and later. Possible values are: - Appear - Custom - Fade - Slide | | AutoGreeting | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The text that is automatically sent from an agent to a visitor when a chat session starts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note A greeting message in the AutoGreeting field of the LiveChatButton object overrides individual users’ greeting messages in the AutoGreeting field in the LiveChatUserConfig object. | | ChasitorIdleTimeout | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The amount of time a customer has to respond to an agent message before the chat times out. | | ChasitorIdleTimeoutWarning | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The amount of time a customer has to respond to an agent message before a warning appears and a timer begins a countdown. This value must be shorter than the ChasitorIdleTimeout value. We recommend at least 30 seconds shorter. | | ChatPageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the custom VisualForce page that contains the custom chat window code. This field is a relationship field. Relationship Name ChatPage Relationship Type Lookup Refers To ApexPage | | CustomAgentName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The custom name of the agent associated with the button. Available in API version 29.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note A custom agent name in the CustomAgentName field of the LiveChatButton object overrides individual users’ custom agent name in the CustomAgentName field in the LiveChatUserConfig object. | | DeveloperName | Type string Properties 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | HasQueue | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether or not to allow queing incoming chat requests until an agent is available. The default value is false. | | InviteEndPosition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The position on screen where an automated chat invitation’s animation ends. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You don’t need to select an end position for your automated chat invitation if you use a custom animation. For automated chat invitations only. Available in API version 29.0 and later. Possible values are: - Bottom - BottomLeft - BottomRight - Center - Left - Right - Top - TopLeft - TopRight | | InviteImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the static image resource displayed on your automated chat invitation. For automated chat invitations only. Available in API version 29.0 and later. This field is a relationship field. Relationship Name InviteImage Relationship Type Lookup Refers To StaticResource | | InviteStartPosition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort , Update Description The position on screen where an automated chat invitation’s animation begins. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You don’t need to select a start position for your automated chat invitation if you use a custom animation. For automated chat invitations only. Available in API version 29.0 and later. Possible values are: - Bottom - BottomLeft - BottomLeftBottom - BottomLeftLeft - BottomRight - BottomRightBottom - BottomRightRight - Left - Top - Right - TopLeft - TopLeftLeft - TopLeftTop - TopRight—Top Right - TopRightRight - TopRightTop | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description For automated chat invitations, specifies whether an automated chat invitation is active or not. The default value is false. | | IsRoutingFlowEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether routing flow is enabled or not. The default value is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the chat. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for the chat button. | | NumberOfReroutingAttempts | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the number of times a chat request can be rerouted to available agents if all agents reject the chat request. | | OfflineImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the static image resource that is displayed when the button is offline (inactive). This field is a relationship field. Relationship Name OfflineImage Relationship Type Lookup Refers To StaticResource | | OnlineImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the static image resource that is displayed when the button is online (active). This field is a relationship field. Relationship Name OnlineImage Relationship Type Lookup Refers To StaticResource | | OptionsHasChasitorIdleTimeout | Type boolean Properties Create, Filter, Update Description Specifies whether Customer Time-Out is enabled. | | OptionsHasInviteAfterAccept | Type boolean Properties Create, Filter, Update Description Specifies whether an automated chat invitation can be sent to a customer after that customer has accepted a prior automated chat invitation (true) or not (false). For automated chat invitations only. Available in API version 29.0 and later. | | OptionsHasInviteAfterReject | Type boolean Properties Create, Filter, Update Description Specifies whether an automated chat invitation can be sent to a customer after that customer has rejected a prior automated chat invitation (true) or not (false). For automated chat invitations only. Available in API version 29.0 and later. | | OptionsHasRerouteDeclinedRequest | Type boolean Properties Create, Filter, Update Description Specifies whether a chat request that has been rejected by all available agents should be rerouted to available agents again (true) or not (false). | | OptionsIsAutoAccept | Type boolean Properties Create, Filter, Update Description Specifies whether a chat request should be automatically accepted by the agent it’s assigned to (true) or not false). For chat buttons and automated chat invitations with RoutingType set to Most Available or Least Active. Available in API version 30.0 and later. | | OptionsIsInviteAutoRemove | Type boolean Properties Create, Filter, Update Description Specifies whether an automated chat invitation should be automatically removed from the screen after a certain amount of time (true) or not (false). For automated chat invitations only. Available in API version 29.0 and later. | | OverallQueueLength | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of chat requests allowed to queue. | | PerAgentQueueLength | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of chat requests allowed to queue for each agent with the required skill. | | PostchatPageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the custom VisualForce page displayed when the chat ends. This field is a relationship field. Relationship Name PostchatPage Relationship Type Lookup Refers To ApexPage | | PostchatUrl | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The URL the user is directed to after the chat ends. | | PrechatFormPageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the custom VisualForce page displayed before the chat begins. This field is a relationship field. Relationship Name PrechatFormPage Relationship Type Lookup Refers To ApexPage | | PrechatFormUrl | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The URL the user is directed to before the chat begins. | | PushTimeout | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of seconds an agent has to answer a chat request before it’s routed to the next available agent. | | QueueId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the queue used for this chat button. This field is a relationship field. Relationship Name Queue Relationship Type Lookup Refers To Group | | RoutingConfigurationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the routing configuration used for this chat button. This field is a relationship field. Relationship Name RoutingConfiguration Relationship Type Lookup Refers To QueueRoutingConfig | | RoutingType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description How chat requests are routed to agents. The values are: - Choice—Incoming chat requests are added to the queue in Live Agent in the Salesforce console and are available to any agent with the required skill. - Least Active—Incoming chats are routed to the agent with the required skill who has the fewest active chats. - Most Available—Incoming chats are routed to the agent with the required skill and the greatest difference between chat capacity and active chat sessions. For example, if Agent A and Agent B each have a chat capacity of five, and Agent A has three active chat sessions while Agent B has one, incoming chats will be routed to Agent B. - Omni—Incoming chats are routed using Omni-Channel queues. | | SiteId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the site used for loading static resources and custom VisualForce pages. This field is a relationship field. Relationship Name Site Relationship Type Lookup Refers To Site | | SkillId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record ID of the skill used to route incoming chat requests. To associate multiple skills with a chat button, reference one skill in the SkillId field and use LiveChatButtonSkill junction objects for the remaining skills. This field is a relationship field. Relationship Name Skill Relationship Type Lookup Refers To Skill | | TimeToRemoveInvite | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of seconds an automated invitation stays on-screen before it is automatically removed. For automated chat invitations only. Available in API version 29.0 and later. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of element to display to customers. Possible values are: - Invite—Automated invitation - Standard—Chat button | | WindowLanguage | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language used for standard chat windows. Custom chat windows use the language of the user’s browser. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | ## Usage Use this object to query and manage chat buttons and automated chat invitations. <!-- document id=ac53b3ebdec557e3585adc36f5adc9191400c54f55e4fa098051ed1a6a70089a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatbuttondeployment.md --> # LiveChatButtonDeployment Associates an automated chat invitation with a specific deployment. This object is available in API versions 28.0 and later. ## Supported Calls create(), delete()query(), update(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ButtonId | Type reference Properties Create, Filter, Group, Sort Description The ID of the automated invitation associated with the deployment. | | DeploymentId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the deployment that will feature the automated invitation. | ## Usage Use this object to associate automated chat invitations with specific deployments. <!-- document id=b2bdcd0855ac232928078b1a6c1eb193950aed70ab1200edf3b6056e76d90878 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatbuttonskill.md --> # LiveChatButtonSkill Represents all the skills available to a LiveChatButton except the one currently assigned. To retrieve the skill currently assigned, query LiveChatButton. This object is available in API version 25.0 and later. ## Supported Calls create(), delete(), update(), query() ## Fields | Field Name | Details | | --- | --- | | ButtonID | Type reference Properties Create, Filter, Group, Sort Description The record ID of the button. | | SkillID | Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the skill. | ## Usage Use this object to assign a specific skill to a specific button for multi-skill routing. For example: String myButtonId = "button\_Id"; String myButtonDevName = "button\_DeveloperName"; List<String> skillIds = new List<String>(); //Get one skill ID from button for(LiveChatButton lcb : \[SELECT SkillId FROM LiveChatButton WHERE DeveloperName =: myButtonDevName\]) { skillIds.add(lcb.SkillId); } //Get remaining skills from LiveChatButtonSkill join object for(LiveChatButtonSkill lcbs : \[SELECT SkillID FROM LiveChatButtonSkill WHERE ButtonId =: myButtonId\]) { skillIds.add(lcbs.SkillId); } //Retrieve all skills into a single list List<Skill> skills = \[SELECT Id, DeveloperName FROM Skill WHERE Id IN :SkillIds\]; <!-- document id=e8b6ec7109f87e4db08f495ba264b9a8c8c4e437c224699a39a05e290ccbdd2b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatdeployment.md --> # LiveChatDeployment Represents the general settings for deploying Live Agent on a website. This object is available in API version 24.0 and later. ## Supported Calls create(), query(), update(), retrieve() ## Fields | Field Name | Details | | --- | --- | | BrandingId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the static image resource that’s displayed in the chat window. | | ConnectionTimeoutDuration | Type int Properties Create, Filter, Group, Nillable, Sort Description Indicates the amount of time before the chat times out, in seconds. | | ConnectionWarningDuration | Type int Properties Create, Filter, Group, Nillable, Sort Description Indicates the amount of time before a time-out warning is displayed to the agent, in seconds. | | DeveloperName | Type string Properties Create, Filter, Group, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Domains | Type textarea Properties Create, Filter (unavailable in API version 25.0 and later), Nillable, Sort (unavailable in API version 25.0 and later) Description A comma-separated list of domains the deployment is allowlisted for. Leave this blank to allow the deployment to be used on any domain. | | HasTranscriptSave | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Determines whether visitors can download and save transcripts from the chat window. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the deployment. | | MasterLabel | Type string Properties Create, Filter, Group, Sort Description The name of the deployment | | MobileBrandingId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the static image resource displayed in the mobile version of the chat window. | | OptionsHasPrechatApi | Type boolean Properties Create, Filter Description Determines whether developers can access the Pre-Chat API. | | SiteId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the site used for loading static resources. | | WindowTitle | Type string Properties Create, Filter, Group, Sort Description The text displayed in the title bar of the browser window used to launch the chat window. | ## Usage Use this object to query and manage live chat deployments. <!-- document id=dd98465e528e823e36503fd9b608aff85cfefe48b03a4b6917804632fb464e64 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatobjectaccessconfig.md --> # LiveChatObjectAccessConfig Represents the action you can perform on a specified object by the Chat API. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, enable Chat. To see the list of objects you can find or create in the UI using this API, enable the "Turns on findOrCreate in chat API" permission. You can find this permission in the Chat Settings page of the Setup UI. ## Fields | Field | Details | | --- | --- | | AccessType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The API action you can perform on the object specified in SobjectType. Possible values are: - Create - Find | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the associated LiveChatObjectAccessDefinition record. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To LiveChatObjectAccessDefinition | | SobjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The object that the action specified by AccessType applies to. Possible values are all standard and custom objects. Custom objects are available as picklist values in API version 55.0 and later. | #### See Also - [LiveChatObjectAccessDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatobjectaccessdefinition.htm "Represents the parent record for one or more LiveChatObjectAccessConfig objects. This object is available in API version 53.0 and later.") <!-- document id=70729634b113c8a71a928e216dde4b7bf5668a8cab6df1c9117474d45eea6230 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatobjectaccessdefinition.md --> # LiveChatObjectAccessDefinition Represents the parent record for one or more LiveChatObjectAccessConfig objects. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, enable Chat. To see the list of objects you can find or create in the UI using this API, enable the "Turns on findOrCreate in chat API" permission. You can find this permission in the Chat Settings page of the Setup UI. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The combined language and locale ISO code, which controls the language for labels displayed in an application. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for this object's record. This display value is the internal label that doesn’t get translated. | <!-- document id=eb721b1e72f821b7b256b6d4939747372d8cd00a6089d91c7060523e89f542df url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatsensitivedatarule.md --> # LiveChatSensitiveDataRule Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex). This object is available in API version 35.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), update(), retrieve() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field Name | Details | | --- | --- | | ActionType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The action to take on the text (remove or replace) when the sensitive data rule is triggered. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the sensitive data rule—for example, “Block social security numbers.” | | DeveloperName | Type string Properties 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | EnforceOn | Type int Properties Create, Filter, Group, Sort, Update Description Determines the roles on which the rule is enforced. The value is determined using bitwise OR operation. There are seven possible values: 1. Rule enforced on Agent 2. Rule enforced on Visitor 3. Rule enforced on Agent and Visitor 4. Rule enforced on Supervisor 5. Rule enforced on Agent and Supervisor 6. Rule enforced on Visitor and Supervisor 7. Rule enforced on Agent, Visitor, and Supervisor | | IsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether a sensitive data rule is active (true) or not (false). Default value (if none is provided) is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the sensitive data rule. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for the sensitive data rule. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Pattern | Type textarea Properties Create, Update Description The pattern of text blocked by the rule. Written as a JavaScript regular expression (regex). | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the priority level of a Chat. | | Replacement | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The string of characters that replaces the blocked text (if ActionType Replace is selected). | ## Usage Use this object to mask or delete data of specified patterns, such as credit card, social security, phone and account numbers, or even profanity. <!-- document id=1a9fc7b1a7f0f623792f04835b71b0caa961754c01b260931989a274276ff200 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechattranscript.md --> # LiveChatTranscript This object is automatically created for each Live Agent chat session and stores information about the session. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Abandoned | Type int Properties Filter, Group, Nillable, Sort Description The amount of time in seconds an incoming chat request remained unanswered by an agent before the chat was disconnected by the customer. | | AccountId | Type ID Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the account associated with the chat transcript. | | AverageResponseTimeOperator | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The agent’s average response time (in seconds) to chat messages from the visitor. | | AverageResponseTimeVisitor | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The visitor’s average response time (in seconds) to chat messages from the agent. | | Body | Type textarea Properties Create, Nillable, Update Description The contents of the chat. | | Browser | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The browser the visitor used for the chat. | | BrowserLanguage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The language of the visitor’s browser. | | CaseID | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the case associated with the chat transcript. | | ChatDuration | Type int Properties Filter, Group, Nillable, Sort Description The total duration of the chat in seconds. | | ChatKey | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort Description The session ID of the chat before it is persisted. ChatKey can be used with advanced integrations in the Salesforce console. This field is available in API version 25.0 and later. | | ContactID | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the contact associated with the chat transcript. | | EndedBy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The way the chat was ended: by the operator, the visitor, or the system. | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time the chat ended. | | IpAddress | Type string Properties Create, Filter, Nillable, Sort, Update Description The auto-populated visitor’s IP address. Do not edit. Create a custom field if you need an IP address field for your use case. | | IsChatbotSession | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the visitor is chatting with a chatbot (true) or not (false). | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | LeadID | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the lead associated with the chat transcript. | | LiveChatButtonID | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the LiveChatButton the chat session originated from. | | LiveChatDeploymentID | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the LiveChatDeployment the chat session originated from. | | LiveChatVisitorID | Type reference Properties Create, Filter, Group, Sort Description The ID of the visitor associated with the chat transcript. | | Location | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The auto-populated best-guess approximation of the visitor’s location. Do not edit. | | MaxResponseTimeOperator | Type int Properties Filter, Group, Nillable, Sort Description The maximum time in seconds it took an agent to respond to a chat visitor’s message. | | MaxResponseTimeVisitor | Type int Properties Filter, Group, Nillable, Sort Description The maximum time in seconds it took a customer to respond to an agent’s message. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the transcript. | | OperatorMessageCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of messages sent by one or more agents during the chat. | | OwnerID | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the operator who participated in the chat last; for missed chats, this is a system user. | | Platform | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The visitor’s operating system platform. | | ReferrerUri | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The auto-populated URI where the chat request originated. Do not edit. | | RequestTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time the visitor requested the chat. | | ScreenResolution | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The visitor’s screen resolution. | | SkillId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The auto-populated record ID of the primary Skill associated with the LiveChatButton the chat session originated from. Do not edit. To associate multiple skills with a LiveChatTranscript, use LiveChatTranscriptSkill junction objects. | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time the chat started. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The final status of the chat: completed, missed, or blocked. | | SupervisorTranscriptBody | Type textarea Properties Create, Nillable, Update Description The text body of the supervisor’s chat transcript. | | UserAgent | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The visitor’s user agent string. | | VisitorMessageCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of messages sent by the visitor during the chat. | | VisitorNetwork | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The network or service provider the chat visitor used for the chat. | | WaitTime | Type int Properties Filter, Group, Nillable, Sort Description The total amount of time in seconds a chat request was waiting to be accepted by an agent. | ## Usage Use this object to query and manage live chat transcripts. ## 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. [LiveChatTranscriptChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [LiveChatTranscriptFeed](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.") (API version 47.0) Feed tracking is available for the object. [LiveChatTranscriptHistory](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. [LiveChatTranscriptOwnerSharingRule](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.") (API version 29.0) Sharing rules are available for the object. [LiveChatTranscriptShare](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. <!-- document id=389c8abc1114bf397edbc798b665595ad0f830cc852b260ce48ecf0fb16f7a38 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechattranscriptevent.md --> # LiveChatTranscriptEvent Captures specific events that occur over the lifetime of a chat. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AgentId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the agent associated with the event. | | Detail | Type string Properties Create, Filter, Group, Nillable, Sort Description Details associated with the event. | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | LastViewedDate | Type date Properties Filter, Nillable, Sort, Update Description The 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. | | LiveChatTranscriptId | Type reference Properties Create, Filter, Group, Sort Description The ID of the live chat transcript associated with the event. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the event. | | Time | Type dateTime Properties Create, Filter, Sort Description The time at which the event happened. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The kind of event that occurred. - Accept—Accepted - AgentBlocked—Blocked by Agent - AlertCriticalWaitChat—Critical Wait Alert Time Reached - CancelBlocked—Cancel (Blocked) - CancelNoAgent—Cancel (No Agent) - CancelNoQueue—Cancel (No Queue) - CancelVisitor—Canceled by Visitor - ChasitorIdleTimeout—Visitor Idle Time-Out - ChasitorIdleTimeoutWarningCleared—Visitor Idle Time-Out Warning Cleared - ChasitorIdleTimeoutWarningTriggered—Visitor Idle Time-Out Warning Appeared - ChatRequest—Chat Requested - ChatResumedAfterTransfer—Chat resumed - ChatbotEndChat—Chatbot end chat - ChatbotEndedChatByAction—Conversation ended by automated action - ChatbotEstablished—Accepted by Chatbot - ChatbotNotEstablished—Chatbot Request Failed - ChoiceRoute—Routed (Choice) - ClearCriticalWaitChat—Critical Wait Alert Cleared - ConferenceRequest—Chat Conference Requested - ConferenceRequestCanceled—Chat Conference Canceled - ConferenceRequestDeclined—Chat Conference Declined - ConnectionTimeout—Visitor connection timed out. Available in API version 38.0 and later. - ConnectionWarning—Warning that visitor hasn't been connected for some time and that the connection times out soon. Available in API version 38.0 and later. - DeclineManual—Decline (Manual) - DeclineTimeout—Decline (Timeout) - EndAgent—Ended by Agent - EndVisitor—Ended by Visitor - Enqueue—Queued - FileCanceledAgent—File Transfer Canceled by Agent - FileCanceledChasitor—File Transfer Canceled by Visitor - FileTransferFailure—File Transfer Failure - FileTransferRequested—File Transfer Requested by Agent - FileTransferSuccess—File Transfer Success - FileTransferToChasitor—File Transfer Initiated by Agent - FlagLoweredAgent—Flag Lowered by Agent - FlagLoweredSupervisor—Flag Lowered by Supervisor - FlagRaised—Flag Raised - LeaveAgent—Agent Left - LeaveVisitor—Visitor Left - OperatorJoinedConference—Agent Joined Conference - OperatorLeftConference—Agent Left Conference - Other - PushAssignment—Routed (Push) - SensitiveDataAgent—Sensitive data blocked (Agent) - SensitiveDataSupervisor—Sensitive data blocked (Supervisor) - SensitiveDataVisitor—Sensitive data blocked (Visitor) - Transfer—Transfer Accepted - TransferCancelled—Transfer Request Canceled - TransferDeclined—Transfer Request Declined - TransferRequest—Transfer Requested - TransferToBotFailed—Transfer to bot failed - TransferToButtonFailed—Transfer to button failed - TransferToQueueFailed—Transfer to queue failed - TransferredToBot—Transferred to bot - TransferredToButton—Transferred to button - TransferredToQueue—Transferred to queue - TransferredToSbrSkill—Transferred to skill - TransferredToSbrSkillFailed—Transfer to skill failed - Unassigned | ## Usage Use this object to query and manage live chat transcript events. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note LiveChatTranscriptEvent records are inserted after the chat is closed and the LiveTranscript record updated). However, the trigger on the LiveChatTranscriptEvent sObject fires separately on each LiveChatTranscriptEvent record within the same transaction. All the LiveChatTranscriptEvent records are inserted in a single transaction but one by one. For example, the trigger is executed for each individual record. trigger LCTE on LiveChatTranscriptEvent (before insert) { // Trigger.New will have only 1 record at a time and trigger will execute for individual record for(LiveChatTranscriptEvent l : Trigger.New) system.debug(l.Type + '>>' +l.Detail); } To avoid hitting any governors and limits, design your functionality considering this behavior. You can execute the logic by filtering the records based on the Type field of LiveChatTranscriptEvent. ## 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. [LiveChatTranscriptChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. <!-- document id=c90baa61235386750546c90b29bb971d0dc4a2cebd0134392abe95c417dae48d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechattranscriptshare.md --> # LiveChatTranscriptShare Represents a sharing entry on a LiveChatTranscript object. This object is available in API version 24.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), query(), retrieve()update(), upsert() ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field Name | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the LiveChatTranscript. The possible values are: - Read - Edit - All (This value is not valid for create() or update() calls.) This value must be set to an access level that is higher than the organization’s default access level for live chat transcripts. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent object, if any | | RowCause | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Values can include: - Manual—The User or Group has access because a user with “All” access manually shared the LiveChatTranscript with them. - Owner—The User is the owner of the LiveChatTranscript or is in a role above the LiveChatTranscript owner in the role hierarchy. | | UserOrGroupID | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the LiveChatTranscript. | ## Usage This object lets you determine which users and groups can view and edit LiveChatTranscript records owned by other users. If you attempt to create a new record that matches an existing record, the create() call updates any modified fields and returns the existing record. <!-- document id=7919af042c35da0ce69b7e23c902e0b750e733028209bb2c0554a07e5e63fd81 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechattranscriptskill.md --> # LiveChatTranscriptSkill Represents a join between LiveChatTranscript and Skill. This object is available in API version 25.0 and later. ## Supported Calls create(), delete(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the transcript. | | SkillId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the skill. | | TranscriptId | Type reference Properties Create, Filter, Group, Sort Description The record ID of the transcript. | ## Usage Use this object to assign a specific skill to a specific transcript for multi-skill routing. <!-- document id=b22987e6195ed3b75d2f93220e2dffd131fcba57e79e1b205db6c1f82efa57f2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatuserconfig.md --> # LiveChatUserConfig Represents a setting that controls the console settings for Chat users. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field Name | Details | | --- | --- | | AutoGreeting | Type textarea Properties Create, Nillable Description The text that is automatically sent from an agent to a visitor when a chat session starts. | | Capacity | Type int Properties Create, Filter, Group, Nillable, Sort Description Limits the amount of active chat sessions an agent can engage in. | | CriticalWaitTime | Type int Properties Create, Filter, Group, Nillable, Sort Description The amount of time before a chat flashes to alert an agent to answer it. | | CustomAgentName | Type string Properties Create, Filter, Group, Nillable, Sort Description The custom name of the agent associated with the Live Agent configuration. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | HasLogoutSound | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Determines whether a sound plays when an agent logs out of the console. | | HasNotifications | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Determines whether desktop notifications are enabled for the configuration. Available in API version 25.0 and later. | | HasRequestSound | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Determines whether a sound plays when a chat request comes in. | | HasSneakPeek | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Determines whether an agent sees a real-time preview of the messages typed by a visitor. | | HasTransferConferenceGreeting | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether to enable sending an autogreeting when you transfer to another agent or invite an agent to a conference chat. The default value is false. Available in API version 53.0 and later. | | IsAutoAwayOnDecline | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Determines whether agents’ status is automatically changed to Away when they decline a chat request. Available in API version 26.0 and later. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the configuration. | | MasterLabel | Type string Properties Create, Filter, Group, Sort Description The name of the configuration. | | OptionsHasAgentFileTransfer | Type boolean Properties Create, Filter Description Determines whether agents can initiate a file transfer from a chat customer. Available in API version 31.0 and later. | | OptionsHasAgentSneakPeek | Type boolean Properties Create, Filter Description Determines whether Sneak Peek is enabled for agents. Available in API version 29.0 and later. | | OptionsHasAssistanceFlag | Type boolean Properties Create, Filter Description Determines whether assistance flags are enabled for agents. Available in API version 29.0 and later. | | OptionsHasChatConferencing | Type boolean Properties Create, Filter Description Determines whether agents can invite other agents into a customer chat. Available in API version 34.0 and later. | | OptionsHasChatMonitoring | Type boolean Properties Create, Filter Description Determines whether supervisors can view agents’ ongoing chats. Available in API version 29.0 and later. | | OptionsHasChatTransferToAgent | Type boolean Properties Create, Filter Description Specifies whether an agent can transfer a chat directly to another agent. Available in API version 36.0 and later. | | OptionsHasChatTransferToButton | Type boolean Properties Create, Filter Description Specifies whether an agent can transfer a chat to an agent assigned to a particular chat button. Available in API version 36.0 and later. | | OptionsHasChatTransferToSkill | Type boolean Properties Create, Filter Description Specifies whether an agent can transfer a chat to agents assigned to a particular skill. Available in API version 36.0 and later. | | OptionsHasTransferConferenceGreeting | Type boolean Properties Create, Filter, Update Description Specifies whether an agent can transfer a chat to an autogreeting or conference greeting. Available in API version 53.0 and later. | | OptionsHasVisitorBlocking | Type boolean Properties Create, Filter Description Determines whether an agent can block IP addresses of troublesome visitors. Available in API version 34.0 and later. | | OptionsHasWhisperMessage | Type boolean Properties Create, Filter Description Determines whether supervisors can send private messages to agents within an agent’s chat with a customer. Available in API version 29.0 and later. | | OptionsIsAutoAwayOnPushTimeout | Type boolean Properties Create, Filter Description Determines whether an agent’s status automatically changes to Away if the agent doesn’t respond to a chat request within the specified push time-out limit. Available in API version 34.0 and later. | | SupervisorDefaultAgentStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The default agent status by which to filter agents in the Agent Status list in the supervisor panel. | | SupervisorDefaultButtonId | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The default button ID by which to filter agents in the Agent Status list in the supervisor panel. | | SupervisorDefaultSkillId | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The default skill ID by which to filter agents in the Agent Status list in the supervisor panel. | ## Usage Use this object to query and manage agent configurations in Chat. <!-- document id=bd493ac01612d851344cf4db39e1b4774531e300ceec240b39688c2292c712ac url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatuserconfigprofile.md --> # LiveChatUserConfigProfile Represents a join between LiveChatUserConfig and Profile. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field Name | Details | | --- | --- | | LiveChatUserConfigId | Type reference Properties Create, Filter, Group, Sort Description The record ID of the agent configuration | | ProfileId | Type reference Properties Create, Filter, Group, Sort Description The record ID of the profile | ## Usage Use this object to assign specific agent configurations to specific user profiles. <!-- document id=13433f57d9c0535fece35dad6122b121a9913cb0c391ee4281d60ab843278176 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatuserconfiguser.md --> # LiveChatUserConfigUser Represents a join between Live Chat User Config and User. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field Name | Details | | --- | --- | | LiveChatUserConfigId | Type reference Properties Create, Filter, Group, Sort Description The record ID of the agent configuration | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the user | ## Usage Use this object to assign specific agent configurations to specific users. <!-- document id=038115fe13ecd55405ba372935e775888c8f4b17a8621992ac7d3cd89c99b2fe url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_livechatvisitor.md --> # LiveChatVisitor Represents a website visitor who has started or tried to start a chat session. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | LastViewedDate | Type date Properties Filter, Nillable, Sort, Update Description The 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. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The name of the visitor | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The session key used to uniquely identify the visitor. | ## Usage Use this object to query and manage live chat visitors. ## 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. [LiveChatVisitorChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. <!-- document id=af57bd819bfddda94417655ff341de5ad3039d4ad0135fb0d8dd796987a3de62 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_location.md --> # Location Represents a warehouse, service vehicle, work site, or other element of the region where your team performs field service work. In API version 49.0 and later, you can associate activities with specific locations. Activities, such as the tasks and events related to a location, appear in the activities timeline when you view the location detail page. Also in API version 49.0 and later, Work.com users can view Employees as a related list on Location records. In API version 51.0 and later, this object is available for Omnichannel Inventory and represents physical locations where inventory is available for fulfilling orders. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules At least one of these features must be enabled: - Commerce Store - Contact Tracing for Employees - Employee Experience - Field Service - Fulfillment Orders - Health Cloud - Industries Insurance - Industries Visit - Locations - Omnichannel Inventory - Public Sector - Retail Execution - Work.com ## Fields | Field Name | Details | | --- | --- | | AssignedFoCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of fulfillment orders assigned to the location. Confirming held fulfillment order capacity increments this value. To reset the location’s capacity, set this value to 0. This field is available when Order Management is installed and configured. By default, it’s hidden by field-level security. This field is available in API version 55.0 and later. | | CloseDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date the location closed or went out of service. | | ConstructionEndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date construction ended at the location. | | ConstructionStartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date construction began at the location. | | DefaultPickupTime | Type time Properties Create, Filter, Group, Nillable, Sort, Update Description Default pickup time at the location. This field is available when Order Management is installed and configured. By default, it’s hidden by field-level security. This field is available in API version 61.0 and later. | | DefaultProcessingTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Default processing time at the location. This field is available when Order Management is installed and configured. By default, it’s hidden by field-level security. This field is available in API version 61.0 and later. | | DefaultProcessingTimeUnit | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Default processing time unit at the location. Possible values are: - Hours - Days - Weeks This field is available when Order Management is installed and configured. By default, it’s hidden by field-level security. This field is available in API version 61.0 and later. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of the location. | | DrivingDirections | Type string Properties Create, Filter, Nillable, Sort, Update Description Directions to the location. | | EarliestPickupTimeOffset | Type integer Properties Create, Filter, Nillable, Sort, Update Description The earliest pickup time for BOPIS. This value is measured in minutes after the start of business hours. | | ExternalReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Identifier of a location. | | FoCapacity | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of fulfillment orders that can be assigned to the location per time period. If this value is null, then this location’s capacity isn’t limited. This field is available when Order Management is installed and configured. By default, it’s hidden by field-level security. This field is available in API version 55.0 and later. | | FulfillingBusinessHours | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Fulfilling business hours at the location. This field is available when Order Management is installed and configured. By default, it’s hidden by field-level security. This field is available in API version 61.0 and later. | | FoCapacity | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of fulfillment orders that can be assigned to the location per time period. If this value is null, then this location’s capacity isn’t limited. This field is available when Order Management is installed and configured. By default, it’s hidden by field-level security. This field is available in API version 55.0 and later. | | IsEligibleForPickup | Type boolean Properties Create, Filter, Nillable, Sort, Update Description Indicates whether the location supports BOPIS | | IsInventoryLocation | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the location stores parts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field must be selected if you want to associate the location with product items. | | IsMobile | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the location moves. For example, a truck or tool box. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The date when the location was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The date the location was last viewed. | | LatestPickupTimeOffset | Type integer Properties Create, Filter, Nillable, Sort, Update Description The latest pickup time for BOPIS. This value is measured in minutes before the end of business hours. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude of the location. | | Location | Type location Properties Nillable Description The geographic location. | | LocationLevel | Type int Properties Filter, Group, Nillable, Sort Description The location’s position in a location hierarchy. If the location has no parent or child locations, its level is 1. Locations that belong to a hierarchy have a level of 1 for the root location, 2 for the child locations of the root location, 3 for their children, and so forth. | | LocationType | Type picklist Properties Create, Filter, Group, Sort, Update Description Picklist of location types. It has no default values, so you must populate it before creating any location records. | | LogoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A ContentAsset representing a logo for the location. This field is available in API version 50.0 and later. This is a relationship field. Relationship Name Logo Relationship Type Lookup Refers To ContentAsset | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude of the location. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the location. For example, Service Van #4. | | OpenDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date the location opened or came into service. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The location’s owner or driver. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location’s parent location. For example, if vans are stored at a warehouse when not in service, the warehouse is the parent location. This is a relationship field. Relationship Name ParentLocation Relationship Type Lookup Refers To Location | | PickupProcessingTime | Type integer Properties Create, Filter, Nillable, Sort, Update Description The processing time required for BOPIS orders at this location. | | PossessionDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the location was purchased. | | Priority | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The priority of the location when routing orders. No default values are included. Add values to the picklist and reference them in your custom routing logic. This field is available when Order Management is installed and configured. By default, it’s hidden by field-level security. This field is available in API version 55.0 and later. | | RemodelEndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when remodel construction ended at the location. | | RemodelStartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when remodel construction started at the location. | | RootLocationId | Type reference Properties Filter, Group, Nillable, Sort Description (Read Only) The top-level location in the location’s hierarchy. This is a relationship field. Relationship Name RootLocation Relationship Type Lookup Refers To Location | | ShouldSyncWithOci | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the location should sync its data with Omnichannel Inventory. The default value is false. This field is available in API version 51.0 and later. | | ShouldTrackFoCapacity | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the location should track its fulfillment order capacity. The default value is false. This field is available when Order Management is installed and configured. By default, it’s hidden by field-level security. This field is available in API version 55.0 and later. | | TimeZone | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Picklist of available time zones. | | VisitorAddressId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup to an account’s or client’s address. This is a relationship field. Relationship Name VisitorAddress Relationship Type Lookup Refers To Address | ## Usage Before creating any location records, add at least one value to the Location Type picklist. LocationType is a required field. To track your inventory in Salesforce, create product items, which represent the stock of a particular product a particular location. For example, create a product item that represents the 500 bolts you have in stock at your Warehouse A location. Each product item must be associated with a location. To get a more granular picture of your field service operation, associate locations with service territories. For example, if a warehouse is located in a particular service territory, add it as a service territory location. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important “Location” in Salesforce can also refer to the geolocation compound field found on many standard objects. When referencing the Location object in your Apex code, always use Schema.Location instead of Location to prevent confusion with the standard Location compound field. If referencing both the Location object and the Location field in the same snippet, you can differentiate between the two by using System.Location for the field and Schema.Location for the object. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [LocationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [LocationFeed](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. [LocationHistory](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. [LocationOwnerSharingRule](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. [LocationShare](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. #### See Also - [LocationGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationgroup.htm "Represents a group of Omnichannel Inventory locations, providing an aggregate view of inventory availability across those locations. Omnichannel Inventory can create an inventory reservation for an order at the location group level, then assign the reservation to one or more locations in the group as needed. This object is available in API version 51.0 and later.") - [LocationGroupAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationgroupassignment.htm "Represents the assignment of a location to a location group. This object is available in API version 51.0 and later.") - [_B2B Commerce and D2C Commerce Developer Guide_: Inventory Data Model](https://developer.salesforce.com/docs/commerce/salesforce-commerce/guide/b2b-b2c-comm-data-model-inventory.html " B2B Commerce and D2C Commerce Developer Guide: Inventory Data Model - HTML (New Window)") <!-- document id=a647db384ddb88188e444c95cb360c48e352d817697a3da2862e6d390fdff222 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_locationgroup.md --> # LocationGroup Represents a group of Omnichannel Inventory locations, providing an aggregate view of inventory availability across those locations. Omnichannel Inventory can create an inventory reservation for an order at the location group level, then assign the reservation to one or more locations in the group as needed. This object is available in API version 51.0 and later. You can define location groups according to the logic of your business needs. For example, a location group can represent the warehouses in a geographic region, or it can include the fulfillment centers associated with a particular online storefront. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Omnichannel Inventory orgs. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description Description of the location group. | | ExternalReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used when OCI is integrated with B2C Commerce to associate the location group with an inventory list in B2C Commerce. This value must match the inventory list ID in B2C Commerce. | | IsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the location group is in use. If set to false, then inventory functions ignore this location group and its data isn’t synchronized with OCI. The default value is true. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed. | | LocationGroupName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the location group. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this location group. Default value is the API user that created the record. | | ShouldSyncWithOci | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether to synchronize inventory data for this location group with Omnichannel Inventory. The default value is true. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [LocationGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [LocationGroupFeed](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. [LocationGroupHistory](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. [LocationGroupOwnerSharingRule](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. [LocationGroupShare](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. #### See Also - [Location](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_location.htm "Represents a warehouse, service vehicle, work site, or other element of the region where your team performs field service work. In API version 49.0 and later, you can associate activities with specific locations. Activities, such as the tasks and events related to a location, appear in the activities timeline when you view the location detail page. Also in API version 49.0 and later, Work.com users can view Employees as a related list on Location records. In API version 51.0 and later, this object is available for Omnichannel Inventory and represents physical locations where inventory is available for fulfilling orders.") - [LocationGroupAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationgroupassignment.htm "Represents the assignment of a location to a location group. This object is available in API version 51.0 and later.") - [_B2B Commerce and D2C Commerce Developer Guide_: Inventory Data Model](https://developer.salesforce.com/docs/commerce/salesforce-commerce/guide/b2b-b2c-comm-data-model-inventory.html " B2B Commerce and D2C Commerce Developer Guide: Inventory Data Model - HTML (New Window)") <!-- document id=6c3b34fbf65bb419c9cacf9c736d70c9d87cf6b99051ff4fc74187c7185bf277 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_locationgroupassignment.md --> # LocationGroupAssignment Represents the assignment of a location to a location group. This object is available in API version 51.0 and later. You can assign a location to multiple location groups, which associates it with one location group assignment for each location group that it’s assigned to. Each location group assignment represents the relationship between one location and one location group, so a location or location group can be associated with multiple location group assignments. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Omnichannel Inventory orgs. ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed. | | LocationExternalReference | Type string Properties Filter, Group, Nillable, Sort Description The external reference of the associated location. | | LocationGroupAssignment | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the location group assignment. | | LocationGroupExternalReference | Type string Properties Filter, Group, Nillable, Sort Description The external reference of the associated location group. | | LocationGroupId | Type reference Properties Create, Filter, Group, Sort Description (Master-Detail) The associated location group. | | LocationGroupName | Type string Properties Filter, Group, Nillable, Sort Description The location group name of the associated location group. | | LocationId | Type reference Properties Create, Filter, Group, Sort Description (Master-Detail) The associated location. | | LocationName | Type string Properties Filter, Group, Nillable, Sort Description The name of the associated location. | ## 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. [LocationGroupAssignmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. #### See Also - [Location](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_location.htm "Represents a warehouse, service vehicle, work site, or other element of the region where your team performs field service work. In API version 49.0 and later, you can associate activities with specific locations. Activities, such as the tasks and events related to a location, appear in the activities timeline when you view the location detail page. Also in API version 49.0 and later, Work.com users can view Employees as a related list on Location records. In API version 51.0 and later, this object is available for Omnichannel Inventory and represents physical locations where inventory is available for fulfilling orders.") - [LocationGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationgroup.htm "Represents a group of Omnichannel Inventory locations, providing an aggregate view of inventory availability across those locations. Omnichannel Inventory can create an inventory reservation for an order at the location group level, then assign the reservation to one or more locations in the group as needed. This object is available in API version 51.0 and later.") <!-- document id=97c8aaf5d2d4b4c8a73939e5f7e7eded2322f496b35ac9897c99d49414b337dc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_locationshippingcarriermethod.md --> # LocationShippingCarrierMethod The available shipping carrier services associated with a location or location group. Allows the assignment of different shipping methods to a specific location and enables flexibility and customization in the shipping process. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The LocationShippingCarrierMethod object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the record was last viewed. | | LocationSourceId | Type reference Properties Create, Filter, Group, Sort, Update Description The location source ID. This is a polymorphic relationship field. Relationship Name LocationSource Refers To Location, LocationGroup | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the shipping carrier service associated with the location or location group. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who currently owns this LocationShippingCarrierMethod object. Default value is the user logged in to the API to perform the create. This is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | PickupTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The time when the shipping carrier picks up the order from the associated location or location group. This field is available in API version 66.0 and later. | | ShippingCarrierMethodId | Type reference Properties Create, Filter, Group, Sort, Update Description Shipping carrier method ID. This is a relationship field. Relationship Name ShippingCarrierMethod Refers To Location, ShippingCarrierMethod | <!-- document id=431d1842badb38277003d90dbf38d96df0387e15df4644d8544eb27c5fa2217f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_locationtrustmeasure.md --> # LocationTrustMeasure Represents the COVID safety protocols that your business follows. For example, enforcement of masks, social distancing, cleanliness, and capacity limits. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Sort, Update Description A brief description of the safety protocol. For example, “Employees and customers are required to wear a mask in the store.” | | IconUrl | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A public image URL to display for the LocationTrustMeasure object. | | IsVisibleInPublic | Type boolean Properties Create, defaulted on create, Filter, Group, Sort, Update Description If true, displays the LocationTrustMeasure object on your site. If false, hides the LocationTrustMeasure object on your site. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The date on which the record was last viewed. | | LocationExternalReference | Type string Properties Filter, Group, Nillable, Sort Description An ID assigned to the LocationTrustMeasure objects for a particular location. | | LocationId | Type reference Properties Create, Filter, Group, Sort, Update Description The unique ID for the location associated with the LocationTrustMeasure. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-assigned name for the LocationTrustMeasure. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner for this record. | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The order in which to display LocationTrustMeasure objects on your site. | | Title | Type string Properties Create, Filter, Group, Sort, Update Description The name of the safety protocol. For example, Enforcement of Masks. | <!-- document id=8ffdba16c65f66fcabc567fe88536f8d49c4feee1c66b3846c55d6d49b37cf8f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_locationwaitlist.md --> # LocationWaitlist Represents a queue created for a specific location. Multiple queues can be created for a single location. For example, you can have a queue for each sales agent or a standard queue and a queue for vulnerable groups. The specific party of people in a queue is represented by LocationWaitlistedParty. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BusinessHoursId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the BusinessHours record that contains the hours the business is open. | | ClosedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time a queue is closed. | | CumulativeGuestCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of guests allowed. | | CumulativeGuestGroupCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of groups allowed. | | CurrentGuestCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The current number of guests. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of this record. | | GuestCapacity | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total capacity of guests. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The date on which the record was last viewed. | | MaxPartySize | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum size of a group. | | MessagingChannelId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The messaging channel ID. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the group. | | OpenDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time a queue is open. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner for this record. | | PartyReminderDelayMinutes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of minutes between when a party is notified and when they receive a reminder. | | PlaceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location ID for this record. | | ResourceCapacity | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The capacity for this resource. | | ResourceOccupancyCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The occupancy count for this resource. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the queue. Possible values are: - closed - open - paused | <!-- document id=034098d383c2947180d1dfbabfc4353a66303e0723ba1e61e86ae87c042ee351 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_locationwaitlistedparty.md --> # LocationWaitlistedParty Represents a specific party of people waiting in a queue. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A brief description of this queue. | | EntryDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time a party is added to the queue. | | EstimatedWaitHours | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The estimated hours of wait time for a party. | | EstimatedWaitMinutes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The estimated minutes of wait time for a party. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The date on which the record was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the group. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner for this record. | | PartySize | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The size of the queued party. | | PartyStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The state of a party in the queue. Possible values are: - canceled - entered - exited - ready - waiting | | SignUpDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when a party signed up for the queue. | | WaitlistId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID for the queue. | <!-- document id=170319d361e2a2604a93163d7b62511fb02bce5baf2bec99dac9fc6856911e82 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_locwaitlistmsgtemplate.md --> # LocWaitlistMsgTemplate Represents a junction object connecting LocationWaitlist to MessagingTemplate. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The date on which the record was last viewed. | | LocationWaitlistId | Type reference Properties Create, Filter, Group, Sort, Update Description Reference to the LocationWaitlist record. | | MessagingTemplateId | Type reference Properties Create, Filter, Group, Sort, Update Description Reference to the MessagingTemplate record. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner for this record. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the queue. Possible values are: - approaching—In Progress - confirmation—Confirmed - inactive—Inactive - ready—Ready - removed—Removed | <!-- document id=e94775ad4e07dd78b85ff11aef19b2fb24726d8da142076000d656411c50af4f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_loginas.md --> # Login As Event Type Login As events contain details about what a Salesforce admin did while logged in as another user. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Login As Event Type is used by EventLogFile (ELF). It isn’t a real-time event. For the LoginAsEvent real-time event, which is part of Real-Time Event Monitoring (RTEM), see [LoginAsEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_loginasevent.htm "HTML (New Window)") in the Platform Events Developer Guide. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Bolster your security posture by receiving alerts and blocking potentially malicious LoginAsEvent activities with a Transaction Security policy. ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_IP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.</dd><dd class="dd">For example: <samp class="codeph nolang">96.43.144.26</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CPU_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DELEGATED_USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the user who’s using Salesforce services through the UI or API. In this case, the user who’s doing the impersonation.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DELEGATED_USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or API. In this case, the user who’s doing the impersonation.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DELEGATED_USER_NAME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The username of the user who’s using Salesforce services through the UI or API. In this case, the user who’s doing the impersonation.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="event-type-desc"><a name="event-type-desc"></a>The type of event.</span> The value is always <samp class="codeph nolang">LoginAs</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LOGIN_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.</dd><dd class="dd">For example: <samp class="codeph nolang">GeJCsym5eyvtEK2I</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the organization.</dd><dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">RUN_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The amount of time that the request took in milliseconds.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.</dd><dd class="dd">For example: <samp class="codeph nolang">d7DEq/ANa7nNZZVD</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd><dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. Timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The URI of the page that’s receiving the request.</dd><dd class="dd">For example: <span class="keyword parmname">/home/home.jsp</span>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">ID</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the URI of the page that’s receiving the request.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00530000009M943</samp></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00590000000I1SNIA0</samp>.</dd></dl></td></tr></tbody></table> #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=a331a6dc9310f7e083980e0cc7ee3224e73724a91b8480095387e68b8f5b47bd url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_login.md --> # Login Event Type Login events contain details about your org’s user login history. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The Login event type is used by EventLogFile (ELF). It isn’t a real-time event. For the LoginEvent real-time event, which is part of Real-Time Event Monitoring (RTEM), see [LoginEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_loginevent.htm "HTML (New Window)") in the Platform Events Developer Guide. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or the [REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""> <tbody class="tbody"> <tr> <td class="entry"><strong class="ph b">Field</strong></td> <td class="entry"><strong class="ph b">Details</strong></td> </tr> <tr> <td class="entry"><span class="keyword parmname">API_TYPE</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of API request.</dd> <dd class="dd">Possible values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">D</samp>—Apex Class </li> <li class="li"> <samp class="codeph nolang">E</samp>—SOAP Enterprise </li> <li class="li"> <samp class="codeph nolang">M</samp>—SOAP Metadata </li> <li class="li"> <samp class="codeph nolang">P</samp>—SOAP Partner </li> <li class="li"> <samp class="codeph nolang">S</samp>—SOAP Apex </li> <li class="li"> <samp class="codeph nolang">T</samp>—SOAP Tooling </li> <li class="li"> <samp class="codeph nolang">f</samp>—Feed </li> <li class="li"> <samp class="codeph nolang">l</samp>—Live Agent </li> <li class="li"> <samp class="codeph nolang">p</samp>—SOAP ClientSync </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">API_VERSION</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The version of the API that’s being used.</dd> <dd class="dd">For example: <samp class="codeph nolang">36.0</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">AUTHENTICATION_CONTEXT_CLASS_REFERENCE</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">If provided by a third-party identity provider, the authentication method indicated in the Authentication Context Class Reference (ACR) claim.<ul class="ul bulletList"> <li class="li">SAML providers—Stores the value of the <samp class="codeph nolang">AuthnContextClassRef</samp> statement in the SAML response.</li> <li class="li">OpenID Connect providers—Stores the value of the ACR claim in the ID token </li> </ul> This field is available in API version 66.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">AUTHENTICATION_METHOD_REFERENCE</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">If provided by a third-party identity provider, the authentication method indicated in the Authentication Method Reference (AMR) claim.<ul class="ul bulletList"> <li class="li">SAML providers—Stores the value of any attribute named <samp class="codeph nolang">AMR</samp> or <samp class="codeph nolang">authmethodsreferences</samp> in the SAML response. </li> <li class="li">OpenID Connect providers—Stores the value of the AMR claim in the ID token.</li> </ul> </dd> <dd class="dd"> This field is available in API version 51.0 and later.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">AUTHENTICATION_SERVICE_ID</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Id</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The 15-character ID for the authentication service used to log in. This field stores IDs for these authentication services.<ul class="ul bulletList"> <li class="li">SAML single sign-on providers</li> <li class="li">Token exchange handlers</li> </ul> </dd> </dl> <p class="p">Available in API version 60.0 and later.</p> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">BROWSER_TYPE</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The identifier string returned by the browser used at login.</dd> <dd class="dd">Example values are:<ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">Go-http-client/1.1</samp></li> <li class="li"><samp class="codeph nolang">Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv%3A50.0) Gecko/20100101 Firefox/50.0</samp></li> <li class="li"><samp class="codeph nolang">Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36</samp></li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">CIPHER_SUITE</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The TLS cipher suite used for the login. Values are OpenSSL-style cipher suite names, with hyphen delimiters. For more information, see <a class="xref" href="https://www.openssl.org/source/" target="_blank" title="HTML (New Window)">OpenSSL Cryptography and SSL/TLS Toolkit</a>.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">CLIENT_IP</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="client-ip-desc"><a name="client-ip-desc"><!-- --></a>The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.</span></dd> <dd class="dd"> <span class="ph" id="client-ip-ex"><a name="client-ip-ex"><!-- --></a>For example: <samp class="codeph nolang">96.43.144.26</samp></span>. </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">COUNTRY_CODE</span></td> <td class="entry"> <a name="dl_sdc_wsq_xgc"><!-- --></a> <dl class="dl detailList" id="dl_sdc_wsq_xgc"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The country code associated with the IP address of the user logging in.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">CPU_TIME</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Number</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">DB_TOTAL_TIME</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Number</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and <span class="keyword parmname">DB_CPU_TIME</span>. Compare this field to <span class="keyword parmname">CPU_TIME</span> to determine whether performance issues are occurring in the database layer or in your own code.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="event-type-desc"><a name="event-type-desc"><!-- --></a>The type of event.</span> The value is always <samp class="codeph nolang">Login</samp>. </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">FORWARDED_FOR_IP</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The value in the <samp class="codeph nolang">X-Forwarded-For</samp> header of HTTP requests sent by the client. For logins that use one or more HTTP proxies, the <samp class="codeph nolang">X-Forwarded-For</samp> header is sometimes used to store the origin IP and all proxy IPs.</dd> <dd class="dd">The <span class="keyword parmname">FORWARDED_FOR_IP</span> field stores whatever value the client sends, which might not be an IP address. The maximum length is 256 characters. Longer values are truncated. The <span class="keyword parmname">FORWARDED_FOR_IP</span> field isn’t populated for logins completed via OAuth flows or single sign-on (SSO). </dd> <dd class="dd"> <p class="p">Available in API version 61.0 and later.</p> </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">HTTP_REFERER</span></td> <td class="entry"> <a name="dl_zzl_ltq_xgc"><!-- --></a> <dl class="dl detailList" id="dl_zzl_ltq_xgc"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The referring URI of the page that’s receiving the request.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">LOGIN_KEY</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.</dd> <dd class="dd">For example: <samp class="codeph nolang">GeJCsym5eyvtEK2I</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">LOGIN_STATUS</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The status of the login attempt. For successful logins, the value is LOGIN_NO_ERROR. All other values indicate errors or authentication issues. For details, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_login_status.htm" title="When users attempt to log in to your org, the success or failure of their login attempts is tracked in event log file data. Specifically, the LOGIN_STATUS field in the Login event type contains the result of these login attempts. The data in LOGIN_STATUS can help you determine whether your users’ login attempts were successful. This field is available in the Login event type in the EventLogFile object in API version 39.0 and later.">Login Event Type — LOGIN_STATUS Values</a>.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">LOGIN_SUB_TYPE</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable, Restricted picklist</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="def_loginsubtype"><a name="def_loginsubtype"><!-- --></a>The type of login flow used.</span> See the <span class="keyword parmname">LoginSubType</span> field of <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_loginhistory.htm" target="_blank">LoginHistory</a> in the Object Reference guide for the list of possible values. <p class="p">Label is <strong class="ph uicontrol">Login Subtype</strong>. </p> </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">LOGIN_TYPE</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of login used to access the session.</dd> <dd class="dd">Possible values are:<ul class="ul bulletList"> <li class="li"> <samp class="codeph nolang">7</samp>—AppExchange </li> <li class="li"> <samp class="codeph nolang">A</samp>—Application </li> <li class="li"> <samp class="codeph nolang">s</samp>—Certificate-based login </li> <li class="li"> <samp class="codeph nolang">k</samp>—Chatter Communities External User </li> <li class="li"> <samp class="codeph nolang">n</samp>—Chatter Communities External User Third Party SSO </li> <li class="li"> <samp class="codeph nolang">x</samp>—Cross Tenant Login (for internal use only) </li> <li class="li"> <samp class="codeph nolang">r</samp>—Employee Login to Community </li> <li class="li"> <samp class="codeph nolang">z</samp>—Lightning Login </li> <li class="li"> <samp class="codeph nolang">l</samp>—Networks Portal API Only </li> <li class="li"> <samp class="codeph nolang">6</samp>—Remote Access Client </li> <li class="li"> <samp class="codeph nolang">i</samp>—Remote Access 2.0 </li> <li class="li"> <samp class="codeph nolang">I</samp>—Other Apex API </li> <li class="li"> <samp class="codeph nolang">R</samp>—Partner Product </li> <li class="li"> <samp class="codeph nolang">w</samp>—Passwordless Login </li> <li class="li"> <samp class="codeph nolang">3</samp>—Customer Service Portal </li> <li class="li"> <samp class="codeph nolang">q</samp>—Partner Portal Third-Party SSO </li> <li class="li"> <samp class="codeph nolang">9</samp>—Partner Portal </li> <li class="li"> <samp class="codeph nolang">5</samp>—SAML Idp Initiated SSO </li> <li class="li"> <samp class="codeph nolang">m</samp>—SAML Chatter Communities External User SSO </li> <li class="li"> <samp class="codeph nolang">b</samp>—SAML Customer Service Portal SSO </li> <li class="li"> <samp class="codeph nolang">c</samp>—SAML Partner Portal SSO </li> <li class="li"> <samp class="codeph nolang">h</samp>—SAML Site SSO </li> <li class="li"> <samp class="codeph nolang">8</samp>—SAML Sfdc Initiated SSO </li> <li class="li"> <samp class="codeph nolang">E</samp>—SelfService </li> <li class="li"> <samp class="codeph nolang">j</samp>—Third Party SSO </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">LOGIN_URL</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The URL of the login page. </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Id</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The 15-character ID of the organization.</dd> <dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">REQUEST_ID</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"><span class="ph" id="request-id-desc"><a name="request-id-desc"><!-- --></a>The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</span></dd> <dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">REQUEST_STATUS</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The status of the request for a page view or user interface action. </dd> <dd class="dd">For example:<a name="ul_wgy_1rf_4q"><!-- --></a> <ul class="ul bulletList" id="ul_wgy_1rf_4q"> <li class="li"> <samp class="codeph nolang">S</samp>—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. </li> <li class="li"> <samp class="codeph nolang">F</samp>—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. </li> <li class="li"> <samp class="codeph nolang">U</samp>—Undefined </li> <li class="li"> <samp class="codeph nolang">A</samp>—Authorization Error </li> <li class="li"> <samp class="codeph nolang">R</samp>—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. </li> <li class="li"> <samp class="codeph nolang">N</samp>—Not Found. 404 error. </li> </ul> This field can have a blank value. </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">RUN_TIME</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Number</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The amount of time that the request took in milliseconds.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">SESSION_KEY</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For Login Event Type, this field is usually null because the event is captured before a session is created.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd">d7DEq/ANa7nNZZVD</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">SOURCE_IP</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">IP</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The IP address of the incoming client request that first reaches Salesforce during a login. For example, <samp class="codeph nolang">126.7.4.2</samp>. For clients that redirect through one or more HTTP proxies, this field stores the IP address of the first proxy to reach Salesforce. To better identify the origin IP for these cases, check the <span class="keyword parmname">FORWARDED_FOR_IP</span> field instead.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">TIMESTAMP</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The access time of Salesforce services in GMT.</dd> <dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">DateTime</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd> <dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. Time zone is GMT.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">TLS_PROTOCOL</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The TLS protocol used for the login.</dd> <dt class="dt dlterm">Example</dt> <dd class="dd">There are 3 possible values.<ul class="ul bulletList"> <li class="li">1.0</li> <li class="li">1.1</li> <li class="li">1.2</li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">URI</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The URI of the page that’s receiving the request.</dd> <dd class="dd">For example: <span class="keyword parmname">/home/home.jsp</span>.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">URI_ID_DERIVED</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">ID</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The 18-character case insensitive ID of the URI of the page that’s receiving the request.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">USE_API_TOKEN</span></td> <td class="entry"> <a name="dl_h2y_2tq_xgc"><!-- --></a> <dl class="dl detailList" id="dl_h2y_2tq_xgc"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Login with API Token - T token, or P password.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">USER_ID</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Id</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The 15-character ID of the user who’s using Salesforce services through the UI or the API.</dd> <dd class="dd">For example: <samp class="codeph nolang">00530000009M943</samp> </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">Id</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. </dd> <dd class="dd"> <span class="ph" id="user-id-derived-ex"><a name="user-id-derived-ex"><!-- --></a>For example: <samp class="codeph nolang">00590000000I1SNIA0</samp></span>. </dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">USER_NAME</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The username that’s used for login.</dd> </dl> </td> </tr> <tr> <td class="entry"><span class="keyword parmname">USER_TYPE</span></td> <td class="entry"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">String</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The category of user license.</dd> <dd class="dd">Possible values are:<a name="user-type-values"><!-- --></a> <ul class="ul bulletList" id="user-type-values"> <li class="li"> <samp class="codeph nolang">CsnOnly</samp>—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. </li> <li class="li"> <samp class="codeph nolang">CspLitePortal</samp>—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. </li> <li class="li"> <samp class="codeph nolang">CustomerSuccess</samp>—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. </li> <li class="li"> <samp class="codeph nolang">Guest</samp>—Users whose access is limited so that your customers can view and interact with your site without logging in. </li> <li class="li"> <samp class="codeph nolang">PowerCustomerSuccess</samp>—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. </li> <li class="li"> <samp class="codeph nolang">PowerPartner</samp>—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. </li> <li class="li"> <samp class="codeph nolang">SelfService</samp>—Users whose access is limited because they’re organization customers and access the application through a self-service portal. </li> <li class="li"> <samp class="codeph nolang">Standard</samp>—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. </li> </ul> </dd> </dl> </td> </tr> </tbody> </table> - **[Login Event Type — LOGIN\_STATUS Values](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_login_status.htm)** When users attempt to log in to your org, the success or failure of their login attempts is tracked in event log file data. Specifically, the LOGIN\_STATUS field in the Login event type contains the result of these login attempts. The data in LOGIN\_STATUS can help you determine whether your users’ login attempts were successful. This field is available in the Login event type in the EventLogFile object in API version 39.0 and later. #### See Also - [Login Event Type — LOGIN\_STATUS Values](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_login_status.htm "When users attempt to log in to your org, the success or failure of their login attempts is tracked in event log file data. Specifically, the LOGIN_STATUS field in the Login event type contains the result of these login attempts. The data in LOGIN_STATUS can help you determine whether your users’ login attempts were successful. This field is available in the Login event type in the EventLogFile object in API version 39.0 and later.") - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=aee905113a5d18ce9e7e3c83879c0ddd64961de307740f933019ac6d546bb3c3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_loginaseventlog.md --> # LoginAsEventLog LoginAsEventLog contains details about when a user logs in as another user in your org. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DelegatedUserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Unique ID that identifies the user who’s logging in as, or impersonating, another user. For example: 00530000009M943. | | DelegatedUsername | Type string Properties Filter, Group, Nillable, Sort Description The username of the user who’s logging in as, or impersonating, another user. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The impersonated user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For Login Event Type, this field is usually null because the event is captured before a session is created. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Unique ID that identifies the user who is being logged in as, or impersonated, by another user. For example: 005000000000123. | <!-- document id=81fad32b1ee2732b140e9179ba5f7d538f9d062061d2ea9890deb8df1078b214 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_loginevent.md --> # LoginEvent The documentation has moved to [LoginEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_loginevent.htm "HTML (New Window)") in the Platform Events Developer Guide. <!-- document id=329f2010a444260d5df3fce5b838ee9ce051e6b5bca5f992d161d53ab0ccea20 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_logineventlog.md --> # LoginEventLog Login event logs contain details about your Salesforce org's user login history. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ApiType | Type string Properties Filter, Group, Nillable, Sort Description The type of API request. Possible values are: - D—Apex Class - E—SOAP Enterprise - I—SOAP Cross Instance - M—SOAP Metadata - O—Old SOAP - P—SOAP Partner - S—SOAP Apex - T—SOAP Tooling - X—XmlRPC - f—Feed - l—Live Agent - p—SOAP ClientSync | | ApiVersion | Type int Properties Filter, Group, Nillable, Sort Description The version of the API that’s being used. For example: 36.0. | | AuthenticatedMethodReference | Type string Properties Filter, Group, Nillable, Sort Description The authentication method used by a third-party identification provider for an OpenID Connect single sign-on protocol. | | AuthenticationServiceIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The authentication service used for single sign-on. | | BrowserType | Type string Properties Filter, Group, Nillable, Sort Description The identifier string returned by the browser used at login. Example values are: - Go-http-client/1.1 - Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv%3A50.0) Gecko/20100101 Firefox/50.0 - Mozilla/5.0 (Macintosh; Intel Mac OS X 10\_11\_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36 | | CipherSuite | Type string Properties Filter, Group, Nillable, Sort Description The TLS cipher suite used for the login. Values are OpenSSL-style cipher suite names, with hyphen delimiters. For more information, see [OpenSSL Cryptography and SSL/TLS Toolkit](https://www.openssl.org/source/ "HTML (New Window)"). | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CountryCode | Type string Properties Filter, Group, Nillable, Sort Description A regional identifier for the login event. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DatabaseTotalTime. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | ForwardedForIp | Type string Properties Filter, Group, Nillable, Sort Description Reserved for future use. | | HttpReferer | Type string Properties Filter, Group, Nillable, Sort | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | LoginStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the login attempt. For successful logins, the value is LOGIN\_NO\_ERROR. All other values indicate errors or authentication issues. For details, see [Login Event Type — LOGIN\_STATUS Values](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_login_status.htm "When users attempt to log in to your org, the success or failure of their login attempts is tracked in event log file data. Specifically, the LOGIN_STATUS field in the Login event type contains the result of these login attempts. The data in LOGIN_STATUS can help you determine whether your users’ login attempts were successful. This field is available in the Login event type in the EventLogFile object in API version 39.0 and later."). | | LoginSubType | Type string Properties Filter, Group, Nillable, Sort Description The type of login flow used. Possible values are: - uiup—UI Username-Password - oauthpassword—OAuth Username-Password - oauthtoken—OAuth User-Agent - oauthhybridtoken—OAuth User-Agent for Hybrid Apps - oauthtokenidtoken—OAuth User-Agent with ID Token - oauthclientcredential—OAuth Client Credential - oauthcode—OAuth Web Server - oauthhybridauthcode—OAuth Web Server for Hybrid Apps | | LoginType | Type string Properties Filter, Group, Nillable, Sort Description The type of login used to access the session. Possible values are: - 7—AppExchange - A—Application - s—Certificate-based login - k—Chatter Communities External User - n—Chatter Communities External User Third Party SSO - r—Employee Login to Community - z—Lightning Login - l—Networks Portal API Only - 6—Remote Access Client - i—Remote Access 2.0 - I—Other Apex API - R—Partner Product - w—Passwordless Login - 3—Customer Service Portal - q—Partner Portal Third-Party SSO - 9—Partner Portal - 5—SAML Idp Initiated SSO - m—SAML Chatter Communities External User SSO - b—SAML Customer Service Portal SSO - c—SAML Partner Portal SSO - h—SAML Site SSO - 8—SAML Sfdc Initiated SSO - E—SelfService - j—Third Party SSO | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. Possible values are: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For Login Event Type, this field is usually null because the event is captured before a session is created. For example: d7DEq/ANa7nNZZVD. | | SourceIp | Type string Properties Filter, Group, Nillable, Sort Description The source IP of the login request. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | TransportLayerSecurityProtocol | Type string Properties Filter, Group, Nillable, Sort Description The TLS protocol used for the login. Possible values are: - 1.0 - 1.1 - 1.2 | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UseApiToken | Type string Properties Filter, Group, Nillable, Sort | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | Username | Type string Properties Filter, Group, Nillable, Sort Description The username that’s used for login. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | <!-- document id=3c3580952ced952d287197a7b3e2fdf4580059a724a02377d7cd4d13c6cdf04a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_logingeo.md --> # LoginGeo Represents the geographic location of the user’s IP address for a login event. Due to the nature of geolocation technology, the accuracy of geolocation fields (for example, country, city, postal code) may vary. This object is available in API version 34.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Only users with Manage Users permissions can access this object. ## Fields | Field | Details | | --- | --- | | City | Type string Properties Filter, Group, Nillable, Sort Description The city where the user’s IP address is physically located. This value is not localized. | | Country | Type string Properties Filter, Group, Nillable, Sort Description The country where the user’s IP address is physically located. This value is not localized. | | CountryIso | Type string Properties Filter, Group, Nillable, Sort Description The ISO 3166 code for the country where the user’s IP address is physically located. For more information, see [Country Codes - ISO 3166](http://www.iso.org/iso/country_codes.htm) | | Latitude | Type double Properties Filter, Nillable, Sort Description The latitude where the user’s IP address is physically located. | | LoginTime | Type dateTime Properties Filter, Sort Description Time of the login attempt, in GMT time zone. | | Longitude | Type double Properties Filter, Nillable, Sort Description The longitude where the user’s IP address is physically located. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort Description The postal code where the user’s IP address is physically located. This value is not localized. | | Subdivision | Type string Properties Filter, Group, Nillable, Sort Description The name of the subdivision where the user’s IP address is physically located. In the U.S., this value is usually the state name (for example, Pennsylvania). This value is not localized. | ## Usage The API allows you to do many powerful queries. A few examples are: | Sample Query | Query String | | --- | --- | | Query showing the country for a login event, where Id=LoginGeoId from AuthSession | SELECT Country FROM LoginGeo WHERE Id = '0LE###############' | | Query showing the city and postal code for a login event, where Id=LoginGeoId from LoginHistory | SELECT City, PostalCode FROM LoginGeo WHERE Id = '0SO###############' | <!-- document id=5062f800307361d3a4b66df0cf9f4fd3f0186ef7ee134fc9db9b8603cccd7640 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_loginhistory.md --> # LoginHistory Represents the login history for all successful and failed login attempts for organizations and enabled portals. This object is available in API version 21.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules With one exception, only users with Manage Users or Monitor Login History permissions can access this object. The exception is that, in API version 37.0 and later, all users can retrieve their own login history records. ## Fields | Field | Details | | --- | --- | | ApiType | Type string Properties Group, Nillable, Sort Description Indicates the API type, for example Soap Enterprise. Label is **API Type**. | | ApiVersion | Type string Properties Group, Nillable, Sort Description Displays the API version used by the client. Label is **API Version**. | | Application | Type string Properties Group, Nillable, Sort Description The application used to access the organization. Label is **Application**. | | AuthContextClassRef | Type string Properties Filter, Group, Nillable, Sort Description If provided by a third-party identity provider, the authentication method indicated in the Authentication Context Class Reference (ACR) claim. - SAML providers—stores the value of the AuthnContextClassRef statement in the SAML response. - OpenID Connect providers—stores the value of the ACR claim in the ID token This field is available in API version 67.0 and later. | | AuthMethodReference | Type string Properties Filter, Group, Nillable, Sort Description The authentication method used by a third-party identification provider for an OpenID Connect single sign-on protocol. This field is available in API version 51.0 and later. Label is **Authentication Method Reference**. | | AuthenticationServiceId | Type reference Properties Filter, Group, Nillable, Sort Description The 18-character ID for an authentication service for a login event. For example, you can use this field to identify the SAML or authentication provider configuration with which the user logged in. This field is available in API version 34.0 and later. Label is **Authentication Service Id**. This field is a polymorphic relationship field. Relationship Name AuthenticationService Relationship Type Lookup Refers To AuthProvider, SamlSsoConfig | | Browser | Type string Properties Group, Nillable, Sort Description The current browser version. Label is **Browser**. | | CipherSuite | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The TLS cipher suite used for the login. Values are OpenSSL-style cipher suite names, with hyphen delimiters. For more information, see [OpenSSL Cryptography and SSL/TLS Toolkit](https://www.openssl.org/source/ "HTML (New Window)"). This field is available in API version 37.0 and later. | | ClientVersion | Type string Properties Group, Nillable, Sort Description Version of the API client. Label is **Client Version**. | | CountryIso | Type string Properties Filter, Group, Nillable, Sort Description The ISO 3166 code for the country where the user’s IP address is physically located. For more information, see [Country Codes - ISO 3166](http://www.iso.org/iso/country_codes.htm). This field is available in API version 37.0 and later. | | ForwardedForIp | Type string Properties Filter, Group, Nillable, Sort Description The value in the X-Forwarded-For header of HTTP requests sent by the client. For logins that use one or more HTTP proxies, the X-Forwarded-For header is sometimes used to store the origin IP and all proxy IPs. The ForwardedForIp field stores whatever value the client sends, which might not be an IP address. The maximum length is 256 characters. Longer values are truncated. The ForwardedForIp field isn’t populated for logins completed via OAuth flows or single sign-on (SSO). Available in API version 61.0 and later. | | LoginGeoId | Type reference Properties Filter, Group, Nillable, Sort Description The 18-character ID for the record of the geographic location of the user for a successful or unsuccessful login event. The accuracy of geolocation fields like country, city, or postal code can vary because of the nature of the technology. The Manage Users permission is required for accessing this field. This field is available in API version 34.0 and later. This field is a relationship field. Relationship Name LoginGeo Relationship Type Lookup Refers To LoginGeo | | LoginSubType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of login flow used. - InternalSalesforceAuthentication–Internal Salesforce Authentication This subtype is for internal use only. - OauthClientCredentials–OAuth Client Credentials - OAuthDevice—OAuth Device - OauthHybridRefreshToken—OAuth Refresh Token for Hybrid Apps - OauthHybridTokenExchange—OAuth Token Exchange for Hybrid Apps - OauthHybridUserAgent–OAuth User-Agent for Hybrid Apps - OauthHybridWebServer–OAuth Web Server for Hybrid Apps - OauthOtpLogin—OAuth OTP Login - OauthRefreshToken—OAuth Refresh Token - OauthTokenExchange—OAuth Token Exchange - OauthUserAgent–OAuth User-Agent - OauthUserAgentIdToken–OAuth User-Agent with ID Token - OauthUsernamePassword–OAuth Username-Password - OauthWebServer–OAuth Web Server - SoapApiLogin–SOAP API This subtype is for internal use only. - SoapApiLoginMobile–SOAP API (Mobile) This subtype is for internal use only. - SoapApiLoginNetworksPortal–SOAP API (Networks Portal) This subtype is for internal use only. - SoapApiLoginPortal–SOAP API (Portal) This subtype is for internal use only. - SoapApiLoginSelfService–SOAP API (Self-Service) This subtype is for internal use only. - UiPasswordReset–UI Password Reset - UsernamePasswordUiLogin–UI Username-Password Label is **Login Subtype**. | | LoginTime | Type dateTime Properties Filter, Sort Description Time zone is based on GMT. Label is **Login Time**. | | LoginType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of login used to access the session. - AppExchange–AppExchange - Application–Application - Certificate–Certificate-based login - ChatterCommunityPortalUnPwd–Chatter Communities External User - ChatterCommunityThirdPartySso–Chatter Communities External User Third Party SSO - CrossTenantLogin–Cross Tenant Login—For internal use only. - EmployeeLoginToCommunity–Employee Login to Community - HelpAndTraining–Help And Training - IeOfflineClient–Offline Client - LightningLogin–Lightning Login - NetworksPortalApiOnly–Networks Portal API Only - Oauth, Remote Access Client–Remote Access Client - Oauth2, Remote Access 2.0–Remote Access 2.0 - OtherApi–Other Apex API - Partner–Partner Product - PasswordlessLogin–Passwordless Login - PasswordlessPasskeyLogin–Passwordless Login via Passkeys (beta) Passwordless login with passkeys is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/?_ga=2.247987783.1372150065.1709219475-629000709.1639001992). Use of this pilot or beta service is at the Customer's sole discretion. - Portal–Customer Service Portal - PortalThirdPartySso–Customer Service Portal Third-Party SSO - PrmPortalThirdPartySso–Partner Portal Third-Party SSO - PrmPortal–Partner Portal - Saml–SAML Idp Initiated SSO - SamlChatterNetworks–SAML Chatter Communities External User SSO - SamlCspPortal–SAML Customer Service Portal SSO - SamlPrmPortal–SAML Partner Portal SSO - SamlSite–SAML Site SSO - Saml2–SAML Sfdc Initiated SSO - SelfService–SelfService - ThirdPartySso–Third Party SSO Label is **Login Type**. | | LoginUrl | Type string Properties Filter, Group, Nillable, Sort Description URL from which the login request is coming. Label is **Login URL**. | | NetworkId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Experience Cloud site that the user is logging in to. This field is available in API version 31.0 and later, if Salesforce Experience Cloud sites are enabled for your org. | | OptionsIsGet | Type boolean Properties Filter Description The HTTP method used for the session login is a GET request. | | OptionsIsPost | Type boolean Properties Filter Description The HTTP method used for the session login is a POST request. | | Platform | Type string Properties Group, Nillable, Sort Description Operating system on the login machine. Label is **Platform**. | | SourceIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the incoming client request that first reaches Salesforce during a login. For example, 126.7.4.2. For clients that redirect through one or more HTTP proxies, this field stores the IP address of the first proxy to reach Salesforce. To better identify the origin IP for these cases, check the ForwardedForIp field instead. The SourceIp field doesn't support the LIKE [comparison operator](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_comparisonoperators.htm). | | Status | Type string Properties Group, Nillable, Sort Description Displays the status of the attempted login. Status is either success or a reason for failure. Label is **Status**. | | TlsProtocol | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The TLS protocol used for the login. Possible values are: - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 - Unknown This field is available in API version 37.0 and later. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user logging in. Label is **User ID**. | ## Usage Not all fields are filterable. You can only filter on the following fields: - AuthenticationServiceId - CipherSuite - CountryIso - Id - LoginTime - LoginType - LoginUrl - NetworkId - OptionsIsGet - OptionsIsPost - TlsProtocol - UserId The API allows you to do many powerful queries. A few examples are: | Sample Query | Query String | | --- | --- | | Simple query showing UserId & LoginTime for each user | SELECT UserId, LoginTime from LoginHistory; | | Query showing logins only after a specified date and time | SELECT UserId, LoginTime from LoginHistory WHERE LoginTime > 2010-09-20T22:16:30.000Z; | | Query showing logins for a specific time interval | SELECT UserId, LoginTime from LoginHistory WHERE LoginTime > 2010-09-20T22:16:30.000Z AND LoginTime < 2010-09-21T22:16:30.000Z; | | Query showing the authentication service for a SAML login event, where Id=AuthenticationServiceId from LoginHistory | SELECT DeveloperName, Issuer, Version FROM SamlSsoConfig WHERE Id = '0LE###############' | | Query showing the authentication service for an authentication provider login event, where Id=AuthenticationServiceId from LoginHistory | SELECT Type, DeveloperName FROM AuthProvider WHERE Id = '0SO###############' | <!-- document id=7d482f005e7b57e9bddfb403dfd283016234da61537af80cb592b09fa2cb06c2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_loginip.md --> # LoginIp Represents a validated IP address. This object is available in version 28.0 and later. ## Supported Calls describeSObjects(), delete(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ChallengeMethod | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The challenge method used to confirm the user’s identity. Possible values include the following. - Email - SMS - TOTP\_CHOICE: The user chooses multi-factor authentication. - TOTP\_ONLY: The user is required to use multi-factor authentication. | | ChallengeSentDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the user was authenticated. | | IsAuthenticated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the user has already been authenticated. | | SourceIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address the user logged in from. | | UsersId | Type reference Properties Filter, Group, Sort Description The ID of the user associated with this item. This is a relationship field. Relationship Name Users Relationship Type Lookup Refers To User | ## Usage At every login, the IP address of the login request is checked against the validated IP addresses using LoginIp. A match means the login IP address is a known IP address. If there’s no match, the address is unknown, and the user is asked to confirm their identity. <!-- document id=6f363beab8e92959735865ef2d1b6ea3a4f730825a7b8d574bc0c0d42a689f52 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_logout.md --> # Logout Event Type Contains details of user sessions ending or being revoked. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Logout Event Type is used by EventLogFile (ELF). It isn’t a real-time event. For the LogoutEvent real-time event, which is part of Real-Time Event Monitoring (RTEM), see [LogoutEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_logoutevent.htm) in the Platform Events Developer Guide. These scenarios count as logout events. - Logging out via the UI - Session expiration - Revoking access for a connected app - Calling the Salesforce revocation endpoint - Salesforce disabling a connected app - ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For batch operations where multiple sessions are revoked at once, Salesforce records only one logout event. You can tell that it’s a batch operation because there’s no user ID. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">API_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The type of API request.</dd><dd class="dd">Possible values are:<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">D</samp>—Apex Class</li><li class="li"><samp class="codeph nolang">E</samp>—SOAP Enterprise</li><li class="li"><samp class="codeph nolang">M</samp>—SOAP Metadata</li><li class="li"><samp class="codeph nolang">P</samp>—SOAP Partner</li><li class="li"><samp class="codeph nolang">S</samp>—SOAP Apex</li><li class="li"><samp class="codeph nolang">T</samp>—SOAP Tooling</li><li class="li"><samp class="codeph nolang">f</samp>—Feed</li><li class="li"><samp class="codeph nolang">l</samp>—Live Agent</li><li class="li"><samp class="codeph nolang">p</samp>—SOAP ClientSync</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">API_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The version of the API that’s being used.</dd><dd class="dd">For example: <samp class="codeph nolang">36.0</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">APP_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The application type that was in use upon logging out.</dd><dt class="dt dlterm">Example Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><samp class="codeph nolang">1000</samp>: Application</li><li class="li"><samp class="codeph nolang">1007</samp>: SFDC Application</li><li class="li"><samp class="codeph nolang">1014</samp>: Chat</li><li class="li"><samp class="codeph nolang">2501</samp>: CTI</li><li class="li"><samp class="codeph nolang">2514</samp>: OAuth</li><li class="li"><samp class="codeph nolang">3475</samp>: SFDC Partner Portal</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">BROWSER_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The identifier string returned by the browser used at login.</dd><dd class="dd">Example values are:<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">Go-http-client/1.1</samp></li><li class="li"><samp class="codeph nolang">Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv%3A50.0) Gecko/20100101 Firefox/50.0</samp></li><li class="li"><samp class="codeph nolang">Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36</samp></li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_IP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.</dd><dd class="dd">For example: <samp class="codeph nolang">96.43.144.26</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The version of the client that was in use upon logging out.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="event-type-desc"><a name="event-type-desc"></a>The type of event.</span> The value is always <samp class="codeph nolang">Logout</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LOGIN_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.</dd><dd class="dd">For example: <samp class="codeph nolang">GeJCsym5eyvtEK2I</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the organization.</dd><dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">PLATFORM_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The code for the client platform. If a timeout caused the logout, this field is null.</dd><dt class="dt dlterm">Example Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><samp class="codeph nolang">1000</samp>: Windows</li><li class="li"><samp class="codeph nolang">1008</samp>: Windows 2003</li><li class="li"><samp class="codeph nolang">1013</samp>: Windows 8.1</li><li class="li"><samp class="codeph nolang">1015</samp>: Windows 10</li><li class="li"><samp class="codeph nolang">2003</samp>: Macintosh/Apple OSX</li><li class="li"><samp class="codeph nolang">4000</samp>: Linux</li><li class="li"><samp class="codeph nolang">5005</samp>: Android</li><li class="li"><samp class="codeph nolang">5006</samp>: iPhone</li><li class="li"><samp class="codeph nolang">5007</samp>: iPad</li><li class="li"><samp class="codeph nolang">5200</samp>: Android 10.0</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">RESOLUTION_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The screen resolution of the client. If a timeout caused the logout, this field is null.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.</dd><dd class="dd">For example: <samp class="codeph nolang">d7DEq/ANa7nNZZVD</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_LEVEL</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The security level of the session that was used when logging out.</dd><dt class="dt dlterm">Possible Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><samp class="codeph nolang">1</samp>: Standard Session</li><li class="li"><samp class="codeph nolang">10</samp>: High-Assurance Session</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The session type that was used when logging out.</dd><dt class="dt dlterm">Possible Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><samp class="codeph nolang">A</samp>: API</li><li class="li"><samp class="codeph nolang">I</samp>: APIOnlyUser</li><li class="li"><samp class="codeph nolang">N</samp>: ChatterNetworks</li><li class="li"><samp class="codeph nolang">Z</samp>: ChatterNetworksAPIOnly</li><li class="li"><samp class="codeph nolang">C</samp>: Content</li><li class="li"><samp class="codeph nolang">P</samp>: OauthApprovalUI</li><li class="li"><samp class="codeph nolang">O</samp>: Oauth2</li><li class="li"><samp class="codeph nolang">T</samp>: SiteStudio</li><li class="li"><samp class="codeph nolang">R</samp>: SitePreview</li><li class="li"><samp class="codeph nolang">S</samp>: SubstituteUser</li><li class="li"><samp class="codeph nolang">B</samp>: TempContentExchange</li><li class="li"><samp class="codeph nolang">G</samp>: TempOauthAccessTokenFrontdoor</li><li class="li"><samp class="codeph nolang">Y</samp>: TempVisualforceExchange</li><li class="li"><samp class="codeph nolang">F</samp>: TempUIFrontdoor</li><li class="li"><samp class="codeph nolang">U</samp>: UI</li><li class="li"><samp class="codeph nolang">E</samp>: UserSite</li><li class="li"><samp class="codeph nolang">V</samp>: Visualforce</li><li class="li"><samp class="codeph nolang">W</samp>: WDC_API</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd><dd class="dd"><p class="p">When a customer logs out by using the <strong class="ph uicontrol">Logout</strong> button, the <span class="keyword parmname">TIMESTAMP</span> field records the actual logout time. However, when a customer is logged out automatically, Salesforce detects the event by using a process that runs every 15 minutes. <span class="keyword parmname">TIMESTAMP</span> values can reflect a logout time up to 15 minutes later than the actual automatic logout time.</p></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd><dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. Timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00530000009M943</samp></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00590000000I1SNIA0</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_INITIATED_LOGOUT</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Boolean</dd><dt class="dt dlterm">Description</dt><dd class="dd">The value is 1 if the user intentionally logged out of the organization by clicking the <strong class="ph uicontrol">Logout</strong> button. If the user’s session timed out due to inactivity or another implicit logout action, the value is 0.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The category of user license of the user that logged out.</dd><dt class="dt dlterm">Possible Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><samp class="codeph nolang">A</samp>: Automated Process</li><li class="li"><samp class="codeph nolang">b</samp>: High Volume Portal</li><li class="li"><samp class="codeph nolang">C</samp>: Customer Portal User</li><li class="li"><samp class="codeph nolang">D</samp>: External Who</li><li class="li"><samp class="codeph nolang">F</samp>: Self-Service</li><li class="li"><samp class="codeph nolang">G</samp>: Guest</li><li class="li"><samp class="codeph nolang">L</samp>: Package License Manager</li><li class="li"><samp class="codeph nolang">N</samp>: Salesforce to Salesforce</li><li class="li"><samp class="codeph nolang">n</samp>: CSN Only</li><li class="li"><samp class="codeph nolang">O</samp>: Power Custom</li><li class="li"><samp class="codeph nolang">o</samp>: Custom</li><li class="li"><samp class="codeph nolang">P</samp>: Partner</li><li class="li"><samp class="codeph nolang">p</samp>: Customer Portal Manager</li><li class="li"><samp class="codeph nolang">S</samp>: Standard</li><li class="li"><samp class="codeph nolang">X</samp>: Salesforce Administrator</li></ul></dd></dl></td></tr></tbody></table> #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=08eb2875a90e90a1f360fd07d00c8417c28b5c247cac3f08924658753aaa8113 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_logouteventlog.md --> # LogoutEventLog Contains details of user sessions ending or being revoked. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ApiType | Type string Properties Filter, Group, Nillable, Sort Description The type of API request. Possible values are: - D—Apex Class - E—SOAP Enterprise - M—SOAP Metadata - P—SOAP Partner - S—SOAP Apex - T—SOAP Tooling - f—Feed - l—Live Agent - p—SOAP ClientSync | | ApiVersion | Type int Properties Filter, Group, Nillable, Sort Description The version of the API that’s being used. For example: 36.0. | | AppType | Type double Properties Filter, Nillable, Sort Description The application type that was in use upon logging out. Example Values - 1000: Application - 1007: SFDC Application - 1014: Chat - 2501: CTI - 2514: OAuth - 3475: SFDC Partner Portal | | BrowserType | Type string Properties Filter, Group, Nillable, Sort Description The identifier string returned by the browser used at login. Example values are: - Go-http-client/1.1 - Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv%3A50.0) Gecko/20100101 Firefox/50.0 - Mozilla/5.0 (Macintosh; Intel Mac OS X 10\_11\_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36 | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | ClientVersion | Type double Properties Filter, Nillable, Sort Description The version of the client that was in use upon logging out. | | IsUserInitiatedLogout | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The value is 1 if the user intentionally logged out of the organization by clicking the Logout button. If the user’s session timed out due to inactivity or another implicit logout action, the value is 0. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | PlatformType | Type double Properties Filter, Nillable, Sort Description The code for the client platform. If a timeout caused the logout, this field is null. Example Values - 1000: Windows - 1008: Windows 2003 - 1013: Windows 8.1 - 1015: Windows 10 - 2003: Macintosh/Apple OSX - 4000: Linux - 5005: Android - 5006: iPhone - 5007: iPad - 5200: Android 10.0 | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | ResolutionType | Type double Properties Filter, Nillable, Sort Description The screen resolution of the client. If a timeout caused the logout, this field is null. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. | | SessionLevel | Type string Properties Filter, Group, Nillable, Sort Description The security level of the session that was used when logging out. | | SessionType | Type string Properties Filter, Group, Nillable, Sort Description The session type that was used when logging out. Possible Values - A: API - I: APIOnlyUser - N: ChatterNetworks - Z: ChatterNetworksAPIOnly - C: Content - P: OauthApprovalUI - O: Oauth2 - T: SiteStudio - R: SitePreview - S: SubstituteUser - B: TempContentExchange - G: TempOauthAccessTokenFrontdoor - Y: TempVisualforceExchange - F: TempUIFrontdoor - U: UI - E: UserSite - V: Visualforce - W: WDC\_API | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. When a customer logs out by using the **Logout** button, the TIMESTAMP field records the actual logout time. However, when a customer is logged out automatically, Salesforce detects the event by using a process that runs every 15 minutes. TIMESTAMP values can reflect a logout time up to 15 minutes later than the actual automatic logout time. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license of the user accessing Salesforce services through the UI or API. | <!-- document id=766e737889b64fa8312c51b4b082f09f8cc07f006fe794c786a2b10dcc3b6bf3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_logouteventstream.md --> # LogoutEventStream The documentation has moved to [LogoutEventStream](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_logouteventstream.htm "HTML (New Window)") in the Platform Events Developer Guide. <!-- document id=8fbeac3b0a1d640c4c25cbfa5af1c7fbd8814c07ff3514b3841258129645d325 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_lookedupfromactivity.md --> # LookedUpFromActivity This read-only object is displayed as a related list on an activity record (an event or a task); the list contains records that have custom lookup relationships from the activity to another object. This object is not queryable. ## Supported Calls describeSObjects() ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d1224641e67">Field Name</th> <th class="featureTableHeader " id="d1224641e70">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">AccountId</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates the ID of the related account, which is determined as follows:<ul class="ul bulletList"> <li class="li">The account associated with the <span class="keyword parmname">WhatId</span>, if it exists; or </li> <li class="li">The account associated with the <span class="keyword parmname">WhoId</span>, if it exists; otherwise </li> <li class="li"><samp class="codeph nolang">null</samp></li> </ul> </dd> <dd class="dd">For information on IDs, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm#field_types" title="In addition to the primitive data types, the API defines the following data types for fields.">Field Types</a> </dd> <dd class="dd">This is a relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">Account</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Account</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">ActivityDate</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">date</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates one of the following:<ul class="ul bulletList"> <li class="li">The due date of a task</li> <li class="li">The date of an event if <span class="keyword parmname">IsAllDayEvent</span> is set to <samp class="codeph nolang">true</samp> </li> </ul> </dd> <dd class="dd">This field has a time stamp that is always set to midnight in the Universal Time Coordinated (UTC) time zone. The time stamp doesn’t represent the time of the activity; don’t attempt to alter it to accommodate time zone differences. Label is <span class="keyword parmname">Date</span>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">ActivityDateTime</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Aggregate, Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Contains the event’s due date if the <span class="keyword parmname">IsAllDayEvent</span> flag is set to <samp class="codeph nolang">false</samp>. <span class="ph" id="date_time_field_info"><a name="date_time_field_info"><!-- --></a> The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate.</span> Label is <strong class="ph uicontrol">Due Date Time</strong>.<p class="p">The value for this field and <span class="keyword parmname">StartDateTime</span> must match, or one of them must be <samp class="codeph nolang">null</samp>. </p> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">ActivitySubtype</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm"> <a name="activitysubtype_dlentry"><!-- --></a>Description </dt> <dd class="dd"> <span class="ph" id="activitsubtype_desc"><a name="activitsubtype_desc"><!-- --></a>Provides standard subtypes to facilitate creating and searching for specific activity subtypes. This field isn’t updateable.</span> <div class="p">Possible values are:<ul class="ul bulletList"> <li class="li">Task</li> <li class="li">Email</li> <li class="li">Call</li> <li class="li">Event</li> <li class="li">LinkedIn —Available in API version 56.0 and later.</li> <li class="li">List Email</li> </ul> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">ActivityType</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Represents one of the following values: <samp class="codeph nolang">Call</samp>, <samp class="codeph nolang">Email</samp>, <samp class="codeph nolang">Meeting</samp>, or <samp class="codeph nolang">Other</samp>. Label is <span class="keyword parmname">Type</span>. These are default values, and can be changed. </dd> </dl> <p class="p"><span class="keyword parmname">ActivityType</span> is the union of <span class="keyword parmname">TaskType</span> and <span class="keyword parmname">EventType</span>. If the same activity appears in both dynamic picklists, duplicate activities appear. </p> <p class="p"><span class="keyword parmname">TaskType</span> and <span class="keyword parmname">EventType</span> can each have a <samp class="codeph nolang">Call</samp> type. Internally, they are distinct from each other.</p> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">CallDisposition</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Represents the result of a given call; for example, “we’ll call back,” or “call unsuccessful.” Limit is 255 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">CallDurationInSeconds</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Duration of the call in seconds.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">CallObject</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Name of a call center. Limit is 255 characters.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">CallType</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The type of call being answered: Inbound, Internal, or Outbound.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">CompletedDateTime</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The date and time the task was saved with a Closed status. <ul class="ul bulletList"> <li class="li">For insert, if the task is saved with a Closed status the field is set. If the task is saved with an Open status the field is set to NULL.</li> <li class="li">For update, if the task is saved with a new Closed status, the field is reset. <p class="p">If the task is saved with a new non-closed status, the field is reset to NULL. </p> <p class="p">If the task is saved with the same closed status (that is, unchanged) there is no change to the field. </p> </li> </ul> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>The status is a dynamic enum. If the Closed mapping is changed it won’t cause an update of existing tasks. Only new insert/update operations are affected.</p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">Description</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Nillable</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Contains a description of the event or task. Limit is 32 KB.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">DurationInMinutes</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">int</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates the duration of the event or task.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">EndDateTime</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates the end date and time of the event or task. Available in versions 27.0 and later. This field is optional, depending on the following:<a name="DurationConditions"><!-- --></a> <ul class="ul bulletList" id="DurationConditions"> <li class="li">If <span class="keyword parmname">IsAllDayEvent</span> is true, you can supply a value for either <span class="keyword parmname">DurationInMinutes</span> or <span class="keyword parmname">EndDateTime</span>. Supplying values in both fields is allowed if the values add up to the same amount of time. If both fields are <samp class="codeph nolang">null</samp>, the duration defaults to one day. </li> <li class="li">If <span class="keyword parmname">IsAllDayEvent</span> is false, a value must be supplied for either <span class="keyword parmname">DurationInMinutes</span> or <span class="keyword parmname">EndDateTime</span>. Supplying values in both fields is allowed if the values add up to the same amount of time. </li> </ul> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">IsAllDayEvent</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">If the value of this field is set to <samp class="codeph nolang">true</samp>, then the activity is an event spanning a full day, and the <span class="keyword parmname">ActivityDate</span> defines the date of the event. If the value of this field is set to <samp class="codeph nolang">false</samp>, then the activity may be an event spanning less than a full day, or it may be a task. The default value of this field is <samp class="codeph nolang">false</samp>. Label is <span class="keyword parmname">All-Day Event</span>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">IsClosed</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether a task is closed (<samp class="codeph nolang">true</samp>) or not closed (<samp class="codeph nolang">false</samp>). The default value of this field is <samp class="codeph nolang">false</samp>. This field is set indirectly by setting <span class="keyword parmname">Status</span> on the task—each picklist value has a corresponding <samp class="codeph nolang">IsClosed</samp> value. Label is <span class="keyword parmname">Closed</span>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">IsHighPriority</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates a high-priority task. The default value of this field is <samp class="codeph nolang">false</samp>. This field is derived from the <span class="keyword parmname">Priority</span> field. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">IsReminderSet</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates whether a reminder is set for an activity (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value of this field is <samp class="codeph nolang">false</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">IsTask</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">If the value of this field is set to <samp class="codeph nolang">true</samp>, then the activity is a task; if the value is set to <samp class="codeph nolang">false</samp>, then the activity is an event. The default value of this field is <samp class="codeph nolang">false</samp>. Label is <span class="keyword parmname">Task</span>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">IsVisibleInSelfService</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">boolean</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">If the value of this field is set to <samp class="codeph nolang">true</samp>, then the activity can be viewed in the self-service portal. The default value of this field is <samp class="codeph nolang">false</samp>. Label is <span class="keyword parmname">Visible in Self-Service</span>. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">Location</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">If the activity is an event, then this field represents the location of the event. If the activity is a task, then the value is <samp class="codeph nolang">null</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">OwnerId</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates the ID of the user or group who owns the activity.</dd> <dd class="dd">This is a polymorphic relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">Owner</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Calendar, Group, User</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">Priority</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates the priority of a task, such as high, normal, or low. The default value of this field is <samp class="codeph nolang">Normal</samp>.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">ReminderDateTime</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Represents the time at which a reminder is scheduled to fire if <span class="keyword parmname">IsReminderSet</span> is set to <samp class="codeph nolang">true</samp>. If <span class="keyword parmname">IsReminderSet</span> is set to <samp class="codeph nolang">false</samp>, then either the user has deselected the reminder checkbox in the user interface or the reminder has already fired at the time indicated by the value. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">StartDateTime</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">dateTime</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates the start date and time of the event. Available in versions 13.0 and later.</dd> <dd class="dd">The <span class="keyword parmname">StartDateTime</span> field contains the event start date. </dd> <dd class="dd">However, if the event’s <span class="keyword parmname">IsAllDayEvent</span> flag is set to <samp class="codeph nolang">true</samp> (indicating an all-day event), then the time stamp in the <span class="keyword parmname">StartDateTime</span> field is always set to midnight in the Coordinated Universal Time (UTC) time zone. Don’t attempt to alter the time stamp to account for any time zone differences. </dd> <dd class="dd">If the event’s <span class="keyword parmname">IsAllDayEvent</span> flag is set to <samp class="codeph nolang">false</samp>, then you must translate the time portion of the time stamp in the <span class="keyword parmname">StartDateTime</span> field to or from a local time zone for the user or the application, as appropriate, and the translation must be in the Coordinated Universal Time (UTC) time zone.</dd> <dd class="dd">If this field has a value, then <span class="keyword parmname">ActivityDate</span> and <span class="keyword parmname">ActivityDateTime</span> either must be <samp class="codeph nolang">null</samp> or must match the value of this field. </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">Status</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Indicates the current status of a task. The default value of this field is <samp class="codeph nolang">Not Started</samp>. Each predefined status field sets a value for <span class="keyword parmname">IsClosed</span>.<div class="p">Possible values are:<ul class="ul bulletList"> <li class="li">Completed</li> <li class="li">Deferred</li> <li class="li">In Progress</li> <li class="li">Not Started</li> <li class="li">Waiting on someone else</li> </ul> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">Subject</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">combobox</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Contains the subject of the task or event.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">WhatId</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The <span class="keyword parmname">WhatId</span> represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. <span class="keyword parmname">WhatId</span>s are polymorphic. Polymorphic means a <span class="keyword parmname">WhatId</span> is equivalent to the ID of a related object. The label is <span class="keyword parmname">Related To ID</span>. </dd> <dd class="dd">This is a polymorphic relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">What</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CommSubscriptionConsent, ContactEncounter, ContactEncounterParticipant, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem, CreditMemo, DelegatedAccount, DocumentChecklistItem, EnrollmentEligibilityCriteria, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, ListEmail, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PartyConsent, PersonLifeEvent, PlanBenefit, PlanBenefitItem, ProcessException, Product2, ProductItem, ProductRequest, ProductRequestLineItem, ProductTransfer, PurchaserPlan, ReceivedDocument, ResourceAbsence, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, Shift, Shipment, ShipmentItem, Solution, Visit, VisitedParty, VolunteerProject, WorkOrder, WorkOrderLineItem</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1224641e67" data-title="Field Name"><span class="keyword parmname">WhoId</span></td> <td class="entry" headers="d1224641e70" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">reference</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is <span class="keyword parmname">Name ID</span>. </dd> <dd class="dd">This is a polymorphic relationship field.</dd> <dt class="dt dlterm">Relationship Name</dt> <dd class="dd">Who</dd> <dt class="dt dlterm">Relationship Type</dt> <dd class="dd">Lookup</dd> <dt class="dt dlterm">Refers To</dt> <dd class="dd">Contact, Lead</dd> </dl> </td> </tr> </tbody> </table> ## Usage Query activities related to an object 1. Optionally, issue a describe call against the object whose activities you wish to query, to get a suggestion of the correct SOQL to use. 2. Issue a SOQL relationship query with a main clause that references the object, and an inner clause that references the activity custom lookup relationship; for example: SELECT id, name, (SELECT id, subject from sponsoredact\_\_r) FROM Contact In this example sponsoredact\_\_r is a user defined relationship list. The user interface enforces sharing rules, filtering out related-list items that a user doesn’t have permission to see. The following restrictions on users who don’t have “View All Data” permission help prevent performance issues: - In the main clause of the relationship query, you can reference only one record. For example, you can’t filter on all records where the account name starts with ‘A’; instead, you must reference a single account record. - In the inner clause of the query, you can’t use WHERE. - In the inner clause of the query, you must specify a limit of 500 or fewer on the number of rows that are returned in the list. - You must sort on ActivityDate in descending order and LastModifiedDate in descending order; you can display nulls last. For example: ORDER BY ActivityDate DESC NULLS LAST, LastModifiedDate DESC. <!-- document id=0fbd9edf33313c10d66d70114fa00a2a844fa33020cb20f51dd7c70a6f64463e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_macro.md --> # Macro Represents a macro, which is a set of instructions that tells the system to perform one or more tasks. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description Description of what this macro does. | | FolderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Returns the ID of the folder that contains the macro. Available in API version 44.0 and later. | | FolderName | Type string Properties Filter, Nillable, Sort Description Name of the folder that contains the macro. Available in API version 44.0 and later. | | IsAlohaSupported | Type boolean Properties Defaulted on create, Filter Description Specifies whether the macro is supported in Salesforce Classic. | | IsLightningSupported | Type boolean Properties Defaulted on create, Filter Description Specifies whether the macro is supported in Lightning Experience. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the macro record was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the macro record was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the macro. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the session record. | | StartingContext | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The object the macro performs actions on. In Salesforce Classic, macros are supported on objects with both feed-based layouts and quick actions. In Lightning Experience, macros are supported on standard and custom objects that allow quick actions and have a customizable page layout. | ## Usage A macro definition consists of a Macro object and several associated [MacroInstruction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_macroinstruction.htm#sforce_api_objects_MacroInstruction "Represents an instruction in a macro. An instruction can specify the object that the macro interacts with, the context or publisher that the macro works within, the operation or action that the macro performs, and the target of the macro’s actions.") objects. First, create a Macro object. Then, create MacroInstructions that specify objects, operations, conditions, and targets for the macro. A macro contains an ordered list of macro instructions whose index field, sortOrder, is 0-based. If there’s an incorrect sequence of macro instructions, the macro doesn’t execute. If you update a macro definition or add or remove instructions from a macro, make sure that the sortOrder field that defines the execution order is correct. To delete an entire macro definition, invoke the delete operation on the Macro object. The table describes the supported macro instruction targets and how they relate to each other. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Strings indicated by <brackets> are variables. The variable description describes the required type. For example, Tab.<EntityApiName> requires the entity name. If your custom entity name is MyCustomObject, your target API is Tab.MyCustomObject\_\_c. If a macro instruction listed in the table supports an implicit operation, you can use that operation as a direct child instruction without explicitly specifying a target. The hyphens used in the table illustrate the hierarchical relationship between targets. A target isn't available if its parent isn’t. Table 1. Macro Instruction Target Grammar and Hierarchy | Target API Name | Supported Operations | | --- | --- | | Tab.<EntityApiName> | SELECT, CLOSE (implicit) | | \- QuickAction.<EntityApiName>.<QuickActionName> | SELECT, SUBMIT (implicit) | | \- - Field.<QATargetEntityApiName>.<FieldApiName> | SET | | \- - Field.<QATargetEntityApiName>.<MultilineTextFieldApiName>.cursor | INSERT | | \- - Field.<QATargetEntityApiName>.<SinglelineTextFieldApiName>.end | INSERT | | \- QuickAction.Case.Email | SELECT, SUBMIT (implicit) | | \- - Field.EmailMessage.<FieldApiName> | SET | | \- - Field.EmailMessage.<MultilineTextFieldApiName>.cursor | INSERT | | \- - Field.EmailMessage.<SinglelineTextFieldApiName>.end | INSERT | | \- - Field.EmailTemplate | SET | | \- SidebarCmp.Knowledge | SELECT | | \- - SearchAction.KnowledgeArticle | SELECT | | \- - - Field.SearchString | SET, INSERT | | \- - - Command.Search | SUBMIT | | \- - SearchResult.KnowledgeArticle.MostRecentItem | SELECT | | \- - - Command.AttachToRecord | SUBMIT | | \- - - Command.InsertToEmail | SUBMIT | | \- - - Command.AttachToEmailAsPDF | SUBMIT | ## Example This example describes a macro that opens a quick action, sets some fields in the quick action, and submits the quick action. 0\. SELECT Tab.Case 1. SELECT QuickAction.Case.Email 2. SET Field.EmailMessage.Subject 3. SET Field.EmailMessage.ToAddress 4. INSERT Field.EmailMessage.HtmlBody.cursor 5. SUBMIT ## 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. [MacroChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [MacroHistory](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. [MacroOwnerSharingRule](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. [MacroShare](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. <!-- document id=03b29841664481406a93b7037896d44823bccb62e9eae95cca339d1e0a948f91 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_macroinstruction.md --> # MacroInstruction Represents an instruction in a macro. An instruction can specify the object that the macro interacts with, the context or publisher that the macro works within, the operation or action that the macro performs, and the target of the macro’s actions. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | MacroId | Type reference Properties Create, Filter, Group, Sort Description ID of the macro that contains this instruction. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Name of the instruction. | | Operation | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The action that the macro instruction performs. Valid values are: - Select - Set - Insert - Submit - Close To create macro instructions that execute conditionally, these values are available in API version 46.0 and later. - IF - ELSEIF - ELSE - ENDIF | | SortOrder | Type int Properties Create, Filter, Group, Sort, Update Description Order of this instruction in the macro. | | Target | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The object that’s the target of the operation. For example, the target for the active case tab (Tab.Case) or a quick action, like the Send Email action on the case object (QuickAction.Case.SendEmail). In Lightning Experience, macros are supported on standard and custom objects that allow quick actions and have a customizable page layout. In Salesforce Classic, macros are supported on objects with feed-based layouts and quick actions. You can specify relative dates and times for the following targets. - DateTime - Date - Time - DueDate - Birthday | | Value | Type string Properties Create, Filter, Nillable, Sort, Update Description Value of a field. If the operation is Select, then the value is null, because the operation selects the object on which the macro performs an action. An instruction can contain both a Value field and a ValueRecord field, but only one of these fields can have a value. The other field value must be null. To create relative dates and times, specify a valid Salesforce formula, prefaced by MacroFormula. For example, the following formula creates a date that is 1 day from now: MacroFormula:NOW() + 1 You can’t edit custom relative formulas in the Macro Builder. | | ValueRecord | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the value or record. The ValueRecord can be either a value or a record, but not both. An instruction can contain both a Value field and a ValueRecord field, but only one of these fields can have a value. The other field value must be null. | ## Usage MacroInstructions can specify objects, operations, conditions, and targets. For example, a macro containing these instructions performs a quick action that sends an email. Select Email QuickAction Set Subject… Set To… Set Body… Submit You can create conditional macros using IF, ELSEIF, ELSE, and ENDIF as operations. In a conditional statement, the [ExpressionFilter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expressionfilter.htm "Represents a logical expression that’s used to control the execution of macro instructions. This object is available in API version 46.0 and later.") and [ExpressionFilterCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expressionfiltercriteria.htm "Represents a condition in an expression that’s used to control the execution of macro instructions. This object is available in API version 46.0 and later.") objects are used to control which instructions execute. The ExpressionFilter object lets you define a logical expression with one or more conditions. It uses a child object, ExpressionFilterCriteria, to represent each condition that is evaluated. For example, consider the following conditional statement and macro instructions. IF (Case.Status EQUALS New) AND (Case.Origin EQUALS Phone) Select Email QuickAction Set Subject… Set To… Set Body… Submit ELSE Select Update Case Detail Update Case Description… Submit ENDIF The ExpressionFilter object includes a FilterConditionLogic field containing 1 AND 2, where 1 and 2 are ExpressionFilterCriteria objects. The SortOrder field in the ExpressionFilterCriteria object maps condition 1 to Case.Status EQUALS New, and condition 2 to Case.Origin EQUALS Phone. If the conditional statement evaluates to true, then the instructions in the IF block are executed; otherwise, the instructions in the ELSE block are executed. Any number of macro instructions can be present inside an IF, ELSEIF, or ELSE block. In addition, conditions can be nested. ## Data Model ![The MacroInstruction data model.](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/Sforce_macroinstruction.png) ## 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. [MacroInstructionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. <!-- document id=b9713551929184a7712ff3fe33131b2ab357be43cf9176a548fda6fc09c52cf3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_macrousage.md --> # MacroUsage Represents macro usage on a record, including which macro was used, who used it, and how they used it. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() delete() is supported in API version 55.0 and later. ## Special Access Rules This object is always read-only. Only users with “Modify All Data” permission can delete MacroUsage records. ## Fields | Field | Details | | --- | --- | | AppContext | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Context in which the macro was run. Possible values are: - Aloha—Salesforce Classic - Lightning—Lightning Experience - Unknown | | ConditionCount | Type int Properties Filter, Group, Nillable, Sort Description Number of conditional instructions contained in the macro at execution. | | ContextRecord | Type string Properties Filter, Group, Nillable, Sort Description ID of the record on which the macro was run. | | DurationInMs | Type int Properties Filter, Group, Nillable, Sort Description The execution time, in milliseconds, for the macro. | | ExecutedInstructionCount | Type int Properties Filter, Group, Nillable, Sort Description The number of macro instructions that ran successfully. If the macro completed successfully, this value is the same as InstructionCount. | | ExecutionEndTime | Type dateTime Properties Filter, Nillable, Sort Description The time at which macro execution completed. | | ExecutionState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The end state of macro execution. Possible values are - SUCCESS - FAILURE - CANCELED | | FailureReason | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description If ExecutionState is failure, this field stores the reason for the failure. Possible values are: - ACCESS - GENERIC - TIMEOUT - UNSUPPORTED | | FolderId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the folder containing the macro at the time it was used. | | InstructionCount | Type int Properties Filter, Group, Nillable, Sort Description The number of instructions in the macro at the start of execution. | | IsFromBulk | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the macro was run as a bulk macro. When a bulk macro is run on multiple records, usage is recorded per record. | | MacroID | Type reference Properties Filter, Group, Sort Description ID of the macro. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Name of the macro. | | OwnerId | Type reference Properties Filter, Group, Sort Description ID of the group or user that owns the macro. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user that ran the macro. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [MacroUsageOwnerSharingRule](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. [MacroUsageShare](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. <!-- document id=8c05295673cf2d875041f09f84ef5e8363310a2c857b47e609f189d62c3529e1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mailmergetemplate.md --> # MailmergeTemplate Represents a mail merge template (a Microsoft Word document) used for performing mail merges for your organization. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules - All users can view this object, but you need the “Customize Application” permission to modify it. - Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | Body | Type base64 Properties Create Description Required. Microsoft Word document to use as a mail merge template. Due to limitations with Microsoft Word mail merge templates, your client application can specify the Body field when creating these records, but not when updating them. Limit: 5 MB. | | BodyLength | Type int Properties Filter, Group, Nillable, Sort Description Length of the Microsoft Word document. | | Category | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of document template. Possible values are: - Document - Envelope - Label The default value is Document. | | Description | Type string Properties Create, Filter,Group, Nillable, Sort, Update Description Required. Text description of this mail merge template. Limit: 255 characters. | | Filename | Type string Properties Create, Filter, Group, Sort Description Required. File name of the Microsoft Word document that was uploaded as a mail merge template. Limit: 255 characters in length. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | LastUsedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when this MailmergeTemplate was last used. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of this mail merge template. | | SecurityOptionsAttachmentHasFlash | Type boolean Properties Create, Filter, Update Description Required. True if Flash Injection was detected in the attachment. | | SecurityOptionsAttachmentHasXSSThreat | Type boolean Properties Create, Filter, Update Description Required. True if a cross site scripting threat was detected in the attachment. | | SecurityOptionsAttachmentScannedforFlash | Type boolean Properties Create, Filter, Update Description Required. True if the attachment has been scanned for Flash Injection. | | SecurityOptionsAttachmentScannedForXSS | Type boolean Properties Create, Filter, Update Description Required. True if the attachment has been scanned for a cross site scripting threat. | ## Usage Use this object to manage mail merge templates for your organization. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=5cc59db330caf46151b9487d2f3dd9de765cad87c43cd2cdc019aa5740e747f8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_maintenanceasset.md --> # MaintenanceAsset Represents an asset covered by a maintenance plan in field service. Assets can be associated with multiple maintenance plans. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Sort, Update Description The asset associated with the maintenance asset. | | ContractLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Contract line item associated with the maintenance asset. This field can only list a contract line item that is associated with the asset, and whose parent service contract is associated with the parent maintenance plan. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the maintenance asset was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product request was last viewed. | | MaintenanceAssetNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-assigned number that identifies the maintenance asset. | | MaintenancePlanId | Type reference Properties Create, Filter, Group, Sort Description Maintenance plan associated with the maintenance asset. | | NextSuggestedMaintenanceDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The suggested date of service for the maintenance asset’s first work order (not the date the work order is created). This corresponds to the work order’s SuggestedMaintenanceDate. If left blank when the maintenance asset is created, this field inherits its initial value from the related maintenance plan. This field auto-updates after each batch is generated. Its label in the user interface is Date of the first work order in the next batch. | | WorkTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Work type associated with the maintenance asset. Work orders generated from the maintenance plan inherit its work type’s duration, required skills and products, and linked articles. Maintenance assets covered by the plan use the same work type, though you can update them to use a different one. | ## 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. [MaintenanceAssetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [MaintenanceAssetFeed](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. [MaintenanceAssetHistory](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. <!-- document id=9736003f29c87fdd3c3f0d3cf5dd729cb3bf310c633077c5cadadbd28cd24dd1 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_maintenanceplan.md --> # MaintenancePlan Represents a preventive maintenance schedule for one or more assets in field service. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The associated account, which typically represents the customer receiving the maintenance service. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The associated contact. | | Description | Type textarea Properties Create, Nillable, Update Description A brief description of the plan. | | DoesAutoGenerateWorkOrders | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Turns on auto-generation of work order batches for a maintenance plan and prohibits the manual generation of work orders via the Generate Work Orders action. If this option is selected, a new batch of work orders is generated for the maintenance plan on the NextSuggestedMaintenanceDate listed on each maintenance asset, or on the maintenance plan if no assets are included. If a GenerationHorizon is specified, the date of generation is that many days earlier. | | DoesGenerateUponCompletion | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If both this option and DoesAutoGenerateWorkOrders are set to true, a new batch of work orders isn’t generated until the last work order generated from the maintenance plan is completed. A work order is considered completed when its status falls into one of the following status categories: Cannot Complete, Canceled, Completed, or Closed. If a maintenance plan covers multiple assets, work orders are generated per asset. If a maintenance asset’s final work order is completed late, its work order generation is delayed, which may cause a staggered generation schedule between maintenance assets. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The last day the maintenance plan is valid. | | Frequency | Type int Properties Create, Filter, Group, Sort, Update Description (Optional) Amount of time between work orders. The unit is specified in the FrequencyType field. | | FrequencyType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description (Optional) The unit of frequency: - Days - Weeks - Months - Years For example, to perform monthly maintenance visits you need a work order for each visit, so enter 1 as the Frequency and select Months. | | GenerationHorizon | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Moves up the timing of batch generation if DoesAutoGenerateWorkOrders is set to true. A generation horizon of 5 means the new batch of work orders is generated 5 days before the maintenance asset’s (or maintenance plan’s, if there are no assets) NextSuggestedMaintenanceDate. The generation horizon must be a whole number. | | GenerationTimeframe | Type int Properties Create, Filter, Group, Sort, Update Description (Required) How far in advance work orders are generated in each batch. The unit is specified in the GenerationTimeframeType field. | | GenerationTimeframeType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description (Required) The generation timeframe unit: - Days - Weeks - Months - Years For example, if you need work orders for six months, enter 6 and select Months. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | LocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Where the service takes place. | | MaintenancePlanNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description (Read Only) An auto-assigned number that identifies the maintenance plan. | | MaintenancePlanTitle | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A name for the maintenance plan. | | MaintenanceWindowEndDays | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Days after the suggested service date on the work order that its service appointment can be scheduled. | | MaintenanceWindowStartDays | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Days before the suggested service date on the work order that its service appointment can be scheduled. The maintenance window start and end fields affect the Earliest Start Permitted and Due Date fields on the maintenance plan’s work orders’ service appointments. For example, if you enter 3 for both the maintenance window start and end, the Earliest Start Permitted and the Due Date will be 3 days before and 3 days after, respectively, the Suggested Maintenance Date on each work order. If the maintenance window fields are left blank, the service appointment date fields list their work order’s suggested maintenance date. | | NextSuggestedMaintenanceDate | Type date Properties Create, Filter, Group, Sort, Update Description The suggested date of service for the first work order (not the date the work order is created). This corresponds to the work order’s SuggestedMaintenanceDate. You can use this field to enforce a delay before the first maintenance visit (for example, if monthly maintenance should begin one year after the purchase date). Its label in the user interface is Date of the first work order in the next batch. For example, if you want the first maintenance visit to take place on May 1, enter May 1. When you generate work orders, the earliest work order will list a suggested maintenance date of May 1, and the dates on the later work orders will be based on the GenerationTimeframe and Frequency. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Maintenance assets also list a NextSuggestedMaintenanceDate, which is initially inherited from the maintenance plan. If the plan has maintenance assets, this date auto-updates on the maintenance assets after each batch is generated, but doesn’t update on the maintenance plan itself because batch timing is calculated at the maintenance asset level. If the plan doesn’t have maintenance assets, this date auto-updates on the maintenance plan after each batch is generated. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the maintenance plan. | | ServiceContractId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service contract associated with the maintenance plan. The service contract can’t be updated if any child maintenance asset is associated with a contract line item from the service contract. | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description The first day the maintenance plan is valid. | | SvcApptGenerationMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The service appointment generation method. - One service appointment per work order - One service appointment per work order line item If your existing maintenance plans have work orders or work order line items associated with them, you can’t change their generation methods. To change pre-existing maintenance plan generation methods, either delete the work orders and regenerate them or delete the maintenance plan and recreate it with the needed generation methods. If Work Order Generation Method is set to One work order per asset, you can’t set a Service Appointment Generation Method. If Work Order Generation Method is set to One work order line item per asset, you must select a Service Appointment Generation Method. | | WorkOrderGenerationMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The work order generation method. - One work order per asset - One work order line item per asset If your existing maintenance plans have work orders or work order line items associated with them, you can’t change their generation methods. To change pre-existing maintenance plan generation methods, either delete the work orders and regenerate them or delete the maintenance plan and recreate it with the needed generation methods. If Work Order Generation Method is left as None, the generation is defaulted to one work order per asset. When One work order line item per asset is set, and all maintenance assets have the same Next Suggested Maintenance Date on the maintenance plan, they are grouped in one work order. However, if maintenance assets have different Next Suggested Maintenance Dates, multiple work orders are created for each date. If Work Order Generation Method is set to One work order per asset, you can’t set a Service Appointment Generation Method. | | WorkOrderGenerationStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description (Read Only) Indicates the status of work order generation: - NotStarted—the default value, work order generation has not started - InProgress—work order generation is underway - Completed—work order generation is complete - Unsuccessful—it was not possible to generate work orders You can generate only one batch at a time. | | WorkTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The associated work type. Work orders generated from the maintenance plan inherit its work type’s duration, required skills and products, and linked articles. Maintenance assets covered by the plan use the same work type, though you can update them to use a different one. | ## 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. [MaintenancePlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [MaintenancePlanFeed](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. [MaintenancePlanHistory](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. [MaintenancePlanOwnerSharingRule](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. [MaintenancePlanShare](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. <!-- document id=761eb469453a1e9154aaa13bce2ed380112ba545baaade27ab22f58a005f03cb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_maintenanceworkrule.md --> # MaintenanceWorkRule Represents the recurrence pattern for a maintenance record. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DoesFloatingWorkOrder | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the maintenance plan uses the floating work order adjustment. The default is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the line item was last modified. Its label in the user interface is Last Modified Date. | | | | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the line item was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of this maintenance work rule. | | NextSuggestedMaintenanceDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The next date on which this rule will generate maintenance items. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The assigned owner of the maintenance work rule. | | ParentMaintenancePlanId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The maintenance plan associated with the maintenance work rule. | | ParentMaintenanceRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The maintenance record this work rule applies to. | | RecordsetFilterCriteriaId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the recordset filter criteria associated with this maintenance work rule. Available in API version 52.0 and later. | | RecurrencePattern | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The RRULE that defines the pattern of recurrence for this work order rule. | | SortOrder | Type int Properties Create, Filter, Group, Sort, Update Description The sort order that applies to this work order rule. | | Title | Type string Properties Create, Filter, Group, Sort, Update Description The title of this work order rule. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of maintenance work rule. Available values are: - Criteria-based - Calendar-based (default) Available in API version 52.0 and later. | | WorkTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the work type that this work order rule generates. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [MaintenanceWorkRuleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [MaintenanceWorkRuleFeed](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. [MaintenanceWorkRuleHistory](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. [MaintenanceWorkRuleOwnerSharingRule](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. [MaintenanceWorkRuleShare](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. <!-- document id=1f932fc281038150690d3fada2a88d144479062d48383b960677ae4423e07f13 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_managedcontent.md --> # ManagedContent Represents managed content in a Salesforce CMS workspace for use in an Experience Cloud site or a channel. The ManagedContent object represents the complete instance of a managed content record. It provides a consistent identifier for the managed content so that variants of the content item can be created over time. This object is available in API version 56.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules ManagedContent is available when the Digital Experiences app is enabled. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, Nillable, Sort Description The unique API name of the Salesforce CMS content. Name requirements: - must be 80 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can't include spaces - can't end with an underscore - can't contain two consecutive underscores This field is available in API version 62.0 and later. | | AuthoredManagedContentSpaceId | Type reference Properties Filter, Group, Nillable, Sort Description The Salesforce CMS workspace ID where the content resides. This field is a relationship field. Relationship Name AuthoredManagedContentSpace Relationship Type Lookup Refers To ManagedContentSpace | | ContentKey | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Unique identifier of the content. | | ContentTypeFullyQualifiedName | Type string Properties Filter, Group, Nillable, Sort Description The fully qualified name of the content type of this CMS content. In an enhanced CMS workspace, the ContentTypeFullyQualifiedName for each standard content type is: - News: sfdc\_cms\_\_news - Image: sfdc\_cms\_\_image - Document: sfdc\_cms\_\_document In a CMS workspace, the ContentTypeFullyQualifiedName for each standard content type is: - News: news - Image: cms\_image - Document: cms\_document In both CMS workspaces and enhanced CMS workspaces, the ContentTypeFullyQualifiedName for a custom content type is the same as the developer name of the custom content type. This field is available in API version 62.0 and later. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the Salesforce CMS content. When you view this content in a CMS workspace, Name is the title of the latest content version. In an enhanced CMS workspace, Name is the title of the content in the workspace’s default language. This field is available in API version 58.0 and later. | | PrimaryLanguage | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The default language of the Salesforce CMS workspace where the content resides. | ## Usage When you create or add content in a Salesforce CMS workspace, the content is uniquely identified by the Salesforce CMS workspace, a content key, and a default language. ManagedContent can be queried through the public sObject API. Use this object to create and retrieve information for a specific managed content. ## 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. [ManagedContentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. <!-- document id=b4a1801cfc6bd688711345726d63a2d5f34815df0298ecd3585f2b74f279d1dc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_managedcontentchannel.md --> # ManagedContentChannel Represents the details of a CMS channel. CMS channels correspond to managed content publishing endpoints. They deliver published content from your Salesforce CMS workspaces to an audience. This object is available in API version 55.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules ManagedContentChannel is available when the Digital Experiences app is enabled. ## Fields | Field | Details | | --- | --- | | CacheControlMaxAge | Type long Properties Filter, Group, Nillable, Sort Description The amount of time, in seconds, it takes for a requested CMS content resource in the CMS channel to expire before a new request for the resource must be made. | | Domain | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The domain for a public channel. Only public channels can have an assigned domain. Possible value is: - mydomain.cdn.salesforce-experience.com ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The mydomain value is specific to the domain of the channel. | | DomainHostName | Type string Properties Filter, Nillable, Sort Description The hostname of the domain assigned to the CMS channel. Only public channels can have an assigned domain. | | MediaCacheControlMaxAge | Type long Properties Filter, Group, Nillable, Sort Description The amount of time, in seconds, it takes for a requested CMS image or document content resource in the CMS channel to expire before a new request for the resource must be made. This field is available in API version 57.0 and later. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Name of the CMS channel. | | OptionsIsCacheControlPublic | Type boolean Properties Filter Description When true, the CMS channel connection type is public. When false, the cache control is private. The default value is false. | | OptionsIsDomainLocked | Type boolean Properties Filter Description When true, the domain set to the channel can’t be changed. Only public channels can have this field set to true. If the channel type is COMMUNITY, the default value is true. For all other channel types, the default value is false. | | OptionsIsSearchable | Type boolean Properties Filter Description When true, users can search for all published CMS content types within the channel. The default value is false. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The connection type of the CMS channel. The connection type determines which audience can access the CMS content delivered in the channel. Possible values are: - COMMUNITY: User access is controlled by the settings of the Experience Cloud site. - CloudToCloud: Connects Salesforce CMS to the B2C Commerce Page Designer. - ConnectedApp: User access to the channel is controlled by the connected application associated with the channel. - PublicUnauthenticated: No user authentication required, content can be cached on public CDNs. - Record: User access to the content is controlled by the user access to the associated record. Content is only accessible to users with access to the record. - UserPermission: This value is reserved for future use. | ## Usage ManagedContentChannel can be queried through the public sObject API. Use this object to retrieve information for a specific CMS channel. <!-- document id=54464706cf9c8ab96a8440c4932f15bca28a0e2dc3ba7a1b79ba136110bdbbf6 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_managedcontentinfo.md --> # ManagedContentInfo Allows the creation of relationship to Product using ProductMedia. This object is available in API version 49.0 to 57.0. In API version 58.0 and later, use the ManagedContent object. ## Supported Calls describeSObjects() ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access a web store. ## Usage The CMS content import process returns a ManageContentInfo ID for each piece of content. The ManagedContentInfo entity has a 1:1 relationship with ProductMedia. To create this relationship, ProductMedia must be associated with a Product entity, for example, Product > ProductMedia > ManagedContentInfo. Use the ID to associate content uploaded through the API with the ProductMedia entity <!-- document id=3ea25cccc3e0713cf9d0899c91d26b2b24b50fc993457def7055a36caae6d05e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_managedcontentspace.md --> # ManagedContentSpace Represents the complete instance of a Salesforce CMS workspace that stores managed content. Users and groups with designated permissions can access and manage the content in a CMS workspace. This object is available in API version 56.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules ManagedContentSpace is available when the Digital Experiences app is enabled. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, Nillable, Sort Description The unique API name of an enhanced Salesforce CMS workspace. Name requirements: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can't include spaces - can’t end with an underscore - can’t contain two consecutive underscores | | DefaultLanguage | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Default language for the Salesforce CMS workspace. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | Description | Type textarea Properties Filter, Group, Nillable, Sort Description Description of the Salesforce CMS workspace. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Name of the Salesforce CMS workspace. | <!-- document id=00307ec88c58dcb31c1759e170cbb00a794cdb0e5a4c5be379fa095d8b1200ab url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_managedcontentvariant.md --> # ManagedContentVariant Represents a variant of a managed content item. This object is available in API version 56.0 and later. Managed content variants are associated with a ManagedContent object. The managed content and variants are counted as one content record in your Salesforce org. For example, say you have a managed content item of content type News and a default language of English. When you translate the News content into other languages such as Spanish, Japanese, and French, a managed content variant for each language is created. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules ManagedContentVariant is available when the Digital Experiences app is enabled. ## Fields | Field | Details | | --- | --- | | ContentTypeFullyQualifiedName | Type string Properties Filter, Group, Nillable, Sort Description The fully qualified name of the content type of this CMS content. In an enhanced CMS workspace, the ContentTypeFullyQualifiedName for each standard content type is: - News: sfdc\_cms\_\_news - Image: sfdc\_cms\_\_image - Document: sfdc\_cms\_\_document The ContentTypeFullyQualifiedName for a custom content type is the same as the developer name of the custom content type. This field is available in API version 62.0 and later. | | IsPublished | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the managed content variant is published to a channel. The default value is false. This field is calculated. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Language of the variant. | | ManagedContentId | Type reference Properties Filter, Group, Sort Description Globally unique identifier for the managed content item. This field is a relationship field. Relationship Name ManagedContent Relationship Type Lookup Refers To ManagedContent | | ManagedContentKey | Type string Properties Filter, Group, idLookup, Sort Description Globally unique identifier for managed content that associates with the managed content variant. | | ManagedContentVariantStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Publication status of the managed content. Possible values are: - Draft - Published - Revised | | Name | Type string Properties Filter, Group, idLookup, Sort Description Name of the managed content variant. | | UrlName | Type string Properties Filter, Group, Nillable, Sort Description URL name of the managed content variant. | | VariantType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Type of variant. Possible value is: - Content | ## Usage Managed content variants are associated with a ManagedContent object. The managed content and managed content variants are counted as one content record in your Salesforce org. ManagedContentVariant can be queried through the public sObject API. Use this object to retrieve information for a specific content in a certain language and format of a managed content. <!-- document id=5c2e7744ca58d53c4dd11d7b93bbda42e237857b5a7f87bf9adfecfd69c20d13 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_marketingform.md --> # MarketingForm Represents an Account Engagement marketing form that has been synched to Salesforce. Use forms on your website and landing pages to collect information about visitors and turn anonymous visitors into identified prospects. This object is available in API version 42.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules To access this object, your org must use Account Engagement and users need the CRM User or Sales User permission set. ## Fields | Field Name | Details | | --- | --- | | CampaignId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related campaign. | | ErrorRate | Type percent Properties Filter, Nillable, Sort Description The percentage of views that led to an error. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when the current user last viewed a record that is related to this form. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the current user last viewed this record. If this value is null, this record might only have been referenced (see LastReferencedDate) and not viewed. | | Name | Type string Properties Filter, Group, Sort Description The name of the marketing form. | | SubmissionRate | Type percent Properties Filter, Nillable, Sort Description The percentage of the views that led to a form submission. | | TotalErrors | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of times a form error prevented a submission. | | TotalSubmissions | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of times the form was successfully submitted. | | TotalTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of link clicks from your thank you page. | | TotalViews | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of times your form has been viewed. Includes multiple views from the same visitor. | | Type | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Specifies the type of marketing form record, either a form or form handler. | | UniqueErrors | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of errors generated by separate visitors. | | UniqueSubmissions | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of unique submissions. Removes multiple submissions from the same prospect. | | UniqueTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of unique link clicks from your thank you page. Removes multiple clicks from the same prospect. | | UniqueViews | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of form views by separate visitors. | ## 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. [MarketingFormEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [MarketingFormFeed](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. <!-- document id=0b5bff974618e5a0e15cf5e7deadc592634cb7bec4d123db03a4109b8cf26c1c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_marketinggoal.md --> # MarketingGoal Represents a measurable target for a marketing program or a campaign, tracking target values, actual results, and assignments across different levels of the marketing hierarchy. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Marketing Planning and Operations must be available to access this object. See [Availability of Marketing Planning and Operations](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | ActualAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The actual monetary amount achieved till current date. | | ActualSourceType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of source that hosts the information about the actual value or the actual amount of the marketing goal. Possible values are: - MANUAL—Manual - SDM—Semantic Model | | ActualValue | Type double Properties Create, Filter, Nillable, Sort, Update Description The actual value achieved till current date. | | AttributionModelId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the attribution model associated with the marketing goal. This field is a relationship field. Relationship Name AttributionModel Refers To AttribModel | | CampaignId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the campaign that the goal belongs to. This field is a relationship field. Relationship Name Campaign Refers To Campaign | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the marketing goal. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The end date of the goal. | | EngagementSignalMetricId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the engagement signal metric associated with the marketing goal. This field is a relationship field. Relationship Name EngagementSignalMetric Refers To EngagementSignalMetric | | ExternalSystemIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier of the marketing goal in an external system. | | GoalRuleType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the logical rule used to evaluate actual performance against the target. This determines whether the goal is achieved by meeting a minimum threshold (At Least) or staying within a maximum limit (At Most). Possible values are: - AT\_LEAST—At Least - AT\_MOST—At Most | | IsFinancialGoal | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the goal is a financial target (true) or a non-financial metric (false). The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastRollupRunDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the automated rollup job last ran, aggregating actual values or amounts from child goals into this goal. This timestamp also helps identify a rollup that's stuck in progress for more than 90–120 minutes, so it can be retriggered. | | LastRollupStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the current status of the automated job that aggregates the actual values or amounts from the child goals in the rollup hierarchy and updates the aggregated value as the actual value or amount of the current goal. Possible values are: - COMPLETED—Completed - FAILED—Failed - IN\_PROGRESS—In Progress - SUBMITTED—Submitted | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate is not null, the user accessed this record or list view indirectly. | | MarketingProgramId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the marketing program that the goal belongs to. This field is a relationship field. Relationship Name MarketingProgram Refers To MarketingProgram | | MeasureType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of measure used to identify the target and actual values of the marketing goal. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the marketing goal. | | Notes | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Additional information about the goal. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the marketing goal record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ParentGoalId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the goal that the current goal rolls up to. This field is a relationship field. Relationship Name ParentGoal Refers To MarketingGoal | | RootMarketingGoalId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the top-level marketing goal that the current goal rolls up to. This field is a relationship field. Relationship Name RootMarketingGoal Refers To MarketingGoal | | SemanticMetricDefinitionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the semantic metric definition that hosts the information about the actual value or the actual amount of the marketing goal. This field is a relationship field. Relationship Name SemanticMetricDefinition Refers To SemanticMetricDefinition | | SourceReferenceId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the campaign or marketing program that the goal belongs to. This field is a polymorphic relationship field. Relationship Name SourceReference Refers To Campaign, MarketingProgram | | Stage | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the stage of the marketing goal. Possible values are: - AT\_RISK—At Risk - CANCELLED—Cancelled - COMPLETE—Complete - NOT\_STARTED—Not Started - ON\_TRACK—On Track The default value is NOT\_STARTED. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the goal. | | SubType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the subtype of marketing goal. | | TargetAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The target monetary amount of the goal. | | TargetValue | Type double Properties Create, Filter, Nillable, Sort, Update Description The target value of the goal. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of marketing goal. | ## 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. [MarketingGoalFeed](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. [MarketingGoalHistory](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. [MarketingGoalOwnerSharingRule](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. [MarketingGoalShare](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. <!-- document id=0d1689aa15c4f423aa5490398a732b5649eb1bbbb2ef4d550f2b649d501a97ac url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_marketinglink.md --> # MarketingLink Represents an Account Engagement marketing link record, either a custom redirect or a file, that has been synced to Salesforce. This object is available in API version 42.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules To access this object, your org must use Account Engagement and users need the CRM User or Sales User permission set. ## Fields | Field Name | Details | | --- | --- | | CampaignId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related campaign. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when the current user last viewed a record that is related to this marketing link. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the current user last viewed this record. If this value is null, this record might only have been referenced (see LastReferencedDate) and not viewed. | | Name | Type string Properties Filter, Group, Sort Description The name of the marketing link. | | TargetUrl | Type url Properties Filter, Group, Sort Description The target URL of the marketing link. | | TotalTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The total number of clicks for the redirect. Includes clicks from visitors and identified prospects. When a person clicks the link multiple times, each click is counted in this number. | | Type | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Specifies the type of marketing link record, either a custom redirect or file. | | UniqueTrackedLinkClicks | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of unique clicks for the redirect. Includes clicks from visitors and identified prospects. Only the first click is counted in this number. | ## 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. [MarketingFormEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [MarketingLinkFeed](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. <!-- document id=b6d47afb08c00835418fc189ef3219138d6c6fec85461100f3191b06f00a5ac4 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_marketingprogram.md --> # MarketingProgram Represents a marketing program in a marketing hierarchy group that's tied to a specific node in the hierarchy. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Marketing Planning and Operations must be available to access this object. See [Availability of Marketing Planning and Operations](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | AudienceProfile | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The persona of the marketing program's target audience, describing the mindset, motivations, and defining traits that characterize them, such as a visionary steward focused on ethical legacy or a technical skeptic who demands proof over promises. | | BrandGuardrail | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The rules that keep the marketing program's communications consistent with the brand's identity and positioning, such as presenting the brand as a trusted governance leader, avoiding startup aesthetics, or requiring an evidence-led brand voice. Establishes the boundaries for how the brand is represented across visual identity, tone, and messaging. | | BusinessUnitId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the business unit associated with the marketing program. This field is a relationship field. Relationship Name BusinessUnit Refers To BusinessUnit | | ChannelList | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The list of channels available to the marketing program for reaching its audience, such as a corporate website, executive PR, or industry events. Defines the complete range of channels at the program level, from which campaigns created under the program select a more specific subset. | | CommunicationExclusions | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The elements that the marketing program's communications must avoid, such as competitor mentions, restricted words, or unsubstantiated claims. | | CommunicationInclusions | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The elements that the marketing program's communications must always include, such as SOC 2 Type II compliance, HIPAA compliance, or cryptographic proof. | | CommunicationStyle | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The formatting and style conventions that the marketing program's communications follow, such as long-form academic documents, data-heavy slide decks, or bulleted technical whitepapers. | | CommunicationTone | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The tone that the marketing program's communications convey, such as authoritative, consultative, or peer-to-peer. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the marketing program. | | EndDate | Type date Properties Create, Filter, Group, Sort, Update Description Specifies the end date of the marketing program. | | ExternalSystemIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier of the marketing program in an external system. | | KeyBenefits | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The key benefits that the marketing program promotes to its audience, such as regulatory safety, patient trust, or seamless API integration | | KeyMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The primary message that the marketing program conveys to its audience, capturing the central theme or business value the audience should resonate with. | | KeyOffering | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The key offering that the marketing program intends to promote to its audience, such as access to an industry charter, a strategy consultation, or a technical proof of concept. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate is not null, the user accessed this record or list view indirectly. | | MarketingHierGroupDefId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the marketing hierarchy group definition associated with the marketing program. This field is a relationship field. Relationship Name MarketingHierGroupDef Refers To MarketingHierarchyGroupDef | | MarketingHierGrpNdDefId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the marketing hierarchy group node definition associated with the marketing program. This field is a relationship field. Relationship Name MarketingHierGrpNdDef Refers To MarketingHierarchyGroupNodeDef | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the marketing program. | | OverallComplianceStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the compliance status of the marketing program based on the reviews of all applicable compliance controls. Possible values are: - Compliant - NotCompliant—Not Compliant - NotStarted—Not Started The default value is NotStarted. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the marketing program record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ParentMarketingProgramId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the marketing program that the current program rolls up to. This field is a relationship field. Relationship Name ParentMarketingProgram Refers To MarketingProgram | | RootMarketingProgramId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the top-level marketing program that the current program rolls up to. This field is a relationship field. Relationship Name RootMarketingProgram Refers To MarketingProgram | | Stage | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the current stage of the marketing program. Possible values are: - Approval - Archive - Completed - Development - Discovery - Execution - Planning The default value is Discovery. | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description Specifies the start date of the marketing program. | | TargetAudience | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The audience segment that the marketing program is intended to reach, such as Global Fortune 500 enterprises, hospital systems, or IT architects and chief security officers. | ## 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. [MarketingProgramFeed](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. [MarketingProgramHistory](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. [MarketingProgramShare](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. <!-- document id=569df378a444e932b28e94de64a3ee8103037bbfc898a9b1e8918cdb9d58d0a0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_marketingtactic.md --> # MarketingTactic Represents a single executable unit of work for a campaign or marketing program that combines marketing content with a specific delivery method, such as an email or a social post. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Marketing Planning and Operations must be available to access this object. See [Availability of Marketing Planning and Operations](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | BusinessUnitId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the business unit that the marketing tactic belongs to. This field is a relationship field. Relationship Name BusinessUnit Refers To BusinessUnit | | CampaignId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the campaign that the marketing tactic belongs to. This field is a relationship field. Relationship Name Campaign Refers To Campaign | | Description | Type textarea Properties Create, Update Description The description of the marketing tactic. | | ExternalSystemIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier of the marketing tactic in an external system. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate is not null, the user accessed this record or list view indirectly. | | MarketingProgramId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the marketing program that the marketing tactic belongs to. This field is a relationship field. Relationship Name MarketingProgram Refers To MarketingProgram | | MarketingTacticTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the marketing tactic template that was used to create the marketing tactic. This field is a relationship field. Relationship Name MarketingTacticTemplate Refers To MarketingTacticTemplate | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the marketing tactic. | | OverallComplianceStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the compliance status of the marketing tactic, based on the reviews of all applicable compliance controls. Possible values are: - Compliant - NotCompliant—Not Compliant - NotStarted—Not Started The default value is NotStarted. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the marketing tactic record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | SourceReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the campaign or marketing program that the marketing tactic belongs to. This field is a polymorphic relationship field. Relationship Name SourceReference Refers To Campaign, MarketingProgram | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the status of the marketing tactic. Possible values are: - Active - Complete - Draft - InActive—Inactive - OnHold—On Hold The default value is Draft. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of marketing tactic. | ## 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. [MarketingTacticFeed](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. [MarketingTacticHistory](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. [MarketingTacticShare](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. <!-- document id=3afb4e7d9cd51ac085ab51a1c6d41a8d67a710395803fe132a0725a63505630b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_marketingtactictemplate.md --> # MarketingTacticTemplate Represents a repeatable template used to replicate successful marketing tactics across teams. This object is available in API version 68.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update() ## Special Access Rules Marketing Planning and Operations must be available to access this object. See [Availability of Marketing Planning and Operations](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | BusinessUnitId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the business unit that the marketing tactic template belongs to. This field is a relationship field. Relationship Name BusinessUnit Refers To BusinessUnit | | Description | Type textarea Properties Filter, Group, Sort Description The description of the marketing tactic template. | | ExternalSystemIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the marketing tactic template in an external system. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the marketing tactic template. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the owner of the marketing tactic template record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Status | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the status of the marketing tactic template. Possible values are: - Active - InActive—Inactive The default value is Active. | | Type | Type picklist Properties Filter, Group, Nillable, Sort Description Specifies the type of marketing tactic template. | ## 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. [MarketingTacticTemplateFeed](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. [MarketingTacticTemplateHistory](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. [MarketingTacticTemplateShare](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. <!-- document id=b7dc63c6aee07a5fc17f8b816e8678b3649702521e87d18fb31ea3b74a75e653 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_matchingrule.md --> # MatchingRule Represents a matching rule that is used to identify duplicate records. This object is available in API version 33.0 and later. A matching rule compares field values to determine whether a record is similar enough to existing records to be considered a duplicate. For example, a matching rule can specify that if the Email and Phone values of two records match exactly, the records are possible duplicates. Your organization uses matching rules with duplicate rules to define what happens when duplicates are identified. If the rule is for a Person Account, SobjectSubType is automatically set to PersonAccount. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only users with the View Setup and Configuration permission can access this object. ## Fields <table class="featureTable sort_table" summary=""> <thead class="thead sorted" align="left"> <tr> <th class="featureTableHeader " id="d1250846e100">Field Name</th> <th class="featureTableHeader " id="d1250846e103">Details</th> </tr> </thead> <tbody class="tbody"> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">BooleanFilter</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Specifies filter logic conditions.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">Description</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">textarea</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The description of the matching rule.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">DeveloperName</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The developer name for the matching rule.</dd> <dd class="dd"> <div class="box message info"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note"> <div class="mediaBd"> <h4 class="mbs">Note</h4> <p>Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.</p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">Language</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The language selected for your organization.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">MasterLabel</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The name of the matching rule.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">MatchEngine</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The match engine used by the matching rule.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">NamespacePrefix</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">string</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Nillable, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The namespace prefix for matching rules for your organization.</dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">RuleStatus</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">Required. The activation status of the matching rule. Values are:<ul class="ul bulletList"> <li class="li"><kbd class="ph userinput">Inactive</kbd></li> <li class="li"><kbd class="ph userinput">Deactivating</kbd></li> <li class="li"><kbd class="ph userinput">DeactivationFailed</kbd></li> <li class="li"><kbd class="ph userinput">Active</kbd></li> <li class="li"><kbd class="ph userinput">Activating</kbd></li> <li class="li"><kbd class="ph userinput">ActivationFailed</kbd></li> </ul> <div class="box message confirm"> <div class="inner"> <div class="bd"> <div class="media"> <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png" alt="Important"> <div class="mediaBd"> <h4 class="mbs">Important</h4> <p>The only valid values you can declare when deploying a package are <kbd class="ph userinput">Active </kbd> and <kbd class="ph userinput"> Inactive</kbd>. </p> </div> </div> </div> </div> </div> </dd> </dl> </td> </tr> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">SobjectSubtype</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd"> <span class="ph" id="SobjectSubType_descr"><a name="SobjectSubType_descr"><!-- --></a>Read-only. Indicates if the matching rule is defined for the <span class="keyword parmname">Person</span> subtype of <span class="keyword parmname">Account</span>.</span> Valid values are:<ul class="ul bulletList"> <li class="li"><samp class="codeph nolang">PersonAccount</samp></li> <li class="li"><samp class="codeph nolang">None</samp></li> </ul> </dd> </dl> <p class="p">If the rule is for a Person Account, <span class="keyword parmname">SobjectSubType</span> is automatically set to <samp class="codeph nolang">PersonAccount</samp>. </p> </td> </tr> <tr> <td class="entry" headers="d1250846e100" data-title="Field Name"><span class="keyword parmname">SobjectType</span></td> <td class="entry" headers="d1250846e103" data-title="Details"> <dl class="dl detailList"> <dt class="dt dlterm">Type</dt> <dd class="dd">picklist</dd> <dt class="dt dlterm">Properties</dt> <dd class="dd">Filter, Group, Restricted picklist, Sort</dd> <dt class="dt dlterm">Description</dt> <dd class="dd">The object for the matching rule.</dd> </dl> </td> </tr> </tbody> </table> ## Usage Use the Salesforce API to retrieve and view details about MatchingRule and MatchingRuleItem. Use the Salesforce Metadata API to create, update, or delete these objects. #### See Also - [MatchingRuleItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_matchingruleitem.htm "Represents criteria used by a matching rule to identify duplicate records. This object is available in API version 33.0 and later.") - [DuplicateRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_duplicaterule.htm "Represents a duplicate rule for detecting duplicate records.") - [MatchingRule in the Salesforce Metadata API Developer's Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_matchingrule.htm " MatchingRule in the Salesforce Metadata API Developer's Guide - HTML (New Window)") <!-- document id=7344cfa69884bf40785f90d8c7ad48d38ca6681caed79563208196766f28142e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_matchingruleitem.md --> # MatchingRuleItem Represents criteria used by a matching rule to identify duplicate records. This object is available in API version 33.0 and later. A matching rule item determines which field the matching rule uses to identify a duplicate record. It also determines the method used to compare value that two records have for the field. For example, a matching rule item might specify that the Email field values of two records must match exactly in order for the records to be considered duplicates. When a matching rule has multiple matching rule items, it means that multiple fields must match in order for the records to be identified as dupcliates. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only users with the View Setup and Configuration permission can access this object. ## Fields | Field Name | Details | | --- | --- | | BlankValueBehavior | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Specifies how blank fields affect whether the fields being compared are considered matches. Valid values are: - MatchBlanks - NullNotAllowed (default) | | Field | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates which field to compare when determining if a record is similar enough to an existing record to be considered a match. | | MatchingMethod | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Defines how the fields are compared. Choose between the exact matching method and various fuzzy matching methods. Valid values are: - Exact - FirstName - LastName - CompanyName - Phone - City - Street - Zip - Title For details on each matching method, see “Matching Methods Used with Matching Rules” in the Salesforce Help. | | MatchingRuleId | Type reference Properties Filter, Group, Sort Description The ID for the matching rule. This is a relationship field. Relationship Name MatchingRule Relationship Type Lookup Refers To MatchingRule | | SortOrder | Type int Properties Filter, Group, Sort Description The order of the matching rule items for a matching rule. | ## Usage Use the Salesforce SOAP API to retrieve and view details about MatchingRule and MatchingRuleItem. Use the Salesforce Metadata API to create, update, or delete these objects. #### See Also - [MatchingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_matchingrule.htm "Represents a matching rule that is used to identify duplicate records. This object is available in API version 33.0 and later.") - [DuplicateRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_duplicaterule.htm "Represents a duplicate rule for detecting duplicate records.") - [MatchingRule in the Salesforce Metadata API Developer's Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_matchingrule.htm " MatchingRule in the Salesforce Metadata API Developer's Guide - HTML (New Window)") <!-- document id=b7fd9b42ee186881fcec1ce9f985089aee8a878c90b86ac1fcfde2974bc6eeab url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_merchaccpaymentmethodset.md --> # MerchAccPaymentMethodSet Defines an ordered list of payment methods that are available to a merchant's cudstomer during checkout. You can configure multiple payment method sets, each designated for a specific locale, payment region, or sale channel. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license with the Payments permission enabled for your org. Salesforce Payments entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. The ISO code for any currency allowed by the organization. | | DeveloperName | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Unique name for the object given by the Payments admin. | | MerchantAccountId | Type reference Properties Create, Filter, Group, Sort Description Foreign key to the MerchantAccount. This field is a relationship field. Relationship Name MerchantAccount Relationship Type Lookup Refers To MerchantAccount | | PaymentMethodSetNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-assigned ID for the MerchAccPaymentMethodSet. | | PaymentMethodSummary | Type string Properties Filter, Group, Nillable, Sort Description Summary field that is automatically populated with comma-separated values from MerchAccPaymentMethodType. This field is a calculated field. | <!-- document id=df3affb62cac12386ed15d7dd12c5147385d0ae132d6907d560761e998dbab53 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_merchaccpaymentmethodtype.md --> # MerchAccPaymentMethodType Refers to a payment method that is in a payment method set, which is defined by the MerchAccPaymentMethodSet object. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license with the Payments permission enabled for your org. Salesforce Payments entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only when the multicurrency feature is enabled. Contains the ISO code for any currency used by the org. | | PaymentInstrumentType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of instrument the payer can pay with. Possible values are: - us\_bank\_account - ACH\_Debit - affirm - Affirm - afterpay - Afterpay - afterpay\_clearpay - Afterpay/Clearpay - amazon\_pay - Amazon Pay - applepay - Apple Pay - au\_becs\_debit - BECS\_Debit - bacs\_debit - BACS\_Debit - bancontact - Bancontact - card - Credit Cards - cashapp - Cash App - clearpay - Clearpay - eps - EPS - googlepay - Google Pay - ideal - iDEAL - klarna - Klarna - link - Link - paypal - PayPal - sepa\_debit - SEPA Debit - venmo - Venmo - wechat\_pay - WeChat Pay | | PaymentMethodSetId | Type reference Properties Create, Filter, Group, Sort Description ID of the MerchAccPaymentMethodSet. This field is a relationship field. Relationship Name PaymentMethodSet Relationship Type Lookup Refers To MerchAccPaymentMethodSet | | PaymentMethodSetTypeNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-assigned ID for the MerchAccPaymentMethodSet. | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Sort order for the MechAccPaymentMethodType within the MerchAccPaymentMethodSetExperience. | ## Associated Objects This object has these associated object. 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. [MerchAccPaymentMethodTypeHistory](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. <!-- document id=663421284c28b7f7bf9b3f2ee36b7b9493cc80de665dc7b02d52dc4313287895 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_merchantaccount.md --> # MerchantAccount A type of bank account that lets a merchant accept payments from a variety of payment methods, including credit or debit cards, or digital wallets. A Salesforce Payments merchant account is linked to an underlying payment gateway to process payments This object is available in API version 56.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license and Payments must be enabled for your org. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountDescription | Type textarea Properties Create, Nillable, Update Description Information about the merchant account. | | CountryIsoCode | Type string Properties Create, Filter, Group, Sort, Update Description Country where the legal entity representing the account is. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Contains the ISO code for any currency allowed by the organization. Available only for organizations with multi-currency enabled. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, the user can have accessed this record or list view but not viewed it. | | Mode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The operational mode of the merchant account. This field determines the account’s ability to accept payments. For production, the account must be in Live mode. Possible values are: - Connected– Merchant account is active but it can’t accept payments. This option is only valid in production orgs. - Live– Merchant account is active and can accept payments. This option is only valid in production orgs. - Test –Merchant account is active but not able to accept payments. This option is only valid in sandbox orgs, and the account can accept only test transactions. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the merchant account. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Name of the individual or group assigned to the merchant account. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaymentStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Merchant account is active and can accept payments. Possible values are: - Disabled - Enabled The default value is Disabled. | | PayoutStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Money can be moved from the payment provider account to the designated merchant account. Possible values are: - Disabled - Enabled The default value is Disabled. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the state of the merchant account. Possible values are: - Active - The merchant account can accept payments. - Complete - PaymentStatus and DepositStatus are enabled and all the required information is provided. - Enabled - PaymentStatus and PayoutStatus are enabled, but the payment provider requires more information later. If the merchant doesn't provide the information, then the account becomes restricted. The time limit that the merchant has to provide the information is longer than the RestrictedSoon state. - Pending - The merchant account exists but it can’t accept payments. This option maintains backward compatibility for accounts that were created with API version 55.0 and earlier. - Rejected - The account is rejected and an explanation is provided. - Restricted - PaymentStatus, PayoutStatus, or both are disabled, so the merchant account’s operation is limited. - Restricted Soon - PaymentStatus and PayoutStatus are enabled, but the payment provider requires more information. If the merchant doesn't provide the information in a specific time period, then the account becomes restricted. | ## 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. [MerchantAccountChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [MerchantAccountFeed](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. [MerchantAccountHistory](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. [MerchantAccountOwnerSharingRule](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. [MerchantAccountShare](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. <!-- document id=55d1b99432bc5ea1e81348d65ce50b203ba08ed9e10599c4663427f3421a2f70 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_merchantaccountevent.md --> # MerchantAccountEvent Represents a merchant account platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later. For more information about platform events, see the [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_intro.htm "HTML (New Window)"). ## Supported Calls describeSObjects() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license and Payments must be enabled for your org. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | ChangeType | Type picklist Properties Restricted picklist Description Type of merchant account event, which triggers an event notification. You can write code to listen to operate conditionally on the value of this field. For example, you can ignore a create change but get notified of updates. Possible values are: - Create–Merchant account is created. - Disable–The account is deactivated. For example, the payment provider or the merchant disables an account due to fraudulent activity. - PaymentEnable–The account is active and ready to receive payments. - PayoutEnable–The account is ready to receive payouts. - Update–Merchant account property change occurs. | | MerchantAccountId | Type reference Properties Nillable Description Identifies the merchant account for which the event occurs. This field is a relationship field. Relationship Name MerchantAccount Relationship Type Lookup Refers To MerchantAccount | <!-- document id=75b94144375daa4cddbc2848b5ad6f86073374fa8b6d55ef7f90486f6ccf56bb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messagingchannel.md --> # MessagingChannel Represents a communication channel that an end user can use to send a message to an agent. A communication channel can be an SMS number, a Facebook page, or another supported messaging channel. This object is available in API version 40.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | BusinessHoursId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The operating hours for your business, when agents are available. Available only in orgs that use Einstein Bots. This is a relationship field. Relationship Name BusinessHours Relationship Type Lookup Refers To BusinessHours | | ChannelAddressIdentifier | Type string Properties Filter, Group, Nillable, Sort Description A UUID that identifies a deployed messaging channel. This identifier is unique across orgs, so a channel with the same MessagingPlatformKey in a sandbox and production will have a different ChannelAddressIdentifier for each. Available in API version 59.0 and later. | | ChannelDefinitionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The associated conversation channel definition, which is used only in Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS. Available in API version 58.0 and later. This field is a relationship field. Relationship Name ChannelDefinition Refers To ConversationChannelDefinition | | ConsentType | Type picklist Properties Create, defaultedOnCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of consent, or opt-in, that is required to message users on this channel. This field is available in API version 48.0 and later. Possible values are: - DoubleOptIn - ExplicitOptIn - ImplicitOptIn (default value) The property defaultedOnCreate has been removed in API version 51.0 and later. Now the consent type is defaulted to ImplicitOptIn when the consent type isn’t set on create only for channels that support consents. | | ConversationEndResponse | Type textarea Properties Create, Nillable, Update Description Automated response to the customer when the agent ends the conversation. (Optional) | | CriticalWaitTime | Description Reserved for future use. This field has been deprecated as of API version 52.0. | | DefaultApplication | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies which application should handle an inbound message on this channel when no routing handler matches it. Possible values are: - DefaultResponse—Default Response - DigitalEngagement—Digital Engagement - IgnoreMessage—Ignore Message - MarketingCloudEngagement—Marketing Cloud Engagement | | DefaultResponse | Type textarea Properties Create, Nillable, Update Description Message sent to the customer when a customer initiates a conversation. | | Description | Description Reserved for future use. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer name for the messaging channel. This value is a concatenation of the messaging platform key and the message type. | | DoubleOptInPrompt | Type textarea Properties Create, Nillable, Update Description Automated response to the end user to prompt them to doubly opt in to receiving messages. Available in API version 48.0 and later. | | EngagedResponse | Type textarea Properties Create, Nillable, Update Description Automated response to the customer when the conversation is accepted by the agent. (Optional) | | InitialResponse | Type textarea Properties Create, Nillable, Update Description First automated response to the customer for a new conversation. (Optional) | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a channel is active and can receive messages. | | IsAuthenticated | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a user is authenticated to a voice assistant. The org permission Live Message Voice is required to access and update this field. Available in API version 44.0 and later. | | IsoCountryCode | Type string Properties Create, Filter, Group, Nillable, Sort Description Two-letter ISO 3166-1 alpha-2 code for the country that the phone number is associated with. For example, the code for United States is US. Available in API version 44.0 and later. | | IsRequireDoubleOptIn | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether double opt-in is required (true) or not (false) for this Messaging channel. Available in API version 48.0 and later. | | IsRestrictedToBusinessHours | Description Reserved for future use. | | IsUserMatchByExternalIdOnly | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to restrict matching on customer by external ID only (and not use the full name). This field has been deprecated as of API version 52.0. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reserved for future use. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Unique name for the MessagingChannel. | | MessageType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Type of message. Possible values are: - AppleBusinessChat—Represents Apple Messages for Business. - Custom—Represents Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS. Available in API version 58.0 and later. - EmbeddedMessaging—Represents Enhanced Chat. Available in API version 50.0 and later. - Email - Facebook - MsCopilot - Phone - PSTNVoice—Represents an Agentforce Voice channel that uses PSTN. Available in API version 65.0 and later. - Rcs - SIPVoice—Represents an Agentforce Voice channel that uses SIP. Available in API version 65.0 and later. - Text - Voice - WhatsApp | | MessagingPlatformKey | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Unique key for a channel that the end user can message or call based on the MessageType. - In PSTNVoice, SMS, WhatsApp, and LINE channels, the platform key is the phone number associated with this channel. - In Facebook Messenger channels, the platform key is the Facebook page ID associated with this channel. - In Apple Messages for Business channels, the platform key is the Apple Messages identifier. - In Enhanced Chat, the platform key is identical to the Channel Address Identifier. | | OfflineAgentsResponse | Description Reserved for future use. | | OptInPrompt | Type textarea Properties Create, Nillable, Update Description Automated response to the end user to prompt them to explicitly opt in to receiving messages. Available in API version 49.0 and earlier. | | OptInResponse | Type textarea Properties Create, Defaulted on create, Nillable, Update Description Automated response to the end user when they opt in to messaging. Available in API versions 48.0 and 49.0. Use the OptInConfirmation field of the [MsgChannelLanguageKeyword](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_msgchannellanguagekeyword.htm "Represents the consent configuration for a Messaging channel. This object is available in API version 48.0 and later.") object instead. | | OptionsIdentifyEndUserLanguage | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Auto-populates the Language field for this channel’s messaging users if their locale is known. Supported for Enhanced Chat and Apple Messages for Business only. | | OptOutResponse | Type textarea Properties Create, Defaulted on create, Nillable, Update Description Automated response to the end user when they opt out of messaging. Available in API version 48.0 only. Use the OptOutConfirmation field of the [MsgChannelLanguageKeyword](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_msgchannellanguagekeyword.htm "Represents the consent configuration for a Messaging channel. This object is available in API version 48.0 and later.") object instead. | | OutsideBusinessHoursResponse | Description Reserved for future use. | | PlatformType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the channel is Standard or Enhanced. When a standard SMS or Facebook Messenger channel is upgraded, the PlatformType changes from Standard to Enhanced. When a standard WhatsApp channel is upgraded, the original channel’s PlatformType remains Standard and a new channel is created with a PlatformType of Enhanced. Enhanced Chat channels have a PlatformType of Enhanced. | | RoutingConfigurationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies which Omni-Channel routing configuration to use. This field is required when RoutingType is OmniSkills. To learn more, see [Create Routing Configurations](https://help.salesforce.com/articleView?id=service_presence_create_routing_configuration.htm&language=en_US). | | RoutingType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type used to support Omni-Channel’s different routing methods. - OmniQueue (queue-based routing) - OmniSkills (skills-based routing) When this value isn’t set, OmniQueue is used. | | SessionHandler | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The queue or Omni-Channel flow that the channel's messaging sessions are routed to. Available in API version 51.0 and later. | | TargetQueueId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Queue in which incoming conversations are placed while waiting for an agent to accept. This is a relationship field. Relationship Name TargetQueue Relationship Type Lookup Refers To Group | | TargetUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Messaging User or agent for the conversation. Available in API version 50.0 and earlier. | ## Usage While third-party messaging channels can be created via Apex, we recommend creating channels via the Messaging Settings page in Setup. Channels created via Apex may not work and can't be deleted. In enhanced WhatsApp, Facebook Messenger, Apple Messages for Business, and LINE channels, the flow of a channel's messaging traffic is controlled by an associated MessagingChannelUsage record. The MessagingChannelUsage determines whether the channel is active or deactivated. <!-- document id=81834fd258f065f7502cad11c089ade223937f654b4dfe44ef584a1fd1cb6851 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messagingchannelskill.md --> # MessagingChannelSkill Junction object that represents an association between MessagingChannel and Skill. This object is available in API version 45.0 and later. For example, when we want to use Omni-Channel skills-based routing in Live message, this object maintains the mapping between the messaging channel and the skill. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | MessagingChannelId | Type reference Properties Create, Filter, Group, Sort Description ID of the [MessagingChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingchannel.htm "Represents a communication channel that an end user can use to send a message to an agent. A communication channel can be an SMS number, a Facebook page, or another supported messaging channel. This object is available in API version 40.0 and later."). This is a relationship field. Relationship Name MessagingChannel Relationship Type Lookup Refers To MessagingChannel | | SkillId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the [Skill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_skill.htm "Represents a category or group of Chat users or service resources in Field Service or Workforce Engagement. This object is available in API version 24.0 and later."). This is a relationship field. Relationship Name Skill Relationship Type Lookup Refers To Skill | <!-- document id=37aca8ab9ff5520d6a1fe2ee297f2d1659286a54fe23b3417ce5c28b3f5b22cb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messagingchannelusage.md --> # MessagingChannelUsage Represents the status of an enhanced Messaging channel or of an application in a Unified Messaging channel. This object is available in API version 60.0 and later. A MessagingChannel can be associated with up to three MessagingChannelUsage records, each with a unique DeploymentType. The role of a MessagingChannelUsage record differs slightly depending on whether it's used in an enhanced Messaging channel or a Unified Messaging channel. - In enhanced WhatsApp, Facebook Messenger, Apple Messages for Business, and LINE channels, each channel has one associated MessagingChannelUsage record with a DeploymentType of Conversation. The MessagingChannelUsage record determines the channel's flow of messaging traffic. When you activate such a channel in Setup, its MessagingChannelUsage record updates to use a DeploymentStatus of Active, and messaging traffic can flow to and from Salesforce. Similarly, deactivating the channel in Setup causes its MessagingChannelUsage record to update to a DeploymentStatus of Disabled, and stops the flow of messaging traffic. - In Unified Messaging channels, the MessagingChannelUsage record represents the status of a connected Service Cloud or Marketing Cloud application. For example, if a WhatsApp Unified Messaging channel is connected to both Service Cloud and Marketing Cloud, the MessagingChannel record has two associated MessagingChannelUsage records with a DeploymentType of Conversation and MJ, respectively. These MessagingChannelUsage records are created when a user selects the Marketing or Service application during Unified Messaging setup. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ConsentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of customer consent required for your business to message a customer on this channel. Customers can opt out at any time. Possible values are: - Implicit Opt-In: By sending an initial message to your business, the customer agrees to receive messages. - Explicit Opt-In: The customer uses keywords to actively opt into receiving messages. - Double Opt-In: The customer uses keywords to opt in twice to receiving messages. | | DeploymentStatus | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the connected channel or application. If the DeploymentStatus is Active, messages can be sent or received (if permitted). Possible values are: - New—Admin selected the Marketing or Service application in Unified Messaging Setup, or created a new enhanced WhatsApp, Facebook Messenger, Apple Messages for Business, or LINE channel on the Messaging Settings page in Setup. - Provisioning—Admin clicked **Connect** on an application in Unified Messaging Setup, or **Activate** on an enhanced Messaging channel. - Active—Provisioning was successful and the channel can be used to message with customers via the connected application or channel. - Error—Provisioning or deprovisioning wasn’t successful. The admin can retry. - Deprovisioning—Admin clicked **Disconnect** on an application in Unified Messaging Setup, or **Deactivate** on an enhanced Messaging channel. - Disabled—Deprovisioning was successful and the channel or application can no longer be used to message with customers. | | DeploymentType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Indicates whether the record is related to Service Cloud or Marketing Cloud. Possible values are: - Conversation—Relating to Service Cloud. - MessagingEngagement—Relating to Marketing Cloud. - MJ—Relating to Marketing Cloud. J stands for Journey Builder. | | DisabledTime | Type dateTime Properties Filter, Nillable, Sort Description The time the MessagingChannelUsage record entered the Disabled state after an admin clicked **Disconnect** or **Deactivate** on the application or channel. When the record is disabled, all inbound and outbound messages aren’t sent via the connected application. Any sessions with a status other than Ended or Error are automatically ended within 48 hours unless the MessagingChannelUsage record is reenabled.  | | ErrorReason | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If an error occurs during connection, activation, disconnection, or deactivation of a MessagingChannelUsage record, the ErrorReason provides more information about what went wrong. For example, if an associated Service Cloud application for a Unified Messaging channel is missing a fallback queue or consent keywords, the connection attempt fails with an ErrorReason of ProvisioningError. Possible values are: - DeprovisioningError - InternalError - InvalidSelection - ProvisioningError - WHATSAPP\_DEPROV\_ERR\_ChannelDetailDeleteFailed\_3053 - WHATSAPP\_DEPROV\_ERR\_TemplateDeleteFailed\_3052 - WHATSAPP\_DEPROV\_ERR\_WabaDetailDeleteFailed\_3052 - WHATSAPP\_DEPROV\_ERR\_WabaDoesNotExist\_3051 - WHATSAPP\_DEPROV\_ERR\_WabaNotActive\_3051 - WHATSAPP\_PROV\_ERR\_PhoneNumberDetailsFetchFailed\_3041 - WHATSAPP\_PROV\_ERR\_PhoneNumberMigrationFailed\_3041 - WHATSAPP\_PROV\_ERR\_ProvisioningException\_3040 - WHATSAPP\_PROV\_ERR\_WabaAlreadyRegisteredWithDirect\_3042 - WHATSAPP\_PROV\_ERR\_WabaContextMismatch\_3041 | | MessagingChannelId | Type reference Properties Create, Filter, Group, Sort Description The enhanced Messaging channel or Unified Messaging channel that the MessagingChannelUsage record is associated with. A MessagingChannel can be associated with up to three MessagingChannelUsage records. This field is a relationship field. Relationship Name MessagingChannel Relationship Type Lookup Refers To MessagingChannel | | RoutingOverride | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Applicable only to MessagingChannelUsage records with a deployment type of MJ (Marketing Cloud). RoutingOverride indicates how messages are delivered in a unified channel where both the Service and Marketing applications are connected.    Possible values are: - MJKeywordsOnly—If a messaging user sends a marketing keyword that is defined in Journey Builder, Journey Builder handles the message delivery and response. If a messaging user sends a non-keyword message, Omni-Channel handles the message delivery and response. - NonSessionMessages—If a messaging user is engaged in an active Service Cloud messaging session, Service Cloud handles message delivery and response. If the user isn’t engaged in an active session, Journey Builder handles message delivery and response. Regardless of the RoutingOverride value, outbound messages are always handled by Service Cloud if the messaging user is engaged in an active Service Cloud messaging session. A session is considered active if its status isn't Ended or Error. | <!-- document id=d1f1c1e8d954ab5b6bb7a44ae12efde315aee67db8e7b07652c931162496db0c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messagingconfiguration.md --> # MessagingConfiguration Represents the details for a Messaging configuration. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The API name for this Messaging configuration. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of this Messaging configuration. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label for the Messaging configuration. | | MessagingServiceUrl | Type string Properties Filter, Group, Nillable, Sort Description The URL for the Messaging service. | | ProvisioningServiceUrl | Type string Properties Filter, Group, Nillable, Sort Description The URL for the provisioning service. | <!-- document id=4dc4a4d5d4a6af58cdb2c8fc5efb3be77d1d7e37ab9fc1f2611efd9fac751e7c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messagingdeliveryerror.md --> # MessagingDeliveryError Represents a log of triggered outbound failures to verify when a triggered outbound has failed. This object is available in API version 44.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CreatedById | Type reference Properties Defaulted on createFilter, Group, Sort Description ID of the user who created the error. | | CreatedDate | Type dateTime Properties Defaulted on create, Filter, Sort Description Date the error was created. | | DestinationPhoneNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The recipient of the phone call. | | FailureReason | Type textarea Properties Create, Nillable, Update Description The provided reason for why the message failed. | | FlowEntity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The entity that triggered the flow to send the message. | | FullMessage | Type textarea Description Plain error text. | | Id | Type id Properties Defaulted on create, Filter, Group, idLookup, Sort Description Identifier of the error. | | IsDeleted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the error has been deleted. | | LastModifiedById | Type reference Properties Defaulted on create, Filter, Group, Sort Description The ID of the user who last modified the error log. | | LastModifiedDate | Type dateTime Properties Defaulted on create, Filter, Sort Description Date when the Messaging error log was last modified. | | MessagingChannelId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the [MessagingChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingchannel.htm "Represents a communication channel that an end user can use to send a message to an agent. A communication channel can be an SMS number, a Facebook page, or another supported messaging channel. This object is available in API version 40.0 and later."). This is a relationship field. Relationship Name MessagingChannel Relationship Type Lookup Refers To MessagingChannel | | MessagingEndUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Identifier for the Messaging user. This is a relationship field. Relationship Name MessagingEndUser Relationship Type Lookup Refers To MessagingEndUser | | MessagingTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Messaging template used. This is a relationship field. Relationship Name MessagingTemplate Relationship Type Lookup Refers To MessagingTemplate | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Namefield, Sort Description Name of the error. Maximum length is 80 characters. | | SystemModstamp | Type dateTime Properties Defaulted on create, Filter, Sort Description System modification time for the Messaging delivery error log. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The kind of event that occurred. Possible values include: - Error (Default) - Warning | <!-- document id=bcef30737cad92cc46388dfb35d6029bc2e0967d35f92e389f0a4d0b4af4333a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messagingenduser.md --> # MessagingEndUser Represents a single address—such as a phone number or Facebook page—communicating with a single Messaging channel. This object is available in API version 40.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available for Einstein Conversation Insights customers whose data is stored natively on the Salesforce Platform. If you turned on Einstein Conversation Insights for the first time starting in Spring ’26, this object is available to query and access using Salesforce tools. For existing ECI customers, data migration and access to related Salesforce Platform objects is scheduled to begin in Summer ’26. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Account associated with this Messaging end user. Available in API version 43.0 and later. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | AuthenticatedEndUserId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the authenticated user associated with this messaging end user. This field is a relationship field. Relationship Name AuthenticatedEndUser Relationship Type Lookup Refers To User | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the associated Contact. Available in API version 43.0 and later. This field is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | HasInitialResponseSent | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether an initial response has been sent to the Messaging end user (true) or not (false). | | IsFullyOptedIn | Type boolean Properties Defaulted on create, Filter, Sort Description Indicates whether the Messaging end user has opted in to receiving messages (true) or not (false). This field compares the related messaging channel’s consent requirement to the user’s consent status; if the user’s status meets the channel’s required consent level, IsFullyOptedIn is set to true. Available in API version 48.0 and later. | | IsOptedOut | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Messaging end user has opted out of receiving messages. Available in API version 48.0 and earlier. Use MessagingConsentStatus and IsFullyOptedIn instead. | | IsoCountryCode | Type string Properties Create, Filter, Group, Nillable, Sort Description The ISO country code associated with the Messaging end user. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | LeadId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the associated lead. Available in API version 57.0 and later. This field is a relationship field. Relationship Name Lead Relationship Type Lookup Refers To Lead | | Locale | Type string Properties Create, Filter, Group, Nillable, Sort Description Reserved for future use. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The preferred language of the messaging user who participated in the messaging session. Supported for Enhanced Chat and Apple Messages for Business only. | | MessageType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Type of message. Possible values are: - AppleBusinessChat—Represents Apple Messages for Business. - Custom—Represents Bring Your Own Channel. Available in API version 58.0 and later. - EmbeddedMessaging—Represents Enhanced Chat. Available in API version 50.0 and later. - Email—Available in API version 66.0 and later. - Facebook - MsCopilot—Available in API version 67.0 and later. - Phone - Rcs—Available in API version 67.0 and later. - Text - Voice - WhatsApp | | MessagingChannelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Messaging channel associated with the Messaging end user. This is a relationship field. Relationship Name MessagingChannel Relationship Type Lookup Refers To MessagingChannel | | MessagingConsentStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The consent status of the messaging user. This field is available in API version 48.0 and later. Possible values are: - DoublyOptedIn - ExplicitlyOptedIn - ImplicitlyOptedIn - OptedOut | | MessagingExternalUserKey | Type string Properties Filter, Group, Nillable Description The business-scoped user identifier provided by external messaging platforms such as Meta. This opaque, stable identifier uniquely represents the end user within the context of your business relationship on that platform. Available in API version 63.0 and later. | | MessagingPlatformKey | Type string Properties Create, Filter, Group, Sort Description The phone number, Facebook page ID, or unique key associated with this Messaging end user. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Messaging end user. Because this field is editable, we don’t recommend referencing it in automation. Instead, use the Messaging Platform Key. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner associated with this Messaging end user. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ProfilePictureUrl | Type url Properties Create, Filter, Group, Nillable, Sort Description The URL of the Messaging end user's profile picture. | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [MessagingEndUserChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [MessagingEndUserHistory](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. [MessagingEndUserOwnerSharingRule](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. [MessagingEndUserShare](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. <!-- document id=4d801858e18f1958f4d1f34252532bc7b42e1813ee7a0b8de0ca1bcd1805d08d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messaginglink.md --> # MessagingLink Represents the link between a Messaging Channel and where it's shared. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | EntityType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Possible values are: - Account - Case - Contact - CustomEntityDefinition—Custom Object Definition - Lead - Opportunity | | MessagingChannelId | Type reference Properties Create, Filter, Group, Sort Description The channel being shared. This is a relationship field. Relationship Name MessagingChannel Relationship Type Lookup Refers To MessagingChannel | | RecordTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description This is a relationship field. Relationship Name RecordType Relationship Type Lookup Refers To RecordType | | ShouldAttemptAutoLink | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description No longer in use. Indicated that an incoming messaging session was auto-linked to a Salesforce contact or account based on information such as a phone number. | | ShouldPromptCreate | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description No longer in use. Indicated that a contact or account was created for the messaging user if none existed. | <!-- document id=c962818255ababc67443fe68b3173818a752f51896dbdced4855e1f673c126b3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messagingsession.md --> # MessagingSession Represents a session on a Messaging channel. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AcceptTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time when an agent accepts an incoming Messaging session. | | AgentMessageCount | Type int Properties Nillable Description The number of messages sent by the agent during the session. | | AgentType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of agent that is assigned to the Messaging session. Possible values are: - Agent - Bot - BotToAgent—Bot & Agent - System—Used for triggered outbound messages | | CampaignId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related campaign. Available in API version 67.0 and later. This field is a relationship field. Relationship Name Campaign Relationship Type Lookup Refers To Campaign | | CaseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the case associated with this Messaging session. | | ChannelEndUserFormula | Type string Properties Filter, Group, idLookup, Nillable, Sort Description A concatenation of the Messaging channel and Messaging user. | | | | | | | | ChannelKey | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier for the associated Messaging channel. | | ChannelLocale | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The locale of the associated Messaging channel. | | ChannelName | Type string Properties Filter, Group, Nillable, Sort Description The name of the associated Messaging channel. | | ChannelType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the associated Messaging channel. Possible values are: - Alexa - AppleBusinessChat—Represents Apple Messages for Business. - Email - EmbeddedMessaging—Available in API version 55.0 and later. - Facebook - GoogleHome - Line - Omega - Phone - Text - Voice - WeChat - WebChat - WhatsApp | | ConversationId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related conversation. Available in API version 55.0 and later. This field is a relationship field. Relationship Name Conversation Relationship Type Lookup Refers To Conversation | | EndedByType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Who or what ended the enhanced messaging session. Possible values are: - Agent - Bot - EndUser - System: - The session is inactive for a while, so the session ends. - An automation ends the session. - The session ended because of an error. | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort Description The time when the Messaging session ended. | | EndUserAccountId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the end user's account record. This is a relationship field. Relationship Name EndUserAccount Relationship Type Lookup Refers To Account | | EndUserContactId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the end user's contact record. This is a relationship field. Relationship Name EndUserContact Relationship Type Lookup Refers To Contact | | EndUserLanguage | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The preferred language of the messaging user who participated in the messaging session. | | EndUserMessageCount | Type int Properties Nillable Description The number of messages sent by the Messaging end user. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | LeadId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Lead associated with this Messaging session. | | MessagingChannelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Messaging channel associated with this Messaging session. This is a relationship field. Relationship Name MessagingChannel Relationship Type Lookup Refers To MessagingChannel | | MessagingEndUserId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Messaging end user associated with this Messaging session. This is a relationship field. Relationship Name MessagingEndUser Relationship Type Lookup Refers To MessagingEndUser | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of this Messaging session. | | OpportunityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the opportunity record associated with this Messaging session. | | Origin | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The origin of this Messaging session. Possible values are: - AgentInitiated - ConversationClose—Messaging user deleted the conversation in Apple Messages - ConversationControlLost—Third-party bot resumes control from Salesforce bot or agent - Help - InboundInitiated - OptIn—Opt In Status Change - OptOut—Opt Out Status Change - TriggeredOutbound Messaging sessions can’t be created using Apex code. They can be created only through customer initiation or by using Process Builder, flows, or the Start Conversation action. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner associated with this Messaging session. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PreviewDetails | Type string Properties Nillable Description The preview shown to an agent for this Messaging session. | | SessionKey | Type string Properties Create, Filter, Group, Nillable, Sort Description The identifier for the Messaging session. | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort Description The time when the Messaging session started. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The status of the Messaging session. Possible values are: - New (standard channels only) - Active - Consent (enhanced channels only) - Waiting - Paused (enhanced channels only) - Inactive (enhanced channels only) - Ended - Error (enhanced channels only) To learn more about these statuses, see [Lifecycle of a Messaging Session](https://help.salesforce.com/s/articleView?id=service.messaging_life_cycle.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. | | TargetUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the target user associated with this Messaging session. This is a relationship field. Relationship Name TargetUser Relationship Type Lookup Refers To User | ## Usage To monitor messaging session activity, report on the MessagingSession and [MessagingSessionMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingsessionmetrics.htm "Represents a metric gathered about a specific enhanced messaging session, such as average agent response time. This object is available starting in October 2024 in API version 62.0 and later.") objects. MessagingSessionMetrics captures metrics about a messaging session, such as agent and end user response time. See [Report on Messaging Activity in Service Cloud](https://help.salesforce.com/s/articleView?id=service.messaging_reporting.htm&type=5&language=en_US "HTML (New Window)"). ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [MessagingSessionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [MessagingSessionFeed](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. [MessagingSessionHistory](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. [MessagingSessionOwnerSharingRule](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. [MessagingSessionShare](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. <!-- document id=83462374172f87b25ce752ba857f98401fa61453a877bbb8fbce373f67c73710 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messagingsessionmetrics.md --> # MessagingSessionMetrics Represents a metric gathered about a specific enhanced messaging session, such as average agent response time. This object is available starting in October 2024 in API version 62.0 and later. To reference this object in reports, create a custom report type with Messaging Session as the primary object and Messaging Session Metrics as the secondary object. Be sure to include the MessagingSessionMetricType field in your custom report. These records are available only for Messaging sessions created after October 1, 2024.  ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Multiple MessagingSessionMetrics records are generated when a session ends in an enhanced Messaging channel or Messaging for In-App and Web channel. These records aren't generated for standard messaging sessions. ## Fields | Field | Details | | --- | --- | | MessagingSessionId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related messaging session. This field is a relationship field. Relationship Name MessagingSession Relationship Type Master-detail Refers To MessagingSession (the master object) | | MessagingSessionMetricType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The metric that this record captures. Possible values are: - AgentMessageCount—The number of messages sent by the Service rep in the session. - AverageAgentResponseTime—The average number of seconds between an end user's message and the agent’s response in the session. - AverageEndUserResponseTime—The average number of seconds between an agent or bot’s message and the end user's response in the session. - EndUserMessageCount—The number of messages sent by the end user in the session. - MaxAgentResponseTime—The longest span of time (in seconds) between an end user's message and the agent’s response in the session. - MaxEndUserResponseTime— The longest span of time (in seconds) between an agent or bot’s message and the end user's response in the session. - ServiceRepAcceptToFirstResponseTime— The time (in seconds) between when a Service rep accepts the work in Omni-Channel and their first response to the customer in the session. Available in API version 68.0 and later. - ServiceRepFirstResponseTime—The time (in seconds) between when a conversation is routed to a human and when a service rep first responds. Routing is triggered either when an end user sends a message that initiates routing, or when an agent or bot decides to route the conversation to a human. Available in API version 67.0 and later. For each closed messaging session in enhanced Messaging channels and Messaging for In-App and Web, one MessagingSessionMetrics record is generated per MessagingSessionMetricType value. This means that six MessagingSessionMetrics records are generated per session. | | MessagingSessionMetricValue | Type int Properties Create, Filter, Group, Sort Description The value of the measured metric. For example, if the MessagingSessionMetricType is EndUserMessageCount, a MessagingSessionMetricValue of 12 means that the end user sent 12 messages during the messaging session. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An autogenerated number identifying the MessagingSessionMetrics record. | <!-- document id=f4b2d0f18e48b3d24253b5861aa422a466f406d2d821dfa58d34bcebc5acdc44 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_messagingtemplate.md --> # MessagingTemplate Represents a Messaging template used to send pre-formatted messages. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the Messaging template. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API name for the Messaging template. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the Messaging template. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The label of the Messaging template. | | Message | Type textarea Properties Create, Update Description The body text of the Messaging template. | <!-- document id=bc63218dae62c815038a6c49d088c4e9a12af793c4f597f64125cd9f1873109d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_metadataapi.md --> # Metadata API Operation Event Type Metadata API Operation events contain details of Metadata API retrieval and deployment requests. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">API_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The version of the API that’s being used.</dd><dd class="dd">For example: <samp class="codeph nolang">36.0</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The API client ID.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_IP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.</dd><dd class="dd"><span class="ph" id="client-ip-ex"><a name="client-ip-ex"></a>For example: <samp class="codeph nolang">96.43.144.26</samp></span>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CPU_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="event-type-desc"><a name="event-type-desc"></a>The type of event.</span> The value is always <samp class="codeph nolang">MetadataApiOperation</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LOGIN_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.</dd><dd class="dd">For example: <samp class="codeph nolang">GeJCsym5eyvtEK2I</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">OPERATION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The operation that’s being performed.</dd><dt class="dt dlterm">Possible Values</dt><dd class="dd"><ul class="ul bulletList"><li class="li"><samp class="codeph nolang">meta_deploy</samp></li><li class="li"><samp class="codeph nolang">meta_list</samp></li><li class="li"><samp class="codeph nolang">meta_retrieve</samp></li><li class="li"><samp class="codeph nolang">meta_synchronous_create</samp></li><li class="li"><samp class="codeph nolang">meta_synchronous_read</samp></li><li class="li"><samp class="codeph nolang">meta_synchronous_upsert</samp></li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the organization.</dd><dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="request-id-desc"><a name="request-id-desc"></a>The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</span></dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">RUN_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The amount of time that the request took in milliseconds.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.</dd><dd class="dd">For example: <samp class="codeph nolang">d7DEq/ANa7nNZZVD</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd><dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. Timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The URI of the page that’s receiving the request.</dd><dd class="dd">For example: <span class="keyword parmname">/home/home.jsp</span>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">ID</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the URI of the page that’s receiving the request.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00530000009M943</samp></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00590000000I1SNIA0</samp>.</dd></dl></td></tr></tbody></table> #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=c72e540a3389853ab5942a77ebf17d89f49c900cddb234348f250458c305c61d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_metadataapiopeventlog.md --> # MetadataApiOpEventLog MetadataApiOpEventLog stores details of Metadata API retrieval and deployment requests. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | | | | ClientIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The API client ID. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The operation that’s being performed. Possible Values - meta\_deploy - meta\_list - meta\_retrieve - meta\_synchronous\_create - meta\_synchronous\_read - meta\_synchronous\_upsert | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Globally unique id for a given request. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 18-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943YAS | <!-- document id=f91d575e18769ebc3531f0c45d0063ada2bb3318fa3c30f889cedb1e175c2954 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_metadatapackage.md --> # MetadataPackage Represents a package that has been developed in the org you’re logged in to. Applies to unlocked, unmanaged, first-generation, and second-generation managed packages. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the package. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description For first-generation and second-generation managed packages, and unlocked packages with namespaces, this field is the namespace prefix assigned to the package. For unmanaged packages, or no-namespace unlocked packages, this field is blank. | | PackageCategory | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of package. Valid values are: - Application (internal use only) - Module (internal use only) - Package—Represents either an unmanaged package or a first-generation managed package. - Package2—Represents either an unlocked package or a second-generation managed package. The default value is Package. This field is available in API version 49.0 and later. | ## Usage Here are examples of the types of API queries you can perform. | Query | String | | --- | --- | | Show all managed and unmanaged packages in the org | SELECT Name, NamespacePrefix FROM MetadataPackage | | Show only managed packages in the org | SELECT Name, NamespacePrefix FROM MetadataPackage WHERE NamespacePrefix <> '' | <!-- document id=de41ede0840cb9eb8857dfe8e58cf8902a449617a911d4578d31e4e8fddafad0 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_metadatapackageversion.md --> # MetadataPackageVersion Represents a package version (managed or unmanaged) that has been uploaded from the org you’re logged in to. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | BuildNumber | Type int Properties Filter, Group, Nillable, Sort Description The build number of the version. For example, if you upload two beta versions, they have build numbers 1 and 2. Then, when you upload a non-beta version, the build number is 3. When you upload a new version, the build number resets to 1. | | IsDeprecated | Type boolean Properties Filter, Group, Sort Description Indicates whether the package version is deprecated. Available in API version 46.0 and later. | | MajorVersion | Type int Properties Filter, Group, Nillable, Sort Description The first number in a package version number. A version number either has an x.y format or an x.y.z format. The x represents the major version, y the minor version, and z the patch version. | | MetadataPackageId | Type reference Properties Filter, Group, Nillable, Sort Description The 18-character package ID starting with 033. | | MinorVersion | Type int Properties Filter, Group, Nillable, Sort Description The second number in a package version number. A version number either has an x.y format or an x.y.z format. The x represents the major version, y the minor version, and z the patch version. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the package version. | | PatchVersion | Type int Properties Filter, Group, Nillable, Sort Description The third number in a package version number, if present. A version number either has an x.y format or an x.y.z format. The x represents the major version, y the minor version, and z the patch version. | | ReleaseState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description If the package version is a beta version, the value is Beta. Otherwise, the value is Released. | ## Usage Here are examples of the types of API queries you can perform. | Query | String | | --- | --- | | Get all package versions for the package that has a MetadataPackageID of 033D00000001xQlIAI | SELECT Id, Name, ReleaseState, MajorVersion, MinorVersion, PatchVersion FROM MetadataPackageVersion WHERE MetadataPackageId = '033D00000001xQlIAI' | | Get the package version for the package with a specific MetadataPackageID and a major version greater than 1 | SELECT Id FROM MetadataPackageVersion WHERE MetadataPackageId ='033D00000001xQlIAI' AND MajorVersion > 1 | | Get released package versions for the package with a specific MetadataPackageID | SELECT Id FROM MetadataPackageVersion WHERE MetadataPackageId = '033D00000001xQlIAI' AND ReleaseState = 'Released' | **Java Code Sample** Suppose you want to push version 3.4.6 of your package to all orgs. Let’s write some code to identify the orgs eligible for the upgrade. This example demonstrates how to generate the list of subscriber orgs eligible to be upgraded to version 3.4.6 of a package. This code sample uses the Web Services Connector (WSC). // Finds all Active subscriber orgs that have the package installed String PACKAGE\_SUBSCRIBER\_ORG\_KEY\_QUERY = "Select OrgKey from PackageSubscribers where OrgStatus = 'Active' and InstalledStatus = 'I'"; // Finds all MetadataPackageVersions lower than the version given, including the list // of subscribers for each version String METADATA\_PACKAGE\_VERSION\_QUERY = "Select Id, Name, ReleaseState, (%s) from" + " MetadataPackageVersion where MetadataPackageId = '%s' AND ReleaseState = 'Released'" + " AND (MajorVersion < 3 OR (MajorVersion = 3 and MinorVersion < 4)" + " OR (MajorVersion = 3 and MinorVersion = 4 and PatchVersion < 6))"; // conn is an EnterpriseConnection instance initialized with a ConnectionConfig object // representing a connection to the developer org of the package QueryResult results = conn.query(String.format(METADATA\_PACKAGE\_VERSION\_QUERY, PACKAGE\_SUBSCRIBER\_ORG\_KEY\_QUERY)); // This list will hold all of the PackageSubscriber objects that are eligible for upgrade // to the given version List<PackageSubscriber> subscribers = new ArrayList<>(); for (SObject mpvso : results.getRecords()) { // Cast the sObject to a MetadataPackageVersion MetadataPackageVersion mpv = (MetadataPackageVersion) mpvso; // Add subscribers to our list if (mpv.getPackageSubscribers() != null) { for (SObject psso : mpv.getPackageSubscribers().getRecords()) { subscribers.add((PackageSubscriber) psso); } } } **Next Step** Create a push request using PackagePushRequest. <!-- document id=f31409cb90ae4a3f1fabfa983a748938b20fd60af8ff15802b18762173a4a277 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_metric.md --> # Metric The Metric object represents the components of a goal metric such as its name, metric type, and current value. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | CompletionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The completion date of the metric. | | CurrentValue | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The current value of the metric. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the metric. The maximum length is 65,535 characters. | | DueDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The due date of the metric. | | GoalId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the goal the metric is related to. | | InitialValue | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The initial value of the metric. | | IsCompletionMetric | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read only. If true, the metric measures whether or not the metric is finished. If false, the metric measures how much is finished compared to a targeted value. | | LastComment | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A comment that provides more context about the metric, such as its status or progress. The maximum length is 255 characters. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when a user last viewed a record that is related to this metric. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when a user last viewed this metric. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description The name of the metric. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who owns the metric. | | Progress | Type percent Properties Filter, Nillable, Sort Description Read only. The overall progress of the metric. | | RecordTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the related record type. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the metric. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the metric. Possible values include: - Not Started - On Track - Behind - Critical - Completed - Postponed - Canceled - Not Completed | | TargetValue | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The target value of the metric. | | Weight | Type double Properties Create, Filter, Nillable, Sort, Update Description The weight of the metric. The sum of the weights should equal 100%. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [MetricFeed](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. [MetricHistory](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [MetricOwnerSharingRule](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [MetricShare](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. <!-- document id=8e26a48acb70d9f992189e8672c9496c293e821db0ed3734855d7f21fe16e04b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_metricdatalink.md --> # MetricDataLink The link between the metric and the data source, such as a report. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | DatasourceFieldName | Type string Properties Create, Filter, Group, Sort, Update Description The field name of the data source, such as a report summary field. | | DataSourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the data source. | | LastSynchronizationTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last time the data was synchronized. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The name given to the data link record. | | TargetId | Type reference Properties Create, Filter, Group, Sort Description The ID of the metric that the data is linked to. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [MetricDataLinkHistory](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). <!-- document id=cfc2f6c7edb80f8c9815d4b294a0b8fd31531838bfce129ff0f53a2d2a64e157 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_migratedemail.md --> # MigratedEmail For internal use only. <!-- document id=9215a868d7c5ba56c83576d88267f99278f753b1a1d231090087d38006536726 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_milestonetype.md --> # MilestoneType Represents a milestone (required step in a customer support process). This object is available in API version 18.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only Salesforce admins, users with access to the Case, Entitlement, or Work Order objects, and users with the View Setup and Configuration permission can access this object. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Update Description A description of the milestone. | | Name | Type string Properties Create, Filter, idLookup, Update Description The name of the milestone. | | RecurrenceType | Type picklist Properties Create,Update Description The type of recurrence for the milestone. | ## Usage Use this object to query and manage the milestone type for CaseMilestone records. #### See Also - [CaseMilestone](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casemilestone.htm "Represents a milestone (required step in a customer support process) on a Case. This object is available in API version 18.0 and later.") - [SlaProcess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_slaprocess.htm "Represents an entitlement process associated with an Entitlement. This object is available in API version 19.0 and later.") <!-- document id=9f28530648ec5b3d1c0fa32a0a1f6cbd1d932b78fcbd98bdaa7bf050f01daa2d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mktjourneydcsnsetup.md --> # MktJourneyDcsnSetup Represents a collection of Marketing Cloud Engagement journeys that you can interact with by using Salesforce Flow in Marketing Cloud. This object is available in API version 65.0 and later. You can use interaction data from a Marketing Cloud Engagement journey to trigger a Flow, or to configure decision activities in a Flow. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BusinessUnitId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique Marketing Cloud business unit ID to use with the collection of journeys‌. This ID is configured in Marketing Cloud, and is different from the Member ID (MID) or Enterprise ID (EID) of your Marketing Cloud Engagement account. This field is a relationship field. Relationship Name BusinessUnit Refers To BusinessUnit | | Description | Type textarea Properties Create, Nillable, Update Description A description of the collection of journeys. | | EnterpriseIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Enterprise ID (EID) of your parent Marketing Cloud Engagement account. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description A name for the collection of journeys. | <!-- document id=5dbfbc9c0499706b2a87b64969e2771352b1166ce3a36cd2a0436bb8bb019659 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mlfield.md --> # MLField Represents a single field in a data definition. This object is available in API version 50.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Entity | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The object that contains the field. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field. | <!-- document id=b1ce5decd29e0a562a8b392eb34f394e15642cb94d09f960354232a1fa36702f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mlintentutterancesuggestion.md --> # MlIntentUtteranceSuggestion Represents a customer input, used for training purposes in the feedback loop process of a conversation. Admins can add these inputs to the intent training model. This object is available in API version 51.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ConfigId | Type reference Properties Filter, Group, Nillable, Sort | | IntentSuggestion | Type string Properties Filter, Group, Nillable, Sort Description The recommended intent. | | ReviewStatus | Type picklist Properties Filter, Group, Restricted Picklist, Sort Description Possible values are: Ignore, New | | Utterance | Type string Properties Filter, Group, Sort Description The text input from the end user. | | UtteranceCount | Type integer Properties Filter, Group, Sort Description A count of the Utterance field. | <!-- document id=331a2e48aeef01f749f06888f65c19248f32aae37812695c595f33589b497913 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mlmodel.md --> # MLModel Represents an AI model that can be used in Einstein Prediction Builder, Einstein Recommendation Builder, and other Einstein features. This object is available in API version 53.0 and later. This object contains information that represents many types of AI models. Some fields contain information for only a specific type of model. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Available with Einstein Prediction Builder and Einstein Recommendation Builder. ## Fields | Field | Details | | --- | --- | | ApprovalStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the model is approved, pending approval, or rejected. Possible values are: - Approved - Pending - Rejected The default value is Pending. | | Dataset | Type string Properties Filter, Group, Nillable, Sort Description The ID of the dataset used to create the model. | | ModelType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the type of model. Possible values are: - BinaryClassification - DecisionTree - DeepLearningIntent - DeepLearningNER - GeneralizedLinearModels - GlobalDeepLearningIntent - GlobalDeepLearningNER - GlobalLanguageDetection - GradientBoostedTrees - LinearRegression - LinearSupportVectorClassifiers - LogisticRegression - MulticlassClassification - NaiveBayes - NeuralNet - PopularityCount - RandomForest - Regression - XGBoost | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The automatically generated ID that uniquely identifies the model. | | PredictionDefinitionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related prediction definition. This field is a relationship field. Relationship Name PredictionDefinition Relationship Type Lookup Refers To MLPredictionDefinition | | RecommendationDefinitionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related recommendation definition. This field is a relationship field. Relationship Name RecommendationDefinition Relationship Type Lookup Refers To MLRecommendationDefinition | | ScoringStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates whether scoring is enabled or disabled. Possible values are: - Disabled - Enabled | | TrainingEndTime | Type dateTime Properties Filter, Nillable, Sort Description Indicates the date and time when the training ended. | | TrainingStartTime | Type dateTime Properties Filter, Nillable, Sort Description Indicates the date and time when the training started. | <!-- document id=fbf5c5492270aa56ca85c965d1c61494413eab1fc37903ac06c955b9a08aac16 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mlmodelfactor.md --> # MLModelFactor Represents a field value that has a positive or negative effect on the model’s score. This object is available in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Available with Einstein Prediction Builder and Einstein Recommendation Builder. ## Fields | Field | Details | | --- | --- | | Correlation | Type double Properties Filter, Nillable, Sort Description Shows the strength of association between the variable and the outcome. The higher the correlation, the greater the association. | | FactorType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of factor. Possible values are: - ModelFactlet—The field value strongly influences the outcome because the model determined that this field is always important. For example, the model can decide that the field Industry is always important to the outcome, regardless of its value. - ModelFactor—The field value is important to the outcome because the field’s value is significant. For example, the model can decide that the Annual Revenue field value is important to the outcome because the value is above $1,000,000 or below $50,000. | | Importance | Type double Properties Filter, Nillable, Sort Description Shows how much the variable influences the outcome. The higher the value, the greater the impact. | | ModelId | Type reference Properties Filter, Group, Sort Description The ID of the related model. This field is a relationship field. Relationship Name Model Relationship Type Lookup Refers To MLModel | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The automatically generated ID that uniquely identifies the model. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of model factor. Possible values are: - And - Basic - Or | | Weight | Type double Properties Filter, Nillable, Sort Description Indicates how significant the field value is to the outcome or score. Model factlets tend to have higher weights than model factors. | <!-- document id=01e5841806887ddc0f30ceeacfbd5274de00ce371b903800b821e0e6316b786c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mlmodelfactorcomponent.md --> # MLModelFactorComponent Represents information about the related MLModelFactor. For example, this object can represent a field value or a field range such as “Title = CEO” or “Annual Revenue >10000000”. This object is available in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Available with Einstein Prediction Builder and Einstein Recommendation Builder. ## Fields | Field | Details | | --- | --- | | FactorLabelKey | Type string Properties Filter, Group, Nillable, Sort Description Maps the model factor component to a label that can be displayed to the user. | | FeatureType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description FeatureType and FeatureValue indicate a feature that doesn’t have a corresponding field. For example, to indicate the feature “Percent = 97%”, the FeatureType is Percent and the FeatureValue is 97. Possible values are: - Binary - Combobox - Currency - Date - DateTime - Email - ID - Integral - MultiPicklist - Percent - Phone - Picklist - Real - Text - TextArea - URL | | FeatureValue | Type string Properties Filter, Group, Nillable, Sort Description The feature’s value. See FeatureType. | | LeftHandDerivedField | Type string Properties Filter, Group, Nillable, Sort Description If the model factor component is an equation, this field represents the name of the field on the left side of the equation. For example, if the model factor component is Title = CEO, this value is Title. | | ModelFactorId | Type reference Properties Filter, Group, Sort Description The ID of the related MLModelFactor. This field is a relationship field. Relationship Name ModelFactor Relationship Type Lookup Refers To MLModelFactor | | ModelId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related MLModel. This field is a relationship field. Relationship Name Model Relationship Type Lookup Refers To MLModel | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The automatically generated ID that uniquely identifies the model. | | Operator | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description If the model factor component is an equation, this field represents the operator. For example, if the model factor component is Title = CEO, the operator is Equals. Possible values are: - Contains - EndsWith - Equals - GreaterThan - IsNotNull - IsNull - LessThan - NotEquals - StartsWith | | RightHandDerivedField | Type string Properties Filter, Group, Nillable, Sort Description If the model factor component is an equation, this field represents the name of the field on the right side of the equation. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description If the model factor has multiple model factor components, this field indicates the order in which this model factor component appears. | | Value | Type string Properties Filter, Group, Nillable, Sort Description If the model factor component specifies a value, this field represents the value. For example, if the model factor component is Title = CEO, this field is CEO. | <!-- document id=e9b4fa082e95b5db9c416e888c46c3d87cf2b26d7de84283675766a7a3c7bdd3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mlmodelmetric.md --> # MLModelMetric Represents a metric or statistic about the related model, such as accuracy, precision, or RSquared. Use a model’s metrics to learn about its performance and to compare it with other models. This object is available in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Available with Einstein Prediction Builder and Einstein Recommendation Builder. ## Fields | Field | Details | | --- | --- | | BasicMetricValue | Type double Properties Filter, Nillable, Sort Description The value of a basic metric. A basic metric is a single number. For metrics that comprise a set of graph points, see ComplexMetricValue . | | ComplexMetricValue | Type textarea Properties Nillable Description The X and Y values for a complex metric. A complex metric is a coordinate on a graph. For example, in classification models, you can use a line on a graph to create classification categories. | | DataSetType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of dataset. Possible values are: - Baseline - HoldOut - Live - Model - Training | | EndTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the model training finished. | | GraphType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of graph. Possible values are: - ConfidencePlot - ConfusionMatrixPerThreshold - DiscountedCumulativeGainsGraph - HitRateGraph - KBasedRankingGraph - LiftPlot - MeanReciprocalRankGraph - MultiClassConfusionMatrixPerThreshold - MultiClassMisclassifications - NormalizedDiscountedCumulativeGainsGraph - PrecisionGraph - RecallGraph - RegressionErrorBands | | MetricType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of metric. Possible values are: - Accuracy - AveragePrecision - BalancedAccuracy - DiscountedCumulativeGainAtK - ExpectedTopAbsoluteRank - ExpectedTopPercentileRank - F1Score - FMeasure - HitRateAtK - LiftBucket - MeanAbsoluteError - MeanAbsoluteRank - MeanAveragePrecisionAtK - MeanPercentileRank - MeanReciprocalRank - MeanReciprocalRankAtK - MeanTopReciprocalRank - NormalizedDiscountedCumulativeGainsAtK - Precision - PrecisionAtK - RSquared - Recall - RecallAtK - RootMeanSquaredError - auPR - auROC | | ModelId | Type reference Properties Filter, Group, Sort Description The ID of the related MLModel. This field is a polymorphic relationship field. Relationship Name Model Relationship Type Lookup Refers To MLModel | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An automatically generated ID that uniquely identifies the metric. | | RowCount | Type int Properties Filter, Group, Nillable, Sort Description The number of rows. | | Span | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The time span for the metric. Possible values are: - Day - Hour - Month - SinceLastAction - Week | | StartTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the model training started. | <!-- document id=c9a6f13ecf279951ed8fae4e708024ae2b58fd72102f0214315339b289c2f682 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mlpredictiondefinition.md --> # MLPredictionDefinition Represents a prediction definition that specifies details about the prediction. This object is available in API version 50.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ApplicationId | Type reference Properties Filter, Group, Nillable, Sort Description The unique ID of the parent AI Application. | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the prediction. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Filter, Group, Sort Description Label that identifies the prediction throughout the Salesforce user interface. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Specifies the namespace of the prediction, if installed with a managed package. | | PredictionField | Type string Properties Filter, Group, Nillable, Sort Description Field that the prediction is based on. | | PushbackField | Type string Properties Filter, Group, Nillable, Sort Description Field that the prediction writes scores to. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the prediction. Possible values are: - Disabled - Draft - Enabled | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of model that returns the prediction values. Possible values are: - BinaryClassification - DeepLearningIntentClassification - DeepLearningNameEntityRecognition - GlobalDeepLearningIntentClassification - GlobalDeepLearningNameEntityRecognition - LanguageDetection - MulticlassClassification - Regression - ScoringSpecificOutcome | <!-- document id=d67b4103d9d83982e05bd8cd3a3bafc5afc225340eb7c8dfe63596cd6e8ff9dc url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mlrecommendationdefinition.md --> # MLRecommendationDefinition For internal use only. <!-- document id=8ff584d842317c8f282c1e78880a65667b8a12c90eb0aaf4f7285a1da655449a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mobiledeviceappregistration.md --> # MobileDeviceAppRegistration Represents the details provided in a mobile device registration event from an app that uses the Engagement Mobile SDK. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DatetimeInDevice | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time of the registration event, based on values provided by the device. | | DeviceModel | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The model of the device that’s being registered, such as iPhone 17 or Google Pixel. | | DevicePlatform | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The operating system of the mobile device, such as iPhone OS or Android. | | DeviceSystemToken | Type string Properties Create, Filter, Nillable, Sort, Update Description A unique token that represents the mobile device. The push notification service (such as Apple Push Notification service or Firebase Cloud Messaging) uses this token to deliver messages to the device. | | DeviceSystemTokenHash | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A hash of the device token. | | DeviceTimezone | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The time zone that the device is located in when the registration event occurs. | | DeviceVersion | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The version or model number of the device. | | Deviceid | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique identifier for the mobile device. | | Eventid | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique identifier for the registration event. | | IsBackgroundRefreshEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the device gives permission for the app to receive updates while it’s in the background. The default value is false. | | IsBluetoothEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Bluetooth is enabled on the device. The default value is false. | | IsDst | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the device’s locale observes daylight saving time (DST). The default value is false. | | IsLocationEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the device has location services enabled for the app. The default value is false. | | IsPushEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the device has push notifications enabled for the app. The default value is false. | | Locale | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The locale string for the device, such as en\_US or ja\_JP. | | MobileAppName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the mobile app, as configured in Setup. | | MobileAppVersion | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The version number of the mobile app that generated the registration event. | | MobileAppid | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique ID that represents the mobile app. | | PartyIdentificationName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the party identifier for identity resolution rules. | | PartyIdentificationNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID used for identity resolution comparisons. | | PartyIdentificationType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A string that provides additional information about the type of party identifier used, such as Driver License or SSN. | | RegistrationDatetime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the registration event occurred. | | Registrationid | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique ID for the registration event. | | SdkVersion | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The version of the Mobile Engagement SDK that the app uses. | <!-- document id=2f9e92d7289a5324ad12be8e77a0c43d5dbbd17bfe99d527a94b15cec9ce16b5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mobilesecurityassignment.md --> # MobileSecurityAssignment Represents the assignment of mobile security policies to a profile. The policies apply to the Salesforce mobile app with Enhanced Mobile App Security enabled. This object is available in API version 54.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Accessing this object requires the Enhanced Mobile App Security add-on subscriptions and the Enforce Enhanced Mobile App Security user permission. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The combined language and locale ISO code, which controls the language of the MobileSecurityAssignment. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for this MobileSecurityAssignment value. This display value is the internal label that doesn't get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The profile ID that the mobile security policies are assigned to. This field is a relationship field. Relationship Name Profile Refers To Profile | <!-- document id=52daf6e7a43643b615e85add36749598c80acad33711b7ff73e28eb96cffcb2d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mobilesecuritypolicy.md --> # MobileSecurityPolicy Enables mobile security policies on the Salesforce mobile app with Enhanced Mobile Security. This object is available in API version 50.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Accessing this object requires the Enhanced Mobile App Security add-on subscriptions and the Enforce Enhanced Mobile App Security user permission. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | EffectiveDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date a mobile security policy is enforced. | | IsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description A value indicating whether a mobile security policy is enabled. The default value is 'false'. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The two-to five-character code that represents the language and locale ISO. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label of the mobile security policy. | | MobilePlatform | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The mobile operating system. Possible values are: - Android - iOS | | MobileSecurityAssignmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the ID of the mobile security assignment. This is a relationship field. Relationship Name MobileSecurityAssignment Relationship Type Lookup Refers To MobileSecurityAssignment | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | RuleValue | Type string Properties Create, Filter, Group, Sort, Update Description Value of the mobile security policy rule. | | RuleValueType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of mobile security policy rule. Possible values are: - Boolean - Text - TextList | | SeverityLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The severity level of a mobile security policy. Possible values are: - Critical - Error - Info - Warn | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of mobile security policy. Possible values are: - AllowedDeviceList—Allowed Device List - Block3dTouch—Block 3D Touch - BlockCalendar—Block Calendar - BlockCamera—Block Camera - BlockContacts—Block Contacts - BlockCustomKeyboard—Block Custom Keyboard - BlockFileBackup—Block File Backup - BlockMicrophone—Block Microphone - BlockOsSharing—Block OS Share Actions - BlockedDeviceList—Blocked Device List - BrowserUriScheme—Mobile Browser URI Scheme - CheckBiometric—Check Biometric Login Data - DevicePasscode—Require Device Passcode - DisableUrlCaching—Disable URL Caching - JailbrokenDevice—Block Jailbroken Device - LogCertPin—Log Certificate Pinning - LogEmail—Log Email - LogPhonecall—Log Phone Call - LogPolicyResult—Log Security Policy Evaluation Result - LogScreenshot—Log Screenshot - LogTextmessage—Log SMS - LogoutAfterRestart—Log Out User After Device Restart - LogoutOnBiometricChange—Log Out User After Changing Biometric Login Data - MalwareDetection—Malware Detection - ManInMiddle—Block Man In The Middle Attack - MaxOffline—Maximum Days Offline Without Policy Refresh - MaximumAppVersion—Maximum Application Version - MaximumOsVersion—Maximum OS Version - MinimumAppVersion—Minimum Application Version - MinimumOsVersion—Minimum OS Version - MinimumSecurityPatchVersion—Minimum Security Patch Version - PhonecallUriScheme—Phone Call Application Handler - Screenshot—Block Screenshot | <!-- document id=6e1e80b21a5311ed3c3010e35a57e319d91dc8d5f298e37829bd5d4f5cfd8770 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mobilesecurityusermetric.md --> # MobileSecurityUserMetric Represents the metrics for users who have Enhanced Mobile Security policies enforced. This object is available in API version 51.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Accessing this object requires the Enhanced Mobile App Security add-on subscriptions and the Enforce Enhanced Mobile App Security user permission. ## Fields | Field | Details | | --- | --- | | MetricsDate | Type date Properties Filter, Group, Sort Description The date the metrics were collected. | | UserCount | Type double Properties Filter, Nillable, Sort Description The number of users who have mobile security policies enforced. | ## Usage A user with the Manage Enhanced Mobile App Security permission can run this SOQL query. SELECT MetricsDate, UserCount FROM MobileSecurityUserMetric ORDER BY MetricsDate DESC <!-- document id=4bc2aecae4479be16a2db685b59a88dfb534d7994fa812e7e1f0aa40ada3f54d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mobilesettingsassignment.md --> # MobileSettingsAssignment Represents the assignment of a particular field service mobile settings configuration to a user profile. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout()—available in API version 51.0 and later, describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | FieldServiceMobileSettingsId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of a set of field service mobile settings. | | ProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the profile to associate with the set of field service mobile settings. | <!-- document id=d8903dcadd4d6f5bb8075aea3588c150a2c6722fc9b52d7a404e092439649f34 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mobsecuritycertpinconfig.md --> # MobSecurityCertPinConfig Configuration of mobile security certificate pinning on the Salesforce mobile app with Enhanced Mobile Security. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Accessing this object requires the Enhanced Mobile App Security add-on subscriptions and the Enforce Enhanced Mobile App Security user permission. ## Fields | Field | Details | | --- | --- | | CertificateHash | Type string Properties Create, Filter, Group, Sort, Update Description The unique identifier for the certificate. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. | | DomainName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the domain. | | IsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The default value is False. | | IsSubdomainIncluded | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The default value is False. | | Language | Type string Properties Create, Filter, Group, Sort, Update Description The two-to five-character code that represents the language and locale ISO. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The master label of the mobile security pin. | | MobilePlatform | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The mobile operating system. Possible values are: - Android - iOS | | MobileSecurityAssignmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the ID of the mobile security assignment. This is a relationship field. Relationship Name MobileSecurityAssignment Relationship Type Lookup Refers To MobileSecurityAssignment | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | SeverityLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The severity level of a mobile security policy. Possible values are: - Critical - Error - Info - Warn | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of pin Possible values are: - AuthServer—Authentication Server - Resource—Resource | <!-- document id=76de8cc07f195832a9214ead502eed45599c790099280d89647dfeb4a3b09b22 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mobsecuritycertpinevent.md --> # MobSecurityCertPinEvent The event of mobile security certificate pinning on the Salesforce mobile app with Enhanced Mobile Security. This object is available in API version 53.0 and later. ## Supported Calls create(), describeSObjects() ## Special Access Rules Accessing this object requires the Enhanced Mobile App Security add-on subscriptions and the Enforce Enhanced Mobile App Security user permission. ## Fields | Field | Details | | --- | --- | | AppPackageIdentifier | Type string Properties Create Description The unique identifier for the certificate. | | AppVersion | Type string Properties Create Description The version of the app. | | CertPinResults | Type json Properties Create Description The results of certificate pinning. | | DeviceIdentifier | Type string Properties Create Description The hardware IDs or IDs to uniquely identify a mobile device. | | DeviceModel | Type string Properties Create Description The model of the mobile device. | | EventDate | Type dateTime Properties Create, Nillable Description The date of the certificate pinning event. | | EventDescription | Type string Properties Create, Nillable Description The description of the certificate pinning event. | | EventIdentifier | Type string Properties Create, Nillable Description The ID of the certificate pinning event. | | EventUuid | Type string Properties Nillable Description The universally unique identifier of the event. | | OsName | Type string Properties Create Description The name of the operating system. | | OsVersion | Type string Properties Create Description The version of the operating system. | | ReplayId | Type string Properties Nillable Description The position of the event in the event stream. | | UserId | Type reference Properties Create Description This is polymorphic relationship field. Relationship Name User Relationship Type Lookup Refers To User | | WebkitVersion | Type string Properties Create, Nillable Description The version of the web browser engine developed by Apple. | <!-- document id=1e4f4cc435d0ffe4159d77d488bdf9158a822eaa84aabf2865fa6d7f349c3fe5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_msgchannelavailability.md --> # MsgChannelAvailability Represents the availability of a Messaging channel for a specific country. This object is available in API version 67.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available for Einstein Conversation Insights customers whose data is stored natively on the Salesforce Platform. If you turned on Einstein Conversation Insights for the first time starting in Spring ’26, this object is available to query and access using Salesforce tools. For existing ECI customers, data migration and access to related Salesforce Platform objects is scheduled to begin in Summer ’26. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CountryCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The ISO country code for which the Messaging channel is available. There are 81 possible values for this field. | | MessagingChannelId | Type reference Properties Filter, Group, Sort Description The ID of the Messaging channel associated with this availability. This field is a relationship field. Relationship Name MessagingChannel Relationship Type Lookup Refers To MessagingChannel | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of availability. Valid value is: - Country | <!-- document id=0d599b7c6852fdfe994dd7da83fa0791190d88baf29ac3e7427157ca5164e9b3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_msgchannellanguagekeyword.md --> # MsgChannelLanguageKeyword Represents the consent configuration for a Messaging channel. This object is available in API version 48.0 and later. ## Supported Calls describeSObjects(), delete(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | CustomKeywords | Type textarea Properties Nillable Description The keywords a Messaging end user can send to receive the Custom Response. | | CustomResponse | Type textarea Properties Nillable Description The automated response sent when a Messaging end user sends a Custom Keyword. | | DoubleOptInKeywords | Type textarea Properties Nillable Description The keywords a Messaging end user can send to doubly opt in to receiving messages. | | HelpKeywords | Type textarea Properties Nillable Description The keywords a Messaging end user can send to request help during a Messaging session. | | HelpResponse | Type textarea Properties Nillable Description The automated response sent when a Messaging end user requests help. | | MasterLanguage | Type textarea Properties Description The language used for this consent configuration. | | MessagingChannelId | Type reference Properties Filter, Group, Sort Description The ID of the associated Messaging channel. This is a relationship field. Relationship Name MessagingChannel Relationship Type Lookup Refers To MessagingChannel | | MessagingChannelUsageId | Type reference Properties Filter, Group, Sort Description The ID of the associated Messaging channel usage record, which is in turn associated with a messaging channel. This is a relationship field. Relationship Name MessagingChannelUsage Relationship Type Lookup Refers To MessagingChannelUsage | | OptInConfirmation | Type textarea Properties Nillable Description The automated response sent when a Messaging end user opts in to receiving messages. | | OptInKeywords | Type textarea Properties Nillable Description The keywords a Messaging end user can send to explicitly opt in to receiving messages. | | OptOutConfirmation | Type textarea Properties Nillable Description The automated response sent when a Messaging end user opts out of receiving messages. | | OptOutKeywords | Type textarea Properties Nillable Description The keywords a Messaging end user can send to opt out of receiving messages. | <!-- document id=6c19fca7599f8ce0cbf19d5a4feac703eff8bbb7f68c36fa7101c4c706fc8b81 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_msgchannelusageexternalorg.md --> # MsgChannelUsageExternalOrg Represents the Enterprise ID (EID) and Business Unit (MID) for Marketing Cloud connections in a Unified Messaging channel. This object is available in API version 60.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ExternalOrgIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort Description The Enterprise ID (EID) of a Marketing Cloud connection. | | ExternalSubOrgIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Business Unit (MID) of a Marketing Cloud connection. | | MessagingChannelUsageId | Type reference Properties Create, Filter, Group, Sort Description The associated MessagingChannelUsage record, which must have a DeploymentType of MJ (referring to Marketing Cloud Journey Builder). This field is a relationship field. Relationship Name MessagingChannelUsage Relationship Type Lookup Refers To MessagingChannelUsage | ## Usage MsgChannelUsageExternalOrg records apply only to MessagingChannelUsage records related to Marketing Cloud. Only one MsgChannelUsageExternalOrg record can exist for each MessagingChannelUsage record with a DeploymentType of MJ. MsgChannelUsageExternalOrg records are created when an admin enters the EID and MID for a Marketing Cloud application in Unified Messaging Setup and then clicks **Connect**. The data saved in a MsgChannelUsageExternalOrg record is used for making a connection to Marketing Cloud. If an admin disconnects a Marketing Cloud application in Unified Messaging Setup, the saved EID and MID are used during deprovisioning. <!-- document id=5e8de94bd7cae605cc2c8bc5bd67ff52e8c2c75973f5c4fd2165d152d222f945 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_multiblock.md --> # Multiblock Report Event Type Multiblock Report events contain details about Joined Report reports. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields <table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_IP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="client-ip-desc"><a name="client-ip-desc"></a>The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.</span></dd><dd class="dd">For example: <samp class="codeph nolang">96.43.144.26</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CPU_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DB_TOTAL_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and <span class="keyword parmname">DB_CPU_TIME</span>. Compare this field to <span class="keyword parmname">CPU_TIME</span> to determine whether performance issues are occurring in the database layer or in your own code.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="event-type-desc"><a name="event-type-desc"></a>The type of event.</span> The value is always <samp class="codeph nolang">MultiblockReport</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">HAS_CHART</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Boolean</dd><dt class="dt dlterm">Description</dt><dd class="dd">True if the report has a chart.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LOGIN_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.</dd><dd class="dd">For example: <samp class="codeph nolang">GeJCsym5eyvtEK2I</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">MASTER_REPORT_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the master report.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the organization.</dd><dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="request-id-desc"><a name="request-id-desc"></a>The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</span></dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_STATUS</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The status of the request for a page view or user interface action.</dd><dd class="dd">For example:<a name="ul_wgy_1rf_4q"></a><ul class="ul bulletList" id="ul_wgy_1rf_4q"><li class="li"><samp class="codeph nolang">S</samp>—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.</li><li class="li"><samp class="codeph nolang">F</samp>—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.</li><li class="li"><samp class="codeph nolang">U</samp>—Undefined</li><li class="li"><samp class="codeph nolang">A</samp>—Authorization Error</li><li class="li"><samp class="codeph nolang">R</samp>—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.</li><li class="li"><samp class="codeph nolang">N</samp>—Not Found. 404 error.</li></ul>This field can have a blank value.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">RUN_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The amount of time that the request took in milliseconds.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.</dd><dd class="dd">For example: <samp class="codeph nolang">d7DEq/ANa7nNZZVD</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd><dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. Timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The URI of the page that’s receiving the request.</dd><dd class="dd">For example: <span class="keyword parmname">/home/home.jsp</span>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">ID</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the URI of the page that’s receiving the request.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00530000009M943</samp></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00590000000I1SNIA0</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The category of user license.</dd><dd class="dd">Possible values are:<a name="user-type-values"></a><ul class="ul bulletList" id="user-type-values"><li class="li"><samp class="codeph nolang">CsnOnly</samp>—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.</li><li class="li"><samp class="codeph nolang">CspLitePortal</samp>—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.</li><li class="li"><samp class="codeph nolang">CustomerSuccess</samp>—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.</li><li class="li"><samp class="codeph nolang">Guest</samp>—Users whose access is limited so that your customers can view and interact with your site without logging in.</li><li class="li"><samp class="codeph nolang">PowerCustomerSuccess</samp>—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.</li><li class="li"><samp class="codeph nolang">PowerPartner</samp>—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.</li><li class="li"><samp class="codeph nolang">SelfService</samp>—Users whose access is limited because they’re organization customers and access the application through a self-service portal.</li><li class="li"><samp class="codeph nolang">Standard</samp>—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.</li></ul></dd></dl></td></tr></tbody></table> #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=a65c5b3f9cc429c20f92a3d577f0113b61a6415a8ace7ce408f0b6eadebeb00b url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mutingpermissionset.md --> # MutingPermissionSet Represents a set of disabled permissions and is used in conjunction with PermissionSetGroup. This object is available in API version 46.0 and later. Use a muting permission set with a permission set group to mute certain permissions. For instance, you have a subscriber org using a managed package that contains a permission set group. To use the existing permission set group, the subscriber org can disable specific permissions with a muting permission set. Or, perhaps you have a permission set group that contains several permission sets managed by different departments. Use a muting permission set to disable specific permissions based on your organization's needs. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only users who have one of these permissions can access this object: - View Setup and Configuration - Manage Session Permission Set Activations - Assign Permission Sets ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance can slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the muting permission set. Possible values are: - da (Danish) - de (German) - en\_US (English) - es (Spanish) - es\_MX (Spanish - Mexican) - fi (Finnish) - fr (French) - it (Italian) - ja (Japanese) - ko (Korean) - nl\_NL (Dutch) - no (Norwegian) - pt\_BR (Portuguese - Brazilian) - ru (Russian) - sv (Swedish) - th (Thai) - zh\_CN (Chinese - Simplified) - zh\_TW (Chinese - Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The muting permission set label for the aggregated, disabled permissions. | | PermissionsPermissionName | Type boolean Properties Create, Filter, Update Description One field for each permission. If true, the permission is disabled in the related permission set group. The number of fields varies depending on the permissions for the organization and license type. To get a list of available permissions, use describeSObjects(). | ## Usage Use MutingPermissionSet to disable specified permissions within a permission set group. <!-- document id=3fdf6bf2af3f75d8224a743d8fcf66f09ccde2f8af6678a95abe8aac43e4d782 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_mydomaindiscoverablelogin.md --> # MyDomainDiscoverableLogin Represents configuration settings when the My Domain login page type is Discovery. Login Discovery provides an identity-first login experience, where the login page contains the identifier field only. Based on the identifier entered, a handler determines how to authenticate the user. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ApexHandlerId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the Apex handler that contains the Discovery authentication logic. This is a relationship field. Relationship Name ApexHandler Relationship Type Lookup Refers To ApexClass | | DeveloperName | Type string Properties 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | ExecuteApexHandlerAsId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who is executing the handler. Requires Manage User permission. This is a relationship field. Relationship Name ExecuteApexHandlerAs Relationship Type Lookup Refers To User | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the MasterLabel. Possible values are: - da (Danish) - de (German) - en\_US (English) - es (Spanish) - es\_MX (Spanish - Mexican) - fi (Finnish) - fr (French) - it (Italian) - ja (Japanese) - ko (Korean) - nl\_NL (Dutch) - no (Norwegian) - pt\_BR (Portuguese - Brazilian) - ru (Russian) - sv (Swedish) - th (Thai) - zh\_CN (Chinese - Simplified) - zh\_TW (Chinese - Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The name of the action link group template. | | UsernameLabel | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Login prompt on login page when the My Domain login page type is Discovery. It supports localization with custom labels. | ## Usage Use this object to access the My Domain Login Discovery Page, which is a login page type that prompts users to identity themselves with an email address, phone number, or custom identifier. My Domain Login Discovery performs an interview-based login process, where users are first prompted to provide identity and then authenticated. For example, users receive a verification code that they enter to complete the login process. <!-- document id=31771763c9bd9f5a15870e3f204efd32641ab5a76d4d9fbae8663ee3a22b44d5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_name.md --> # Name Non-queryable object that provides information about foreign key traversals when the foreign key has more than one parent. This object is used to retrieve information from related records where the related record can be from more than one object type (a polymorphic foreign key). For example, the owner of a case can be either a user or a group (queue). This object allows retrieval of the owner name, whether the owner is a user or a group (queue). You can use a describe call to access the information about parents for an object, or you can use the who, what, or owner fields (depending on the object) in SOQL queries. This object can’t be directly accessed. ## Supported Calls describeSObjects() ## Fields | Field | Details | | --- | --- | | Alias | Type string Properties Filter, Group, Nillable, Sort Description The user alias. This field contains a value only if the related record is a user. | | Email | Type email Properties Filter, Group, Nillable, Sort Description The email address of the user or group (queue). | | FirstName | Type string Properties Filter, Group, Nillable, Sort Description The first name of the user, contact, or lead. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the related record is an active user (true) or not (false). This field contains a value only if the related record is a user. | | LastName | Type string Properties Filter, Group, Nillable, Sort Description The last name of the user, contact, or lead. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | MiddleName | Type string Properties Filter, Group, Nillable, Sort Description The middle name of the user contact, or lead. | | Name | Type string Properties Filter, Group, Nillable, Sort Description The name of the parent of the object queried. If the parent is a user, contact, or lead, the value is a concatenation of the FirstName, MiddleName, LastName, and Suffix fields of the related record. | | Phone | Type phone Properties Filter, Group, Nillable, Sort Description The phone number of the user. This field contains a value only if the related record is a user. | | Profile | Type reference Properties Filter, Nillable Description The Profile of the user. Only populated if the related record is a user. | | ProfileId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user’s Profile. Only populated if the related record is a user. This field is a relationship field. Relationship Name Profile Relationship Type Lookup Refers To Profile | | Suffix | Type string Properties Filter, Group, Nillable, Sort Description The name suffix of the user, contact, or lead. | | Title | Type string Properties Filter, Group, Nillable, Sort Description The title of the user, for example CFO or CEO. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description A list of the types of sObject that can be an owner of this object. You can use this field to filter on a type of owner, for example, return only the leads owned by a user. | | Username | Type string Properties Filter, Group, Nillable, Sort Description Contains the name that a user enters to log into the API or the user interface. The value for this field is in the form of an email address, and is only populated if the related record is a user. | | UserRole | Type picklist Properties Filter, Nillable Description Name of the Role played by the user. Only populated for user rows. | | UserRoleId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user role associated with this object. This field is a relationship field. Relationship Name UserRole Relationship Type Lookup Refers To UserRole | ## Usage To query on relationships where the parent can be more than one type of object, use who, what, or owner relationship fields. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=0317c9cc2b0f8f5218da2649582fd4cce122e214095a4a1d16e3054cb22e075d url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_namedcredential.md --> # Named Credential Event Type The Named Credential event type captures information about Apex callouts that use named credentials as their endpoints. Use this event type to audit the installed managed packages that use named credentials. If you don’t recognize the package namespace in the named credential event log file, then you can investigate whether a security breach has occurred. This event type is available in the EventLogFile object in API version 53.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | BOT\_IDENTIFIER | Type String Description The ID of the bot. | | BOT\_SESSION\_IDENTIFIER | Type String Description The bot session ID. | | CALLER\_PACKAGE\_NAMESPACE | Type String Description If an Apex callout using a Named Credential endpoint is initiated from a package, then this field contains the package’s namespace. If the callout isn’t initiated from a package, then this field is empty. Example Acme | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CPU\_TIME | Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | EVENT\_TYPE | Type String Description The type of event. The value is always NamedCredential. | | LOGIN\_KEY | Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | NAMED\_CREDENTIAL\_NAME | Type String Description The name of the named credential that’s the endpoint of the Apex callout. Example My\_Named\_Credential | | ORGANIZATION\_ID | Type ID Description The 15-character ID of the org. Example 00D000000000123 | | PLANNER\_IDENTIFIER | Type String Description The ID of the agent planner. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RUN\_TIME | Type Number Description The amount of time that the request took in milliseconds. | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | URI | Type String Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | URI\_ID\_DERIVED | Type ID Description The 18-character case-safe ID of the URI of the page that’s receiving the request. | | USER\_ID | Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case-safe ID of the user who’s using Salesforce services through the UI or the API. For example: 00590000000I1SNIA0. | #### See Also - [_Salesforce Help_: Named Credentials](https://help.salesforce.com/articleView?id=xcloud.named_credentials_about.htm&type=5&language=en_US " Salesforce Help: Named Credentials - HTML (New Window)") - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") <!-- document id=c135fab1a61f26e561a8db9b4cf863946e3f5671266c7566f19b37306ab6283c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_namedcredential.md --> # NamedCredential Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts. This object is available in API version 33.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note All credentials stored within this entity are encrypted under a framework that is consistent with other encryption frameworks on the platform. Salesforce encrypts your credentials by auto-creating org-specific keys. Credentials encrypted using the previous encryption scheme have been migrated to the new framework. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object. ## Fields | Field Name | Details | | --- | --- | | AuthProviderId | Type reference Properties Filter, Group, Nillable, Sort Description Salesforce ID of the authentication provider, which defines the service that provides the login process and approves access to the external system. Only users with the “Customize Application” and “Manage AuthProviders” permissions can view this field. This field is a relationship field. This field is only valid for legacy named credentials. This field was first available in API version 39.0, this field is deprecated in API version 56.0. Relationship Name AuthProvider Relationship Type Lookup Refers To AuthProvider | | AuthTokenEndpointUrl | Type textarea Properties Nillable Description The URL where SON Web Tokens (JWTs) are exchanged for access tokens. This field is only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0. | | CalloutOptionsAllowMergeFieldsInBody | Type boolean Properties Filter Description For Apex callouts, indicates whether the code can use merge fields to populate HTTP request bodies with org data. This field is available in API version 35.0 and later. | | CalloutOptionsAllowMergeFieldsInHeader | Type boolean Properties Filter Description For Apex callouts, indicates whether the code can use merge fields to populate HTTP headers with org data. This field is available in API version 35.0 and later. | | CalloutOptionsGenerateAuthorizationHeader | Type boolean Properties Filter Description Indicates whether Salesforce automatically generates a standard authorization header for each callout to the named credential–defined endpoint. This field is available in API version 35.0 and later. | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. 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. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Endpoint | Type textarea Properties Nillable Description The root URL of the endpoint. This field is only valid for legacy named credentials. This field is deprecated in API version 56.0. | | JwtAudience | Type textarea Properties Nillable Description External service or other allowed recipients for the JSON Web Token. Written as JSON, with a quoted string for a single audience and an array of quoted strings for multiple audiences. Single audience example: “aud1”. Multiple audiences example: \[”aud1”, “aud2”, “aud3”\]. This field is only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0. | | JwtFormulaSubject | Type string Properties Filter, Group, Nillable, Sort Description Formula string calculating the JSON Web Token’s subject. API names and constant strings, in single quotes, can be included. Allows a dynamic Subject unique per user requesting the token. For example, 'User='+$User.Id. Use this field when PrincipalType is set to PerUser. Corresponds to Per User Subject in the user interface. This field is only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0. | | JwtIssuer | Type string Properties Filter, Group, Nillable, Sort Description Specify who issued the JSON Web Token using a case-sensitive string. This field is only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0. | | JwtTextSubject | Type string Properties Filter, Group, Nillable, Sort Description Static text, without quotes, that specifies the JSON Web Token subject. Use this field when PrincipalType is set to NamedUser. Corresponds to Named Principal Subject in the user interface. This field is only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0. | | JwtValidityPeriodSeconds | Type int Properties Filter, Group, Nillable, Sort Description The number of seconds that the JSON Web Token is valid. This field is only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the MasterLabel. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label for the named credential. This display value is the internal label that doesn’t get translated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. | | PrincipalType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Tracks users who are accessing the external system. Anonymous implies that a user identity isn’t specified for external system access. Named Principal uses one user identity for all users to access the external system. This field is only valid for legacy named credentials. This field is deprecated in API version 56.0. | ## Usage Use the NamedCredential object to query named credentials in your organization. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Some named credential fields rely on per-user authentication to connect with an external system. If an admin edits one of these fields, then the previously authenticated credentials can get invalidated, requiring individual users to reauthenticate. #### See Also - [ExternalDataUserAuth](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externaldatauserauth.htm "Stores authentication settings for a Salesforce user to access an external system. The external system must be defined in an external data source or a named credential that’s configured to use per-user authentication. This object is available in API version 27.0 and later.") - [ExternalDataSource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externaldatasource.htm "Represents an external data source, which defines connection details for integration with data and content that are stored outside the Salesforce org. This object is available in API version 27.0 and later.") - [_Salesforce Help_: Named Credentials](https://help.salesforce.com/s/articleView?id=xcloud.named_credentials_about.htm&type=5&language=en_US "Salesforce Help: Named Credentials - HTML (New Window)") - [_Named Credentials Developer Guide_: Get Started with Named Credentials](https://developer.salesforce.com/docs/platform/named-credentials/guide/get-started.html "Named Credentials Developer Guide: Get Started with Named Credentials - HTML (New Window)") - [_Named Credentials Developer Guide_: Named Credential API Links](https://developer.salesforce.com/docs/platform/named-credentials/references/named-credentials-reference/nc-api-links.html "Named Credentials Developer Guide: Named Credential API Links - HTML (New Window)") - [_Apex Developer Guide_: Invoking Callouts Using Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_callouts.htm "Apex Developer Guide: Invoking Callouts Using Apex - html (New Window)") - [_Apex Developer Guide_: Named Credentials as Callout Endpoints](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_callouts_named_credentials.htm "Apex Developer Guide: Named Credentials as Callout Endpoints - HTML (New Window)") <!-- document id=3b5e33312311c26a4d8e5730edd22ece7ba34b28a27a2c785ef7dba0ae0fb29a url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_namedcredentialeventlog.md --> # NamedCredentialEventLog The Named Credential event type captures information about Apex callouts that use named credentials as their endpoints. Use this event type to audit the installed managed packages that use named credentials. If you don’t recognize the package namespace in the named credential event log file, then you can investigate whether a security breach has occurred. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | BotIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the bot. | | BotSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The bot session ID. | | CallerPackageNamespace | Type string Properties Filter, Group, Nillable, Sort Description If an Apex callout using a Named Credential endpoint is initiated from a package, then this field contains the package’s namespace. If the callout isn’t initiated from a package, then this field is empty. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that is using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | NamedCredentialName | Type string Properties Filter, Group, Nillable, Sort Description The name of the named credential that’s the endpoint of the Apex callout. | | PlannerIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the agent planner. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds.. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who is using Salesforce services through the UI or the API. | <!-- document id=c18b581c4aacf6d959e2bed6fd36a035c70ee774ce441c9d163abec603a5f03f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_namespaceregistry.md --> # NamespaceRegistry Represents a namespace that you can link to scratch orgs that were created from your org’s Dev Hub. You use the namespace when developing, packaging, and releasing an app. You can’t create this object with the API. Use the **Link Namespace** action in the Dev Hub graphical interface to insert a NamespaceRegistry record. This object is available in API version 41.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The name of this namespace registry entry. | | NamespaceOrg | Type string Properties Filter, Group, Nillable, Sort Description The org ID of the Developer Edition org where you've registered the namespace you want to link. | | NamespacePrefix | Type string Properties Filter, Group, Sort Description The namespace prefix that you want to link to the scratch org. | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [NamespaceRegistryFeed](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. [NamespaceRegistryHistory](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. #### See Also - [ActiveScratchOrg](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activescratchorg.htm "Represents an active scratch org. This object is available in API version 41.0 and later.") - [ScratchOrgInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scratchorginfo.htm "Represents a scratch org and its audit log. Use this object to create a scratch org and keep a log of its creation and deletion. This object is available in API version 41.0 and later.") <!-- document id=91f3a69bd9869d9ddfe83717f0d20463ffd0c204c17a910054f78e796914ca69 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_navigationlinkset.md --> # NavigationLinkSet Represents the navigation menu in an Experience Cloud site. A navigation menu consists of items that users can click to go to other parts of the site. This object is available in API version 35.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() create(), delete(), update(), and upsert() are available in API version 45.0 and later. ## Special Access Rules Navigation menus are available only in Experience Cloud sites created using Experience Builder templates. To use navigation menus in LWR templates, you must build a custom navigation menu component. ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Create and Update are available in API version 45.0 and later. 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 org. 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. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Create, Defaulted on create, Nillable, and Update are available in API version 45.0 and later. Description Language for the navigation menu. Valid values are: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Create and Update are available in API version 45.0 and later. Description Label for the navigation menu. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort Create is available in API version 45.0 and later. Update is available in API versions 45.0 to 47.0. Description ID of the Experience Cloud site. | <!-- document id=9de2a77c93de4035b0cce01facb2c438e56f516828d1fa76921e7b60268e9439 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_navigationmenuitem.md --> # NavigationMenuItem Represents a single menu item in a NavigationLinkSet. Use this object to create, delete, or update menu items in your Experience Cloud site’s navigation menu. This object is available in API version 35.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Navigation menus are available only in Experience Cloud sites created using Experience Builder templates. To use navigation menus in LWR templates, you must build a custom navigation menu component. ## Fields | Field Name | Details | | --- | --- | | AccessRestriction | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Determines if the menu item is available to guest users who aren’t required to log in to the Experience Cloud site. | | DefaultListViewId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description If the value of the Type field is SalesforceObject, the value is the ID of the default list view for the object. | | DraftRowID | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the draft navigation menu item. The ID is unique within your organization. | | Label | Type string Properties Create, Filter, Group, Sort, Update Description The text that appears in the navigation menu for this item. | | NavigationLinkSetId | Type reference Properties Create, Filter, Group, Sort, Update Description The navigation menu that this item is included in. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The parent navigation menu. | | Position | Type int Properties Create, Filter, Group, Sort, Update Description The location of the menu item in the navigation menu. | | Status | Type reference Properties Create, Filter, Group, Nillable, Sort Description Represents if the navigation menu item is published or not. The values can only be DRAFT, LIVE, or null. In API versions 42 and earlier, if the Status field is not set, the field defaults to LIVE. When queried and Status is not part of the query filter, only the NavigationMenuItem objects with a status of LIVE return. In API versions 43 and later, if the Status field is not set, the field defaults to DRAFT. When queried and Status is not part of the query filter, all NavigationMenuItem objects return regardless of status. | | Target | Type string Properties Create, Filter, Group, Sort, Update Description If Type is ExternalLink or InternalLink, the target is the URL that the link points to. For ExternalLink, your entry looks like this: https://salesforce.com. For InternalLink, use a relative URL, such as /contactsupport. | | TargetPrefs | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description If Type is ExternalLink, determines whether a navigation menu item opens in the same tab. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of navigation menu item. The available values are: - SalesforceObject—Available objects include accounts, cases, contacts, and custom objects. - ExternalLink—Links to a URL outside of your Experience Cloud site. For example, https://salesforce.com. - Event—An event, such as logging in, logging out, or switching accounts. Event is internal only and can’t be used in custom components. - GlobalAction—Enables users to create object records, but the new record has no relationship with other records. - InternalLink—Links to a relative URL inside your Experience Cloud site. For example, /contactsupport. - NavigationalTopic—A dropdown list with links to the navigational topics in your Experience Cloud site. - SystemLink—A system link, such as a link to Experience Builder, Workspaces, or Salesforce setup. | ## Usage You can add up to 20 navigation menu items. You can translate navigation menu items using the Translation Workbench. <!-- document id=ba1460c4cb241564b19a0b4205ae17619e566ca6cca3c6e30ef7cdb61c980743 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_navigationmenuitemlocalization.md --> # NavigationMenuItemLocalization Represents the translated value of a navigation menu item in an Experience Cloud site. This object is available in API version 36.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Navigation menus are available only in Experience Cloud sites created using Experience Builder templates. To use navigation menus in LWR templates, you must build a custom navigation menu component. ## Fields | Field Name | Details | | --- | --- | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language of the translated navigation menu item. The picklist contains the following supported languages: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the navigation menu item that this translated value applies to. | | Value | Type string Properties Create, Filter, Sort, Update Description The translated text for the navigation menu item. Label is **Translation Text**. | <!-- document id=670a299b0b912d615c0d25627326b7c841e8bc969b37dd780d922852d2123b10 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_network.md --> # Network Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. Experience Cloud sites let you share information, records, and files with coworkers and stakeholders all in one place. This object is available in API version 26.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), update() ## Special Access Rules This object is available only when your org has digital experiences enabled. ## Fields | Field Name | Details | | --- | --- | | AllowedExtensions | Type textarea Properties Filter, Nillable, Sort, Update Description Specifies the types of files allowed in your site. This list of file types lets you control what members upload and also prevents spammers from polluting your site with inappropriate files. Available in API version 36.0 and later. Separate file types with a comma (for example: jpg,docx,txt). You can enter lowercase and uppercase letters. You can enter up to 1,000 characters. To allow all file types, leave this field empty. | | CaseCommentEmailTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when submitting a comment on a case. This field is available in API version 28.0 and later. | | ChangePasswordEmailTemplateId | Type reference Properties Filter, Group, Sort, Update Description ID of the email template used when notifying users that their password has been reset. | | ChgEmailVerNewEmailTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when notifying users that their email address has been changed. This email is sent to the user’s new email address. | | ChgEmailVerOldEmailTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when notifying users that their email address has been changed. This email is sent to the user’s old email address. | | Description | Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the site. | | DeviceActEmailTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when users log in from an unrecognized browser, app, or IP address. The email contains a one-time password that users enter to verify their identity. This field is available in API version 53.0 and later. | | EmailFooterLogoId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the Document object that displays as an image in the footer of Chatter emails. | | EmailFooterText | Type string Properties Filter, Nillable, Sort, Update Description Text that displays in the footer of Chatter emails. | | EmailSenderAddress | Type email Properties Filter, Group, Sort Description Read only. Email address from which emails are sent. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To change the EmailSenderAddress value, you must first specify NewSenderAddress, which triggers the sending of an address change verification email. After you complete the address verification process, EmailSenderAddress changes to the specified NewSenderAddress. | | EmailSenderName | Type string Properties Filter, Group, Sort, Update Description Name from which emails are sent. | | enableImageOptimizationCDN | Type boolean Properties Filter, Update Description The setting that optimizes cached images for guest users on all devices when a site uses Salesforce’s CDN for Digital Experiences. This field is available in API version 56.0 and later. | | FirstActivationDate | Type date Properties Filter, Group, Nillable, Sort Description The date the site was first activated. This field is available in API version 34.0 and later. If the site was activated or inactive before the release of API version 34.0, this field returns the date that the site was first created. | | ForgotPasswordEmailTemplateId | Type reference Properties Filter, Group, Sort, Update Description ID of the email template used when users forget their password. | | HeadlessForgotPasswordTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template to use with the Headless Forgot Password Flow. This field is available in API version 57.0 and later. | | HeadlessRegistrationTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template to use for identity verification during the Headless Registration Flow. This field is available in API version 59.0 and later. | | LockoutEmailTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when users try to reset their password after locking themselves out because of too many login attempts. This field is available in API version 43.0 and later. | | MaxFileSizeKb | Type int Properties Filter, Group, Nillable, Sort, Update Description Specifies the maximum file size (in KBs) that members can upload in your site. Available in API version 36.0 and later. Enter a number between 3072 KB and your org’s maximum file size. To use the default limit of 2 GB, leave this field empty. | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description The name of the site. | | NewSenderAddress | Type email Properties Filter, Group, Nillable, Sort, Update Description Email address that has been entered as the new value for EmailSenderAddress but hasn’t been verified yet. After a user has requested to change the sender email address and has successfully responded to the verification email, the NewSenderAddress value overwrites the value in EmailSenderAddress. This value becomes the email address from which emails are sent. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - If verification is pending for a new email address and you set NewSenderAddress to null, the verification request is canceled. - NewSenderAddress is automatically set to null after EmailSenderAddress has been set to the new verified address. - If verification is pending for a new email address, and you specify a different new address for this field, only the latest value is retained and used for verification. | | OptionsActionOverrideEnabled | Type boolean Properties Filter, Update Description Override the action that occurs when users click a default button, like New or Edit, with a Lightning component. For example, show a custom window instead of the one that Salesforce provides. Assign action overrides in the Object Manager. In the UI, this setting is available in the Administration Workspace, under **Administration** | **Preferences** under Experience Management This field is available in API version 49.0 and later. | | OptionsAllowInternalUserLogin | Type boolean Properties Filter, Update Description Specifies whether internal users can log in with their internal credentials on the site login page. This field is available in API version 37.0 and later. | | OptionsAllowMembersToFlag | Type boolean Properties Filter, Update Description Determines whether users can flag posts, comments, or files as inappropriate. This field is available in API version 29.0 and later. The ability to flag files is available in version 30.0 and later. | | OptionsApexCDNCachingEnabled | Type boolean Properties Filter, Update Description Determines whether public data from @wire calls to Apex methods is cached only for guest users. This setting applies only to sites using Salesforce's CDN for Digital Experiences. This field is available in API version 55.0 and later. | | OptionsDirectMessagesEnabled | Type boolean Properties Filter, Update Description Controls the availability of direct messages in an Experience Builder site. This field is available in API version 39.0 and later. | | OptionsEmailDomainSubstitutionEnabled | Type boolean Properties Filter, Update Description Determines whether the site uses its verified EmailSenderAddress to send email on behalf of a user with an unverified email domain (true), instead of the org-wide substitute email address set on the Deliverability Setup page (false). The default value is false. If OptionsEmailDomainSubstitutionEnabled is true and EmailSenderAddress isn't verified or doesn't use a verified email domain, Salesforce doesn't send the email. In the UI, this setting is available in the Administration Workspace, under **Administration** | **Emails**, as **Enable Email Domain Substitution**. This field is available in API version 68.0 and later. | | OptionsEmbeddedLoginEnabled | Type boolean Properties Filter, Update Description Determines whether the Embedded Login feature is enabled in a site. When true, Embedded Login is turned on. This field is available in API version 61.0 and later. | | OptionsEnableTalkingAboutStats | Type boolean Properties Filter, Update Description Determines whether site users see how many people are discussing a topic. The number of people discussing the topic appears as the user types the topic and the system gives topic suggestions. This field is available in API version 41.0 and later. | | OptionsEnableTopicAssignmentRules | Type boolean Properties Filter, Update Description When true, displays knowledgeable people in key areas, for example, on Topic Detail pages. | | OptionsExpFriendlyUrlsAsDefault | Type boolean Properties Filter, Update Description When true, URL slugs are on by default for - Product and Category pages of LWR Commerce stores (available in API version 58.0 and later) - Custom object pages on enhanced LWR sites (available in API version 60.0 and later) - Account and contact pages on enhanced LWR sites (available in API version 61.0 and later) | | OptionsExperienceBundleBasedSnaOverrideEnabled | Type boolean Properties Filter, Update Description When true, the Service Not Available Page is an auto-generated Experience Builder-based page. When false, the Service Not Available page uses a static resource page that is set in **Workspaces** | **Administration** | **Pages**. The default value is true. Available in API version 52.0 and later. | | OptionsGatherCustomerSentimentData | Type boolean Properties Filter, Update Description When true, collects data about user likes, upvotes, and downvotes. | | OptionsGuestChatterEnabled | Type boolean Properties Filter, Update Description Specifies whether guest users can access public Chatter groups in the site without logging in. | | OptionsGuestFileAccessEnabled | Type boolean Properties Filter, Update Description When true, lets guest users view asset files and CMS content that’s available to the site. Guest users can access shared asset files and published CMS content that’s made for external use, even if it isn’t used. Shared asset files include images that are associated with topics, recognition badges, branding, and account branding. This preference is automatically enabled if public access is enabled at the page or site level in Experience Builder. | | OptionsGuestMemberVisibility | Type boolean Properties Filter, Update Description When true, lets guest users see who else is part of the site, including non-guest users. In the UI, this setting appears in the Administration Workspace under **Administration** | **Preferences** . Available in API version 47.0 and later. | | OptionsHeadlessFrgtPswEnabled | Type boolean Properties Filter, Update Description When true, Headless Forgot Password Flow is enabled. This field is available in API version 57.0 and later. | | OptionsImageOptimizationCDNEnabled | Type boolean Properties Filter, Update Description When true, cached images are optimized to suit any device that guest users use to access your site. This feature is available only for sites that use Salesforce’s CDN for Digital Experiences. In the UI, this setting appears in the Administration Workspace under **Administration** | **Preferences**. Available in API version 56.0 and later. | | OptionsInvitationsEnabled | Type boolean Properties Filter, Update Description Determines whether users can invite others to the site. | | OptionsKnowledgeableEnabled | Type boolean Properties Filter, Update Description Determines whether users can see knowledgeable people for topics and endorse people for topics. | | OptionsLWRExperienceConnectedAppEnabled | Type boolean Properties Filter, Update Description When true, enhances the performance and scalability of Connect API calls made from Lightning web components in an enhanced LWR site. This field is available in API version 58.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms](https://www.salesforce.com/company/legal/agreements/ "HTML (New Window)"). | | OptionsMemberVisibility | Type boolean Properties Filter, Update Description Controls user visibility on a per-site basis. If true, the See other members of this site preference is enabled for the selected site. This field is available in API version 45.0 and later. | | OptionsMobileImageOptimizationEnabled | Type boolean Properties Filter, Update Description If true, file asset images are optimized for mobile display. This field is available in API version 45.0 and later. | | OptionsNetworkSentimentAnalysis | Type boolean Properties Filter, Update Description If true, enables sentiment analysis in a site. In the UI, this setting is available in the Administration Workspace, under **Administration** | **Preferences**. This field is available in API version 40.0 and later. | | OptionsNicknameDisplayEnabled | Type boolean Properties Filter, Update Description Determines whether user nicknames display instead of their first and last names in most places in the site. A few restrictions to keep in mind about nickname display: - Records and user lookups on records show full names. Keep in mind, though, that you can control record and user visibility with sharing rules. - Mobile notifications in the Salesforce mobile app show full names. You can turn off mobile notifications in the app to avoid this display. - Searches by first, last, and full names aren’t restricted and return matches, but the search results display only nicknames. Global search auto-complete recommendations show any first, last, and full names that the user has searched by or accessed via a record or another location. The recent items list also shows first, last, and full under the same conditions. | | OptionsPrivateMessagesEnabled | Type boolean Properties Filter, Update Description Determines whether users can send and receive Chatter messages in the site. | | OptionsProfileBasedLayoutsForKnowledgeSearchEnabled | Type boolean Properties Filter, Update Description When true, provides a grid layout for Knowledge search results. With grid layout in place, you can edit search profile layouts on the Knowledge object to show and hide different search result fields for different profiles. When you enable the standard grid layout, search-term highlighting isn’t available. This field is available in API version 51.0 and later. | | OptionsRecognitionBadgingEnabled | Type boolean Properties Filter, Update Description Determines whether Recognition Badges is enabled for the site. | | OptionsReputationEnabled | Type boolean Properties Filter, Update Description Determines if reputation is calculated and displayed for members. This field is available in API version 31.0 and later. | | OptionsReputationRecordConversationsDisabled | Type boolean Properties Filter, Update Description Disables the feed on reputation records. | | OptionsSecondaryEmailSenderEnabled | Type boolean Properties Filter, Update Description Determines whether email messages that contain sensitive data are sent from a secondary sender email address (true), instead of via email relay (false). The default value is false. This field is available in API version 67.0 and later. | | OptionsSelfRegistrationEnabled | Type boolean Properties Filter, Update Description Determines whether customers and partners can self-register to join the site. Customers and partners are users with External Identity, Community, Customer Portal, or partner portal licenses. If true, displays a **Not a member?** link on the login page that points to the default self-registration page. This field is available in API version 28.0 and later. | | OptionsSendWelcomeEmail | Type boolean Properties Filter, Update Description Determines whether a welcome email is sent when a new user is added to the site. | | OptionsShowAllNetworkSettings | Type boolean Properties Filter, Update Description Determines whether settings in Experience Management that were hidden based on how you set up your site are visible or remain hidden. This field is available in API version 33.0 and later. | | OptionsSiteAsContainerEnabled | Type boolean Properties Filter, Update Description Determines whether the site is an Experience Builder site (true) or a Salesforce Tabs + Visualforce site (false). This field is available in API version 29.0 and later. | | OptionsThreadedDiscussionsEnabled | Type boolean Properties Filter, Update Description Indicates whether threaded discussions are enabled for the site. Available in API version 44.0 and later. | | OptionsTopicFilteringForKnowledgeSearchEnabled | Type boolean Properties Filter, Update Description Determines whether topic filtering is enabled for Knowledge search. This field is available in API version 55.0 and later. | | OptionsTopicSuggestionsEnabled | Type boolean Properties Filter, Update Description Enables topic suggestions when users write posts. This field is available in API version 41.0 and later. | | OptionsUpDownVoteEnabled | Type boolean Properties Filter, Update Description Determines whether up and down voting is enabled for the site. This field is available in API version 41.0 and later. | | PendingSecondaryEmailAddress | Type email Properties Filter, Group, Nillable, Sort, Update Description The secondary sender email address that’s pending verification. Salesforce doesn’t send emails from this address until it’s verified. This field is available in API version 67.0 and later. | | PwdlessRegEmailTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template for the welcome email that users receive when they sign up with passwordless registration. This field is available in API version 61.0 and later. | | SelfRegMicroBatchSubErrorEmailTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the profile assigned to users who self-register using micro-batchng. Only applies if self-registration using micro-batching is enabled for the site. This field is available in API version 54.0 and later. | | SelfRegProfileId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the profile assigned to users who self-register. Only applies if self-registration is enabled for the site. This field is available in API version 29.0 and later. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Status of the site. Available values are: - Live—The site is online and members can access it. Label is Published. - DownForMaintenance—The site was previously published, but was taken offline. Members with the Create and Set Up Experiences permission can still access the setup for offline sites regardless of profile or membership. Members aren’t able to access offline sites, but they still appear in the user interface dropdown menu as SiteName (Offline). Label is Offline. - UnderConstruction—The site hasn’t yet been published. When a user’s profile is associated with the site, and they’ve Create and Set Up Experiences permission, they can access sites in this status. After a site is published, it can never be in this status again. Label is Preview. | | UrlPathPrefix | Type string Properties Filter, Group, Nillable, Sort, Update Description The UrlPathPrefix is a unique string at the end of the URL for the site. For example, in the site URL MyDomainName.my.site.com/customers, customers is the UrlPathPrefix. | | VerificationEmailTemplateId | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the email template used when users must verify their identity, for example, when they log in without a password. This field is available in API version 44.0 and later. | | VerifiedSecondaryEmailAddress | Type email Properties Filter, Group, Nillable, Sort Description The verified secondary sender email address. This email address is used to send sensitive emails when OptionsSecondaryEmailSenderEnabled is true. This field is available in API version 67.0 and later. | | WelcomeEmailTemplateId | Type reference Properties Filter, Group, Sort, Update Description ID of the email template used when sending welcome emails to new members. | ## Usage Use this object to find, view, and update sites in your org. If you’re assigned the Modify All Data, View All Data, or Create and Set Up Experiences permission, you can view all sites in the org. Users without these permissions see only the Preview or Published sites that they’re members of. If you’re assigned the Create and Set Up Experiences permission, you can customize site settings. #### See Also - [WebStoreNetwork](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstorenetwork.htm "Represents the relationship between a web store and an experience site. This object is available in API version 49.0 and later.") <!-- document id=c803e7a8e1ca5de01c5bbafe84d767093e2cfc49c8fa96521683f1b271d913f3 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkactivityaudit.md --> # NetworkActivityAudit Represents an audit trail of moderation actions in Experience Cloud sites. This object is available in API version 30.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available only when your org has digital experiences enabled. ## Fields | Field Name | Details | | --- | --- | | Action | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The moderation action a member performed on a post, comment, or file in an Experience Cloud site. Values are: - Flagged as Inappropriate—A member flagged a post, comment, or file as inappropriate. - Flagged as Spam - A member flagged a post, comment, or file as spam. - Unflagged—A member removed the flag from a post, comment, or file. - RemovedFlags—A moderator removed all flags from a post, comment, or file. - DeletedFlaggedItem—A moderator deleted a flagged post, comment, message, or file. - DeletedPendingReviewItem—A moderator deleted a post or comment with pending status. - ModerationRuleFlag—A moderation rule flagged member-generated content. - ModerationRuleBlock—A moderation rule blocked member-generated content. - ModerationRuleReplace—A moderation rule replaced member-generated content. - ModerationRuleReview—A moderation rule sent member-generated content to be reviewed and approved by a moderator. - ModerationRuleFreeze—A moderation rule froze a member because they created content too frequently within a specific time frame. - ModerationRuleNotify—A moderation rule notified moderators because a member created content too frequently within a specific time frame. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Notes entered by the user. If the entity being tracked is a file, records the version number of the file when it was flagged. | | EntityCreatedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user that created the entity being tracked. | | EntityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the entity that is being tracked. The following entities are tracked: ChatterMessage, ContentDocument, ContentVersion, FeedComment, and FeedItem. | | EntityType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The key prefix of the entity being tracked. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description The ID of the item being tracked. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Experience Cloud site where the moderation action was performed. | | ParentEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the parent of the entity on which an action was performed. | | ParentEntityType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The key prefix of the parent of the entity being audited. | ## Usage Use this object to view an audit trail of moderation activity for your Experience Cloud sites. You must have the Modify All Data permission to access this object. Users with Moderate Experiences Feeds, Moderate Experiences Files, or View All Data can view the audit trail using reports in the Salesforce user interface. <!-- document id=9ea56ea93dcf1ad913172901a288355ff3f630a4fa7fab37106b83cb753ed642 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkaffinity.md --> # NetworkAffinity Represents a junction object that associates a user profile with a Network object, that is, with an Experience Cloud site. Use NetworkAffinity to assign a default Experience Cloud site to a user profile. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To work with the NetworkAffinity object, you must have View Setup or Customize Application permission. ## Fields | Field Name | Details | | --- | --- | | NetworkId | Type reference Properties Create, Filter, Group, Sort Description The ID of the default Experience Cloud site associated with a user profile. | | ProfileId | Type reference Properties CreateFilter, Group, Sort, Update Description ID of the user profile the default Experience Cloud site is assigned to. | ## Usage The default Experience Cloud site allows you to stamp site-agnostic email notifications to all users with that profile with the selected site's branding. The default Experience Cloud site also becomes the target destination for email notification links. Site-agnostic email notifications include notifications about records, such as cases, accounts, and opportunities. The NetworkId field is not updatable through the Apex, REST API, or SOAP API. If you want to change the value for NetworkId, you must delete the record and create one with the right value. <!-- document id=e0c9913b73ce46508e5fb97307ce7c94d4a6294f60e9c6bff8772b5895081702 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkauthapisettings.md --> # NetworkAuthApiSettings Represents the settings that control enablement, access, and security for the Headless Registration Flow, Headless Forgot Password Flow, Headless Passwordless Login Flow, and their associated APIs. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Headless identity features are set up via Experience Cloud sites. You must have an Experience Cloud site to access Headless Identity APIs and store users, even if users never interact with the site directly. ## Fields | Field | Details | | --- | --- | | CustomOtpDeliveryHandlerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description This field is a relationship field. The ID of a custom one-time password (OTP) delivery handler that implements the Auth.CustomOneTimePasswordDeliveryHandler interface. | | DoesForgotPasswordRequireAuth | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether authentication is required to access Headless Forgot Password API when a password reset is requested. If true, an access token issued to an internal integration user in your initial POST request to the /services/auth/headless/forgot\_password endpoint is required. The access token must include the forgot\_password scope. The default value is false. | | DoesPasswordLoginRequireAuth | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether reCAPTCHA is required for headless username-password login that uses the OAuth 2.0 for First-Party Applications draft protocol. | | DoesPwdlessLoginRequireAuth | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether authentication is required to access Headless Passwordless Login API when user information is submitted to Salesforce. If true, an access token issued to an internal integration user is required in your initial POST request to the /services/auth/headless/init/passwordless/login endpoint. The access token must include the pwdless\_login\_api scope. The default value is false. This field is available in API version 59.0 and later. | | DoesRegistrationRequireAuth | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether authentication is required to access Headless Registration API when user registration information is submitted to Salesforce. If true, an access token issued to an internal integration user in your initial POST request to the /services/auth/headless/init/registration endpoint is required. The access token must include the user\_registration\_api scope. The default value is false. | | HeadlessDiscoveryExecutionUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description This field is a relationship field. The ID of an integration user account to run a headless user discovery Apex handler. Relationship Name HeadlessDiscoveryExecutionUser Refers To User | | HeadlessDiscoveryHandlerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description This field is a relationship field. The ID of an Apex class that implements the Auth.HeadlessUserDiscoveryHandler interface. Relationship Name HeadlessDiscoveryHandler Refers To ApexClass | | isFirstPartyAppsAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the Experience Cloud site can use headless identity flows that use the OAuth 2.0 for First-Party Applications draft protocol. | | IsForgotPwdAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the Headless Forgot Password Flow is enabled. The default value is false. | | IsForgotPwdEmailTemplateAllowlistingEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Descriptions Determines whether email template allowlisting is enabled for the Headless Registration Flow, Headless Passwordless Login Flow, and Headless Forgot Password Flow. If true, the initial request to the headless API must include an emailtemplate parameter that contains only allowlisted email templates. The default value is false. | | IsHeadlessUserRegistrationAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the Headless Registration Flow is enabled. The default value is false. | | IsPwdlessLoginAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the Headless Passwordless Login Flow is enabled (true) or not (false). The flow is disabled by default. This field is available in API version 59.0 and later. | | IsRecaptchaRequiredForgotPwd | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether a reCAPTCHA token is required to access Headless Forgot Password API when a password reset is requested. If true, a reCAPTCHA token is required in your initial POST request to the /services/auth/headless/forgot\_password endpoint. The default value is false. | | IsRecaptchaRequiredPwdlessLogin | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether a reCAPTCHA token is required to access Headless Passwordless Login API when user information is submitted to Salesforce. If true, a reCAPTCHA token is required in your initial POST request to the /services/auth/headless/init/passwordless/login endpoint. By default, a reCAPTCHA token isn’t required (false). This field is available in API version 59.0 and later. | | IsRecaptchaRequiredRgstr | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether a reCAPTCHA token is required to access Headless Registration API when user registration information is submitted to Salesforce. If true, a reCAPTCHA token is required in your initial POST request to the /services/auth/headless/init/registration endpoint. The default value is false. | | IsUniversalClientRgstrAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether self-registration and passwordless login via Universal Registration API are enabled. The default value is false. | | IsUserDisambiguationAllowedForgotPwd | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the Headless Forgot Password Flow uses the headless user discovery Apex handler that's specified in the HeadlessDiscoveryHandlerId field. The handler enables users to reset their password with an identifier other than their username, such as an email address, phone number, or order number. The default value is false. | | IsUserDisambiguationAllowedUsernamePwd | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether headless login flows use the headless user discovery Apex handler that's specified in the HeadlessDiscoveryHandlerId field. The handler enables users to log in with an identifier other than their username, such as an email address, phone number, or order number. This field applies to the Authorization Code and Credentials Flow and the OAuth 2.0 for First-Party Applications login flow. The default value is false. | | MaxPasswordResetAttempts | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The maximum number of password reset attempts you allow for the Headless Forgot Password Flow before the user must request a new one-time password (OTP). | | NetworkId | Type reference Properties Create, Filter, Group, Sort Description The ID of your Experience Cloud site. This ID is unique within your org. This field is a relationship field. Relationship Name Network Relationship Type Lookup Refers To Network | | RecaptchaScoreThreshold | Type double Properties Create, Filter, Nillable, Sort, Update Description The lowest reCAPTCHA score that is accepted before rejecting a request to access Headless Identity APIs. This value must be between 0.5 and 1. Scores closer to 0.5 are more likely to be bots, while scores closer to 1 are more likely to be valid users. You must set a score threshold if DoesForgotPasswordRequireAuth or DoesRegistrationRequireAuth fields are set to true. reCAPTCHA settings apply to both the Headless Registration Flow and the Headless Forgot Password Flow. Google issues a reCAPTCHA score only for reCAPTCHA v3 implementations. If you implement reCAPTCHA v2, this field doesn’t apply. | | RecaptchaSecretKey | Type encryptedstring Properties Create, Nillable, Update Description The reCAPTCHA secret key from your API key pair. You get the API key pair from Google when you set up reCAPTCHA. The secret key helps your app securely communicate with Google. You must enter a secret key if DoesForgotPasswordRequireAuth or DoesRegistrationRequireAuth are set to true. reCAPTCHA settings apply to both the Headless Registration Flow and the Headless Forgot Password Flow. | | RegistrationExecutionUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who runs your headless registration Apex handler. This field is a relationship field. Relationship Name RegistrationExecutionUser Relationship Type Lookup Refers To User | | RegistrationHandlerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of your headless registration Apex handler. This field is a relationship field. Relationship Name RegistrationHandler Relationship Type Lookup Refers To ApexClass | | RegistrationUserDefaultProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the default profile that gets assigned to new users when they register. This field is a relationship field. Relationship Name RegistrationUserDefaultProfile Relationship Type Lookup Refers To Profile | <!-- document id=956f653efdd25e20c04ca24d67b5551cdb55d5ba1cedaef3a33dac15ea4e5404 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkdatacategory.md --> # NetworkDataCategory Represents data categories in Lightning Web Runtime (LWR) Experience Cloud Sites. This object is available in API version 59.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules This object is available only when your org has Digital Experiences and Knowledge or Service Catalog enabled. ## Fields | Field | Details | | --- | --- | | DataCategoryGroupName | Type string Properties Filter, Group, Nillable, Sort Description Name of the data category group that contains one or more data categories. | | DataCategoryName | Type string Properties Filter, Group, Nillable, Sort Description Name of the data category. | | Description | Type textarea Properties Nillable Description Description of the data category. | | ImageId | Type reference Properties Filter, Group, Nillable, Sort Description Image associated with the data category. This field is a relationship field. Relationship Name Image Relationship Type Lookup Refers To ManagedContent | | Label | Type string Properties Filter, Group, Sort Description The name of the data category shown in the UI. | | NetworkId | Type reference Properties Filter, Group, Sort Description ID of the associated Experience site. This field is a relationship field. Relationship Name Network Relationship Type Lookup Refers To Network | <!-- document id=54b70710992b45e0c76f838fffec1d72feaf468a607fd4e57e72cd998948a96c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkdiscoverablelogin.md --> # NetworkDiscoverableLogin Represents the Login Discoverable page from where customers and partners log in to an Experience Cloud site. Customers and partners are users with an External Identity license or any communities license for Experience Cloud. This object is available in API version 44.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ApexHandlerId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the Apex handler created by the Login Discovery page type. | | ExecuteApexHandlerAsId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user who is executing the handler. | | NetworkId | Type reference Properties Create, Filter, Group, Sort, Update Unique Description The ID of NetworkId is unique within your org. | | UsernameLabel | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Log in prompt on login page when the login page type is Login Discovery. | ## Usage Use this object to access the Login Discovery Page, which is a login page type that prompts users to identify themselves with an email address, phone number, or custom identifier. DiscoverableLogin performs an interview-based login process, where users are first prompted to provide identity and then authenticated. For example, users receive a verification code that they enter to complete the login process. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The NetworkDiscoverableLogin object is created when **Login Discovery Page** is selected as the login page type on the Login & Registration (L&R) page. If you later switch to another login page type, such as a Visualforce Page or Experience Builder Page, the object isn’t deleted. The object persistence means you can’t delete the Apex class associated with the NetworkDiscoverableLogin object. To delete the Apex class, return to the L&R page and change the login page type back to **Login Discovery page**. Select another Apex class, and then you can delete the first one. <!-- document id=8d5dba22b81ce3eca1508165ec3c2621f2692265378f290d9cac37380b15002c url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkemailtmplallowlist.md --> # NetworkEmailTmplAllowlist Represents an allowlist for the one-time password (OTP) email templates that are sent to end users during the Headless Registration Flow, the Headless Passwordless Login Flow, and the Headless Forgot Password Flow. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | EmailTemplateId | Type reference Properties Create, Filter, Group, Sort, Update Description The IDs of the allowlisted email templates that can be sent to users during the headless authorization flows for registration, passwordless login, and forgot password. You can list multiple template IDs. When your app sends its initial request to Headless Registration API or Headless Passwordless Login API, the emailtemplate parameter can include only an email template ID from the allowlist. For Headless Forgot Password API, it works the same way, but only if email template allowlisting is enabled. This field is a relationship field. Relationship Name EmailTemplate Relationship Type Lookup Refers To EmailTemplate | | NetworkId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the Experience Cloud site for which the allowlist is being configured. This field is a relationship field. Relationship Name Network Relationship Type Lookup Refers To Network | <!-- document id=d2474fec0ffd210f73990d66a2a6b73ecd93e1708bebef16a0eb38bd68fa87b2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkfeedresponsemetric.md --> # NetworkFeedResponseMetric Represents an object that stores the date and time values of question posts. It captures information for question creation, answer creation, and when an answer is marked as best answer This object is available in API version 51.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules The NetworkFeedResponseMetric object is available only if both NetworksEnabled and ChatterEnabled org preferences are enabled. ## Fields | Field | Details | | --- | --- | | BestCommentDateTime | Type dateTime Properties Filter, Nillable, Sort Description Represents the date and time a user created an answer that was later marked as best answer. | | BestCommentId | Type reference Properties Filter, Group, Nillable, Sort Description Represents the comment that was marked as the best answer. | | FeedItemCreatedById | Type reference Properties Filter, Group, Sort Description Represents the user who created the feed item. | | FeedItemDateTime | Type dateTime Properties Filter, Sort Description Represents the date and time when the feed Item was created. | | FeedItemId | Type reference Properties Filter, Group, Sort Description Represents the unique ID of the question post. | | FirstCommentDateTime | Type dateTime Properties Filter, Nillable, Sort Description Represents the date and time when the first comment was created. | | FirstCommentId | Type reference Properties Filter, Group, Nillable, Sort Description Represent the first comment on a feed Item. | | MarkedAsBestCommentDateTime | Type dateTime Properties Filter, Nillable, Sort Description Represents the date and time the user marked the answer as best answer. | | NetworkId | Type reference Properties Filter, Group, Sort Description Represents where the feed item was created. | | ParentRecordId | Type reference Properties Filter, Group, Sort Description Represents the parent record. Parent records can include records like user, account, or group. | <!-- document id=8813bb7b11950bf7fa1ae67d715aa43f89a92cab3b56beff7232cf0567c1c239 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkmember.md --> # NetworkMember Represents a member of an Experience Cloud site. Members can be either users in your company or external users with portal profiles. This object is available in API version 26.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), update() ## Special Access Rules This object is available only when your org has digital experiences enabled. ## Fields | Field Name | Details | | --- | --- | | DefaultGroupNotificationFrequency | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. The default frequency for sending the member’s group email notifications when the member joins groups in the Experience Cloud site. The valid values are: - P—Email on every post - D—Daily digests - W—Weekly digests - N—Never The default value is W. In sites, the Email on every post option is disabled once more than 10,000 members choose this setting for the group. All members who had this option selected are automatically switched to Daily digests. However, this field is not currently enabled. These values are reserved for future use. | | DigestFrequency | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. The frequency for sending the member’s personal email digest for the Experience Cloud site. The valid values are: - D—Daily - W—Weekly - N—Never The default value is D. However, daily and weekly personal digests aren’t currently available in sites. These values are reserved for future use. | | LastChatterActivityDate | Type date Properties Filter, Group, Nillable, Sort Description The last time the member posted or commented in the Experience Cloud site. | | MemberId | Type reference Properties Filter, Group, Sort Description The ID of a person who is a member of an Experience Cloud site. | | NetworkId | Type reference Properties Filter, Group, Sort Description The ID of the Experience Cloud site that the member is part of. | | PreferencesDisableAllFeedsEmail | Type boolean Properties Filter, Update Description When false, the member can automatically receive email for updates in the Experience Cloud site, based on the types of feed emails and digests the member has enabled. | | PreferencesDisableBestAnswerEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email when someone selects their answer to a post as best. Available in API 46.0 and later. | | PreferencesDisableBookmarkEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone comments on a feed item after the member has bookmarked it. | | PreferencesDisableChangeCommentEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone comments on a change the member has made, such as an update to their profile. | | PreferencesDisableDirectMessageEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone sends them a direct message in the Experience Cloud site. | | PreferencesDisableEndorsementEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone endorses them for a topic. | | PreferencesDisableFollowersEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone in the Experience Cloud site starts following the member. | | PreferencesDisableItemFlaggedEmail | Type boolean Properties Filter, Update Description When false, the user automatically receives email every time a member flags a post or comment. This setting only applies for community moderators (with the Moderate Experiences Feeds permission) and group owners or managers. This field is available in API version 29.0 and later. | | PreferencesDisableLaterCommentEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone comments on a feed item after the member has commented on the feed item. | | PreferencesDisableLikeEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone comments on a feed item after the member has liked the feed item. | | PreferencesDisableMarketingCloudEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives marketing emails sent by Journey Builder. Available in API version 41.0 and later. | | PreferencesDisableMentionsPostEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time the member is mentioned in posts. | | PreferencesDisableMessageEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time the member is sent a Chatter message. | | PreferencesDisableProfilePostEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone posts to the member’s profile. | | PreferencesDisableSharePostEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time the member’s post is shared. | | PreferencesDisCommentAfterLikeEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone comments on a post the member has liked. | | PreferencesDisMentionsCommentEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time the member is mentioned in comments. | | PreferencesDisProfPostCommentEmail | Type boolean Properties Filter, Update Description When false, the member automatically receives email every time someone comments on posts on the member’s profile. | | ReputationPoints | Type double Properties Filter, Sort, Update Description The number of reputation points the user has accumulated by performing actions in the Experience Cloud site. | ## Usage Use this object to query members of a certain Experience Cloud site and to update their email notification settings. If you have Modify All Data, View All Data, or Create and Set Up Experiences, you can view all members of any Experience Cloud site, regardless of your own membership. If you have Modify All Data or Create and Set Up Experiences, you can also update any member’s email settings. Users without these permissions can update their own email settings and can see members of the Experience Cloud sites that they’re also members of. You can directly update reputation points for a member via the Salesforce API. You can also use Apex triggers to send custom notifications based on changes to reputation points. <!-- document id=216b5f2791b04f7e044922a167c7bd3da188101c697a7c04ea171b1dbbfc7292 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkmembergroup.md --> # NetworkMemberGroup Represents a group of members in an Experience Cloud site. Members can be either users in your internal org or external users assigned portal profiles. An administrator adds members to an Experience Cloud site by adding a profile or a permission set, and any user with the profile or permission set becomes a member of the site. This object is available in API version 26.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If a Chatter customer (from a customer group) is assigned a permission set that is also associated with an Experience Cloud site, the Chatter customer won’t be added to the site. Prior to API version 27.0, this object was called NetworkProfile. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The upsert() call is not supported for this object. ## Special Access Rules This object is available only when your org has digital experiences enabled. ## Fields | Field Name | Details | | --- | --- | | AssignmentStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The status of a profile or permission set within an Experience Cloud site. Values are: - Add Calculated—The number of users that need to be added are calculated and the add operation is in progress. - Added—Users with this profile or permission set are members. - Failed Add—Users with this profile or permission set were not successfully made members. - Failed Remove—Users with this profile or permission set were not successfully removed from membership. - Remove Calculated—The number of users that need to be removed are calculated and the remove operation is in progress. - Waiting for Add—The profile or permission set was added to the Experience Cloud site, but the async process hasn’t completed yet. After the process is complete, the status is updated to Added. - Waiting for Remove—Use this status to remove all the members belonging to a profile or permission set and remove a profile or permission set from an Experience Cloud site. | | NetworkId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Experience Cloud site that this group of members is associated with. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the [profile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profile.htm "Represents a profile, which defines a set of permissions to perform different operations. Operations can include creating a custom profile or querying, adding, updating, or deleting information.") or [permission set](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.") associated with the Experience Cloud site. | ## Usage Use this object to view the profiles or permission sets associated with a particular Experience Cloud site. Profiles and permission sets are added and removed asynchronously, so you can also check the status of a profile or permission set that was updated in a site. If you have Modify All Data, View All Data, or Create and Set Up Experiences, you can view all profiles or permission sets for any Experience Cloud site in the org, regardless of your membership. If you have Modify All Data or Create and Set Up Experiences, you can also add profiles or permission sets. Users without these permissions can only find profiles and permission sets for Experience Cloud sites that they’re members of. ## Sample Code // Create a new NetworkMemberGroup with a profile as the ParentId NetworkMemberGroup nmgInsert = new NetworkMemberGroup(); nmgInsert.setNetworkId('{enter your network ID : ODB...}'); nmgInsert.setParentId('enter the profile or permission set ID : 00e... or 0PS...'); SaveResult\[\] results = connection.create(new SObject\[\] { nmgInsert }); // Update an existing NetworkMemberGroup to be removed from the Network NetworkMemberGroup nmgUpdate = new NetworkMemberGroup(); nmgUpdate.setId('enter your NetworkMemberGroup ID : 0DL...'); nmgUpdate.setAssignmentStatus('WaitingForRemove'); SaveResult\[\] results = connection.update(new SObject\[\] { nmgUpdate }); <!-- document id=700e6db9cece89f6c1b0155c788242180a4f0fc78d2692714d4bfd87579e3b26 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkmoderation.md --> # NetworkModeration Represents a flag on an item in a community. This object is available in API version 30.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Special Access Rules This object is available only when your org has digital experiences enabled. ## Fields | Field Name | Details | | --- | --- | | EntityId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the post, comment, or file that was flagged. | | ModerationType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description Determines the type of flag applied to an item. Values are: - FlagAsInappropriate - FlagAsSpam | | NetworkId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the community in which the item was flagged. | | Visibility | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Nillable, Sort Description Determines visibility of a flagged item. Values are: - SelfAndModerators—The user who flagged the item and any moderators can see the flagged item. This is the default value. - ModeratorsOnly—Only moderators can see the flagged item. If ModeratorsOnly is selected, only moderators can set flags using the API. | ## Usage Use this object to view the items flagged for moderation within a community. Additionally, users with “Moderate Feeds” and “Modify All Data” can remove flags. Flags on items are created either when a member manually flags an item in a community (if flagging is enabled for that community), or when a trigger automatically flags an item because the item met the trigger criteria. <!-- document id=5e6d4ea718faf43636baf2a8859809a467b822d04efa14ca484cc84c1bf093f8 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkpageoverride.md --> # NetworkPageOverride Represents information about custom pages used to override the default pages in Experience Cloud sites. You can create Experience Builder or Visualforce pages and override the default pages in a site. Using custom pages allows you to create a more personalized experience for your users. This object is available in API version 34.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules - Only users with the Create and Setup Experiences permission can update this object. - You can’t override the Change Password Page with a page created using Experience Builder. You can only override it with a Visualforce page. ## Fields | Field Name | Details | | --- | --- | | NetworkId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Experience Cloud site where a custom page is used to override a default page. | | OverrideSetting | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of the page used to override a default page in the Experience Cloud site. OverrideSetting can take the following values: - Standard—The standard page that comes by default with the site. - Configurable—The page created when the Configurable Self-Reg registration page type or the Login Discovery login page type is selected. - Designer—A custom page created using Experience Builder. - Visualforce—A custom page created using Visualforce. | | OverrideType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The name of the default page in the Experience Cloud site that you want to override with a custom page.OverrideType can take the following values: - LoginRequired - ChangePassword - ForgotPassword - SelfReg - Home | <!-- document id=32e2a3aa4e93d8cc07c0cb0fdc0765435ce1c63c9cefc0d5fa3521951cc6dabb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkselfregistration.md --> # NetworkSelfRegistration Represents the account that self-registering Experience Cloud users are associated with by default. Self-registering users in an Experience Cloud site are required to be associated with an account, which the admin must specify while setting up self-registration for the site. If an account isn’t specified, Salesforce creates person accounts (when enabled) for self-registering users. This object is available in API version 34.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the account that self-registering users in the Experience Cloud site are associated with. | | ApexHandlerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Apex handler created by Configurable Self-Reg registration page type. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the org. The default value is USD. | | ExecuteApexHandlerAsId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who is executing the configurable self-registration handler. | | NetworkId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of NetworkId is unique within your org. You can use only one account per Experience Cloud site to assign self-registering users. | | OptionsDisableStandardRgstrComponent | Type boolean Properties Create, Filter, Update Description Determines whether you can use standard Aura and Lightning Web Runtime (LWR) components for self-registration. If this field is true, self-registration flows that use these components don’t work. For more control over self-registration, set this field to true if you’re not using the standard self-registration component. | | OptionsIncludePassword | Type Boolean Properties Create, Filter, Update Description Option on Configurable Self-Reg registration page. If true, the Include Password field is selected. | | OptionsShowEmail | Type Boolean Properties Create, Filter, Update Description Option on Configurable Self-Reg registration page. If true, the Email field appears on the self-registration form. | | OptionsShowFirstName | Type Boolean Properties Create, Filter, Update Description Option on the Configurable Self-Reg registration page. If true, the First Name field appears on the self-registration form. | | OptionsShowLastName | Type Boolean Properties Create, Filter, Update Description Option on the Configurable Self-Reg registration page. If true, the Last Name field appears on the self-registration form. | | OptionsShowMobilePhone | Type Boolean Properties Create, Filter, Update Description Option on the Configurable Self-Reg registration page. If true, the Mobile field appears on the self-registration form. | | OptionsShowNickname | Type Boolean Properties Create, Filter, Update Description Option on the Configurable Self-Reg registration page. If true, the Nickname field appears on the self-registration form. | | OptionsShowUsername | Type Boolean Properties Create, Filter, Update Description Option on the Configurable Self-Reg registration page. If true, the Username field appears on the self-registration form. | | PermissionSetGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the permission set group used for the self registration. This field is a relationship field. Relationship Name PermissionSetGroup Refers To PermissionSetGroup | | VerificationMethod | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of verification method that a user must supply when registering, which can be: - SyncEmail—User must supply an email address to verify identity. - SMS—User must supply a phone number to verify identity. | <!-- document id=9e83ec23bc456f6538edb22e465ebdb570511262dec845c1562ea5750fa055b9 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_networkuserhistoryrecent.md --> # NetworkUserHistoryRecent Represents an Experience Cloud site user’s history of accessed records. This object is available in API version 42.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(),query(), undelete() ## Special Access Rules Only users with the Modify All Data permission can view and delete these data. ## Fields | Field | Details | | --- | --- | | AccessTimestamp | Type datetime Properties Create, Filter, Sort Description The time at which the record was accessed. | | ActionType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the action type taken by the user. The possible values are: - Read - Write | | DomainName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The domain used to access the record. | | FeedCommentId | Type reference Properties Create, Filter, Group, Sort, Update Description Feed comment accessed by the user. | | FeedItemId | Type reference Properties Create, Filter, Group,Sort, Update Description Feed item accessed by the user. | | NetworkId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the Experience Cloud site used to access the record or comment. | | NetworkUserId | Type reference Properties Create, Filter, Group, Sort, Update Description User’s Experience Cloud site user ID to access the record or comment. | | RecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The record that was accessed. | | RecordKeyPrefix | Type string Properties Create, Filter, Group, Sort, Update Description Record’s ID key prefix. | | Url | Type string Properties Create, Filter, Group, Sort, Update Description The URL from which the user accessed the record. | | UserType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of user who accessed this record. The possible values include: - Standard - Partner - Customer Portal Manager - Customer Portal User - Guest - High Volume Portal - CSN Only - Self Service | ## Usage Use the NetworkUserHistoryRecent object to delete comments, posts, or record access by Experience Cloud site users who would like all such activity to be removed. <!-- document id=80f9207e33abafc626bf59140a0ab6684b163248127a53748bff345435ebebc2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_note.md --> # Note Represents a note, which is text associated with a custom object or a standard object, such as a Contact, Contract, or Opportunity. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Body | Type textarea Properties Create, Nillable, Update Description Body of the note. Limited to 32 KB. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsPrivate | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API. Note that if a user who does not have the “Modify All Data” permission sets this field to true on a note that they do not own, then they can no longer query, delete, or update the note. Label is **Private**. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who owns the note. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | ParentId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the object associated with the note. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareMetricTarget, CareObservationComponent, CarePgmProvHealthcareProvider, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareTaxonomy, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, Contact, Contract, CreditMemo, DelegatedAccount, EngagementChannelType, EnrollmentEligibilityCriteria, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, Lead, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PersonEducation, PersonLifeEvent, Product2, ProductRequest, ProductRequestLineItem, PurchaserPlan, ReceivedDocument, ServiceAppointment, ServiceResource, Shift, SocialPost, Visit, VisitedParty, Visitor, VolunteerProject, WorkOrder, WorkOrderLineItem | | Title | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Title of the note. | ## Usage Use this object to manage notes for an object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") <!-- document id=ebd5e5b7ffebdf91719156bc2bdd16644be5a63dc16e699d4a375cc63ffc05fb url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_noteandattachment.md --> # NoteAndAttachment This read-only object contains all notes and attachments associated with an object. ## Supported Calls describeSObjects() ## Fields | Field | Details | | --- | --- | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsNote | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the object contains a note (true) or an attachment (false). | | IsPrivate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API. Note that if a regular user who does not have “Modify All Data” permission sets this field to true on a note that they do not own, then they can no longer query, delete, or update that note. Label is **Private**. | | OwnerId | Type reference Properties Filter, Group, Sort Description ID of the user who owns the note and attachment. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | ParentId | Type reference Properties Filter, Group, Sort Description ID of the parent object. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareMetricTarget, CareObservationComponent, CarePgmProvHealthcareProvider, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareTaxonomy, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, Contact, Contract, CreditMemo, DelegatedAccount, EngagementChannelType, EnrollmentEligibilityCriteria, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, Lead, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PersonEducation, PersonLifeEvent, Product2, ProductRequest, ProductRequestLineItem, PurchaserPlan, ReceivedDocument, ServiceAppointment, ServiceResource, Shift, SocialPost, Visit, VisitedParty, Visitor, VolunteerProject, WorkOrder, WorkOrderLineItem | | Title | Type string Properties Filter, Nillable, Group, Sort Description Title of the note. | ## Usage Use this object to list all notes and attachments for an object. To retrieve notes and attachments, issue a describe call on an object, which returns a query result for each activity since the record was created. You can’t directly query this object. #### See Also - [Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_note.htm "Represents a note, which is text associated with a custom object or a standard object, such as a Contact, Contract, or Opportunity.") - [Attachment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attachment.htm "Represents a file that a User has uploaded and attached to a parent object.") <!-- document id=dad51eb99024225ed625a331d973c3a16b82defdec79d7789092b664f27db35f url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_notetag.md --> # NoteTag Associates a word or short phrase with a Note. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage NoteTag stores the relationship between its parent TagDefinition and the Note being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. <!-- document id=f35d47df2c80b8a1a9c5f69f511880ad37b58f10ef11972422531dd1d870937e url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_oauthcustomscope.md --> # OauthCustomScope Represents a permission defining the protected data that a connected app can access from an external entity when Salesforce is the OAuth authorization provider. An OAuth custom scope tells an external entity about a connected app’s permissions to access protected data. The OAuth custom scope that you create in your Salesforce org corresponds to the same custom scope defined in your external entity, and assigned to the resource. For example, you define an Order Status custom scope in your external entity that allows access to customer order status data in your order system’s API. In Salesforce, you create an OAuth custom scope that you also name Order Status. You assign this custom scope to the connected app requesting access to the order status API. When the external entity receives the connected app’s request to access a customer’s order status, it validates the connected app’s access token and Order Status scope. With a successful validation, the app can access the customer order status information in the order system’s API. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules You must have the “Manage Connected Apps” permission to access this object. ## Fields | Field Name | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Sort, Update Description The description of the permission provided to the connected app by the scope. The custom scope’s description must be unique, can only include alphanumeric characters, and can be up to 60 characters long. You can enter a custom label in place of a description. An advantage of using a custom label is that you can maintain reusable text in a single location and translate the text into multiple languages. See [Custom Labels](https://help.salesforce.com/articleView?id=cl_about.htm&language=en_US). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The description formatting requirements that apply to custom scopes also apply to custom labels. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Use when referring to the OAuth custom scope from a program. This label must be unique, and can include only alphanumeric characters and underscores. | | IsPublic | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the object is included in the connected app’s OpenID Connect discovery endpoint. For more information, see [OpenID Connect Discovery Endpoint](https://help.salesforce.com/articleView?id=remoteaccess_using_openid_discovery_endpoint.htm&language=en_US). | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the default language defined for the developing org. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The master label for the custom scope record. This label must be unique, and can include only alphanumeric characters and underscores. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix for an OAuth custom scope that's been installed as part of a second-generation managed package. If the custom scope isn't packaged, this value is empty. This field is available in API version 61.0 and later. | <!-- document id=05721cb1ad85e44c0a9a4ae1e49df7c4acffc3d5da92bc14f679d03ae8becf11 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_oauthcustomscopeapp.md --> # OauthCustomScopeApp Represents the name of the connected app to which the custom scope is assigned. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | OauthCustomScopeId | Type reference Properties Create, Filter, Group, Sort, Update Description The name of the connected app to which the custom scope is assigned. If the connected app is part of a package, include the package’s namespace prefix with the connected app’s name. Use the following format: <namespace\_prefix>\_\_<connected\_app>. Use two underscores (\_) between the namespace prefix and connected app’s name. This is a relationship field. Relationship Name OauthCustomScope Relationship Type Lookup Refers To OauthCustomScope | <!-- document id=26b8693e85c60225f1a5eee7a6a8dd8169677be0acfd2240f8adee39f7c25503 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_oauthtoken.md --> # OauthToken Represents an OAuth access token for connected app authentication. Use this object to create a user interface for token management. This object is available in API version 32.0 and later. A connected app integrates an application with Salesforce using APIs. Connected apps use standard SAML and OAuth protocols to authenticate, provide single sign-on, and provide tokens for use with Salesforce APIs. In addition to standard OAuth capabilities, connected apps allow Salesforce admins to set various security policies and have explicit control over who can use the corresponding apps. Each time that a user grants access to an application, the application obtains a new access token. ## Supported Calls describeSObjects(), query() ## Special Access Rules Users with the Customize Application permission see all tokens for all users in the org. Otherwise, you see only your own tokens. If you try to use [Apex DML operations](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_dml_section.htm) and then query this object in the same call, you get an UncommittedWork error with this description. A callout was unsuccessful because of pending uncommitted work related to a process, flow, or Apex operation. Commit or roll back the work, and then try again. To avoid this error, execute DML operations and queries in separate, asynchronous calls. ## Fields | Field Name | Details | | --- | --- | | AccessToken | Type string Properties Filter, Group, Nillable, Sort Description The refresh token for authorization. | | AppMenuItemId | Type reference Properties Filter, Group, Nillable, Sort Description The unique ID for the App Picker menu item that’s associated with this OAuth token. This is a relationship field. Relationship Name AppMenuItem Relationship Type Lookup Refers To AppMenuItem | | AppName | Type string Properties Filter, Group, Nillable, Sort Description The label for the connected app that’s associated with this OAuth token. | | DeleteToken | Type string Properties Filter, Group, Nillable, Sort Description A token that can be used at the revoke OAuth token endpoint to remove this token. | | Id | Type ID Properties Defaulted on create, Filter, Group, idLookup, Sort Description Reserved for future use. Currently, the value is always null. | | LastUsedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date when the OAuth token was used. | | RequestToken | Type string Properties Filter, Group, Nillable, Sort Description The authorization code that was used to request the corresponding AccessToken. With this authorization code, you can revoke the corresponding AccessToken by passing the DeleteToken. | | UseCount | Type int Properties Filter, Group, Nillable, Sort Description How often the token has been used. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description The owner of the token. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Usage To delete an AccessToken, send a request to the revoke OAuth token endpoint with the DeleteToken as the parameter. For example, the URL https://MyDomainName.my.salesforce.com/services/oauth2/revoke?token=(the Delete Token) causes the deletion of the token. In API version 34.0 and later, this object was enhanced to help manage high instance counts. A query() call returns up to 500 rows. A queryMore() call returns 500 more, up to 2,500 total. No more records are returned after 2,500. To make sure that you don’t miss any records, issue a COUNT() query in a SELECT clause for OauthToken. This query gives you the total number of records. If there are more than 2,500 records, use these options to manage your results. - Divide queries by filtering on fields like UserId to return subsets of less than 2,500 records. - Use [OFFSET](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_offset.htm) to get batches of 2,000 records. Start with an OFFSET of 0 and then increment by 2,000. If you use this option, we recommend that you also use [LIMIT](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_limit.htm) to limit each query to 2,000. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The OFFSET clause is limited to 2,000 rows. Requesting an offset greater than 2,000 results in a NUMBER\_OUTSIDE\_VALID\_RANGE error. For example, use an initial query with this structure. SELECT <desired fields> FROM OauthToken LIMIT 2000 OFFSET 0 Then, run another query with an offset of 2,000. SELECT <desired fields> FROM OauthToken LIMIT 2000 OFFSET 2000 Continue to increase the offset by 2,000 until you have results for all records. <!-- document id=beedf19e84e090f8176ae2278730102e5a88f6b41e216bf0fd27435ce0b16ef7 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_oauthtokenexchangehandler.md --> # OauthTokenExchangeHandler Represents a token exchange handler. The token exchange handler also consists of an Apex class. During the OAuth 2.0 token exchange flow, the token exchange handler is used to validate tokens from an external identity provider and to map users to Salesforce. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Sort, Update Description A description for your token exchange handler. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API name for the handler. | | IsContactCreationAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description For internal use only. | | IsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the handler is enabled for the token exchange flow. The default value is false. | | IsUserCreationAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the handler can set up new users. During the token exchange flow, the Apex handler maps users from the identity provider to Salesforce. If the IsUserCreationAllowed field is true, the canCreateUser boolean in the getUserForTokenSubject method is true, and the user doesn’t exist in Salesforce, the handler sets up a new User object, which Salesforce automatically inserts to finish creating the user. The default value is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the language used in the org where the token exchange handler was created. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label of the token exchange handler record. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | SupportedTokenTypesAccessToken | Type boolean Properties Create, Filter, Update Description Indicates whether the handler supports opaque access tokens from the identity provider. | | SupportedTokenTypesIdToken | Type boolean Properties Create, Filter, Update Description Indicates whether the handler supports OpenID Connect ID tokens from the identity provider. | | SupportedTokenTypesJwt | Type boolean Properties Create, Filter, Update Description Indicates whether the handler supports tokens from the identity provider that are in JWT format, such as JWT-based access tokens. | | SupportedTokenTypesRefreshToken | Type boolean Properties Create, Filter, Update Description Indicates whether the handler supports OAuth 2.0 refresh tokens from the identity provider. | | SupportedTokenTypesSaml2 | Type boolean Properties Create, Filter, Update Description Indicates whether the handler supports SAML 2.0 assertions from the identity provider. | | TokenHandlerApexId | Type reference Properties Create, Filter, Group, Sort, Update Description The Apex class associated with the token exchange handler. The class contains methods to validate the token and map users to Salesforce. It must extend the Oauth2TokenExchangeHandler Apex class. This field is a relationship field. Relationship Name TokenHandlerApex Relationship Type Lookup Refers To ApexClass | <!-- document id=02e3a9d0512432920beffa19b567bab7e8f07bee789dba19713bb70ba6bbd210 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_oauthtokenexchhandlerapp.md --> # OauthTokenExchHandlerApp Represents the enablement settings for a specific Salesforce connected app or external client app that’s enabled for the token exchange handler. A handler can be enabled for multiple apps. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules ## Fields | Field | Details | | --- | --- | | ApexExecutionUserId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user who runs the Apex token exchange handler. We recommend that you use an integration user. This field is a relationship field. Relationship Name ApexExecutionUser Relationship Type Lookup Refers To User | | ConnectedApplicationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The connected app that’s being used to integrate with Salesforce. This field is a relationship field. Relationship Name ConnectedApplication Relationship Type Lookup Refers To ConnectedApplication | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the token exchange handler is the default handler for this app. During the token exchange flow, in the token request, you can optionally include a token\_handler parameter with the name of a specific handler’s Apex class. If you don’t include this parameter, Salesforce defaults to the default handler. The default value is false. | | OauthTokenExchangeHandlerId | Type reference Properties Create, Filter, Group, Sort, Update Description The OauthTokenExchangeHandler with which these enablement settings are associated. This field is a relationship field. Relationship Name OauthTokenExchangeHandler Relationship Type Lookup Refers To OauthTokenExchangeHandler | <!-- document id=8d51f3d5d6a0a7622c1c8dddb72153f95b1786937eaab6e90ea769605b1cbf45 url=/legacydeveloper/current/en-us/object_reference/sforce_api_concepts_object_cheatsheet.md --> # Object Cheatsheet At a glance, see how objects compare to each other. ## Object Groups - Common Objects: Used to store data available in any standard org for any cloud. Optimized for ACID transactions. Relational and transactional database that scales to millions of records. - High-scale objects: Used for large numbers of transactions and data storage over time - External Objects: Used to represent data stored outside Salesforce ## Object Types | Object Type | Group | Description | Customizable | Cloud | Packaging | Documentation | Reference | | --- | --- | --- | --- | --- | --- | --- | --- | | Base Platform Objects | common objects | Used for data common to most orgs | Yes | Common | Every form of packaging except data kits | [DX and Developer Tools](https://developer.salesforce.com/developer-centers/developer-experience) | [Object Reference for the Platform](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm) | | Big Objects | high-scale objects | Used for large transactions and data storage over time | Yes | Any cloud that provides an org | Deploy/retrieve with .zip files; no standard AppExchange packaging | [Big Objects Implementation Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.bigobjects.meta/bigobjects/big_object.htm) | [Object Reference for the Platform](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm) | | Calculated Insight Objects (CIO) | high-scale objects | Contains data aggregated or calculated from DMOs | Yes | Data Cloud | Data kits | [Calculated Insights](https://help.salesforce.com/s/articleView?id=data.c360_a_calculated_insights.htm&type=5&language=en_US) in Help | N/A | | Custom Objects | common objects | User-defined objects | N/A | Common | Depends on the object | [Create a Custom Object](https://help.salesforce.com/s/articleView?id=platform.dev_objectcreate_task_parent.htm&type=5&language=en_US) in Help | N/A | | Data Graphs (DG) | high-scale objects | Create a materialized view of data to improve query speed | Yes | Data Cloud | Data kits | [Create a Data Graph](https://help.salesforce.com/s/articleView?id=data.c360_a_create_a_data_graph.htm&type=5&language=en_US) in Help | N/A | | Data Lake Objects (DLO) | high-scale objects | Store data ingested into Data Cloud | Yes | Data Cloud | DLOs and data streams can be packaged via data kits | [Data Objects in Data Cloud](https://help.salesforce.com/s/articleView?id=data.c360_a_data_lake_objects.htm&type=5&language=en_US) in Help | Consult the reference documentation for the system storing the data | | Data Model Objects (DMO) | high-scale objects | Provide a common representation of data by using C360 data model | Yes | Data Cloud | Data kits (recommended) | [Data Objects in Data Cloud](https://help.salesforce.com/s/articleView?id=data.c360_a_data_lake_objects.htm&type=5&language=en_US) in Help | [Data Cloud Reference Guide](https://developer.salesforce.com/docs/atlas.en-us.c360a_api.meta/c360a_api/c360a_api_intro_cdpapis.htm) | | External Objects | External Objects | Represent data stored outside Salesforce | N/A | N/A | N/A | N/A | N/A | | High Scale Order Objects | high-scale objects | Optimized for OLTP transactions | N/A | N/A | N/A | [Order Management Implementation Guides](https://developer.salesforce.com/docs/atlas.en-us.264.0.order_management_developer_guide_html.meta/order_management_developer_guide_html/order_management_order_summary_erd.htm) in Help | [Object Reference for the Platform](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm) | | Setup Platform Objects | common objects | Common objects containing setup configuration information created using Setup | Yes | Common | Depends on the cloud, product, and feature | [DX and Developer Tools](https://developer.salesforce.com/developer-centers/developer-experience) | [Object Reference for the Platform](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm) | | Unified Objects | high-scale objects | Created as a golden record of data through identity resolution | Yes | Data Cloud | Packageable through data kits | [Unify Source Profiles](https://help.salesforce.com/s/articleView?id=data.c360_a_identity_resolution.htm&type=5&language=en_US) in Help | N/A | | Unstructured Data Lake Objects (UDLO) | high-scale objects | References unstructured data in Data Cloud and is created manually | Yes | Data Cloud | No, but connections can be packaged | [Unstructured Data Lake Objects](https://help.salesforce.com/s/articleView?id=sf.c360_a_unstructured_data_udlo_overview.htm&language=en_US&type=5) in Help | N/A | | Unstructured Data Model Objects (UDMO) | high-scale objects | Represents data from unstructured data sources | Yes | Data Cloud | Data kits (recommended) | [Data Objects in Data Cloud](https://help.salesforce.com/s/articleView?id=data.c360_a_data_lake_objects.htm&type=5&language=en_US) in Help | N/A | | Zero Copy Objects | External objects | Deep integration with external data sources, so no data syncing required | N/A | N/A | N/A | N/A | N/A | <!-- document id=ad98fdfda2c1441a5ac480f7206838c88fb6839c9ddd58dfbff9cf998ab70adc url=/legacydeveloper/current/en-us/object_reference/sforce_api_concepts_object_groups.md --> # Object Groups Objects can be grouped in any number of ways. Object groups are based on where data is stored, how it's used, and which licenses are required to access it. - Salesforce Common Objects—available for any org - Salesforce Cloud Objects—available for specific clouds or features - High-Scale Objects—available when purchased for specific clouds - External Data—stored outside Salesforce - **[Salesforce Common Objects](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_concepts_common_objects.htm)** Common objects are available in any standard org for any cloud. They don’t require any special licensing. - **[Salesforce Cloud Objects](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_concepts_cloud_objects.htm)** Cloud objects are used only by a specific cloud. These objects sometimes have different limitations, APIs, or querying behavior than standard common objects. - **[Salesforce High-Scale Objects](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_concepts_high_scale_objects.htm)** Use high-scale objects when you have a large number of transactions, large objects, or you must store data over a long period. These objects sometimes have different limitations, APIs, or querying behavior than Salesforce common objects do. - **[Salesforce External Data Objects](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_concepts_external_data_objects.htm)** You can store data outside Salesforce and still access in your org or Data Cloud. <!-- document id=2369e44e1d396df71132890e0e4fc25278351d90bb259ecb995f1ea0a0a80d1b url=/legacydeveloper/current/en-us/object_reference/object_interface.md --> # Object Interfaces An object interface defines the business logic that an object implements. The object that implements the interface, called the **implementor**, stores the data and implements the business logic. An API that accepts a parameter with an object interface data type can accept any implementor of the object interface. For example, /calculate-price accepts the SalesTransaction object interface. You can use any implementor of SalesTransaction, such as an Order object, in the /calculate-price request. <!-- document id=546c4d551687d5e9b678a5de518646ec870b9865697b63748752bf8233c11818 url=/legacydeveloper/current/en-us/object_reference/object_interfaces_list.md --> # Object Interfaces This section provides a list of standard object interfaces and their standard fields. Some fields may not be listed for some object interfaces. To see the system fields for each object interface, see [System Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/system_fields.htm "System fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example, the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies a record.") . To verify the complete list of fields for an object interface, you can use a describe call from the API. - **[PriceAdjustmentGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_interfaces_priceadjustmentgroup.htm)** Defines the business logic for a top-level price adjustment, for example, a discount applied to an entire order. This object interface is available in API version 55.0 and later. - **[PriceAdjustmentItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_interfaces_priceadjustmentitem.htm)** Defines the business logic for an item-level price adjustment, for example, a discount on an order item. This object interface is available in API version 55.0 and later. - **[SalesTransaction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_interfaces_salestransaction.htm)** Defines the business logic for a sales transaction, for example, an order or a cart. This object interface is available in API version 55.0 and later. <!-- document id=31975f6f931b1a503d3065254ed6747b013359420d6b3a4b2a84d89e85aca1e2 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_objectdataimport.md --> # ObjectDataImport Represents the data import status of one or more object records. This object is available in API version 57.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | EndDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time (in UTC) when the data import finished. | | FileName | Type string Properties Filter, Group, Nillable, Sort Description Optional. If the data import was from a comma-delimited file (CSV), the name of the file. The maximum length is 120 characters. | | ObjectDataImportNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the data import. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user who owns the data import status record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PrimaryObject | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the primary object being imported. For example, Lead. This value is usually provided programmatically. The maximum length is 120 characters. | | Result | Type textarea Properties Nillable Description The JSON response of the data object import result, including error messages. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The processing status of the data object import. Possible values are: - Completed - In Progress | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data import, such as from a comma-delimited file or through a connector. Possible values are: - CSV Async - CSV Sync - External Record Import—A record imported or updated by Partner Connect between a partner and vendor system. To see this field, enable Partner Connect. See [Set Up Partner Connect as a Partner](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_partner_parent.htm&type=5&language=en_US) in Salesforce Help. Available in API version 62.0 and later. - One time Connector | ## Associated Objects This object has these 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. [ObjectDataImportChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Sharing rules are available for the object. [ObjectDataImportOwnerSharingRule](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. [ObjectDataImportShare](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. <!-- document id=8697519dbd32d686b702c60fe0e1123407b3983461a720ad47fb023dcd918df5 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_objectdataimportreference.md --> # ObjectDataImportReference Represents the relationships to the associated reference objects showing the source from which the data is imported. This object is available in API version 57.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules ObjectDataImportReference is read only and can only be queried. ## Fields | Field | Details | | --- | --- | | ObjectDataImportId | Type reference Properties Filter, Group, Sort Description Foreign key to the ObjectDataImport object. This field is a relationship field. Relationship Name ObjectDataImport Relationship Type Lookup Refers To ObjectDataImport | | ObjectDataImportReferenceNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Foreign key to the reference object. For example, AsyncApiJob or DatasetImportRequest. | <!-- document id=56c51a1f62a7d78bc4d7ec0b1cba50a54ffdfc99e798e81ab16440cae6a6e522 url=/legacydeveloper/current/en-us/object_reference/sforce_api_objects_objectmetadatatag.md --> # ObjectMetadataTag Represents a meta tag for a store page. Meta tags in HTML documents provide structured data used by search engines for ranking and to show content in search results. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), undelete(), update(), upsert() ## Special Access Rules This object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: - USD—U.S. Dollar The default value is USD. | | Language | Type string Properties Create, Filter, Group, Sort, Update Description The language of the page meta tag. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the page meta tag. | | RecordId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the product or product category with which this record is associated. This is a polymorphic relationship field. Relationship Name Record Relationship Type Lookup Refers To Product2, ProductCategory Availability in API versions: - Product2 is available in API versions 60.0 and later - ProductCategory is available in API versions 63.0 and later | | TagType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of the page meta tag. Possible values are: - Description—Meta Description - Title—Title Tag | | Value | Type textarea Properties Create, Filter, Group, Sort, Update Description The value of the page meta tag. This value populates the HTML tag. For example, a meta tag with a Type of Title and a Value of GoBrew Espresso renders the HTML <title>GoBrew Espresso for the page. | # ObjectPermissions Represents the enabled object permissions for the parent PermissionSet. This object is available in API version 24.0 and later. To grant a user access to an object, associate an ObjectPermissions record with a PermissionSet that’s assigned to a user. ObjectPermissions records are only supported in PermissionSet, not in Profile. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only users with the View Setup and Configuration permission can access this object. ## Fields | Field Name | Details | | --- | --- | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The Id of this object’s parent [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later."). This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To PermissionSet | | PermissionsCreate | Type boolean Properties Create, Filter, Update Description If true, users assigned to the parent PermissionSet can create records for this object. Requires PermissionsRead for the same object to be true. | | PermissionsDelete | Type boolean Properties Create, Filter, Update Description If true, users assigned to the parent PermissionSet can delete records for this object. Requires PermissionsRead and PermissionsEdit for the same object to be true. | | PermissionsEdit | Type boolean Properties Create, Filter, Update Description If true, users assigned to the parent PermissionSet can edit records for this object. Requires PermissionsRead for the same object to be true. | | PermissionsModifyAllRecords | Type boolean Properties Create, Filter, Update Description If true, users assigned to the parent PermissionSet can edit all records for this object, regardless of sharing settings. Requires PermissionsRead, PermissionsDelete, PermissionsEdit, and PermissionsViewAllRecords for the same object to be true. | | PermissionsRead | Type boolean Properties Create, Filter, Update Description If true, users assigned to the parent PermissionSet can view records for this object. | | PermissionsViewAllFields | Type boolean Properties Create, Filter, Update Description If true, users assigned to the parent PermissionSet can view all fields and field data for this object. Available in API version 63.0 and later. | | PermissionsViewAllRecords | Type boolean Properties Create, Filter, Update Description If true, users assigned to the parent PermissionSet can view all records for this object, regardless of sharing settings. Requires PermissionsRead for the same object to be true. | | SobjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The object’s API name. For example, Merchandise\_\_c. | ## Permission Dependencies Some user permissions have dependencies on object permissions. For example, if a permission set has the “Transfer Leads” permission, it also has “Read” and “Create” on the leads object. You can query from ObjectPermissions up to the parent PermissionSet object. For example: SELECT Parent.Name, Parent.PermissionsTransferAnyLead, PermissionsRead, PermissionsCreate FROM ObjectPermissions WHERE SobjectType = 'Lead' ## Determining Object Access with “Modify All Data” When using SOQL to query object permissions, be aware that some object permissions are enabled because a user permission requires them. The exception to this rule is when “Modify All Data” is enabled. While it enables all object permissions, it doesn’t physically store any object permission records in the database. As a result, unlike object permissions that are required by a user permission—such as “View All Data” or “Import Leads”—the query still returns permission sets with “Modify All Data,” but the object permission record will contain an invalid ID that begins with “000”. This ID indicates that the object has full access due to “Modify All Data” and the object permission record can’t be updated or deleted. To remove full access from these objects, disable “Modify All Data” and then delete the resulting object permission record. This ensures that when using SOQL to find all the objects that have full access, it returns all objects that have this access regardless of whether it’s due to “Modify All Data” or because an administrator set full access. For example, the following will return all permission sets that have “Read” on the Merchandise\_\_c object, regardless of whether it’s explicitly defined on the object or implicitly defined through “Modify All Data.” SELECT Id, Parent.label, SobjectType, PermissionsRead, Parent.PermissionsModifyAllData, ParentId FROM ObjectPermissions WHERE PermissionsRead = true and SobjectType = 'Merchandise\_\_c' ## Nesting Object Permissions You can nest ObjectPermissions in a PermissionSet query. For example, the following returns any permission sets where “Transfer Leads” is true. Additionally, the result set will include the “Read” object permission on leads. This is done by nesting the SOQL with an object permission query using the relationship name for object permissions: ObjectPerms. SELECT Id,Name,PermissionsTransferAnyLead, (SELECT Id, PermissionsRead from ObjectPerms where SobjectType='Lead') FROM PermissionSet WHERE PermissionsTransferAnyLead = true As a result, it’s possible to traverse the relationship between the PermissionSet and any child-related objects (in this case, ObjectPermissions). You can do this from the PermissionSet object by using the child relationship (ObjectPerms, FieldPerms, and so on) or from the child object by referencing the PermissionSet with Parent.permission\_set\_attribute. It’s important to consider when to use a conditional WHERE statement to restrict the result set. To query based on an attribute on the permission set object, nest the SOQL with the child relationship. However, to query based on an attribute on the child object, you must reference the permission set parent attribute in your query. The following two queries return the same columns with different results, based on whether you use the child relationship or parent notation. SELECT Id, Name, PermissionsModifyAllData, (SELECT Id, SobjectType, PermissionsRead from Objectperms) FROM PermissionSet WHERE PermissionsModifyAllData=true versus: SELECT Id, SObjectType, PermissionsRead, Parent.Id, Parent.Name, Parent.PermissionsModifyAllData FROM ObjectPermissions WHERE SObjectType='Merchandise\_\_c' #### See Also - [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.") - [FieldPermissions](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fieldpermissions.htm "Represents the enabled field permissions for the parent PermissionSet. This object is available in API version 24.0 and later.") # ObjectRelatedUrl Represents a URL slug for a Product or Category page on a B2B Commerce or D2C Commerce LWR site, or a custom object, account, or contact page on an enhanced LWR Experience Cloud site. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), undelete(), update(), upsert() ## Special Access Rules Your org must have B2B Commerce or D2C Commerce license enabled for commerce use cases. ObjectRelatedUrl is available for Product2 and ProductCategory records in Commerce, and on custom object, account and contact record pages in enhanced LWR sites. ## Fields
Field Details
LanguageCode
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The combined language and locale ISO code, which controls the language of the object-related URL. The maximum length is 8 characters.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the object-related URL. This field isn’t editable.
ParentId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Required. The ID of the parent record that the UrlName refers to. ParentId can point only to Product2, ProductCategory, and custom object, account, and contact record pages.
This field is a polymorphic relationship field.
Relationship Name
Parent
Relationship Type
Lookup
Refers To
Product2, ProductCategory, account, contact, and custom objects
Availability in API versions:
  • Product2 and ProductCategory in LWR Commerce stores (available in API version 58.0 and later)
  • Custom object pages on enhanced LWR sites (available in API version 60.0 and later)
  • Account and contact pages on enhanced LWR sites (available in API version 61.0 and later)
Scope
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Helps ensure uniqueness of the UrlName field across all records with the same Scope and LanguageCode values. The maximum length is 18 characters.
UniqueIndex
Type
string
Properties
Filter, idLookup, Nillable, Sort
Description
Ensures uniqueness for each record within your org and creates an index for lookup. This field isn’t editable.
This field is a calculated field.
UrlName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The URL slug for the record.
![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating a query, for example, SELECT UrlName From ObjectRelatedUrl WHERE Scope='01t', the WHERE condition must use Id, UniqueIndex, Scope, or ParentId. ## 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. [ObjectRelatedUrlChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # ObjectTerritory2AssignmentRule Represents a territory assignment rule that’s associated with an object, such as Account. ObjectTerritory2AssignmentRuleItem can be created or deleted if the BooleanFilter field on its corresponding ObjectTerritory2AssignmentRule is null. Available if Sales Territories has been enabled. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Standard users can access this object. If a territory model is in Active state, any standard user can view that model, including its territories, assignment rules, assigned records, and assigned users. Users cannot view territory models in other states (such as Planning or Archived). ## Fields | Field Name | Details | | --- | --- | | BooleanFilter | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Represents advanced filter conditions that were specified for the rule in the online application. For example, “(1 AND 2) OR 3.” | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. 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. The field label in the user interface is Unique Name. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the rule is active (true) or inactive (false). Via the API, active rules run automatically when object records are created and edited. The exception is when the value of the IsExcludedFromRealign field on an object record is true, which prevents record assignment rules from evaluating that record. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the label in the user interface. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Required. The user interface label for the territory type. | | ObjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The object that the rule is defined for. For API version 31, Account only. | | Territory2ModelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the territory model. | # ObjectTerritory2AssignmentRuleItem A single row of selection criteria for an ObjectTerritory2AssignmentRule object. ObjectTerritory2AssignmentRuleItem can only be created or deleted if the BooleanFilter field on its corresponding ObjectTerritory2AssignmentRule object is a null value. Available if Sales Territories has been enabled. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Standard users can access this object. If a territory model is in Active state, any standard user can view that model, including its territories and assignment rules. For territories in an active model, any standard user can view assigned records and assigned users subject to your Salesforce sharing settings. Users cannot view territory models in other states (such as Planning or Archived). ## Fields | Field Name | Details | | --- | --- | | Field | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The standard or custom object field that the rule item will operate on. | | Operation | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The criterion to apply for the rule item. For example: equals, notContain, or startsWith. | | RuleId | Type reference Properties Create, Filter, Group, Sort Description The ID of the associated ObjectTerritory2AssignmentRule. | | SortOrder | Type int Properties Create, Filter, Group, Sort, Update Description The order in which this row is evaluated in relation to other ObjectTerritoryAssignmentRuleItem objects for the given ObjectTerritoryAssignmentRule. This field is required for assignment rule items, which are used in the Boolean conditions in assignment rule formulas. | | Value | Type string Properties Create, Filter, Nillable, Sort, Update Description The field value or values to evaluate. For example: if the field is Billing ZIP/Postal Code, a value might be 94105. | # ObjectTerritory2Association Represents an association (by assignment) between a territory and an object record such as an account or a lead. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Available after enabling Sales Territories. Standard and partner users can access this object. If a territory model is in Active state, any standard or partner user can view that model, including its territories and assignment rules. For territories in an active model, any standard or partner user can view assigned records and assigned users subject to your sharing settings. If you delete associations, you can query them for up to 12 hours. Keep in mind that deleted associations bypass the recycle bin. ## Fields
Field Name Details
AssociationCause
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The means by which the record was associated with the territory. User interface field label is Method.
Possible values are:
  • Territory2AssignmentRule—Territory assignment rule association
  • Territory2Manual—Manual association
ObjectId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the object assigned to the territory.
Object Availability
Account API version 30.0 and later
Lead API version 55.0 and later
This is a polymorphic relationship field.
Relationship Name
Object
Relationship Type
Lookup
Refers To
Account
Lead
SobjectType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of the object.
Possible values are:
  • Account
  • Lead
Territory2Id
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the territory that the record is assigned to.
This is a relationship field.
Relationship Name
Territory2
Relationship Type
Lookup
Refers To
Territory2
# ObjectUserTerritory2View Represents a user and object, such as an account or lead, assigned to a territory. This object is available in API version 58.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To see this object, enable Sales Territories. ## Fields | Field | Details | | --- | --- | | ObjectId | Type reference Properties Filter, Group, Nillable, Sort Description Required field for querying ObjectUserTerritory2View. ID of the object that the territory user is assigned to. This field is a polymorphic relationship field. Relationship Name Object Refers To Account, Lead | | RoleInTerritory2 | Type picklist Properties Filter, Group, Nillable, Sort Description Role of the user assigned to the territory. | | Territory2Id | Type reference Properties Filter, Group, Nillable, Sort Description ID of the territory to which the object and user are assigned. This field is a relationship field. Relationship Name Territory2 Refers To Territory2 | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user assigned to the territory. This field is a relationship field. Relationship Name User Refers To User | # OmniSupervisorConfig Represents the Command Center for Service configuration for an assigned group of supervisors. This object is available in API version 41.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | IsTimelineHidden | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If set to true, hides the agent timeline from the supervisors assigned to this Command Center for Service configuration. The default value is false. This field is available in API version 53.0 and later. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of this Command Center for Service configuration. | | MasterLabel | Type string Properties Create, Filter, Group, Sort Description A unique label name for this Command Center for Service configuration. The name must begin with a letter. The name can contain alphanumeric characters and underscores. The name can’t contain spaces, two consecutive underscores, or end with an underscore. The name appears as Command Center for Service Configuration Name in the UI. | | SkillVisibility | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines which work items based on skills are visible to the supervisors assigned to this Command Center for Service configuration. Possible values are: - AllSkills — Show work items with all skill requirements selected in this Command Center for Service configuration. - AnySkill — Show work items with at least one skill requirement selected in this Command Center for Service configuration. This field is available in API version 53.0 and later. | # OmniSupervisorConfigAction Represents the actions available to the supervisors of a Command Center for Service configuration. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. Only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | DisplayOrder | Type int Properties Create, Filter, Group, Nillable, Sort Description The order in which the action is displayed. | | OmniSupervisorActionType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description An action that a supervisor can perform. Possible values are: - AgentDetails.CustomAction - AllAgents.AWSDashboard—All Agents - View Amazon Real-Time Metrics - AllAgents.AssignLearning - AllAgents.ChangeQueues - AllAgents.ChangeSkills - AllAgents.CustomAction - AssignedWork.AWSDashboard—Assigned Work - View Amazon Real-Time Metrics - AssignedWork.CustomAction - AssignedWorkDetails.CustomAction - QueueDetails.CustomAction - QueuesBacklog.AWSDashboard—Queues Backlog - View Amazon Real-Time Metrics - QueuesBacklog.CustomAction - QueuesBacklog.ManageQueues—Queues Backlog - Assign Agents to Queues - SkillDetails.CustomAction - SkillsBacklog.AWSDashboard—Skills Backlog - View Amazon Real-Time Metrics - SkillsBacklog.CustomAction | | OmniSupervisorConfigId | Type reference Properties Create, Filter, Group, Sort Description A unique identifier for the Command Center for Service configuration. This field is a relationship field. Relationship Name OmniSupervisorConfig Relationship Type Lookup Refers To OmniSupervisorConfig | # OmniSupervisorConfigGroup Represents the group of reps who are visible to the supervisors of a Command Center for Service configuration. The group, if visible, appears in the Agents tab of Command Center for Service. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), query(), update(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | GroupId | Type reference Properties Create, Filter, Group, Nillable, Sort Description A unique identifier for the group of reps that’s made visible to the supervisors who are assigned to the Command Center for Service configuration. This is a relationship field. Relationship Name Group Relationship Type Lookup Refers To Group | | OmniSupervisorConfigId | Type reference Properties Create, Filter, Group, Sort Description A unique identifier for the Command Center for Service configuration. This is a relationship field. Relationship Name OmniSupervisorConfig Relationship Type Lookup Refers To OmniSupervisorConfig | # OmniSupervisorConfigProfile Represents the supervisor profiles to which a Command Center for Service configuration applies. User-level configurations override profile-level configurations. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), query(), update(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | OmniSupervisorConfigId | Type reference Properties Create, Filter, Group, Sort Description A unique identifier for the Command Center for Service configuration. This is a relationship field. Relationship Name OmniSupervisorConfig Relationship Type Lookup Refers To OmniSupervisorConfig | | ProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort Description A unique identifier for the profile that’s associated with this Command Center for Service configuration. A profile can be associated with only one Command Center for Service configuration. This field is unique within your org. This is a relationship field. Relationship Name Profile Relationship Type Lookup Refers To Profile | # OmniSupervisorConfigQueue Represents the queues that are visible to the supervisors of a Command Center for Service configuration. The queue, if visible, appears in the Queues Backlog and Assigned Work tabs of Command Center for Service. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. Only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | OmniSupervisorConfigId | Type reference Properties Create, Filter, Group, Sort Description om A unique identifier for the Command Center for Service configuration. This is a relationship field. Relationship Name OmniSupervisorConfig Relationship Type Lookup Refers To OmniSupervisorConfig | | QueueId | Type reference Properties Create, Filter, Group, Nillable, Sort Description A unique identifier for the queue that’s made visible to the supervisors who are assigned to the Command Center for Service configuration. This is a relationship field. Relationship Name Queue Relationship Type Lookup Refers To Group | # OmniSupervisorConfigSkill Represents the skills that are visible to the supervisors of a Command Center for Service configuration. These skills, if visible, appear in the Skills Backlog tab of Command Center for Service. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. Only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | OmniSupervisorConfigId | Type reference Properties Create, Filter, Group, Sort Description A unique identifier for the Command Center for Service configuration. This is a relationship field. Relationship Name OmniSupervisorConfig Relationship Type Lookup Refers To OmniSupervisorConfig | | SkillId | Type reference Properties Create, Filter, Group, Nillable, Sort Description A unique identifier for the skill that’s made visible to the supervisors who are assigned to the Command Center for Service configuration. This is a relationship field. Relationship Name Skill Relationship Type Lookup Refers To Skill | # OmniSupervisorConfigTab Represents the visible tabs specified in a Command Center for Service configuration. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. Only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | DisplayOrder | Type int Properties Create, Filter, Group, Nillable, Sort Description The order in which tabs are displayed in Command Center for Service. | | OmniSupervisorConfigId | Type reference Properties Create, Filter, Group, Sort Description A unique identifier for the Command Center for Service configuration. This is a relationship field. Relationship Name OmniSupervisorConfig Relationship Type Lookup Refers To OmniSupervisorConfig | | OmniSupervisorTabType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Tabs shown on the Command Center for Service page. Possible values are: - Agents — the Agents tab - AssignedWork — the Assigned Work tab - FlexiPageType — A custom tab created using Lightning App Builder, with the OmniSupervisorPageType value of the FlexiPage Type field - QueuesBacklog — the Queues Backlog tab - SkillsBacklog — the Skills Backlog tab - Wallboard — the Wallboard tab | # OmniSupervisorConfigUser Represents the users to whom a Command Center for Service configuration applies. User-level configurations override profile-level configurations. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), query(), update(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | OmniSupervisorConfigId | Type reference Properties Create, Filter, Group, Sort Description A unique identifier for the Command Center for Service configuration. This is a relationship field. Relationship Name OmniSupervisorConfig Relationship Type Lookup Refers To OmniSupervisorConfig | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort Description A unique identifier for the user associated with this Command Center for Service configuration. A user can be associated with only one Command Center for Service configuration. This field is unique within your org. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | # One Commerce Usage Event Type One Commerce Usage events capture information about your Commerce instance. This event type is available in the EventLogFile object in API version 51.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | **Field** | **Details** | | --- | --- | | BROWSER\_DEVICE\_TYPE | Type Number Description A code used to identify the browser and device type. The code is in the format “BBVVVXYZ,” with the following signification: - BB — Two digits that indicate the browser type. - IE: “10” - CHROME: "13" - FIREFOX: "11" - SAFARI: "14" - OPERA: "15" - ANDROID\_WEBKIT: "16" - NETSCAPE: "17" - OTHER\_WEBKIT: "18" - OTHER\_GECKO: "19" - OTHER\_KHTML: "20" - OTHER\_MOBILE: "21" - SALESFORCE\_DESKTOP: "22" - BLACKBERRY: "23" - GOOD\_ACCESS: "24" - EDGE: "25" - SALESFORCE\_MOBILE: "26" - VVV—Three digits that indicate version, leading zeroes. - XYZ—Browser-type specific flags or options. Each digit in XYZ represents a different flag depending on the BrowserType: - X=1: If the parser recognizes a "touch" browser. Here, touch means the older touch native client, not that the device supports touch. - Y=1: If the parser recognizes a browser in compatibility mode. Only for IE. - Z=1: If the browser is recognized as MOBILE. - Z=2: If the browser is recognized as PHONE. - Z=3: If the browser is recognized as TABLET. - Z=4: If the browser is a recognized as MEDIA PLAYER. - Z=6: Only for Opera Mini. | | B2B\_EDITION | Type String Description Edition of B2B Commerce. Edition can include Lightning (LB2B), CCRZ, or future flavors. | | B2B\_VERSION | Type String Description This field is optional. For the managed package, then B2B\_VERSION includes Major, Minor, Patch revision numbers. For Lightning B2B\_VERSION includes the optional service version. | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. If the user’s session context isn't available, this field returns a blank value. | | CONTEXT\_ID | Type String Description The contextId (Key Business Domain Value) in which the operation is done. For example, for Cart, the contextId is cartId. | | CONTEXT\_MAP | Type String Description This field is optional. It holds a JSON string with additional operational context. | | CORRELATION\_ID | Type String Description This field holds correlations, such as client to server and other asynchronous calls to B2B subsystems. | | COUNT | Type String Description The number of records impacted by this operation. | | CPU\_TIME | Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DB\_TOTAL\_TIME | Type Number Description Time (in milliseconds) spent waiting for database processing in aggregate for all operations in the request. Compare this field to CPU\_TIME to determine whether performance issues are occurring in the database layer or in your own code. | | EFFECTIVE\_ACCOUNT\_ID | Type String Description The B2B Effective Account ID in context of the operation. | | ERROR\_CODE | Type String Description The API error code that appears when an operation fails. If there is no error the value is null. | | ERROR\_MESSAGE | Type String Description Error message that appears when an operation fails. If there is no error the value is null. | | EVENT\_TYPE | Type String Description The type of event. The value is always OneCommerceUsage. | | IS\_RETRY | Type String Description The field is True if the operation resulted in a retry, otherwise it’s False. Understanding the frequency of operation retries helps determine the health of a service. The default value is False. | | LOGIN\_KEY | Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. For example: 00D000000000123. | | OPERATION | Type String Description The name of the B2B service. For example: CreateCart or KeywordSearch. | | OPERATION\_STAGE | Type String Description This field is optional. Used to capture more granular operation level stages. | | OPERATION\_STATE | Type String Description This field is optional. An enum for the state of the operation. For example: CartLocked, OrderCancelled, InProgress, New, Update, and Pending. | | OPERATION\_STATUS | Type String Description Enum with the outcome of the operation. For example: Success or Fail. | | OPERATION\_TIME | Type String Description Total time of the operation in milliseconds. | | OS\_VERSION | Type String Description Code used to identify the operating system and version. The value is equal to 9999 for an unknown platform. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | REQUEST\_STATUS | Type String Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RUN\_TIME | Type Number Description The amount of time that the request took in milliseconds. Requests with a value over five seconds are considered long-running requests for the purposes of the Concurrent Long-Running Apex Limit. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note HTTP callout processing time isn't included when calculating the 5-second limit. We pause the timer for the callout and resume it when the callout completes. | | SERVICE\_NAME | Type String Description Enum of B2B Services. For example: Cart, Pricing, Products, Order, Search, and so on. | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | URI | Type String Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | URI\_ID\_DERIVED | Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. | | USER\_ID | Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. For example: 00590000000I1SNIA0. | | USER\_TYPE | Type String Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | | WEBSTORE\_ID | Type String Description This field is optional. The ID of the webstore associated with the store (site). | | WEBSTORE\_TYPE | Type String Description The type of webstore. For example: B2B, B2C, and OMS. | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # OpenActivity This read-only object is displayed in a related list of open activities—future events and open tasks—related to an object. It includes activities for all contacts related to the object. OpenActivity fields for phone calls are only available if your organization uses Salesforce CRM Call Center. ## Supported Calls describeSObjects() ## Fields
Field Details
AccountId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the related account, which is determined as follows:
  • The account associated with the WhatId, if it exists; or
  • The account associated with the WhoId, if it exists; otherwise
  • null
This is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
ActivityDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
Indicates one of the following:
  • The due date of a task
  • The date of an event if IsAllDayEvent is set to true

This field has a time stamp that is always set to midnight in the Universal Time Coordinated (UTC) time zone. The time stamp doesn’t represent the time of the activity; don’t attempt to alter it to accommodate time zone differences. Label is Date.
ActivityDateTime
Type
dateTime
Properties
Aggregate, Filter, Nillable, Sort
Description
Contains the event’s due date if the IsAllDayEvent flag is set to false. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate. Label is Due Date Time.

The value for this field and StartDateTime must match, or one of them must be null.
ActivitySubtype
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Provides standard subtypes to facilitate creating and searching for specific activity subtypes. This field isn’t updateable.
Possible values are:
  • Task
  • Email
  • Call
  • Event
  • LinkedIn —Available in API version 56.0 and later.
  • List Email
ActivityType
Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
Represents one of the following values: Call, Email, Meeting, or Other. Label is Type. These are default values, and can be changed.

ActivityType is the union of TaskType and EventType. If the same activity appears in both dynamic picklists, duplicate activities appear.

TaskType and EventType can each have a Call type. Internally, they are distinct from each other.
AlternateDetailId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of a record the activity is related to which contains more details about the activity. For example, an activity can be related to an EmailMessage record.
This is a relationship field.
Relationship Name
AlternateDetail
Relationship Type
Lookup
Refers To
EmailMessage
CallDisposition
Type
string
Properties
Filter, Group, Nillable, Sort
Description

Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit is 255 characters.

CallDurationInSeconds
Type
int
Properties
Filter, Group, Nillable, Sort
Description

Duration of the call in seconds.
CallObject
Type
string
Properties
Filter, Group,Nillable, Sort
Description

Name of a call center. Limit is 255 characters.
CallType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description

The type of call being answered: Inbound, Internal, or Outbound.
CompletedDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time the task was saved with a Closed status. This value is always null.
ConnectionReceivedId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the PartnerNetworkConnection that shared this record with your organization. This field is available only if your organization has enabled Salesforce to Salesforce and only in API versions 28.0 and later.
ConnectionSentId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the PartnerNetworkConnection that your organization shared this record with. This field is available only if your organization has enabled Salesforce to Salesforce, and only in API versions 28.0 and later. The value is always null. You can use the PartnerNetworkRecordConnection object to forward records to connections.
Description
Type
textarea
Properties
Nillable
Description
Contains a description of the event or task. Limit is 32 KB.
DurationInMinutes
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Indicates the duration of the event or task.
EndDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates the end date and time of the event or task. Available in versions 27.0 and later. This field is optional, depending on the following:
  • If IsAllDayEvent is true, you can supply a value for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time. If both fields are null, the duration defaults to one day.
  • If IsAllDayEvent is false, a value must be supplied for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time.
IsAllDayEvent
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If the value of this field is set to true, then the activity is an event spanning a full day, and the ActivityDate defines the date of the event. If the value of this field is set to false, then the activity may be an event spanning less than a full day, or it may be a task. The default value of this field is false. Label is All-Day Event.
IsClosed
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a task is closed (true) or not closed (false). The default value of this field is false. This field is set indirectly by setting Status on the task—each picklist value has a corresponding IsClosed value. Label is Closed.
IsDeleted
Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the activity has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
IsHighPriority
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates a high-priority task. The default value of this field is false. This field is derived from the Priority field.
IsReminderSet
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a reminder is set for an activity (true) or not (false). The default value of this field is false.
IsTask
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If the value of this field is set to true, then the activity is a task; if the value is set to false, then the activity is an event. The default value of this field is false. Label is Task.
IsVisibleInSelfService
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If the value of this field is set to true, then the activity can be viewed in the self-service portal. The default value of this field is false. Label is Visible in Self-Service.
Location
Type
string
Properties
Filter, Group, Nillable, Sort
Description
If the activity is an event, then this field represents the location of the event. If the activity is a task, then the value is null.
OwnerId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Indicates the ID of the user or group who owns the activity.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Calendar, Group, User
PrimaryAccountId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Contains the AccountId value from the activity record. Available in API versions 30.0 and later to organizations that use Shared Activities.
PrimaryWhoId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Contains the WhoId value from the activity record. Available in API versions 30.0 and later to organizations that have enabled Shared Activities.
Priority
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Indicates the priority of a task, such as high, normal, or low. The default value of this field is Normal.
ReminderDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Represents the time at which a reminder is scheduled to fire if IsReminderSet is set to true. If IsReminderSet is set to false, then either the user has deselected the reminder checkbox in the user interface or the reminder has already fired at the time indicated by the value.
Status
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Indicates the current status of a task. The default value of this field is Not Started. Each predefined status field sets a value for IsClosed. To obtain picklist values, query the TaskStatus object.
Possible values are:
  • Completed
  • Deferred
  • In Progress
  • Not Started
  • Waiting on someone else
Subject
Type
combobox
Properties
Filter, Nillable, Sort
Description
Contains the subject of the task or event.
WhatId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The WhatId represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. WhatIds are polymorphic. Polymorphic means a WhatId is equivalent to the ID of a related object. The label is Related To ID.
This is a polymorphic relationship field.
Relationship Name
What
Relationship Type
Lookup
Refers To
Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CommSubscriptionConsent, ContactEncounter, ContactEncounterParticipant, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem, CreditMemo, DelegatedAccount, DocumentChecklistItem, EnrollmentEligibilityCriteria, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, ListEmail, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PartyConsent, PersonLifeEvent, PlanBenefit, PlanBenefitItem, ProcessException, Product2, ProductItem, ProductRequest, ProductRequestLineItem, ProductTransfer, PurchaserPlan, ReceivedDocument, ResourceAbsence, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, Shift, Shipment, ShipmentItem, Solution, Visit, VisitedParty, VolunteerProject, WorkOrder, WorkOrderLineItem
WhoId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is Name ID.

If Shared Activities is enabled, the value of this field is the ID of the related lead or primary contact. If you add, update, or remove the WhoId field, you might encounter problems with triggers, workflows, and data validation rules that are associated with the record. The label is Name ID.

This is a polymorphic relationship field.
Relationship Name
Who
Relationship Type
Lookup
Refers To
Contact, Lead
## Usage Query activities that are related to an object 1. Optionally, issue a describe call against the object whose activities you want to query, to get a suggestion of the correct SOQL query to use. 2. Issue a SOQL relationship query with a main clause that references the object and an inner clause that references the activity history. For example: SELECT (SELECT ActivityDate, Description FROM OpenActivities) FROM Account WHERE Name Like 'XYZ%' The user interface enforces sharing rules, filtering out related-list items that a user doesn’t have permission to see. The following constraints on users who don’t have the “View All Data” permission help prevent performance issues. - In the main clause of the relationship query, you can reference only one record. For example, you can’t filter on all records where the account name starts with “A.” Instead, you must reference a single account record. SELECT (SELECT ActivityDate, Description FROM OpenActivities ORDER BY ActivityDate ASC NULLS LAST, LastModifiedDate DESC LIMIT 500) FROM Account WHERE Name = 'Acme' LIMIT 1 - In the inner clause of the query, you can’t use WHERE. - In the inner clause of the query, you must specify a limit of 500 or fewer on the number of rows that are returned in the list. - In the inner clause of the query, you must sort on ActivityDate in ascending order and LastModifiedDate in descending order. You can optionally display nulls last. For example: ORDER BY ActivityDate ASC NULLS LAST, LastModifiedDate DESC. #### See Also - [Task](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm "Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities.") # OperatingHours Represents the hours in which a service territory, service resource, or account is available for work. OperatingHours is used by Field Service, Salesforce Scheduler, Salesforce Meetings, Sales Engagement, and Workforce Engagement. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the operating hours. Add any details that aren’t included in the name. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the operating hours record was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the operating hours record was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the operating hours. For example, Summer Hours, Winter Hours, or Peak Season Hours. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the operating hours record. This field is available in API version 59.0. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | TimeZone | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The time zone that the operating hours fall within. | ## Usage By default, only System Administrators can view, create, and assign operating hours. Service territory members—which are service resources who can work in the territory—automatically use their service territory’s operating hours. If a resource needs different operating hours than their territory, create separate operating hours for them from the Operating Hours tab. Then, select the desired hours in the Operating Hours lookup field on the service territory member detail page. To view a service resource’s operating hours for a particular territory, navigate to their Service Territories related list and click the Member Number for the territory. You reach the service territory member detail page, which lists the member’s operating hours and dates during which they belong to the territory. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [OperatingHoursChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_associated_objects_change_event.htm) (API version 54.0) Change events are available for the object. [OperatingHoursHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_associated_objects_history.htm;) (API version 62.0) History is available for tracked fields of the object. # OperatingHoursHistory Represents the history of changes made to tracked fields on an operating hours record. This object is available in API version 38.0 and later. ## Supported Calls getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules Field Service must be enabled in your organization, and field tracking for operating hours fields must be configured. ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The value of the field before it was changed. | | TimeSlotId | Type reference Properties Filter, Group, Sort Description ID of the operating hours record being tracked. The history is displayed on the detail page for this record. | # OperatingHoursHoliday Represents the day or hours for which a service territory and service resources exclusive to the service territory are unavailable in Field Service, Salesforce Scheduler, Salesforce Meetings, Sales Engagement, or Workforce Engagement. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Salesforce Scheduler or Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | DateAndTime | Type string Properties Filter, Group, Nillable, Sort Description (Read-Only) The date or time for the holiday. | | HolidayId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the holiday that’s related to the operating hours indicated in the OperatingHoursId field. This is a relationship field. Relationship Name Holiday Relationship Type Lookup Refers To Holiday | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the current user last viewed a record related to this object. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this object. | | OperatingHoursHolidayNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read-Only) An auto-generated number identifying the operating hours holiday. | | OperatingHoursId | Type reference Properties Create, Filter, Group, Sort Description The ID of the operating hours that’s related to the holiday indicated in the HolidayId field. This is a relationship field. Relationship Name OperatingHours Relationship Type Lookup Refers To OperatingHours | # Opportunity Represents an opportunity, which is a sale or pending deal. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Field Type | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the account associated with this opportunity. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | | | | ActivityMetricId | Type reference Properties Filter, Group, Nillable, Sort Description When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric. This field is a relationship field. Relationship Name ActivityMetric Refers To ActivityMetric | | ActivityMetricRollupId | Type reference Properties Filter, Group, Nillable, Sort Description When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup. This field is a relationship field. Relationship Name ActivityMetricRollup Refers To ActivityMetricRollup | | AgeInDays | Type int Properties Aggregate, Filter, Group, Nillable, Sort Description The number of days since the opportunity was created, calculated by the current date minus the created\_date field. This field is available in API version 52.0 and later if you enabled Pipeline Inspection. | | Amount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Estimated total sale amount. For opportunities with products, the amount is the sum of the related products. Any attempt to update this field, if the record has products, will be ignored. The update call will not be rejected, and other fields will be updated as specified, but the Amount will be unchanged. | | CampaignId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of a related Campaign. This field is defined only for those organizations that have the campaign feature Campaigns enabled. The User must have read access rights to the cross-referenced Campaign object in order to create or update that campaign into this field on the opportunity. This is a relationship field. Relationship Name Campaign Relationship Type Lookup Refers To Campaign | | CloseDate | Type date Properties Create, Filter, Group, Sort, Update Description Required. Date when the opportunity is expected to close. | | ConnectionReceivedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce. | | ConnectionSentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the contact associated with this opportunity, set as the primary contact. Read-only field that is derived from the opportunity contact role, which is created at the same time the opportunity is created. This field can only be populated when it’s created, and can’t be updated. To update the value in this field, change the IsPrimary flag on the OpportunityContactRole associated with this opportunity. Available in API version 46.0 and later. | | ContractId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the contract that’s associated with this opportunity. This is a relationship field. Relationship Name Contract Relationship Type Lookup Refers To Contract | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. If the organization has multicurrency and a Pricebook2 is specified on the opportunity (that is, the Pricebook2Id field is not blank), then the currency value of this field must match the currency of the PricebookEntry records that are associated with any opportunity line items it has. | | Description | Type textarea Properties Create, Nillable, Update Description Text description of the opportunity. Limit: 32,000 characters. | | ExpectedRevenue | Type currency Properties Filter, Nillable, Sort Description Read-only field that is equal to the product of the opportunity Amount field and the Probability. You can’t directly set this field, but you can indirectly set it by setting the Amount or Probability fields. | | ExportStatus | Type picklist Properties Filter, Restricted picklist, Sort Description Derived field for the record map for Partner Connect. The export status of this opportunity to the partner’s connected org. To see this field, enable Partner Connect and add the Export Vendor Records to an Authorized Partner Org user permission to the cosell export user. See [Set Up Partner Connect as a Vendor](https://help.salesforce.com/s/articleView?id=slack.prm_pc_setup_vendor_parent.htm&type=5&language=en_US) in Salesforce Help. Available in API version 62.0 and later. | | Fiscal | Type string Properties Filter, Group, Nillable, Sort Description If fiscal years are not enabled, the name of the fiscal quarter or period in which the opportunity CloseDate falls. Use YYYY Q format, for example, '2006 1' for first quarter of 2006. | | FiscalQuarter | Type int Properties Filter, Group, Nillable, Sort Description Represents the fiscal quarter. Valid values are 1, 2, 3, or 4. | | FiscalYear | Type int Properties Filter, Group, Nillable, Sort Description Represents the fiscal year, for example, 2006. | | ForecastCategory | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Restricted picklist field. It is implied, but not directly controlled, by the StageName field. You can override this field to a different value than is implied by the StageName value. The values of this field are fixed enumerated values. The field labels are localized to the language of the user performing the operation, if localized versions of those labels are available for that language in the user interface. In API version 12.0 and later, the value of this field is automatically set based on the value of the ForecastCategoryName and can’t be updated any other way. The field properties Create, Defaulted on create, Nillable, and Update are not available in version 12.0. Possible values are: - BestCase - Closed - Forecast - MostLikely - Omitted - Pipeline | | ForecastCategoryName | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The name of the forecast category. It is implied, but not directly controlled, by the StageName field. You can override this field to a different value than is implied by the StageName value. Available in API version 12.0 and later. Possible values are: - Best Case - Closed - Commit - Most Likely - Omitted - Pipeline | | HasOpenActivity | Type boolean Properties Defaulted on create, Group, Description Indicates whether an opportunity has an open event or task (true) or not (false). Available in API version 35.0 and later. | | HasOpportunityLineItem | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only field that indicates whether the opportunity has associated line items. A value of true means that Opportunity line items have been created for the opportunity. An opportunity can have opportunity line items only if the opportunity has a price book. The opportunity line items must correspond to PricebookEntry objects that are listed in the opportunity Pricebook2. However, you can insert opportunity line items on an opportunity that does not have an associated Pricebook2. For the first opportunity line item that you insert on an opportunity without a Pricebook2, the API automatically sets the Pricebook2Id field, if the opportunity line item corresponds to a PricebookEntry in an active Pricebook2 that has a CurrencyIsoCode field that matches the CurrencyIsoCode field of the opportunity. If the Pricebook2 is not active or the CurrencyIsoCode fields do not match, then the API returns an error. You can’t update the Pricebook2Id or PricebookId fields if opportunity line items exist on the Opportunity. You must delete the line items before attempting to update the PricebookId field. | | HasOverdueTask | Type boolean Properties Defaulted on create, Group, Description Indicates whether an opportunity has an overdue task (true) or not (false). Available in API version 35.0 and later. | | IqScore | Type int Properties Aggregate, Filter, Group, Nillable, Sort Description The likelihood, measured on a scale of 1 to 99, that an opportunity will be won. Einstein Opportunity Scoring must be enabled. Available in API version 41.0 and later. Label is **Opportunity Score**. | | IsClosed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Directly controlled by StageName. You can query and filter on this field, but you can’t directly set it in a create, upsert, or update request. It can only be set via StageName. Label is **Closed**. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsExcludedFromTerritory2Filter | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Used for Filter-Based Opportunity Territory Assignment (Pilot in Spring ’15 / API version 33). Indicates whether the opportunity is excluded (True) or included (False) each time the APEX filter is executed. | | IsPriorityRecord | Type boolean Properties Defaulted on create, Group Description Shows whether the user has marked the opportunity as important (True) or not (False). The default value is false. Available in API version 53.0 and later. | | IsPrivate | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, only the opportunity owner, users above that role in the hierarchy, and admins can view the opportunity or query it via the API. When you mark opportunities as private, opportunity teams, opportunity splits, and sharing are removed. Label is **Private**. The default value is False. | | IsSplit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only field that indicates whether credit for the opportunity is split between opportunity team members. Label is IsSplit. This field is available in versions 14.0 and later for organizations that enabled Opportunity Splits during the pilot period. This field should not be used. However, it’s documented for the benefit of pilot customers who find references to IsSplit in code. | | IsWon | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Directly controlled by StageName. You can query and filter on this field, but you can’t directly set the value. It can only be set via StageName. Label is **Won**. | | LastActivityDate | Type date Properties Filter, Group, Nillable, Sort Description Value is one of the following, whichever is the most recent: - Due date of the most recent event logged against the record. - Due date of the most recently closed task associated with the record. | | LastActivityInDays | Type int Properties Aggregate, Filter, Group, Nillable, Sort Description The number of days since the last completed event or task for the record, calculated by the current date minus the last\_activity field. If the last\_activity field is null, this field is null. This field is available in API version 52.0 and later if you enabled Pipeline Inspection. | | LastAmountChangedHistoryId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the OpportunityHistory record that contains information about when the opportunity Amount field was last updated in Winter ’21 or later. Information includes the date and time of the change and the user who made the change. Available in API version 50.0 and later. This is a relationship field. Relationship Name LastAmountChangedHistory Relationship Type Lookup Refers To OpportunityHistory | | LastCloseDateChangedHistoryId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the OpportunityHistory record that contains information about when the opportunity Close Date field was last updated in Winter ’21 or later. Information includes the date and time of the change and the user who made the change. Available in API version 50.0 and later. This is a relationship field. Relationship Name LastCloseDateChangedHistory Relationship Type Lookup Refers To OpportunityHistory | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | LastStageChangeDate | Type datetime Properties Aggregate, Filter, Nillable, Sort Description The date of the last change made to the Stage field on this opportunity record. This field is available in API version 52.0 and later. | | LastStageChangeInDays | Type int Properties Aggregate, Filter, Group, Nillable, Sort Description The number of days since the last change was made to the Stage field on the opportunity record, calculated by the current date minus the last\_stage\_change\_date field. If the last\_stage\_change\_date is null, then this field contains the value for AgeInDays. This field is available in API version 52.0 and later if you enabled Pipeline Inspection. | | LastSyncTime | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last synced this record. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The 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. | | LeadSource | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Source of this opportunity, such as Advertisement or Trade Show. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. A name for this opportunity. Limit: 120 characters. | | NextStep | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of next task in closing opportunity. Limit: 255 characters. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who has been assigned to work this opportunity. If you update this field, the previous owner's access becomes Read Only or the access specified in your organization-wide default for opportunities, whichever is greater. If you have set up opportunity teams in your organization, updating this field has different consequences depending on your version of the API: - For API version 12.0 and later, sharing records are kept, as they are for all objects. (All previous opportunity team members are kept on the opportunity team.) - For API version before 12.0, sharing records are deleted. (All previous opportunity team members are removed from the opportunity team.) - For API version 16.0 and later, users must have the Transfer Record permission in order to update (transfer) account ownership using this field. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | PartnerAccountId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the partner account for the partner user that owns this opportunity. Available if Partner Relationship Management is enabled or if digital experiences is enabled and you have partner portal licenses. If you are uploading opportunities using API version 15.0 or earlier, and one of the opportunities in the batch has a partner user as the owner, the Partner Account field on all opportunities in the batch is set to that partner user’s account regardless of whether the partner user is the owner. In version 16.0, the Partner Account field is set to the appropriate account for the partner user that owns the opportunity. If the owner of the opportunity is not a partner user, this field remains empty. | | Pricebook2Id | Type reference Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description ID of a related Pricebook2 object. The Pricebook2Id field indicates which Pricebook2 applies to this opportunity. The Pricebook2Id field is defined only for those organizations that have products enabled as a feature. You can specify values for only one field (Pricebook2Id or PricebookId)—not both fields. For this reason, both fields are declared nillable. This is a relationship field. Relationship Name Pricebook2 Relationship Type Lookup Refers To Pricebook2 | | PricebookId | Type reference Properties Create, Defaulted on create, Filter, Nillable, Update Description Unavailable as of version 3.0. As of version 8.0, the Pricebook object is no longer available. Use the Pricebook2Id field instead, specifying the ID of the Pricebook2 record. | | Probability | Type percent Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Percentage of estimated confidence in closing the opportunity. It is implied, but not directly controlled, by the StageName field. You can override this field to a different value than what is implied by the StageName. If you're changing the Probability field through the API using a partner WSDL call, or an Apex before trigger, and the value may have several decimal places, we recommend rounding the value to a whole number. For example, the following Apex in a before trigger uses the round method to change the field value: o.probability = o.probability.round(); | | PushCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times an opportunity’s close date has been pushed out by one calendar month. For example, moving a close date from April to May counts as one push, but moving from April 1 to April 30 doesn't count. The total is not decreased when the close date is moved in. Available in API version 53.0 and later. | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to this object. | | StageName | Type picklist Properties Create, Filter, Group, Sort, Update Description Required. Current stage of this record. The StageName field controls several other fields on an opportunity. Each of the fields can be directly set or implied by changing the StageName field. In addition, the StageName field is a picklist, so it has additional members in the returned describeSObjectResult to indicate how it affects the other fields. To obtain the stage name values in the picklist, query the OpportunityStage object. If the StageName is updated, then the ForecastCategoryName, IsClosed, IsWon, and Probability are automatically updated based on the stage-category mapping. | | SyncedQuoteID | Type reference Properties Create, Filter, Nillable, Update Description Read only in an Apex trigger. The ID of the Quote that syncs with the opportunity. Setting this field lets you start and stop syncing between the opportunity and a quote. The ID has to be for a quote that is a child of the opportunity. | | Territory2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the territory that is assigned to the opportunity. Available only if Enterprise Territory Management has been enabled for your organization. Users who have full access to an opportunity’s account can assign any territory from the active model to the opportunity. Users who do _not_ can assign only a territory that is also assigned to the opportunity’s account. The same restriction applies to territory assignments made via Apex in system mode. | | TotalOpportunityQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description Number of items included in this opportunity. Used in quantity-based forecasting. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Type of opportunity. For example, Existing Business or New Business. Label is **Opportunity Type**. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When importing opportunity data, users need the Set Audit Fields upon Record Creation permission to assign values to audit fields such as CreatedDate. Audit fields are automatically updated during API operations unless you set these fields yourself. ## Usage Use the Opportunity object to manage information about a sale or pending deal. You can also sync this object with a child Quote. To update an Opportunity, your client application needs Edit permission on opportunities. You can create, update, delete, and query Attachment records associated with an opportunity via the API. To split credit for an opportunity among multiple opportunity team members, use the OpportunitySplit object. Client applications can also create or update opportunity objects by converting a Lead with convertLead(). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note On opportunities and opportunity products, the workflow rules, validation rules, and Apex triggers fire when an update to a child opportunity product or schedule causes an update to the parent record. This means your custom application logic is enforced when there are updates to the parent record, ensuring higher data quality and compliance with your organization’s business policies. ## Sample Code—Java This code starts the sync between an object and a child quote. public void startQuoteSync() { Opportunity opp = new Opportunity(); opp.setId(new ID("006D000000CpOSy")); opp.setSyncedQuoteId(new ID("0Q0D000000002OZ")); // Invoke the update call and save the results try { SaveResult\[\] saveResults = binding.update(new SObject\[\] {opp}); // check results and do more processing after the update call ... } catch (Exception ex) { System.out.println("An unexpected error has occurred." + ex.getMessage()); return; } } This code stops the sync between an object and a child quote. public void stopQuoteSync() { Opportunity opp = new Opportunity(); opp.setId(new ID("006D000000CpOSy")); opp.setFieldsToNull(new String\[\] {"SyncedQuoteId"} ); // Invoke the update call and save the results try { SaveResult\[\] saveResults = binding.update(new SObject\[\] {opp}); // check results and do more processing after the update call ... } catch (Exception ex) { System.out.println("An unexpected error has occurred." + ex.getMessage()); return; } } ## Associated Objects This object has these associated objects. Unless noted, they are available in the same API version as this object. [OpportunityChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 44.0) Change events are available for the object. [OpportunityFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) (API version 18.0) Feed tracking is available for the object. [OpportunityHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityhistory.htm "Represents the stage history of an opportunity.") History is available for tracked fields of the object. [OpportunityOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityownersharingrule.htm "Represents a rule for sharing an opportunity with users other than the owner.") Sharing rules are available for the object. [OpportunityShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityshare.htm "Represents a sharing entry on an Opportunity.") Sharing is available for the object. ## Additional Considerations If you are using before triggers to set Stage and Forecast Category for an opportunity record, the behavior is as follows: - If you set Stage and Forecast Category, the opportunity record contains those exact values. - If you set Stage but not Forecast Category, the Forecast Category value on the opportunity record defaults to the one associated with trigger Stage. - If you reset Stage to a value specified in an API call or incoming from the user interface, the Forecast Category value should also come from the API call or user interface. If no value for Forecast Category is specified and the incoming Stage is different than the trigger Stage, the Forecast Category defaults to the one associated with trigger Stage. If the trigger Stage and incoming Stage are the same, the Forecast Category is not defaulted. If you are cloning an opportunity with products, the following events occur in order: ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If errors occur on an opportunity product, you must return to the opportunity and fix the errors before cloning. If any opportunity products contain unique custom fields, you must null them out before cloning the opportunity. - The parent opportunity is saved according to the [order of execution](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_triggers_order_of_execution.htm). - The opportunity products are saved according to the [order of execution](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_triggers_order_of_execution.htm). #### See Also - [OpportunityCompetitor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitycompetitor.htm "Represents a competitor on an Opportunity.") - [OpportunityHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityhistory.htm "Represents the stage history of an opportunity.") - [OpportunityLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitylineitem.htm "Represents an opportunity line item, which is a member of the list of Product2 products associated with an Opportunity.") - [OpportunityLineItemSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitylineitemschedule.htm "Represents information about the quantity, revenue distribution, and delivery dates for a particular OpportunityLineItem.") - [OpportunityFieldHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityfieldhistory.htm "Represents the history of changes to the values in the fields of an opportunity. This object is available in versions 13.0 and later.") - [Quote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quote.htm "Represents a quote, which is a record showing proposed prices for products and services. Available in API version 18.0 and later.") - [QuoteLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelineitem.htm "Represents a quote line item, which is a member of the list of Product2 products associated with a quote, along with other information about those line items on that quote. Available in API version 18.0 and later.") - [PartnerNetworkConnection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnernetworkconnection.htm "Represents a Salesforce to Salesforce connection between Salesforce organizations.") # OpportunityCompetitor Represents a competitor on an Opportunity. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CompetitorName | Type combobox Properties Create, Filter, Nillable, Sort, Update Description Name of the competitor. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | OpportunityId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated Opportunity. This is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | Strengths | Type string Properties Create, Filter, Nillable, Sort, Update Description Description of the competitor’s strengths. Limit: 1,000 characters. | | Weaknesses | Type string Properties Create, Filter, Nillable, Sort, Update Description Description of the competitor’s weaknesses. Limit: 1,000 characters. | ## Usage Use this object to manage competitors on an Opportunity, associating multiple competitors on a opportunity and specifying the strengths and weaknesses of each competitor. #### See Also - [Opportunity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm "Represents an opportunity, which is a sale or pending deal.") # OpportunityContactRole Represents the role that a Contact plays on an Opportunity. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ContactId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of an associated Contact. The API applies user access rights to the associated Opportunity for this object, but not to the associated Contact. The API may return rows from a query on this object that include this field’s values for contacts to which the user does not have sufficient access rights. It may also return values for this field for contacts that have been deleted. In either case, the client must perform a query on the contact table for this field’s value to determine whether the Contact is accessible to the user and has not been deleted. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the org. This field is available in API version 47.0. | | Division | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the record has been moved to the Recycle Bin (true) or not (false). The IsDeleted flag is usable only when the parent record is deleted to the recycle bin, and not when the OpportunityContactRole record is deleted directly. Label is **Deleted**. | | IsPrimary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the associated Contact plays the primary role on the Opportunity (true) or not (false). Each Opportunity has only one primary contact. Label is **Primary**. | | OpportunityId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of an associated Opportunity. This field is non-nullable, and it cannot be updated. You must provide a value for this field when creating new records. You can’t change it after it has been created. This is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | Role | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the role played by the associated Contact on the Opportunity, such as Business User or Decision Maker. | ## Usage Use the Opportunity Contact Role object to manage information about contacts and roles related to opportunities. Records of this type appear in the user interface in the Opportunity Contact Role related list and on the Opportunity detail page. Although allowed, we do not recommend that you create multiple relationships between the same Opportunity and a Contact. ## 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. [OpportunityContactRoleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 45.0) Change events are available for the object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # OpportunityContactRoleSuggestionInsight Represents a suggestion for a new opportunity contact role. Available in API versions 45.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getDeleted(), query(), retrieve() ## Special Access Rules To add or decline opportunity contact role suggestions, users need a Sales Cloud Einstein license, edit access on opportunities, and read or edit access on contacts. As of the Spring ’20 release, Pardot and Sales Engagement users no longer have access to this object. ## Fields | Field Name | Details | | --- | --- | | ContactId | Type reference Properties Filter, Group, Sort Description The ID of the related contact record. | | CreatedRecordId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the created opportunity contact role record. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Division | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The division of the suggested opportunity contact role. | | LastOperationUserId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who last performed a related operation. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OpportunityId | Type reference Properties Filter, Group, Sort Description The ID of the related opportunity. | | RationaleLabel | Type string Properties Filter, Group, Nillable, Sort Description The reason why this is a suggested opportunity contact role. | | Role | Type string Properties Filter, Group, Nillable, Sort Description The role of the suggested opportunity contact role. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the suggested contact. Possible values include: - New - Pending - Added - Declined | ## Usage This object is read-only and isn’t supported in workflows, triggers, or process builder. # OpportunityFieldHistory Represents the history of changes to the values in the fields of an opportunity. This object is available in versions 13.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | OpportunityId | Type reference Properties Filter, Group, Sort Description ID of the Opportunity. Label is **Opportunity ID**. This is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed. | ## Usage Use this object to identify changes to any fields on an Opportunity. The OpportunityHistory object represents the history of a change to the Amount, Probability, Stage, or Close Date fields of an Opportunity. This object respects field level security on the parent object. #### See Also - [Opportunity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm "Represents an opportunity, which is a sale or pending deal.") # OpportunityHistory Represents the stage history of an opportunity. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Filter, Nillable, Sort Description Estimated total sale amount. | | CloseDate | Type date Properties Filter, Group, Nillable, Sort Description Date when the opportunity is expected to close. | | ExpectedRevenue | Type currency Properties Filter, Nillable, Sort Description Calculated revenue based on the Amount and Probability fields. | | ForecastCategory | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Category that determines the column in which an opportunity is totaled in a forecast. Label is **To ForecastCategory**. - BestCase - Closed - Forecast - MostLikely - Omitted - Pipeline | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | OpportunityId | Type reference Properties Filter, Group, Sort Description ID of the associated Opportunity. This is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | PrevAmount | Type currency Properties Filter, Nillable, Sort Description The value in the opportunity’s Amount field before the update of the opportunity. In OpportunityHistory records created before Winter ’21, the value is null.Available in API version 50.0 and later. | | PrevCloseDate | Type date Properties Filter, Group, Nillable, Sort Description The value in the opportunity’s Close Date field before the update of the opportunity. In OpportunityHistory records created before Winter ’21, the value is null.Available in API version 50.0 and later. | | Probability | Type percent Properties Filter, Nillable, Sort Description Percentage of estimated confidence in closing the opportunity. | | StageName | Type picklist Properties Filter, Group, Sort Description Name of the current stage of the opportunity (for example, Prospect or Proposal). | ## Usage This object represents the history of a change to the Amount, Probability, Stage, or Close Date fields of an Opportunity. The OpportunityFieldHistory object represents the history of a change to any of the fields of an Opportunity. To obtain information about how a particular opportunity is progressing, query the OpportunityHistory records associated with a given Opportunity. Please note that if an opportunity's Amount, Probability, Stage, or Close Date fields have not changed, nothing will be returned in the OpportunityHistory objects. In this case, query the OpportunityFieldHistory records associated with a given Opportunity to get more information about changes to the opportunity. This object is read-only. The system generates a new record whenever a user or client application changes the value of any of the above fields; the then-current values of all of these major fields are saved in the newly-generated object. This object respects field-level security on the parent object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The record is automatically deleted if its parent Opportunity is deleted. #### See Also - [Opportunity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm "Represents an opportunity, which is a sale or pending deal.") # OpportunityInsight Represents an individual insight (deal prediction, follow-up reminder, or key moment) related to an opportunity record. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), query(), retrieve() ## Special Access Rules To see an insight related to a specific opportunity, users need a Sales Cloud Einstein license and access to the opportunity record. As of the Spring ’20 release, Pardot and Sales Engagement users no longer have access to this object. ## Fields | Field Name | Details | | --- | --- | | ActualHeardWithinDays | Type int Properties Filter, Group, Nillable, Sort Description The number of days it has been since a prospect has responded for insights of type Prospect has not responded and No communication. | | CloseDate | Type dateTime Properties Filter, Nillable, Sort Description The close date of the related opportunity for insights of type Opportunity is overdue and Opportunity is unlikely to close in time. | | CompetitorName | Type string Properties Filter, Group, Nillable, Sort Description This field has been deprecated as of API version 45.0. | | ContactName | Type string Properties Filter, Group, Nillable, Sort Description This field is not in use as of API version 46.0. | | ContactTitle | Type string Properties Filter, Group, Nillable, Sort Description This field is not in use as of API version 46.0. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Division | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The division of the related record. | | ExpectedHeardWithinDays | Type int Properties Filter, Group, Nillable, Sort Description The expected number of days it takes to hear back from a prospect for insights of type Prospect has not responded and No communication. | | LastHeard | Type dateTime Properties Filter, Nillable, Sort Description The date when the related prospect was last heard from for insights of type Prospect has not responded. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OpportunityId | Type reference Properties Filter, Group, Sort Description The ID of the related opportunity record. | | Rationale | Type string Properties Filter, Group, Nillable Description The explanation for an insight, providing more background information and details that are specific to the org. | | Reason | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The reason why a specific insight type is appearing. Relevant to the following insights: - Opportunity is unlikely to close in time - Opportunity slowing - Opportunity boosting - Time-consuming opportunity | | TaskDue | Type dateTime Properties Filter, Nillable, Sort Description The date that a task associated with the related opportunity record is due. | | Title | Type string Properties Filter, Group, Nillable Description The title of the insight. | | TrendType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The trend type of the insight. Possible values include: - Negative - Positive - Informational | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of insight. Possible values include: - Opportunity is unlikely to close in time - Prospect has not responded - Opportunity slowing - Opportunity boosting - Time-consuming opportunity - No communication - Re-engaged opportunity - Opportunity has an overdue task - Opportunity is overdue - Opportunity has no open activity - Unusual opportunity amount | ## Usage This object is read-only and isn’t supported in workflows, triggers, or process builder. # OpportunityLineItem Represents an opportunity line item, which is a member of the list of Product2 products associated with an Opportunity. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules The user must have the “Edit” permission on Opportunity records to create or update opportunity line items on an opportunity. ## Fields | Field | Details | | --- | --- | | CanUseQuantitySchedule | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the opportunity product can have a quantity schedule (true) or not (false). This field is read-only. | | CanUseRevenueSchedule | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the opportunity product can have a revenue schedule (true) or not (false). This field is read-only. | | ConnectionReceivedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce. | | ConnectionSentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. If the organization has multicurrency enabled, and a Pricebook2 isn’tspecified on the parent opportunity (that is, the Pricebook2Id field is blank on the opportunity referenced by this object’s OpportunityId), then the value of this field must match the currency of the CurrencyIsoCode field on the PricebookEntry records that are associated with this object. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the opportunity line item. Limit: 255 characters. | | Discount | Type percent Properties Create, Filter, Nillable, Sort, Update Description Discount for the product as a percentage. When updating these records: - If you specify Discount without specifying TotalPrice, the TotalPrice is adjusted to accommodate the new Discount value, and the UnitPrice is held constant. - If you specify both Discount and Quantity, you must also specify either TotalPrice or UnitPrice so the system knows which one to automatically adjust. | | HasQuantitySchedule | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether a quantity schedule has been created for this object (true) or not (false). | | HasRevenueSchedule | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a revenue schedule has been created for this object (true) or not (false). If this object has a revenue schedule, the Quantity and TotalPrice fields can’t be updated. In addition, the Quantity field can’t be updated if this object has a quantity schedule. Update requests aren’t rejected but the updated values are ignored. | | HasSchedule | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If either HasQuantitySchedule or HasRevenueSchedule is true, this field is also true. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. Available in API version 50.0 and later. | | LastSyncTime | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last synced this record. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. Available in API version 50.0 and later. | | ListPrice | Type currency Properties Filter, Nillable, Sort Description Corresponds to the UnitPrice on the PricebookEntry that is associated with this line item, which can be in the standard price book or a custom price book. A client application can use this information to show whether the unit price (or sales price) of the line item differs from the price book entry list price. | | Name | Type string Properties Filter, Nillable, Sort Description The opportunity line item name (known as “Opportunity Product” in the user interface). This read-only field is available in API version 30.0 and later. | | OpportunityId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated Opportunity. This is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | PricebookEntryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Required. ID of the associated PricebookEntry. Exists only for those organizations that have Products enabled as a feature. In API versions 1.0 and 2.0, you can specify values for either this field or ProductId, but not both. For this reason, both fields are declared nillable. In API version 3.0 and later, you must specify values for this field instead of ProductId. This is a relationship field. Relationship Name PricebookEntry Relationship Type Lookup Refers To PricebookEntry | | ProductId | Type reference Properties Create, Filter, Nillable Description ID of the related Product record. This field is unavailable as of version 3.0 and is only provided for backward compatibility. The Product object is unavailable beginning with version 8.0. Use the PricebookEntryId field instead, specifying the ID of the PricebookEntry record. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related Product2 record. This is a read-only field available in API version 30.0 and later. Use the PricebookEntryId field instead, specifying the ID of the PricebookEntry record. | | ProductCode | Type string Properties Filter, Group, Nillable, Sort Description This read-only field is available in API version 30.0 and later. It references the value in the ProductCode field of the related Product2 record. | | Quantity | Type double Properties Create, Filter, Sort, Update Description Read-only if this record has a quantity schedule, a revenue schedule, or both a quantity and a revenue schedule. When updating these records: - If you specify Quantity without specifying the UnitPrice, the UnitPrice value is adjusted to accommodate the new Quantity value, and the TotalPrice is held constant. - If you specify both Discount and Quantity, you must also specify either TotalPrice or UnitPrice so the system can determine which one to automatically adjust. | | RecalculateTotalPrice | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Changes behavior of OpportunityLineItem calculations when a line item has child schedule rows for the Quantity value. When enabled, if the rollup quantity changes, then the quantity rollup value is multiplied against the sales price to change the total price. Product2 flag must be set to true. | | ServiceDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when the product revenue will be recognized and the product quantity will be shipped. - Opportunity Close Date—ServiceDate is ignored. - Product Date—ServiceDate is used if not null. - Schedule Date—ServiceDate is used if not null and there are no revenue schedules present for this line item, that is, there are no OpportunityLineItemSchedule records with a field Type value of Revenue that are children of this record. | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number indicating the sort order selected by the user. Client applications can use this to match the sort order in Salesforce. | | Subtotal | Type currency Properties Filter, Nillable, Sort Description Difference between standard and discounted pricing. Converted currency amounts when the opportunity's currency is different from the user's currency. | | TotalPrice | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description This field is available only for backward compatibility. It represents the total price of the OpportunityLineItem. If you don’t specify UnitPrice, this field is required. If you specify Discount and Quantity, this field or UnitPrice is required. When updating these records, you can change either this value or the UnitPrice, but not both at the same time. This field is nillable, but you can’t set both TotalPrice and UnitPrice to null in the same update request. To insert the TotalPrice via the API (given only a unit price and the quantity), calculate this field as the unit price multiplied by the quantity. This field is read-only if the opportunity line item has a revenue schedule. If the opportunity line item doesn’t have a schedule or only has a quantity schedule, this field can be updated. | | UnitPrice | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The unit price for the opportunity line item. In the Salesforce user interface, this field’s value is calculated by dividing the total price of the opportunity line item by the quantity listed for that line item. Label is **Sales Price**. This field or TotalPrice is required. You can’t specify both. If you specify Discount and Quantity, this field or TotalPrice is required. | ## Usage An Opportunity can have associated OpportunityLineItem records only if the Opportunity has a Pricebook2. An OpportunityLineItem must correspond to a Product2 that is listed in the opportunity's Pricebook2. For information about inserting OpportunityLineItem for an opportunity that doesn’t have an associated Pricebook2 or any existing line items, see Effects on Opportunities. This object is defined only for orgs with products enabled as a feature. If the products feature isn’t enabled, this object doesn’t appear in the describeGlobal() call, and you can’t use describeSObjects() or query the OpportunityLineItem object. For a visual diagram of the relationships between OpportunityLineItem and other objects, see the [Product & Price Book](https://developer.salesforce.com/docs/platform/data-models/guide/product-price-book.html) diagram. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - If the multicurrency option is enabled, the CurrencyIsoCode field is present. It can’t be modified, and is always set to the value of the CurrencyIsoCode of the parent Opportunity. - If customizable product schedules are enabled, you can use custom fields in default schedules and customize their layout. But if you’ve applied validation rules or Apex triggers, they’re bypassed when they’re first inserted. ## Effects on Opportunities Opportunities with associated OpportunityLineItem records are affected in the following ways: - Creating an OpportunityLineItem increments the Opportunity Amount value by the TotalPrice of the OpportunityLineItem. Additionally, inserting an OpportunityLineItem increments the ExpectedRevenue on the opportunity by the TotalPrice times the opportunity Probability. - The Opportunity Amount becomes a read-only field when the opportunity has line items. The API ignores any attempt to update this field on an opportunity with line items. Update requests aren’t rejected, but the updated value is ignored. - You can’t update the PricebookId field or the CurrencyIsoCode field on the opportunity if line items exist. The API rejects any attempt to update these fields on an opportunity with line items. - When you create or update an OpportunityLineItem, the API verifies that the line item corresponds to a PricebookEntry in the Pricebook2 associated with the opportunity. - If the opportunity has an associated active or inactive Pricebook2, the OpportunityLineItem is created or updated. - If the opportunity doesn’t have an associated Pricebook2, but the OpportunityLineItem corresponds to a PricebookEntry in an active Pricebook2 where the PricebookEntry has a CurrencyIsoCode value that matches the CurrencyIsoCode value of the opportunity, the API automatically sets this PriceBook2 on the opportunity. - If the opportunity doesn’t have an associated Pricebook2, but the line item corresponds to a PricebookEntry in a Pricebook2 that isn’t active or that has a CurrencyIsoCode value that does not match the CurrencyIsoCode value of the opportunity, an error is returned. - The Opportunity HasOpportunityLineItem field is set to true when an OpportunityLineItem is inserted for that Opportunity. - When OpportunityLineItem records are directly deleted, they aren’t sent to the recycle bin and can’t be undeleted. The getDeleted() call shows deleted OpportunityLineItem records until they’re purged, which is usually within the same day or the next day. - In Lightning, the ListPrice, Name, and ProductCode fields aren’t populated before insert because their values are computed after the OpportunityLineItem.Product2Id value is saved. To access a value from these fields, use an After Insert trigger. ## 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. [OpportunityLineItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 60.0) Change events are available for the object. #### See Also - [OpportunityLineItemSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitylineitemschedule.htm "Represents information about the quantity, revenue distribution, and delivery dates for a particular OpportunityLineItem.") # OpportunityLineItemSchedule Represents information about the quantity, revenue distribution, and delivery dates for a particular OpportunityLineItem. In API version 38.0 and later, when an OpportunityLineItem record is created for a product with a previously established schedule, an OpportunityLineItemSchedule record is also created. In API version 46.0 and later, this object supports custom fields, validation rules, and Apex triggers. Deleting a schedule now also invokes delete triggers. If customizable product schedules are enabled, you can use custom fields in default schedules and customize their layout. But if you’ve applied validation rules or Apex triggers, they’re bypassed when they’re first inserted. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. This field is available in version 10.0 and later. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the opportunity line item schedule. Limit: 80 characters. Label is **Comments**. | | OpportunityLineItemId | Type reference Properties Create, Filter Description Required. ID of the associated OpportunityLineItem. | | Quantity | Type double Properties Create, Filter, Nillable, Sort, Update Description Required. The total number of units to be scheduled in a quantity schedule. | | Revenue | Type currency Properties Create, Filter, Nillable, Sort, Update Description The revenue that should be recognized, or the quantity that should be shipped, or both - depending upon the value of Type. | | ScheduleDate | Type date Properties Create, Filter, Group, Sort, Update Description Required. The date the associated OpportunityLineItem is to be scheduled for an event: delivery, shipping, or any other date you wish to track. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of the schedule. Required when inserting an OpportunityLineItemSchedule. Valid values include Quantity, Revenue, or Both. | ## Allowed Type Field Values The allowed Type values for an OpportunityLineItemSchedule depend on the product-level schedule preferences and whether the line item has any existing schedules. The following criteria must be met: - The Product2 on which the OpportunityLineItem is based must have the appropriate CanUseRevenueSchedule or CanUseQuantitySchedule fields (or both) set to true. - When you create a schedule for a line item that does not have any existing schedules, you can specify any valid value. - If you create a schedule for a line item that already has existing schedules, the new schedule must be consistent with the existing schedules. The following matrix outlines the allowable values: | Value of HasRevenueSchedule on line item | Value of HasQuantitySchedule on line item | Allowable Type Values | | --- | --- | --- | | false | false | Revenue, Quantity, both | | false | true | Quantity | | true | false | Revenue | | true | true | both | ## Allowed Quantity and Revenue Field Values The allowable Quantity and Revenue field values depend on the value of the Type field: | Type Value | Allowable Quantity Value | Allowable Revenue Value | | --- | --- | --- | | Revenue | Null | Non-null | | Quantity | Non-null | Null | | both | Non-null | Non-null | The Quantity and Revenue fields have the following restrictions when this object is updated: - For a schedule of Type Quantity, you can’t update a null Revenue value to non-null. Likewise for a schedule of Type Revenue, you can’t update a null Quantity value to non-null. - You can’t null out the Quantity field for a schedule of Type Quantity. Likewise you can’t null out the Revenue field for a schedule of Type Revenue. - You can’t null out either the Revenue or Quantity fields for a schedule of type Both. ## Usage OpportunityLineItemSchedule supports two types of schedules: - Quantity schedules - Revenue schedules The user must have edit access rights on the Opportunity in order to create or update line item schedules on that opportunity. ## Products and Schedules Must Be Enabled The OpportunityLineItemSchedule object is defined only for those organizations that have the products and schedules features enabled. If the organization does not have the products and schedules features, the OpportunityLineItemSchedule object is not returned in a describe, and you can't describe or query OpportunityLineItemSchedule records. ## Effects on Opportunities and Opportunity Line Items OpportunityLineItemSchedule records affect opportunities and opportunity line items in the following ways: - Inserting an OpportunityLineItemSchedule of Type “Revenue” or “Quantity” increments the TotalPrice field on the OpportunityLineItem by the OpportunityLineItemSchedule Revenue amount. Inserting an OpportunityLineItemSchedule of Type Quantity or Both increments the Quantity field on the OpportunityLineItem by the OpportunityLineItemSchedule Quantity amount. - Creating an OpportunityLineItemSchedule record affects the original opportunity: 1. The Opportunity Amount is incremented the by OpportunityLineItemSchedule revenue amount 2. The Opportunity ExpectedRevenue is incremented by the line item schedule amount multiplied by the Opportunity Probability - Deleting an OpportunityLineItemSchedule has a similar effect on the related OpportunityLineItemand Opportunity. Deleting an OpportunityLineItemSchedule decrements the OpportunityLineItem TotalPrice by the deleted OpportunityLineItemSchedule Quantity or Revenue amount. The Opportunity Amount is also decremented by the OpportunityLineItemSchedule Quantity or Revenue amount, and the Opportunity ExpectedRevenue is reduced by OpportunityLineItemSchedule Quantity or Revenue amount multiplied by the Opportunity Probability. ## Deleting an Opportunity Line Item Schedule Deleting the last remaining schedule will set the corresponding HasQuantitySchedule or HasRevenueSchedule flags (or both) to false on the parent line item. #### See Also - [OpportunityLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitylineitem.htm "Represents an opportunity line item, which is a member of the list of Product2 products associated with an Opportunity.") - [Product2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_product2.htm "Represents a product that your company sells.") # OpportunityLineItemSplit Represents information about an opportunity product split, including percentages, amounts, and owner. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Before creating OpportunityLineItemSplit records, enable Team Selling, set up opportunity splits, and enable product splits on at least one opportunity split type in Setup. ## Fields | Field | Details | | --- | --- | | ArchivedTerritoryName | Type String Properties Filter, Group, Nillable, Sort Description The name of the associated territory that’s on an archived territory model. If the OpportunityLineItemSplit isn’t associated with a territory on an archived territory model, the field value is null. This field is available in API version 62.0 and later. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. If the organization has multicurrency enabled, and a Pricebook2 is specified on the opportunity (that is, the Pricebook2Id field isn’t blank on the opportunity referenced by this object’s OpportunityId), then the value of this field must match the currency of the CurrencyIsoCode field on the PricebookEntry records that are associated with this object. Possible values are: - BRL—Brazilian Real - CAD—Canadian Dollar - EUR—Euro - USD—U.S. Dollar The default value is USD. | | OpportunityLineItemId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated parent OpportunityLineItem. This field is a relationship field. Relationship Name OpportunityLineItem Relationship Type Lookup Refers To OpportunityLineItem | | Split | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Read-only. Automatically generated number identifying the split within the opportunity. | | SplitAmount | Type currency Properties Filter, Nillable, Sort Description The amount or value of the split. | | SplitNote | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Optional text about the split. | | SplitOwnerId | Type reference Properties Create, Filter, Group, Sort Description ID of the user who is the owner of the split. This field is a relationship field. Relationship Name SplitOwner Relationship Type Lookup Refers To User | | SplitPercentage | Type percent Properties Create, Filter, Sort, Update Description The percentage of the OpportunityLineItem's value that the split represents. | | SplitTypeId | Type reference Properties Create, Filter, Group, Sort Description ID of the associated OpptyLineItemSplitType. This field is a relationship field. Relationship Name SplitType Relationship Type Lookup Refers To OpptyLineItemSplitType | | Territory2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the associated territory. This field is a relationship field, and is available in API version 62.0 and later. Relationship Name Territory2 Relationship Type Lookup Refers To Territory2 | ## Usage Use the OpportunityLineItemSplit object to manage opportunity product splits for an opportunity. ## 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. [OpportunityLineItemSplitHistory](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.") (API version 59.0) History is available for tracked fields of the object. # OpportunityOwnerSharingRule Represents a rule for sharing an opportunity with users other than the owner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. This field is available in API version 24.0 and later. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. Opportunities owned by users in the source group trigger the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | OpportunityAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. The possible values are: - Read - Edit | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the target user or group. The target user or group is being given access. | ## Usage Use this object to manage the sharing rules for opportunities. General sharing and Territory-related sharing use this object. #### See Also - [Case](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm "Represents a case, which is a customer issue or problem.") - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") # OpportunityPartner This object represents a partner relationship between an Account and an Opportunity. An OpportunityPartner record is created automatically when a Partner record is created for a partner relationship between an account and an opportunity. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | AccountToId | Type reference Properties Create, Filter, Group, Sort Description ID of the partner Account in the partner relationship. This is a relationship field. Relationship Name AccountTo Relationship Type Lookup Refers To Account | | IsPrimary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the account is the opportunity’s primary partner (true) or not (false). Label is **Primary**. | | OpportunityId | Type reference Properties Create, Filter, Group, Sort Description ID of the Opportunity that is in the partner relationship. This is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | ReversePartnerId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the reciprocal OpportunityPartner record in a partner relationship. | | Role | Type picklist Properties Create, Filter, Group, Nillable, Sort Description The UserRole that the Account has on the Opportunity. For example, Reseller or Manufacturer. | ## Creating an Account-Opportunity Partner Relationship When you create a partner relationship between an account and an opportunity (when you create a Partner record and specify the OpportunityId field), the API automatically creates two OpportunityPartner records, one for the forward relationship and one for the reverse. - The value of the Partner field AccountToId maps to the value of the OpportunityPartner field AccountToId. - The values of the OpportunityId, Role, and IsPrimary fields in both the Partner and OpportunityParnter records are the same. - If you set the IsPrimary value to 1 (true) upon insert of a new OpportunityPartner, the IsPrimary value is automatically set to 0 (false) for any existing primary partners for that opportunity. This mapping allows the API to manage the records and their relationships efficiently. #### See Also - [Partner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partner.htm "Represents a partner relationship between two Account records or between an Opportunity record and an Account record.") - [AccountPartner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountpartner.htm "This object represents a partner relationship between two Account records. An AccountPartner record is created automatically when a Partner record is created for a partner relationship between two accounts. An AccountPartner record is also created automatically between an account and an opportunity’s account when a Partner record is created between an account and an opportunity.") # OpportunityRelatedDeleteLog Represents an audit log of the deletion of opportunity-related child records, such as opportunity team members, product splits, or opportunity splits. This object is available in API version 59.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only when the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. When multicurrency is enabled, and a Pricebook2 is specified on the parent opportunity (that is, the Pricebook2Id field isn’t blank on the opportunity record referenced by this object’s OpportunityId), then the value must match the currency of the CurrencyIsoCode field on the PricebookEntry records that are associated with this object. Possible values are: - AED—UAE Dirham - CAD—Canadian Dollar - INR—Indian Rupee - USD—U.S. Dollar The default value is USD. | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was deleted. Possible values are: - Double - DynamicEnum - EntityId - StaticEnum - Text | | DeleteLog | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort | | FieldName | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The name of the field that was deleted. Possible values are: - OpportunityLineItemSplit.SplitOwnerId - OpportunityLineItemSplit.SplitPercentage - OpportunityLineItemSplit.SplitTypeId - OpportunitySplit.SplitOwnerId - OpportunitySplit.SplitPercentage - OpportunitySplit.SplitTypeId - OpportunityTeamMember.TeamMemberRole - OpportunityTeamMember.UserId - Product2.Name | | OpportunityId | Type reference Properties Filter, Group, Sort Description Required. ID of the associated opportunity. This field is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | Parent | Type string Properties Filter, Group, Nillable, Sort Description ID of the record that was deleted. Records with the same Parent text indicate that the value shown in the Value field came from the same record that was previously deleted. Refer to the FieldName field to see which field is being tracked. | | SobjectType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The object that’s being recorded for this row of data. Possible values are: - OpportunityLineItemSplit - OpportunitySplit - OpportunityTeamMember | | Value | Type anyType Properties Nillable, Sort Description The value of the field that was deleted. | # OpportunityShare Represents a sharing entry on an Opportunity. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls describeSObjects(), create(), delete(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only users with access to the Opportunity object can access this object. ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field | Details | | --- | --- | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | OpportunityAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the opportunity. The possible values are: - Read - Edit - All—This value is not valid when creating, updating, or deleting records. This field must be set to an access level that’s higher than the org’s default access level for opportunities. | | OpportunityId | Type reference Properties Create, Filter, Group, Sort Description ID of the opportunity associated with this sharing entry. This field can’t be updated. This is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Owner—The User is the owner of the opportunity. - Manual—The User or Group has access because a user with “All” access manually shared the opportunity with the user or group. - Rule—The User or Group has access via an opportunity sharing rule. - GuestRule—The User or Group has access via an opportunity guest user sharing rule. - ImplicitChild—The User or Group has access to the opportunity on the account associated with this opportunity. After faster account sharing recalculation is enabled, sharing entries with this value aren’t returned in queries. Instead of storing implicit child shares, record access is determined dynamically. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. - ARImplicit—The User, who belongs to a partner or customer account, has access to the opportunity via an account relationship data sharing rule. - Sales Team—The User has access to the opportunity because the user is on the opportunity sales team for the opportunity. The OpportunityTeamMember object sets the access level. See OpportunityTeamMember for more information. - Territory—The forecast manager has access because they are assigned to a territory above the territory that is assigned the opportunity. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that has been given access to the opportunity. This field can’t be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object allows you to determine which users and groups can view or edit opportunities owned by other users. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note After faster account sharing recalculation is enabled for your org, we no longer store implicit share records between accounts and their child opportunity records. Sharing entries that have a value of ImplicitChild in the RowCause field aren’t returned when you query this object. Instead, the system dynamically determines whether users can access child opportunity records when they try to access them. This change speeds up ownership and sharing recalculation for accounts. For more information, see the [Faster Account Sharing Recalculation](https://help.salesforce.com/s/articleView?id=000394638&type=1&language=en_US) knowledge article. If you attempt to create a record that matches an existing record, any modified fields are updated, the system returns the existing record. If an opportunity is shared in multiple ways with a user, you don’t always see multiple sharing records. If a user has access to an opportunity for one or more of the following RowCause values, the records in the OpportunityShare object are compressed into one record with the highest level of access. - Manual - Owner #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # OpportunitySplit OpportunitySplit credits one or more opportunity team members with a portion of the opportunity amount. This object is available in API version 16.0 and later for pilot customers, and version 28.0 and later for others. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ArchivedTerritoryName | Type String Properties Filter, Group, Nillable, Sort Description The name of the associated territory that’s on an archived territory model. If the OpportunityLineItemSplit isn’t associated with a territory on an archived territory model, the field value is null. This field is available in API version 62.0 and later. | | HasOpportunityLineItemSplit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the opportunity split has a split on the opportunity line item level (true) or not (false). The default value is false. This field is available in API version 58.0 and later. | | OpportunityId | Type reference Properties Create, Filter, Group, Sort Description ID of the opportunity for which the split is being created. This field is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | Split | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Read-only. Automatically generated number identifying the split within the opportunity. | | SplitAmount | Type currency Properties Filter, Nillable, Sort Description Monetary amount of the split. Label is Split Amount. | | SplitNote | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Enter any notes or comments about the split. The character limit is 255. Label is Split Note. | | SplitOwnerId | Type reference Properties Create, Filter, Group, Sort Description The opportunity owner. This field is a relationship field. Relationship Name SplitOwner Relationship Type Lookup Refers To User | | SplitPercentage | Type percent Properties Create, Filter, Sort, Update Description Split percentage that this team member receives. If the split type is validated to a 100% total, this number can range from 0 to 100. If the total isn’t validated, this number can range from 0 to 1,000. Label is Split (%). | | SplitTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Auto-generated, numeric ID for the split type defined by the OpportunitySplitType object. This field is available in API version 28 and later. If this field is blank, the system automatically specifies the default split type for the opportunity amount, which is validated to 100%. This field is a relationship field. Relationship Name SplitType Relationship Type Lookup Refers To OpportunitySplitType | | Territory2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the associated territory. This field is a relationship field, and is available in API version 62.0 and later. Relationship Name Territory2 Relationship Type Lookup Refers To Territory2 | ## Usage Use the OpportunitySplit object to manage splits for an opportunity. If you change the opportunity owner using the API, the old owner remains on the opportunity team with either Read-only access, or the level of access specified in your organization-wide defaults. ## 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. [OpportunitySplitChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [OpportunitySplitHistory](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.") (API version 59.0) History is available for tracked fields of the object. # OpportunitySplitType OpportunitySplitType provides unique labels and behavior for each split type. This object is available in API version 28.0 and later. There are two default split types: revenue splits, which must total 100%, and overlay splits, which can total any percentage. ## Supported Calls describeSObjects(), query(), retrieve(), update() ## Fields
Field Name Details
Description
Type
textarea
Properties
Create, Filter, Group, Sort, Update
Description
Describes the purpose of the split type, providing context to future developers.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The unique name of the object in the API. 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.
Note

Note

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Enables or disables the split type.
IsTotalValidated
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
If true, the split must total 100%. If false, the split can total any percentage.
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates language of split labels in the user interface.
ManageableState
Type
ManageableState enumerated list
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package:
  • beta
  • deleted
  • deprecated
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged

This field is available in API version 38.0 and later.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The user-interface label for the split type.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

  • In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
  • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

This field can’t be accessed unless the logged-in user has the Customize Application permission.
SplitEntity
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The containing record type, such as an opportunity. Available in API version 30 and later.
SplitField
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
Indicates which currency field of the opportunity object is split. Available in API version 30 and later.
SplitDataStatus
Type
picklist
Properties
Filter, Group, Nillable,Restricted picklist, Sort,Update
Description
Indicates the status of the split type. Available in API version 30 and later.
# OpportunityStage Represents the stage of an Opportunity in the sales pipeline, such as New Lead, Negotiating, Pending, Closed, and so on. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an id or master label. | | DefaultProbability | Type percent Properties Filter, Nillable, Sort, Description The default percentage estimate of the confidence in closing a specific opportunity for this opportunity stage value. Label is **Probability (%)**. | | Description | Type string Properties Filter, Group, Nillable, Sort Description Description of this opportunity stage value. Limit: 255 characters. | | ForecastCategory | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The default forecast category for this opportunity stage value. The forecast category automatically determines how opportunities are tracked and totaled in a forecast. Possible values are: - BestCase - Closed - Forecast - MostLikely - Omitted - Pipeline | | ForecastCategoryName | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Available in API version 12.0 and later. The default forecast category value for this opportunity stage value. Possible values are: - Best Case - Closed - Commit - Most Likely - Omitted - Pipeline | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this opportunity stage value is active (true) or not (false). Inactive opportunity stage values are not available in the picklist and are retained for historical purposes only. | | IsClosed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this opportunity stage value represents a closed opportunity (true) or not (false). Multiple opportunity stage values can represent a closed opportunity. Label is **Closed**. | | IsWon | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this opportunity stage value represents a won opportunity (true) or not (false). Multiple opportunity stage values can represent a won opportunity. Label is **Won**. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Master label for this opportunity stage value. This display value is the internal label that does not get translated. Limit: 255 characters. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the opportunity stage picklist. These numbers are not guaranteed to be sequential, as some previous opportunity stage values might have been deleted. | ## Usage This object represents a value in the opportunity stage picklist, which provides additional information about the stage of an Opportunity, such as its probability or forecast category. Query this object to retrieve the set of values in the opportunity stage picklist, and then use that information while processing Opportunity records to determine more information about a given opportunity. For example, the application could test whether a given opportunity is won or not based on its StageName value and the value of the IsWon property in the associated OpportunityStage object. This object is read-only via the API. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # OpportunityTag Associates a word or short phrase with an Opportunity. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage OpportunityTag stores the relationship between its parent TagDefinition and the Opportunity being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. # OpportunityTeamMember Represents a User on the opportunity team of an Opportunity. See also UserTeamMember, which represents a User who is on the default Opportunity team of another user. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields
Field Details
IsDeleted
Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
Note

Note

An OpportunityTeamMember that is deleted isn’t moved to the Recycle Bin and can’t be undeleted, unless the record was cascade-deleted when deleting a related Opportunity. For directly deleted OpportunityTeamMember records, don't use the isDeleted field to detect deleted records in SOQL queries. Instead, use getDeleted().
Name
Type
string
Properties
Filter, Nillable, Sort
Description
The team member name. This read-only field is available in API version 30.0 and later.
OpportunityAccessLevel
Type
picklist
Properties
Filter, Nillable, Restricted picklist
Description
Opportunity access level for this team member. Valid values:
  • Read
  • Edit
  • All
This field is supported in triggers, but not in workflows or validation rules. It’s editable in API version 36.0 and later.
OpportunityId
Type
reference
Properties
Create, Filter
Description
Required. ID of the Opportunity associated with this opportunity team. This field can’t be updated.
PhotoURL
Type
URL
Properties
Filter, Nillable, Sort, Group
Description
Read only. Retrieves the users Chatter photo URL. This field is available in API version 32.0 and later.
TeamMemberRole
Type
picklist
Properties
Create, Filter, Nillable, Update
Description
Role that the team member has on the opportunity. The org’s admin sets the valid values in the Opportunity Team Roles picklist. Label is Team Role.
Title
Type
string
Properties
Filter, Nillable, Sort, Group
Description
Read only. Retrieves the user’s title. This field is available in API version 36.0 and later.
UserId
Type
reference
Properties
Create, Filter
Description
Required. ID of the User who is a member of the opportunity team. This field can’t be updated.
## Usage If you create a record for this object and the OpportunityId and UserId combination matches an existing record, the system updates any modified fields and returns the existing record. In the user interface, users can set up an opportunity team for the opportunities they own. The opportunity team includes other users that are working on the opportunity with them. This object is available only in organizations that have enabled team selling. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The behavior for changing ownership of opportunities is different using the user interface when the previous owner is on an opportunity team. For example, when you change the owner of an opportunity using the API, the previous owner's access becomes Read Only or the access specified in your organization-wide default for opportunities, whichever is greater. However, performing this same action in the user interface allows you to select the access level for the previous owner when the previous owner is on an opportunity team. ## 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. [OpportunityTeamMemberHistory](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.") (API version 59.0) History is available for tracked fields of the object. #### See Also - [UserTeamMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userteammember.htm "Represents a single User on the default opportunity team of another User.") # OppSalesMethodology Represents the sales methodology record attached to an opportunity. This object is available in API version 67.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object turn on the userHasSalesMethodologyEnabled, OrgPreferences, SalesMethodologyPref, and PipelineInspectorUser permissions. To create, edit, or delete records, users must own the associated opportunity's parent opportunity. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note crudEnabled = false. This object isn’t accessible via standard CRUD API calls. ## Fields | Field | Details | | --- | --- | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the opportunity's sales methodology is locked (true) or not (false). The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user can edit the opportunity's sales methodology. The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the opportunity's sales methodology. | | OpportunityId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the associated opportunity. This field is a relationship field. Relationship Name Opportunity Relationship Type Master-detail Refers To Opportunity (the master object) | | SalesMethodologyDefId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The ID of the sales methodology definition record. This field is a relationship field. Relationship Name SalesMethodologyDef Refers To SalesMethodologyDef | # OppSalesMethodologyItem Represents the scored criteria for an opportunity's associated sales methodology. This object is available in API version 67.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object turn on the userHasSalesMethodologyEnabled, OrgPreferences, SalesMethodologyPref, and PipelineInspectorUser permissions. To create, edit, or delete records, users must own the associated opportunity's parent opportunity. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note crudEnabled = false. This object isn't accessible via standard CRUD API calls. ## Fields | Field | Details | | --- | --- | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the opportunity's sales methodology criteria is locked (true) or not (false). The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user can edit the opportunity's sales methodology criteria. The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the opportunity's sales methodology stage or criteria. | | Note | Type textarea Properties Create, Nillable, Update Description This field stores details you enter when updating or scoring the opportunity's sales methodology stage or criteria. | | OppSalesMethodologyId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the opportunity's sales methodology. This field is a relationship field. Relationship Name OppSalesMethodology Relationship Type Master-detail Refers To OppSalesMethodology (the master object) | | SalesMethodologyDefItemId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The ID of the sales methodology stage or criteria. This field is a relationship field. Relationship Name SalesMethodologyDefItem Refers To SalesMethodologyDefItem | | Value | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value associated with the opportunity's scored sales methodology stage or criteria. | # OpptyLineItemSplitType Represents an opportunity product split type. This object is available in API version 58.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Filter, Group, Sort Description Text description of the opportunity line item split type. Limit: 80 characters. | | DeveloperName | Type string Properties Filter, Group, Sort Description The developer (API) name of the opportunity line item split type. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the opportunity line item split type is active (true) or not (false). The value of this field is inherited from the IsActive field of the parent OpportunitySplitType record. | | IsTotalValidated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the OpportunityLineItemSplit records associated with the OpportunityLineItem must have SplitPercent values that aggregate to 100% (true) or not (false). The value of this field is inherited from the IsTotalValidated field of the parent OpportunitySplitType record. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the opportunity line item split type. | | MasterLabel | Type string Properties Filter, Group, Sort Description The opportunity line item split type label. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. | | OpportunitySplitTypeId | Type reference Properties Filter, Group, Sort Description The ID of the parent OpportunitySplitType. Every OpptyLineItemSplitType must have a parent OpportunitySplitType. This field is a relationship field. Relationship Name OpportunitySplitType Relationship Type Lookup Refers To OpportunitySplitType | | SplitDataStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The state of the asynchronous job to delete OpportunityLineItemSplit records when the associated OpptyLineItemSplitType record is deleted. Possible values are: - DeletionFailed–The job failed the last time it ran. - Ready–The job hasn't run or isn't running. OpportunityLineItemSplit records associated with the OpptyLineItemSplitType can be interacted with. - ToBeDeleted–The job is running. | | SplitEntity | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name or ID of the entity that contains the field being split. In API version 58.0, this value is always OpportunityLineItem. | | SplitField | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name or ID of the field on OpportunityLineItem that is being split. If it's a standard field, then the value is the API name of the field. If it’s a custom field, the value is the custom field definition ID. | ## Usage When an OpportunitySplitType has product splits enabled in Setup, then an OpptyLineItemSplitType record is created. For example, if there is an OpportunitySplitType record with a SplitField of Amount and product splits is enabled in Setup, then there is an OpptyLineItemSplitType record with a SplitField of TotalPrice (since the TotalPrice field rolls up to Amount). # Order Represents an order associated with a contract or an account. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. ID of the Account associated with this order. Only updated when the order’s StatusCode value is Draft. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | ActivatedById | Type reference Properties Filter, Group, Nillable, Sort, Update Description ID of the user who activated this order. This field is a relationship field. Relationship Name ActivatedBy Relationship Type Lookup Refers To User | | ActivatedDate | Type dateTime Properties Filter, Nillable, Sort, Update Description Date and time when the order was activated. | | BillingAddress | Type address Properties Filter, Nillable Description | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the billing address for this order. The maximum size is 40 characters. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the billing address for this order. The maximum size is 80 characters. | | BillingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO country code for the billing address for this order. | | BillingEmailAddress | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address for this order’s billing address. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | BillingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode of the address. | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | BillingPhoneNumber | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number for this order’s billing address. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal code for the billing address for this order. The maximum size is 20 characters. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the billing address for this order. The maximum size is 80 characters. | | BillingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO state code for the order’s billing address. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street address for the billing address. | | BillToContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the contact that the order is billed to. | | CompanyAuthorizedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user who authorized the account associated with the order. This field is a relationship field. Relationship Name CompanyAuthorizedBy Relationship Type Lookup Refers To User | | CompanyAuthorizedDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which your organization authorized the order. | | ContractId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the contract associated with this order. Only updated when the order’s StatusCode value is Draft. This field is a relationship field. Relationship Name Contract Relationship Type Lookup Refers To Contract | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code. | | CustomerAuthorizedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the contact who authorized the order. This field is a relationship field. Relationship Name CustomerAuthorizedBy Relationship Type Lookup Refers To Contact | | CustomerAuthorizedDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date on which the contact authorized the order. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the order. | | EffectiveDate | Type date Properties Create, Filter, Group, Sort, Update Description Date at which the order becomes effective. Label is **Order Start Date**. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date at which the order ends. Label is **Order End Date**. | | ExternalCustomerReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The external customer ID from an ecommerce channel or any other external channel. Label is **External Customer ID Reference**. This field is available in API version 66.0 and later. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description Sum of TotalAmount and TotalTaxAmount. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | IsReductionOrder | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Read only. Determines whether an order is a reduction order. Label is **Reduction Order**. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Name | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name for this order. | | OpportunityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID for the opportunity that’s associated with this order. | | OrderedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that the order was placed. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | OrderManagementReferenceIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The field used by Order Management to store the external reference identifier for B2C Commerce orders. On creation, the B2C Integration sets this value to B2C realm ID + "\_" + B2C instance ID + "@" + B2C Commerce catalog/domain ID + "@" + B2C Commerce order number. Otherwise, it isn’t set. When you create an OrderSummary, if you don’t specify an ExternalReferenceIdentifier value, it’s set to this value. If this value is null, then the system generates a value for ExternalReferenceIdentifier. This value isn’t required to be unique in an organization, but the OrderSummary ExternalReferenceIdentifier is. This field is available in API version 56.0 and later. | | OrderNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Order number assigned to this order (not the unique, system-generated ID assigned during creation). The maximum size is 30 characters. | | OrderReferenceNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Order reference number assigned to this order. The maximum size is 80 characters. | | OriginalOrderId | Type reference Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description Optional. ID of the original order that a reduction order is reducing, if the reduction order is reducing a single order. Label is **Original Order**. Editable only if isReductionOrder is true. If the reduction order is reducing more than one order, leave blank. This field is a relationship field. Relationship Name OriginalOrder Relationship Type Lookup Refers To Order | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. ID of the user or queue that owns this order. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaymentTermId | Type reference Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The ID of the related payment term. This field is available in API version 55.0 and later. This field is available if Subscription Management is enabled in your org. This field is a relationship field. Relationship Name PaymentTerm Relationship Type Lookup Refers To PaymentTerm | | PoDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date of the purchase order. | | PoNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Number identifying the purchase order. The maximum is 80. | | Pricebook2Id | Type reference Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Required. ID of the price book associated with this order. This field is a relationship field. Relationship Name Pricebook2 Relationship Type Lookup Refers To Pricebook2 | | QuoteId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the quote that’s associated with this order. If you set QuoteId to null, QuoteLineItemId on all of the order’s child order products is set to null. | | RecordTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the record type assigned to this order. | | RelatedOrderId | Type reference Properties Filter, Group, Nillable, Sort Description The original order that a change order was created from. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. This field is a relationship field. Relationship Name RelatedOrder Relationship Type Lookup Refers To Order | | RelatedOrderType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the related order type. Possible values are: - ChangeOrder - SupplementalOrder - TransferOrder | | SalesChannelId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to a sales channel entity. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | SalesStoreId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the RetailStore or WebStore associated with this Order. This field is a polymorphic relationship field. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v46.0 and later. Relationship Name SalesStore Relationship Type Lookup Refers To WebStore | | ShippingAddress | Type address Properties Filter, Nillable Description Shipping address for the order. | | ShippingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City of the shipping address. The maximum size is 40 characters. | | ShippingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country of the shipping address. The maximum size is 80 characters. | | ShippingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO country code for the order’s shipping address. | | ShippingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode of the shipping address. | | ShippingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | ShippingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | ShippingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal code of the shipping address. The maximum size is 20 characters. | | ShippingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State of the shipping address. The maximum size is 80 characters. | | ShippingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO state code for the order’s shipping address. | | ShippingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street address of the shipping address. Maximum of 255 characters. | | ShipToContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the contact that the order is shipped to. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Picklist of values that indicate order status. Each value is associated with one of the status categories defined in StatusCode. For example, the status picklist might contain Draft, Ready for Review, and Ready for Activation values with a StatusCode of Draft. | | StatusCode | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The status category for the order. Label is **Status Category**. Valid values are: - Draft - Activated - Superseded—This value is applicable only to Revenue Cloud Advanced users and is available in API version 64.0 and later. To use supplemental orders, also known as in-flight amendments, create a status that’s associated with the Superseded status code. . | | TaxLocaleType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of tax calculation that Salesforce uses for the order’s order items. VAT regions use gross tax, which includes tax in all sale amounts. US regions use net tax, which calculates tax separately from the initial sale amount and then adds the sale and tax amounts together in a total. Use TaxLocaleType to determine which types of tax fields to show on your order. If TaxLocaleType is null, the order shows all tax fields. Gross Tax Fields TotalAdjDeliveryAmtWithTax TotalAdjProductAmtWithTax TotalProductAdjDistAmtWithTax TotalDeliveryAdjDistAmtWithTax This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v49.0 and later. | | TotalAdjDeliveryAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Sum of delivery line amounts, delivery line adjustments, and tax. Order products with null Type fields aren’t included. This field is a gross tax field. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v49.0 and later. | | TotalAdjProductAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Sum of product line amounts, line adjustments, and tax. Order products with null Type fields aren’t included. This field is a gross tax field. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v49.0 and later. | | TotalAdjustedDeliveryAmount | Type currency Properties Filter, Nillable, Sort Description Sum of delivery line amounts and delivery line adjustments. Order products with null Type fields aren’t included. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | TotalAdjustedDeliveryTaxAmount | Type currency Properties Filter, Nillable, Sort Description Sum of delivery line tax amounts and delivery line tax adjustments. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | TotalAdjustedProductAmount | Type currency Properties Filter, Nillable, Sort Description Sum of product line amounts and line adjustments. Order products with null Type fields aren’t included. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | TotalAdjustedProductTaxAmount | Type currency Properties Filter, Nillable, Sort Description Sum of line tax amounts and line tax adjustments. Order products with null Type fields aren’t included. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | TotalAmount | Type currency Properties Filter, Sort Description The net total amount for the order products associated with this order. This field is available in API v48.0 and later. | | TotalDeliveryAdjDistAmount | Type currency Properties Filter, Nillable, Sort Description Roll-up of the order’s delivery adjustment distributed amounts. Used only when the Order Adjustment Group has a Type value of Header. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | TotalDeliveryAdjDistAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Roll-up of the order’s delivery adjustment distributed amounts and tax. Used only when the Order Adjustment Group has a Type value of Header. This field is a gross tax field. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v49.0 and later. | | TotalDeliveryAdjDistTaxAmount | Type currency Properties Filter, Nillable, Sort Description Roll-up of the order’s delivery adjustment distributed tax amounts. Used only when the Order Adjustment Group has a Type value of Header. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | TotalProductAdjDistAmount | Type currency Properties Filter, Nillable, Sort Description Roll-up of the order’s product adjustment distributed amounts. Order products with null Type fields aren’t included. Used only when the Order Adjustment Group has a Type value of Header. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | TotalProductAdjDistAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Roll-up of the order’s product adjustment distributed amounts. Order products with null Type fields aren’t included. Used only when the Order Adjustment Group has a Type value of Header. This field is a gross tax field. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v49.0 and later. | | TotalProductAdjDistTaxAmount | Type currency Properties Filter, Nillable, Sort Description Roll-up of the order’s product adjustment distributed tax amounts. Order products with null Type fields aren’t included. Used only when the Order Adjustment Group has a Type value of Header. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Roll-up of all taxes on the order, including delivery taxes, price adjustment taxes, and product taxes. This field is available with Salesforce Order Management, Revenue Cloud, or B2B Commerce license. This field is available in API v48.0 and later. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description To show more information about your order, you can add custom values to the Type picklist. By default, the Type field doesn't perform any actions or show any values. | ## Usage The Status field specifies the current state of an order. Status strings represent its current state (Draft or Activated). When a client application creates an order, the Status Code must be Draft and the Status must be any value that corresponds to a Status Code of Draft. The application can then activate an order by updating it and setting the value in its Status field to an Activated state. However, the Status field is the only field you can update when activating the order. After an order is activated, your client application can change the Status back to the Draft state—but only if the order doesn’t have any child reduction order products. Your client application can delete orders when the Status is Draft but not when its Status is Activated. Client applications can use the API to create, update, delete, and query any Attachment associated with an order. ## Orders Without Price Books If your organization manages products and price books in an external platform, you can use Salesforce API to create orders and order items without values for their price book and price book entry fields. This feature is available only for Salesforce orgs with the B2B Commerce, B2B Commerce Starter, B2B Commerce Growth, or B2B Commerce Plus packages. Admins enable orders without price books by going to Salesforce Order Settings and selecting the Optional Price Book setting. In a standard order, Salesforce prompts the sales rep to select a price book when they add the first order product to the order. The sales rep can then add order products that have price book entries in the selected price book. In an order without a price book, Salesforce hides the order’s Add Products button and Edit Products button so that sales reps must manage their products and price books by using their external system. You can create orders without price books only by creating an order with the Salesforce API and leaving the Pricebook2Id field null. Orders without price books follow several different guidelines compared to standard orders. - Orders without price books don’t support reduction orders or change orders. - Order products without price book entries require list prices. - Orders without price books support only order items without price book entries. Orders with price books support only order items with price book entries. - ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Orders without price books are supported with B2B licenses only. Salesforce Order Management requires price books for orders and price book entries for order products. ## 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. [OrderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 44.0) Change events are available for the object. [OrderFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) (API version 29.0) Feed tracking is available for the object. [OrderHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [OrderOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. #### See Also - [OrderHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderhistory.htm "Represents historical information about changes that have been made to the standard fields of the associated order, or to any custom fields with history tracking enabled.") - [OrderItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitem.htm "Represents an order product that your organization sells.") - [OrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm "Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") - [SalesChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_saleschannel.htm "Represents the origin of an order. For example, a web storefront, physical store, marketplace, or mobile app. If you integrate Salesforce Order Management with Salesforce B2C Commerce, set up a SalesChannel corresponding to each Site in your B2C Commerce implementation. This object is available in API version 48.0 and later.") # OrderAction Indicates the type of order, such as a new sale or a cancellation. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available if Subscription Management is enabled in your org. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name given to the order action. | | OffsetOrderItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the previous order item that is being modified by the business action. For example, the order that is being canceled. This is a relationship field. Relationship Name OffsetOrderItem Relationship Type Lookup Refers To OrderItem | | OrderId | Type reference Properties Create, Filter, Group, Sort Description The order containing the order item that implements the business action. This is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | | SourceAssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset that is changed as a result of the business action. For example, the asset that is being canceled. This is a relationship field. Relationship Name SourceAsset Relationship Type Lookup Refers To Asset | | Subtype | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The subtype of the action on the order line item. Valid values are: - FieldAmendment - Rollback - StartDateAdjustment - TransferFrom - TransferTo This field is available with Revenue Cloud in API version 64.0 and later. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The business action that created the order product. Valid values are: - Add - Amend - Cancel - No Change - Renew - Transfer—Available with Revenue Cloud in API version 65.0 and later. | # OrderAdjustmentGroup Group containing a set of adjustments applied to an order. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AdjustmentBasisReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the specific coupon applied. This is a polymorphic relationship field. Relationship Name AdjustmentBasisReference Relationship Type Lookup Refers To Coupon This field is available in API version 54.0 and later. This field can only refer to Coupon when B2B Commerce is enabled. | | AdjustmentCauseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the specific promotions applied. This field is a polymorphic relationship field. Relationship Name AdjustmentCause Relationship Type Lookup Refers To PriceAdjustmentTier, Promotion This field is available in API version 52.0 and later. This field can only refer to Promotion when B2B Commerce is enabled. | | AdjustmentSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the origin of the adjustment. Possible values are: - Discretionary—The adjustment originates from a decision made by an individual, for example, a manager’s discount granted to a client. - Promotion—The adjustment originates from a promotion, for example, a holiday sale discount. - Rule—Reserved for future use. - System—The adjustment originates from the system, for example, a volume discount after the amount of items reaches a specific number. This field is available in API version 57.0 and later. | | AdjustmentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the type of mathematical adjustment to be applied to the order. Possible values are: - AdjustmentAmount—The adjustment is a numerical amount, for example, a cash discount of 20. - AdjustmentPercentage—The adjustment is a percentage amount, for example, a 10% discount. - OverrideAmount—The adjustment is a manual price override. This field is available in API version 57.0 and later. | | AdjustmentValue | Type double Properties Create, Filter, Nillable, Sort, Update Description The specified AdjustmentType’s amount to be applied to the order. For example, when the AdjustmentType value is AdjustmentAmount, the AdjustmentValue is expected to equal the value of the TotalAmount field. When the AdjustmentType value is AdjustmentPercentage, the AdjustmentValue represents the percentage number, and the TotalAmount field’s value will show the calculated adjustment amount. This field is available in API version 57.0 and later. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The currency used for the checkout session. Default value is USD. Possible values are: - USD—U.S. Dollar | | Description | Type textarea Properties Create, Nillable, Update Description User-entered information about the order adjustment group. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all total amounts of all adjustments in this group, including tax. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The user-defined name of the order adjustment group. | | OrderId | Type reference Properties Create, Filter, Group, Sort Description The unique identifier of the order related to the adjustments in this order adjustment group. This field is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort Description A numeric value that represents the order of precedence of the order adjustment group. It can also represent the order of precedence when applying the AdjustmentType values. For example, an order can have two adjustments: a $100 discount and a 10% discount. This field will tell the pricing engine which adjustment needs to be applied first. This field is available in API version 57.0 and later. | | RelatedAdjustmentGroupId | Type reference Properties Filter, Group, Nillable, Sort Description The unique identifier of the original order’s adjustment group. This field is a useful reference in change order scenarios. This field is a relationship field. Relationship Name RelatedAdjustmentGroup Relationship Type Lookup Refers To OrderAdjustmentGroup | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description The total of all order adjustments in this order adjustment group, excluding tax. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description The total tax for all order adjustments in this order adjustment group. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates how the adjustment was applied to the order. Possible values are: - Header: — The adjustment was applied to the order’s balance, and then distributed among the order products in the adjustment group. - SplitLine— The adjustment was applied to order product balances for the order products in the adjustment group. | ## 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. [OrderAdjustmentGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [OrderAdjustmentGroupFeed](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. [OrderAdjustmentGroupHistory](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. [OrderAdjustmentGroupOwnerSharingRule](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. [OrderAdjustmentGroupShare](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. # OrderAdjustmentGroupSummary Represents the current properties and state of a group of related price adjustments. Associated with a set of OrderItemAdjustmentLineSummaries that apply to OrderItemSummaries belonging to one OrderSummary. Corresponds to one or more order adjustment group objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. An OrderAdjustmentGroupSummary can represent an adjustment to an entire order as a group of adjustments to each of its products. For example, representing “10% off the order” as a set of 10% off adjustments to each product on the order. It can also represent an adjustment that applies to a subset of the products on an order. For example, representing “buy one, get one 50% off” as a 25% off adjustment to each of two products. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentBasisReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the specific coupon applied. This is a polymorphic relationship field. Relationship Name AdjustmentBasisReference Relationship Type Lookup Refers To Coupon This field is available in API version 54.0 and later. | | AdjustmentCauseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the specific promotions applied. This is a polymorphic relationship field. Relationship Name AdjustmentCause Relationship Type Lookup Refers To Promotion This field is available in API version 52.0 and later. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description ISO code for the currency of the OrderSummary associated with the adjustments in the group. The default value is USD. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar This field is available in API version 49.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the OrderAdjustmentGroupSummary. This field can be edited. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including tax, of the associated OrderItemAdjustmentLineSummaries. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderAdjustmentGroupSummary. | | OrderSummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderSummary associated with the OrderAdjustmentGroupSummary. | | OriginalOrderAdjGroupId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the original OrderAdjustmentGroup associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, not including tax, of the associated OrderItemAdjustmentIineSummaries. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAmount. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Type of the OrderAdjustmentGroupSummary. Header represents an order-level adjustment with an OrderItemAdjustmentLineSummary for each OrderItemSummary on the OrderSummary. SplitLine represents any other related set of OrderItemAdjustmentLineSummaries. Possible values are: - Header - SplitLine If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | ## 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. [OrderAdjustmentGroupSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. #### See Also - [OrderAdjustmentGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderadjustmentgroup.htm "Group containing a set of adjustments applied to an order. This object is available in API version 48.0 and later.") - [OrderItemAdjustmentLineSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemadjustmentlinesummary.htm "Represents the current properties and state of price adjustments on an OrderItemSummary. Corresponds to one or more order item adjustment line item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") # OrderChangeLog Represents a log record of all change requests made to an order post activation. A log record is always one-to-one to change an order request. This object is available in API version 48.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Commerce Cloud standard objects in the inventory data model require at least one of the following licenses: B2B Commerce, D2C Commerce. ## Fields | Field | Details | | --- | --- | | ChangeLineId | Type reference Properties Filter, Group, Sort Description The ID of the main change line created as a result of the change request. For example, if you change an order item, the ChangeLineId would be the change OrderItem ID, or if you change a shipping address, the ChangeLineId would be the change OrderDeliveryGroup ID. This field is a polymorphic relationship field. Relationship Name ChangeLine Relationship Type Lookup Refers To OrderAdjustmentGroup, OrderDeliveryGroup, OrderItem, OrderItemAdjustmentLineItem, OrderItemTaxLineItem | | ChangeLineType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The method used to implement the change. Possible values are: - Delta - New | | ChangeOrderId | Type reference Properties Filter, Group, Sort Description The ID of the change order. This field is a relationship field. Relationship Name ChangeOrder Relationship Type Lookup Refers To Order | | ChangeRequest | Type string Properties Filter, Group, idLookup, Sort Description The unique ID of the request of which this change is a part. | | ChangeSummary | Type textarea Properties Description A human-readable summary of the change details. Here’s an example of a change summary: Reduced quantity by -3. Change adjustment by $15. Added an adjustment of $20. Changed tax by $-0.11, effective 1/1/2020. Added a tax of $1.5, effective 1/1/2020. | | ChangeType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of the change request. Possible values are: - NewAdjustmentGroups—Add a new header level adjustment. - NewLineAdjustments—Add a new line level adjustment. - NewOrderItems—Add a new order item. - QuantityChange—Add or remove quantity from an original order item. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The ISO code for any currency allowed by the organization. Possible value is: - USD—U.S. Dollar The default value is USD. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name for the order change log. | | RelatedLineId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the main line that is changed as a result of this change. This field is a polymorphic relationship field. Relationship Name RelatedLine Relationship Type Lookup Refers To OrderAdjustmentGroup, OrderDeliveryGroup, OrderItem, OrderItemAdjustmentLineItem, OrderItemTaxLineItem | | RelatedOrderId | Type reference Properties Filter, Group, Sort Description The ID of the order that is changed. This field is a relationship field. Relationship Name RelatedOrder Relationship Type Master-detail Refers To Order (the master object) | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The order status of the change order. Possible values are: - Activated - Draft | ## Usage Order change log entries are automatically created each time an order is modified. ## 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. [OrderChangeLogFeed](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. [OrderChangeLogHistory](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. # OrderChgReasonCategMap The mapping between an order change reason and a service flow category. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Category | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The service flow that reasons are being categorized by. Possible values are: - Cancel - CancelAll - CancelFee - Discount - Exchange - RMA - Return - ReturnFee | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency code of the order. Possible values are: - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the mapping. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the category mapping is active. The default value is false. | | IsAvailableForExternalUser | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the mapping can be accessed and used by external users. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the mapping. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the mapping. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Reason | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The order change reason that’s being categorized. Possible values are: - Damaged - DoorLocked - IncorrectPrice - Rejected - WrongItem The default value is Damaged. | # OrderDeliveryGroup A group of order items that share a delivery method and address. The delivery method and address are used during the fulfillment process, such as shipping as a gift, downloading, picking up in store, or shipping to a standard address This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | DeliverToAddress | Type address Properties Filter, Nillable Description The delivery group’s order items are delivered to this address. Created based on the values of the other DeliverTo fields. | | DeliverToCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City address value. Sent to DeliverToAddress. | | DeliverToCompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | DeliverToCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country address value. Sent to DeliverToAddress | | DeliverToFullFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | DeliverToFullLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | DeliverToFullName | Type string Properties Filter, Group, Nillable, Sort Description | | DeliverToFullSalutation | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Possible values are: - Dr. - Mr. - Mrs. - Ms. - Prof. | | DeliverToGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Geocode accuracy address value. Sent to DeliverToAddress. | | DeliverToLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Latitude address value. Sent to DeliverToAddress. | | DeliverToLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Longitude address value. Sent to DeliverToAddress. | | DeliverToName | Type string Properties Create, Filter, Nillable, Group, Sort, Update Description Name of the delivery recipient. Sent to DeliverToAddress. | | DeliverToPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal Code address value. Sent to DeliverToAddress. | | DeliverToState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State address value. Sent to DeliverToAddress. | | DeliverToStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street address value. Sent to DeliverToAddress. | | DeliveryInstructions | Type textarea Properties Create, Nillable, Update Description Text field for users to add other delivery instructions. | | Description | Type textarea Properties Create, Nillable, Update Description User-defined description for this delivery group. | | DesiredDeliveryDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The buyer’s target delivery date for the order items included in the delivery group. | | EmailAddress | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The buyer’s email address. | | GiftMessage | Type textarea Properties Create, Nillable, Update Description An optional gift message that the buyer can define if they’re sending the order items as a gift to another recipient. Applies to all order items in the delivery group. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description The sum of the group’s total delivery amount and total tax amount. | | IsGift | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description All items in the delivery group are gifts. | | OrderDeliveryGroupNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Unique number used for referencing this order delivery group. | | OrderDeliveryMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the order delivery method related to this order delivery group. | | OrderId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent order for this order delivery group. An order can have multiple order delivery groups. | | PhoneNumber | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the buyer. | | PromisedDeliveryDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Merchant-defined date that the items in this group will be delivered to the customer. Usually defined based on an estimated date from the shipping provider. | | RelatedDeliveryGroupId | Type reference Properties Filter, Group, Nillable, Sort Description The original delivery group. Used for reference in change order scenarios. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all adjustments (of type Delivery Charge) made to order items in the order delivery group. | | TotalAdjustmentAmtWithTax | Type currency Properties Filter, Nillable, Sort Description The sum of all adjustments (of type Delivery Charge) made to order items in the order delivery group, including tax. This is a gross tax field. To access Commerce Orders fields, your org must have a Salesforce Order Management license. Commerce Orders fields are available only in Lightning Experience. This field is available in API v49.0 and later. | | TotalAdjustmentTaxAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all adjustments (of type Delivery Charge) made to tax lines for order items in the order delivery group. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all Total Amount fields (of type Delivery Charge) on order items within this delivery group. On an order item, the total amount equals the quantity multiplied by the unit price, including adjustments and tax. | | TotalLineAmount | Type currency Properties Filter, Nillable, Sort Description The sum of order items (of the type Delivery Charge). On an order item, the total line amount equals the quantity multiplied by the unit price, before adjustments or tax. | | TotalLineAmtWithTax | Type currency Properties Filter, Nillable, Sort Description The sum of all TotalLineAmtWithTax fields (of type Delivery Charge) on order items within this delivery group. On an order item, the total line amount with tax equals the quantity multiplied by the unit price, plus tax, before adjustments. This is a gross tax field. To access Commerce Orders fields, your org must have a Salesforce Order Management license. Commerce Orders fields are available only in Lightning Experience. This field is available in API v49.0 and later. | | TotalLineTaxAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all Total Line Tax Amount fields (of type Delivery Charge) on order items within this delivery group. On an order item, the total line tax amount equals the total tax for that line. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all Total Tax Amount fields (of type Delivery Charge) on order items within this order delivery group. | # OrderDeliveryGroupSummary Represents the current properties and state of a group of OrderItemSummaries, belonging to one OrderSummary, to be fulfilled using the same delivery method and delivered to the same address. A single shipment can include them all, but that isn’t guaranteed. Corresponds to one or more order delivery group objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description ISO code for the currency of the OrderSummary associated with the OrderDeliveryGroupSummary. The default value is USD. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar This field is available in API version 49.0 and later. | | DeliverToAddress | Type address Properties Filter, Nillable Description Address of the recipient. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | DeliverToCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address city. | | DeliverToCompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | DeliverToCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address country. | | DeliverToFullFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | DeliverToFullLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | DeliverToFullName | Type string Properties Filter, Group, Nillable, Sort Description | | DeliverToFullSalutation | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Possible values are: - Dr. - Mr. - Mrs. - Ms. - Prof. | | DeliverTo​GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy of the geocode for the recipient address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | DeliverToLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with FulfilledToLongitude to specify the precise geolocation of the recipient address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | DeliverToLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with FulfilledToLatitude to specify the precise geolocation of the recipient address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | DeliverToName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name on the recipient address. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | DeliverToPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address postal code. | | DeliverToState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address state. | | DeliverToStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address street. | | DeliveryInstructions | Type textarea Properties Create, Nillable, Update Description Special instructions for the delivery. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the OrderDeliveryGroupSummary. This field can be edited. | | DesiredDeliveryDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Desired date for delivery. This field is informational, available for customizations. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | EmailAddress | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the recipient. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | GiftMessage | Type textarea Properties Create, Nillable, Update Description Gift message to include. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments and tax, of the delivery charges associated with the OrderDeliveryGroupSummary. This value only includes OrderItemSummaries of type code Charge. | | IsGift | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the OrderDeliveryGroupSummary represents a gift. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | OrderDeliveryGroup​SummaryNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the OrderDeliveryGroupSummary. | | OrderDeliveryMethodId | Type reference Properties Filter, Group, Sort Description ID of the order delivery method specified for the OrderDeliveryGroupSummary. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | OrderSummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderSummary associated with the OrderDeliveryGroupSummary. | | OriginalOrderDelivery​GroupId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the original order delivery group associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false. | | PhoneNumber | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the recipient. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | PromisedDeliveryDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Promised date for delivery. This field is informational, available for customizations. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description Total price adjustments applied to delivery charges associated with the OrderDeliveryGroupSummary. This value only includes adjustments to OrderItemSummaries of type code Charge. | | TotalAdjustment​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the delivery charges associated with the OrderDeliveryGroupSummary, inclusive of tax. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount. This field is available in API version 49.0 and later. | | TotalAdjustment​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentAmount. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of the delivery charges associated with the OrderDeliveryGroupSummary. This value only includes adjustments to OrderItemSummaries of type code Charge. | | TotalLineAmount | Type currency Properties Filter, Nillable, Sort Description Total, not including adjustments or tax, of the delivery charges associated with the OrderDeliveryGroupSummary. | | TotalLineAmt​WithTax | Type currency Properties Filter, Nillable, Sort Description Total of the delivery charges associated with the OrderDeliveryGroupSummary, inclusive of tax. This amount is equal to TotalLineAmount + TotalLineTaxAmount. This field is available in API version 49.0 and later. | | TotalLineTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalLineAmount. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAmount. | ## 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. [OrderDeliveryGroupSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. #### See Also - [OrderDeliveryGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderdeliverygroup.htm "A group of order items that share a delivery method and address. The delivery method and address are used during the fulfillment process, such as shipping as a gift, downloading, picking up in store, or shipping to a standard address This object is available in API version 48.0 and later.") - [OrderItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm "Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") # OrderDeliveryMethod Shows the customizations and options that a buyer selected for their delivery method. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | Carrier | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The carrier that the buyer chose for their delivery method. Developers must add values to this field. | | ClassOfService | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The carrier class of service that the buyer chose for their delivery method. Developers must add values to this field. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the delivery method. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Assign new delivery groups to active delivery methods. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Default name of this record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who owns an order delivery method record. | | ProductId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. This product represents a delivery charge order product for a delivery using this delivery method. For example, you could create a product that represents an overnight express charge and assign it to an overnight express delivery method. | | ReferenceNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reference number for an external delivery method. | | ShippingCarrierMethod | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. A specific shipping service provided by a shipping carrier, such as Ground, 2Day, and NextDay. Depends on the range of transit times available for each carrier. | ## 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. [OrderDeliveryMethodChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 62.0) Change events are available for the object. # OrderHistory Represents historical information about changes that have been made to the standard fields of the associated order, or to any custom fields with history tracking enabled. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name of the order field that was modified, or a special value to indicate some other modification to the order. | | NewValue | Type anyType Properties Nillable, Sort Description New value of the modified order field. Maximum of 255 characters. | | OldValue | Type anyType Properties Nillable, Sort Description Previous value of the modified order field. Maximum of 255 characters. | | OrderId | Type reference Properties Filter, Group, Sort Description ID of the order associated with this record. This is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | ## Usage Order history entries are automatically created each time an order is modified. Two rows are added to this record when foreign key fields change. One row contains the foreign key object names that display in the online application. For example, Jane Doe is recorded as the name of a Contact. The other row contains the actual foreign key ID that is only returned to and visible from the API. This object respects field-level security on the parent object. #### See Also - [Order](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_order.htm "Represents an order associated with a contract or an account.") # OrderItem Represents an order product that your organization sells. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules The user must have Edit permission on Order records to create or update order products on an order. The user must have Edit permission on Order records to delete an order product. ## Fields | Field Name | Details | | --- | --- | | AdjustedLineAmount | Type currency Properties Filter, Nillable, Sort Description Line amount following line adjustments, excluding tax. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | AdjustedLineAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Line amount following line adjustments, including tax. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later. | | AggregatedQuantity | Type double Properties Filter, Nillable, Sort Description The quantity of a order item's grouped transaction lines or the products that have been sold and converted to assets. This field is available in API version 64.0 and later. | | AvailableQuantity | Type double Properties Filter, Nillable, Sort Description The amount of an order product that is available to be reduced. Value must be greater than or equal to 0. An order product is reducible only if AvailableQuantity is greater than 0. Value is always 0 if the order product’s parent order is a reduction order. | | BatchIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Identifies a product bundle in a transaction processing batch to ensure that order items from the same bundles are processed together. This field is available in API version 64.0 and later. | | BillingFrequency2 | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time period that indicates how often the order item is billed. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: - Annual - Monthly | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the original Order associated with the OrderItem. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. This field is available in API version 49.0 and later. | | DeliveryEstimationReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique reference ID for the delivery estimation. | | DeliveryEstimationTimeZone | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Time zone in which the estimated delivery times are based. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of this object. For Commerce stores, during checkout, this field is populated with the value of a product name. The product name is copied from the CartItem.Name field of a cart item that corresponds to the OrderItem. | | DoesAutomaticallyRenew | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the order item is set to automatically renew (true) or not (false). This field is available in API version 64.0 and later. | | EarliestEstimatedDeliveryDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Earliest estimated date for the item to be delivered. | | EarliestEstimatedDeliveryTime | Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description Earliest estimated time of the day for the item to be delivered. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. Last day the order product is available. | | EndDateTime | Type datetime Properties Create, Filter, Group, Nillable, Sort, Update Description The end date and time of the order item, derived from the End Date and End Time fields in the time zone specified in the Start and End Time Zone field. If the time zone isn't specified, the default is Coordinated Universal Time (UTC). Label is **End Date Time**. This field is available in Revenue Cloud in API version 65.0 and later. | | EndTime | Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description The end time of the order item. Label is **End Time**. This field is available in Revenue Cloud in API version 65.0 and later. | | GrossUnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description Unit price including tax. This field is a VAT field that includes tax. Salesforce populates it on order creation only when Order.TaxLocaleType has a value of Gross. | | IsOrderItemLocked | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the order item and its children are locked (true) or not (false). Locked order items and their children cannot be modified, added, or deleted. This field is available in API version 63.0 and later. | | LastEstimatedDeliveryDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Latest estimated date for the item to be delivered. | | LastEstimatedDeliveryTime | Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description Latest estimated time of the day for the item to be delivered. | | LineNumber | Type int Properties Create, Filter, Group, Nillable, Sort Description The number used to organize lines on the order. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | ListPrice | Type currency Properties Create, Filter, Nillable, Sort Description List price for the order product. Inherited value from the associated PriceBookEntry upon order product creation. | | ListPriceTotal | Type currency Properties Create, Filter, Nillable, Sort, Update Description The ListPrice times the Quantity. This field is a calculated field. This field is available in API version 55.0 and later. This field is available with Subscription Management. | | NetUnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The unit price after all price adjustments are applied. This field is available in API version 55.0 and later. This field is available with Subscription Management. | | OrderActionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related order action. The order action indicates the type of order; for example, a new sale or a cancellation. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name OrderAction Relationship Type Lookup Refers To OrderAction | | OrderDeliveryGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The delivery group for the order product. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. This field is a relationship field. Relationship Name OrderDeliveryGroup Relationship Type Lookup Refers To OrderDeliveryGroup | | OrderId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the order that this order product is a child of. This field is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | | OrderItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Automatically generated number that identifies the order product. | | OriginalOrderItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Required if isReductionOrder on the parent order is true. ID of the original order product being reduced. This field is a relationship field. Relationship Name OriginalOrderItem Relationship Type Lookup Refers To OrderItem | | PeriodBoundary | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The period boundary helps determine the start and end date of the billing periods. This field is available in API version 55.0 and later. This field is available with Subscription Management and Revenue Cloud. Possible values are: - AlignToCalendar—the period starts on the first day of the term unit; for example, the first day of the month. - Anniversary—The start date determines the boundary. For example, if a monthly subscription starts on September 13, the subscription starts on the 13th day of each month. - DayOfPeriod—the period starts on the day indicated by PeriodBoundaryDay. - LastDayOfPeriod—the period starts on the last day of the pricing term unit; for example, the last day of the month. Keep these considerations in mind for amendment, renewal, and cancellations of assets in Revenue Cloud. - The value of the PeriodBoundary field is copied from the AssetActionSource (initial sale), by default. - For termed selling models where the PeriodBoundary value is Anniversary, the value of the PeriodBoundary field is automatically converted to DayOfPeriod. - Start date adjustment operation on an asset preserves the original value without conversion. | | PeriodBoundaryDay | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Required when PeriodBoundary is DayOfPeriod. Indicates the day of the week or month that marks the period boundary. Must be an integer from 1 through 31. This field is available in API version 55.0 and later. This field is available with Subscription Management and Revenue Cloud. Keep these considerations in mind for amendment, renewal, and cancellations of assets in Revenue Cloud. - The value of the PeriodBoundary field is copied from the AssetActionSource (initial sale), by default. - When PeriodBoundary field value is converted from Anniversary to DayOfPeriod for termed selling models, the value of the PeriodBoundaryDay field is automatically populated with the day value from AssetActionSource.StartDate. - Start date adjustment operation on an asset preserves the original value without conversion. | | PeriodBoundaryStartMonth | Type picklist Properties Create, Filter, Group, Restricted picklist, Nillable, Sort, Update Description The field is populated based on input in the StartDate, PeriodBoundary, and PeriodBoundaryDay when BillingFrequency2 is Annual or by manual user entry. Possible values are: - 1-January - 2-February - 3-March - 4-April - 5-May - 6-June - 7-July - 8-August - 9-September - 10-October - 11-November - 12-December Keep these considerations in mind for amendment, renewal, and cancellations of assets in Revenue Cloud. - The value of the PeriodBoundary field is copied from the AssetActionSource (initial sale), by default. - For termed selling models where PeriodBoundary field value is Anniversary and PricingTermUnit field value is ANNUAL, SEMI\_ANNUAL, or QUARTERLY, the value of the PeriodBoundaryStartMonth field is automatically recalculated by using AssetActionSource.StartDate.month. - Start date adjustment operation on an asset preserves the original value without conversion. | | PricebookEntryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Required. ID of the associated PricebookEntry. Specify this field when creating OrderItem records. It can’t be changed in an update. If you have a B2B Commerce, B2B Commerce Starter, B2B Commerce Growth, or B2B Commerce Plus license, Salesforce users can create orders without price books and order items without price book entries. This field is a relationship field. Relationship Name PricebookEntry Relationship Type Lookup Refers To PricebookEntry | | PriceRevisionPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The price uplift policy associated with this order item. This field is a relationship field. Relationship Name PriceRevisionPolicy Refers To PriceRevisionPolicy Label is **Price Revision Policy**. This field is available in Revenue Cloud in API version 65.0 and later. | | PricingTermCount | Type double Properties Create, Filter, Nillable, Sort, Update Description A calculated field indicating the number of pricing terms in the subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management. | | PricingTransactionType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the type of pricing transaction. For example, a new sale, a cancellation, an amendment, or a renewal. Possible values: - AmendmentAtLastNegotiatedPrice—Calculate the price of the amended order item by using the same price book and price adjustments as the new sale item. For example, an order item that is amended by using a pricing transaction type of AmendmentAtLastNegotiatedPrice is priced by using the same price book information and price adjustments as the new sale item. The amended order item has the same price as the new sale order item. - AmendmentStartingFromListPrice—Calculate the price of the amended order item by using current price book information, disregarding any pricing information or adjustments that were applied to the new sale item. Typically, an amended order item has a different price than the new sale transaction item. - Cancellation—Calculate the price of the canceled transaction. For example, a 1-year subscription purchased on January 1, is canceled on July 31. The price of the canceled products and services from August 1 through Dec 31 is calculated. - NewSale—The price of a new transaction is calculated. - RenewalAtLastNegotiatedPrice—Calculate the price of the order item by using the same price book and price adjustments as the new sale item. For example, an order item that is renewed by using a pricing transaction type of RenewalAtLastNegotiatedPrice is priced by using the same price book information and price adjustments as the new sale item. The renewal order item has the same price as the new sale order item. - RenewalAtListPrice—Calculate the price of the order item by using current price book information, disregarding any pricing information or adjustments that were applied to the new sale item. Typically, a renewal order item has a different price than the new sale order item. This field is available in API version 55.0 and later. This field is available with Subscription Management. | | ProFormaBillingPeriodAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The initial amount for the billing period. The final amount for the billing period can include subsequent amendments, discounts, or charges. This field is available in API version 55.0 and later. This field is available with Subscription Management. | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Product2 associated with this OrderItem. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductSellingModelId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related product selling model. The product selling model defines one method by which a product is sold; for example, as a one-time sale, an evergreen subscription, or a termed subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name ProductSellingModel Relationship Type Lookup Refers To ProductSellingModel | | ProrationPolicyId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related proration policy. The proration policy defines how the price is calculated for each subscription period. For example, whether partial periods are allowed, and how the remainder amounts are handled. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name ProrationPolicy Relationship Type Lookup Refers To ProrationPolicy | | Quantity | Type double Properties Create, Filter, Sort, Update Description Required. Number of units of this order product. | | QuoteLineItemId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the associated quote line item. If this field is specified, the quote line item’s QuoteId must match the QuoteId for the order product’s parent order. | | ReferencePrice | Type currency Properties Create, Filter, Nillable, Sort Description The original or reference price of the order product. This field is available in API version 63.0 and later. | | RelatedChangeIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort Description The identifier used to group all related order items in the same change order. This field is available in API version 63.0 and later. | | RelatedOrderItemID | Type reference Properties Create, Filter, Sort, Group Description Required for change orders, shows the original order product. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | RoundedLineAmount | Type currency Properties Filter, Sort Description The rounded line amount, before tax and adjustments. Currency with decimal values of 0.5 and higher round to the next-highest whole unit of currency. The formula to calculate the rounded line amount is: IF(TotalLineAmount != NULL, TotalLineAmount, Quantity \* UnitPrice) This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | RoundedLineAmtWithTax | Type currency Properties Filter, Nillable, Sort Description The rounded line amount, including tax. Currency with decimal values of 0.5 and higher round to the next-highest whole unit of currency. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later. | | SegmentType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The duration type of the segment. You can use this field from Revenue Cloud only when the **Ramp Deals for Groups in Quotes and Orders** setting is turned on. Valid values are: - Custom—Available in API version 65.0 and later. - Prorated—Available in API version 67.0 and later. - Trial—Available in API version 67.0 and later. - Yearly—Available in API version 65.0 and later. The default value is Yearly. | | ServiceDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Start date for the order product. Label is **Start Date**. | | ServiceDateTime | Type datetime Properties Create, Filter, Group, Nillable, Sort, Update Description The service date and time of the order item, which is derived from the Service Date and Service Time fields in the time zone specified in the Service and End Time Zone field. If the time zone isn't specified, the default is Coordinated Universal Time (UTC). Label is **Service Time**. This field is available in Revenue Cloud in API version 65.0 and later. | | ServiceEndTimeZone | Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the time zone for the order item's service and end dates, times, and datetimes. Label is **Service and End Time Zone**. This field is available in Revenue Cloud in API version 65.0 and later. | | ServiceTime | Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description The service time of the order item. Label is **Service Time**. This field is available in Revenue Cloud in API version 65.0 and later. | | StartingPriceTotal | Type currency Properties Create, Filter, Nillable, Sort, Update Description The starting unit price times the quantity. This field is available in API version 55.0 and later. This field is available with Subscription Management. | | StartingUnitPriceSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the starting unit price was entered manually or calculated. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: - Manual - System | | SupplementalChangeType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the order item change type in the supplemental order. Possible values are: - Add - Amend - Cancel - No Change This field is available in API version 64.0 and later. | | TaxTreatmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related tax treatment. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name TaxTreatment Relationship Type Lookup Refers To TaxTreatment | | TotalAdjustedLineTaxAmount | Type currency Properties Filter, Sort Description Sum of line tax amount and line adjustment tax amounts. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalAdjustmentAmount | Type currency Properties Filter, Sort Description Roll up of the order product’s price adjustments. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalAdjustmentAmtWithTax | Type currency Properties Filter, Sort Description Roll up of the order product’s price adjustments, including tax. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later. | | TotalAdjustmentDistAmount | Type currency Properties Filter, Sort Description Roll up of all adjustments on the order. Used only if the OrderAdjustmentGroup has a Type value of Header. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalAdjustmentDistTaxAmount | Type currency Properties Filter, Sort Description Roll up of all adjustment tax amounts on the order. Used only if the OrderAdjustmentGroup has a Type value of Header. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalAdjustmentDistAmtWithTax | Type currency Properties Filter, Sort Description Roll up of all adjustment tax amounts on the order, including tax. Used only if the OrderAdjustmentGroup has a Type value of Header. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later. | | TotalAdjustmentTaxAmount | Type currency Properties Filter, Sort Description Sum of the order product’s tax adjustments. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Equals TotalPrice + TotalTaxAmount for the order item. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later. | | TotalLineAdjustmentAmount | Type currency Properties Filter, Sort Description The sum of line-level adjustments for the order product. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalLineAdjustmentAmtWithTax | Type currency Properties Filter, Sort Description The sum of line-level adjustments for the order product, including tax. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later. | | TotalLineAdjustmentTaxAmount | Type currency Properties Filter, Sort Description Total tax amount for adjustments made to the order product. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalLineAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The line amount of the order product, before price adjustments, inclusive of quantity, and pricing term count for subscription. The decimal places for this value must match the decimal places for the currency being used. For example, if the currency is the US dollar, the decimal place for TotalLineAmount must be 2. If the currency is the Japanese yen, the decimal place for TotalLineAmount must be 0. TotalLineAmount may only be updated when the order product isn't associated with an active order. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalLineTaxAmount | Type currency Properties Filter, Sort Description Total tax amount for this order product, excluding tax on adjustments. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description Total price for this order product. The calculations for this field’s value are different if Commerce Orders are enabled. Default Value TotalPrice = (UnitPrice \* Quantity) Commerce or Revenue Cloud Orders If TotalLineAmount is null, then TotalPrice = (ROUND(UnitPrice \* Quantity) + TotalAdjustmentAmount. The ROUND(UnitPrice \* Quantity) is stored in the RoundedLineAmount field. Otherwise, TotalPrice = ROUND(TotalLineAmount) + TotalAdjustmentAmount. The ROUND(TotalLineAmount)is also stored in the RoundedLineAmount field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Sort Description Sum of the order product’s tax and any adjustments. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Describes what the order item represents. Each value is associated with one type code, shown here in parentheses. Possible values are: - Delivery Charge (Charge) — A charge, such as a delivery fee. - Fee (Charge) — A charge, such as a return fee. This value is available in API v56.0 and later. - Order Product (Product) — An item that can be ordered. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | TypeCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The category associated with the type. A type code can be associated with one or more types. Possible values are: - Charge - Product This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. | | UnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description Unit price for the order product. | | UnitPriceUplift | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage increase of the order item's unit price. | ## Usage An order can have associated order product records only if the order has a price book associated with it. An order product must correspond to a product that is listed in the order’s price book. Orders with associated OrderItem records are affected. When OrderItem records are directly deleted, they aren’t sent to the recycle bin and can’t be undeleted. The getDeleted() call shows deleted OrderItem records until they’re purged, which is usually within the same day or the next day. ## 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. [OrderItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [OrderItemFeed](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.") (API version 29.0) Feed tracking is available for the object. [OrderItemHistory](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. #### See Also - [Order](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_order.htm "Represents an order associated with a contract or an account.") - [OrderItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm "Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") # OrderItemAdjustmentLineItem An adjustment that has been made to an order item. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AdjustmentAmountScope | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Used with AdjustmentValue to determine the amount of the adjustment. Possible values are: - Total—The adjustment scope is the total price. - Unit—The adjustment scope is the unit price. - UnproratedTotal—The adjustment scope is the unprorated total price. | | AdjustmentBasisReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the specific coupon applied. This is a polymorphic relationship field. Relationship Name AdjustmentBasisReference Relationship Type Lookup Refers To Coupon This field is available in API version 54.0 and later. | | AdjustmentCauseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the specific promotions applied. This is a polymorphic relationship field. Relationship Name AdjustmentCause Relationship Type Lookup Refers To Promotion This field is available in API version 52.0 and later. | | AdjustmentSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the origin of the adjustment. Possible values are: - Discretionary—The adjustment originates from a decision made by an individual, for example, a manager’s discount granted to a client. - Promotion—The adjustment originates from a promotion, for example, a holiday sale discount. - Rule—Reserved for future use. - System—The adjustment originates from the system, for example, a volume discount after the amount of items reaches a specific number. This field is available in API version 57.0 and later. | | AdjustmentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the type of mathematical adjustment to be applied to the order. Possible values are: - AdjustmentAmount—The adjustment is a numerical amount, for example, a cash discount of 20. - AdjustmentPercentage—The adjustment is a percentage amount, for example, a 10% discount. - OverrideAmount—The adjustment is a manual price override. This field is available in API version 57.0 and later. | | AdjustmentValue | Type double Properties Create, Filter, Nillable, Sort, Update Description The specified AdjustmentType’s amount to be applied to the order item. For example, when the AdjustmentType value is AdjustmentAmount, the AdjustmentValue is expected to equal the value of the Amount field. When the AdjustmentType value is AdjustmentPercentage, the AdjustmentValue represents the percentage number, and the Amount field’s value will show the calculated adjustment amount. This field is available in API version 57.0 and later. | | Amount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The net total value of the adjustment line. The value is rounded to the nearest possible amount associated with the currency of the order item. | | AppliedPromotionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time on which the promotion was applied to the asset. | | CouponCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the coupon code that was applied. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. Default value is USD. Possible values are: - USD—U.S. Dollar | | Description | Type textarea Properties Create, Nillable, Update Description Users can add a custom description to the record to provide additional detail. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the adjustment line. | | OrderAdjustmentGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order adjustment group that contains the order item adjustment line item. | | OrderId | Type reference Properties Filter, Group, Nillable, Sort Description The parent order of the order item related to the adjustment line. | | OrderItemId | Type reference Properties Create, Filter, Group, Sort Description The order item that the adjustment line applies to. | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort Description A numeric value that represents the order of precedence of the order adjustment group. It can also represent the order of precedence when applying the AdjustmentType values. For example, an order can have two adjustments: a $100 discount and a 10% discount. This field will tell the pricing engine which adjustment needs to be applied first. This field is available in API version 57.0 and later. | | RelatedAdjustmentLineItemId | Type reference Properties Filter, Group, Nillable, Sort Description The original order item adjustment line. Useful for reference in change order scenarios. | | TotalAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Equals the order item’s price plus TotalTaxAmount for the order item adjustment line item. This is a gross tax field. To access Commerce Orders fields, your org must have a Salesforce Order Management license. Commerce Orders fields are available only in Lightning Experience. This field is available in API v49.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description The total amount of tax applied to the adjustment line. | # OrderItemAdjustmentLineSummary Represents the current properties and state of price adjustments on an OrderItemSummary. Corresponds to one or more order item adjustment line item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentBasisReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the specific coupon applied. This is a polymorphic relationship field. Relationship Name AdjustmentBasisReference Relationship Type Lookup Refers To Coupon This field is available in API version 54.0 and later. | | AdjustmentCauseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the specific promotions applied. This is a polymorphic relationship field. Relationship Name AdjustmentCause Relationship Type Lookup Refers To Promotion This field is available in API version 52.0 and later. | | Amount | Type currency Properties Filter, Sort Description Amount, not including tax, of the OrderItemAdjustmentLineSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description ISO code for the currency of the OrderItemSummary to which the adjustment applies. The default value is USD. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar This field is available in API version 49.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the OrderItemAdjustmentLineSummary. This field can be edited. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderItemAdjustmentLineSummary. | | OrderAdjustmentGroup​SummaryId | Type reference Properties Filter, Group, Nillable, Sort Description If this object belongs to an OrderAdjustmentGroupSummary, this value is the ID of that OrderAdjustmentGroupSummary. | | OrderItemSummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderItemSummary to which the OrderItemAdjustmentLineSummary applies. | | OrderSummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderSummary associated with the OrderItemSummary to which this OrderItemAdjustmentLineSummary applies. | | OriginalOrderItem​AdjustmentLineItemId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the original OrderItemAdjustmentLine associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false. | | Priority | Type integer Properties Create, Nillable Description Numerical rank used to apply promotions in the correct order. This field is available in API version 52.0 and later. | | TotalAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the adjustment, inclusive of tax. This amount is equal to Amount + TotalTaxAmount. This field is available in API version 49.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the Amount. | #### See Also - [OrderItemAdjustmentLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemadjustmentlineitem.htm "An adjustment that has been made to an order item. This object is available in API version 48.0 and later.") - [OrderItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm "Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") - [OrderItemTaxLineItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemtaxlineitemsummary.htm "Represents the current tax on an OrderItemSummary or OrderItemAdjustmentLineSummary. Corresponds to one or more order item tax line items, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") # OrderItemGroup Stores the group information for line items in an order. It also stores the aggregated line field information (subtotal). It contains a parent-child relationship to order. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the group. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for future use. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the group. | | OrderId | Type reference Properties Create, Filter, Group, Sort Description ID of the order that this order product is a child of. This field is a relationship field. Relationship Name Order Relationship Type Master-detail Refers To Order (the master object) | | SegmentType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The duration type of the segment. You can use this field from Revenue Cloud only when the **Ramp Deals for Groups in Quotes and Orders** setting is turned on. Valid values are: - Custom—Available in API version 65.0 and later. - Prorated—Available in API version 67.0 and later. - Trial—Available in API version 67.0 and later. - Yearly—Available in API version 65.0 and later. The default value is Yearly. | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number indicating the sort order selected by the user. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for future use. | | SummarySubtotal | Type currency Properties Create, Filter, Nillable, Sort, Update Description The total amount of all the line items in the group. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the group. Possible values are: - CPQOrderGroup—CPQ Line Grouping The default value is CPQOrderGroup. | | UnitPriceUplift | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage increase of the order item group's unit price. | # OrderItemRecipient Represents a site, employee, or other entity for which services are being ordered. This includes essential details such as the recipient's name, contact information, and the specific site or location where the services will be provided. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BroadbandConnectionType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the broadband connection that's available at the address. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | MaxDownloadSpeed | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum download speed available at the address. | | MaxUploadSpeed | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum upload speed available at the address. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the customer's site or location. | | OrderId | Type reference Properties Create, Filter, Group, Sort Description The order associated with the recipient. This field is a relationship field. Relationship Name Order Relationship Type Master-detail Refers To Order (the master object) | | RecipientType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of recipient of the order. Possible values are: - Location - Subscriber The default value is Location. | | ServiceAddrValidationDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the address was validated. | | Service Account | Type entityid Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to the Account Entity where the product is used, serviced, or installed. | | ServiceAddrValidationMsg | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The message sent after the validation of the address. | | ServiceAddrValidationResult | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the status of the address validation. Possible values are: - Fail - Partial Success - Success The default value is Success. | | ServiceAddress | Type address Properties Filter Description The address where the recipient receives the order. | | ServiceCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where the recipient receives the order. | | ServiceCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the recipient receives the order. | | ServiceGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the accuracy level of the geocoded address coordinates. Possible values are: - Address - Block - City - County - ExtendedZip—Extended Zip - NearAddress—Near Address - Neighborhood - State - Street - Unknown - Zip | | ServiceLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude of the location where the recipient receives the order. | | ServiceLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude of the location where the recipient receives the order. | | ServicePostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address. | | ServiceState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the recipient receives the order. | | ServiceStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street where the recipient receives the order | | ServiceabilityCheckDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the serviceability check was done. | | ServiceabilityData | Type textarea Properties Create, Nillable, Update Description The information about serviciability, such as broadband connection, download, and upload speeds available at the address. | ## 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. [OrderItemRecipientChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [OrderItemRecipientFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [OrderItemRecipientHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [OrderItemRecipientOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [OrderItemRecipientShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # OrderItemRelationship Describes a relationship between order products. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available when Subscription Management or Revenue Cloud is enabled. ## Fields | Field | Details | | --- | --- | | AssociatedOrderItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The unique identifier of the associated order product. This field is a relationship field. In a bundle relationship, this order product is the bundle component. Relationship Name AssociatedOrderItem Relationship Type Lookup Refers To OrderItem | | AssociatedOrderItemInventory | Type picklist Properties Create, Filter, Group, Nillable, Sort Description A static enum that describes the associated order item inventory in the OrderItemSummaryRelationship. Possible values are: - IncludedInMainInventory—The child product’s inventory is included in the main inventory. - NotIncludedInMainInventory—The child product’s inventory isn’t included in the main inventory. Relationship Name AssociatedOrderItemInventory | | AssociatedOrderItemPricing | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how the associated order product is priced relative to the main order product. The value is informative; the system doesn’t check whether the associated order product is included in the bundle price. Possible values are: - IncludedInBundlePrice—The associated order product’s cost is $0 because it’s included in the bundle’s price. - NotIncludedInBundlePrice—The associated order product has a cost because it’s not included in the bundle’s price. | | AssociatedOrderItemRole | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes the position of the associated order product in the relationship. Possible values are: - BundleComponent—The associated order product is part of a bundle. - SetComponent—The associated order product is part of a set. | | AssociatedQuantScaleMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description How the quantity of the associated order product scales, relative to the main order product. The value is informative; the system doesn’t check whether the scaled quantities are correct. Possible values are: - Constant— The associated order’s product quantity remains the same in relation to the main order product’s quantity. For example, the main order product has a quantity of one and the associated order product has a quantity of one. - Proportional— The associated order’s product quantity increases or decreases based on the main order product’s quantity. For example, the main order product has a quantity of one and the associated order product has a quantity of two. In other words, there are two associated order products for every one main order product. The default value is Proportional. | | IsPriceInclusive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether child products are included in the root bundle price. If set to true, the price of each child product is zero. The default value is false. | | MainOrderItemId | Type reference Properties Create, Filter, Group, Sort Description The main order product’s unique identifier. This field is a relationship field. In a bundle relationship, this order product is the bundle parent. Relationship Name MainOrderItem Relationship Type Lookup Refers To OrderItem | | MainOrderItemRole | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the role of the main order product in the relationship. Possible values are: - Bundle— The main order product is the bundle parent. - Set— The main order product is the set parent. Subscription Management doesn’t support the Set value. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the order product relationship. | | OrderId | Type reference Properties Filter, Group, Nillable, Sort Description The unique identifier of the related order. This field is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | | ProductRelationshipTypeId | Type reference Properties Create, Filter, Group, Sort Description The unique identifier of the record that describes the relationship between the main and associated order products. This field is a relationship field. Relationship Name ProductRelationshipType Relationship Type Lookup Refers To ProductRelationshipType | | RootOrderItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The root order item for the order item relationship. In a bundle relationship, the root order item is the root bundle. This field is a relationship field. Relationship Name RootOrderItem Refers To OrderItem | ## 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. [OrderItemRelationshipFeed](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. [OrderItemRelationshipHistory](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. # OrderItemSummary Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustedLineAmount | Type currency Properties Filter, Nillable, Sort Description Total, including line adjustments but not order-lever adjustments or tax, of the OrderItemSummary. This is a calculated field. | | AdjustedLineAmt​WithTax | Type currency Properties Filter, Nillable, Sort Description Total price of the OrderItemSummary, inclusive of adjustments and tax. This amount is equal to AdjustedLineAmount + TotalAdjustedLineTaxAmount. This is a calculated field. This field is available in API version 49.0 and later. | | AssetId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated asset. This field is available in API version 60.0 and later. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. ISO code for the currency of the OrderSummary associated with the OrderItemSummary. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. This field is available in API version 49.0 and later. | | DeliveryEstimationReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique reference ID for the delivery estimation. | | DeliveryEstimationTimeZone | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Timezone in which the estimated delivery times are based. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the OrderItemSummary. This field can be edited. | | EarliestEstimatedDeliveryDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Earliest date when the item is estimated to be delivered. | | EarliestEstimatedDeliveryTime | Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description Earliest time of the day when the item is estimated to be delivered. | | EndDate | Type date Properties Filter, Group, Nillable, Sort Description End date of the OrderItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | GrossUnitPrice | Type currency Properties Filter, Nillable, Sort Description Unit price, including tax, of the OrderItemSummary. This value is equal to UnitPrice + the amount of tax on the UnitPrice. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. This field is available in API version 49.0 and later. | | LastEstimatedDeliveryDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Latest date when the item is estimated to be delivered. | | LastEstimatedDeliveryTime | Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description Latest time of the day when the item is estimated to be delivered. | | LineNumber | Type int Properties Filter, Group, Nillable, Sort Description The order line number assigned to this OrderItemSummary. For example, if this object is the third in the displayed list of OrderItemSummaries belonging to the OrderSummary, this value is 3. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | ListPrice | Type currency Properties Filter, Nillable, Sort Description List price of the product represented by this OrderItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | MainOrderItemSummaryId | Type reference Properties Create, Filter, Group, Sort Description The primary order item summary ID of this order item summary. This field is a relationship field. Relationship Name MainOrderItemSummary Relationship Type Master-detail Refers To OrderItemSummary (the master object) | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderItemSummary. | | OrderDeliveryGroup​SummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderDeliveryGroupSummary to which this object belongs. This field is a relationship field. Relationship Name OrderDeliveryGroupSummary Relationship Type Lookup Refers To OrderDeliveryGroupSummary | | OrderManagementBillingType | Type enum Properties Filter, Restricted Picklist, Sort Description The type of entitlement, either PPO or GMV, that is used to track Order Summary usage. | | OrderSummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderSummary to which this object belongs. This field is a relationship field. Relationship Name OrderSummary Relationship Type Lookup Refers To OrderSummary | | OriginalOrderItemId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the original order item associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false. This field is a relationship field. Relationship Name OriginalOrderItem Relationship Type Lookup Refers To OrderItem | | PricebookEntryId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the pricebook entry associated with this OrderItemSummary. This field is available in API version 54.0 and later. This field is a relationship field. Relationship Name PricebookEntry Relationship Type Lookup Refers To PricebookEntry | | Product2Id | Type reference Properties Filter, Group, Sort Description ID of the product represented by this OrderItemSummary. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductCode | Type string Properties Filter, Group, Nillable, Sort Description Product code of the product represented by this OrderItemSummary. | | Quantity | Type double Properties Filter, Sort Description Current total quantity of products represented by this order item summary. Equal to QuantityOrdered minus (QuantityCanceled and QuantityReturned). If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | QuantityAllocated | Type double Properties Filter, Sort Description Allocated quantity on this order item summary. This quantity is associated with one or more FulfillmentOrderLineItems. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | QuantityAvailable​ToCancel | Type double Properties Filter, Nillable, Sort Description Quantity that can still be canceled on this OrderItemSummary. Equal to QuantityOrdered minus (QuantityCanceled and QuantityAllocated). This value duplicates QuantityAvailableToFulfill. This is a calculated field. | | QuantityAvailable​ToFulfill | Type double Properties Filter, Nillable, Sort Description Quantity available to be fulfilled on this OrderItemSummary. Equal to QuantityOrdered minus (QuantityCanceled and QuantityAllocated). This value duplicates QuantityAvailableToCancel. This is a calculated field. | | QuantityAvailable​ToReship | Type double Properties Filter, Nillable, Sort Description Quantity available to be reshipped on this OrderItemSummary. Equal to QuantityFulfilled minus (QuantityReshipped and QuantityReturnInitiated). This field is available in API version 53.0 and later. This is a calculated field. | | QuantityAvailable​ToReturn | Type double Properties Filter, Nillable, Sort Description Quantity available to be returned on this OrderItemSummary. Equal to QuantityFulfilled minus QuantityReturnInitiated. This is a calculated field. | | QuantityCanceled | Type double Properties Filter, Sort Description Canceled quantity on this OrderItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | QuantityFulfilled | Type double Properties Filter, Sort Description Fulfilled quantity on this OrderItemSummary. This quantity can no longer be canceled. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | QuantityNetOrdered | Type double Properties Filter, Nillable, Sort Description Quantity available to be allocated on this OrderItemSummary. Equal to QuantityOrdered minus QuantityCanceled. | | QuantityOrdered | Type double Properties Filter, Sort Description Ordered quantity on this OrderItemSummary. It includes the originally ordered quantity plus any quantity added to the order later. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | QuantityReshipped | Type double Properties Filter, Nillable, Sort Description Reshipped quantity on this OrderItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. This field is available in API version 53.0 and later. | | QuantityReturned | Type double Properties Filter, Sort Description Returned quantity on this OrderItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | QuantityReturnInitiated | Type double Properties Filter, Sort Description Quantity returned or pending return on this OrderItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | QuantityShipped | Type double Properties Create, Filter, Nillable, Sort, Update Description Quantity shipped on this OrderItemSummary. This field is available in API version 52.0 and later. | | ReferencePrice | Type currency Properties Create, Filter, Nillable, Sort Description The original or reference price of the order product. This field is available in API version 63.0 and later. | | ReservedAtLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for future use. | | ServiceDate | Type date Properties Filter, Group, Nillable, Sort Description Service or start date of the OrderItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Status of the OrderItemSummary. The default value is ORDERED. When a quantity value changes, each status formula is evaluated in order. If a formula is true, no more evaluations are performed for that change. Possible values and their formulas, in the order of evaluation, are: - RETURNINITIATED—Return Initiated — (Quantity > 0) & (QuantityReturnInitiated = QuantityFulfilled) & (QuantityReturned < QuantityReturnInitiated) - RESHIPPED—Reshipped — (QuantityReshipped = QuantityFullfilled) & (QuantityFullfilled > 0) & (QuantityReturnInitiated = 0) & (QuantityFulfilled = QuantityOrdered) - RETURNED—Returned — (Quantity = 0) & (QuantityReturned > 0) - CANCELED—Canceled — (Quantity = 0) & (QuantityCancelled > 0) & (QuantityReturned = 0) - FULFILLED—Fulfilled — (Quantity > 0) & ((QuantityOrdered - QuantityCancelled) <= QuantityFulfilled) - PARTIALLYFULFILLED—Partially Fulfilled — (QuantityFulfilled > 0) & (QuantityFulfilled < (QuantityOrdered - QuantityCancelled)) - ALLOCATED—Allocated — (Quantity > 0) & (Quantity <= QuantityAllocated) - PARTIALLYALLOCATED—Partially Allocated — (QuantityAllocated > 0) & (QuantityAllocated < Quantity) - ORDERED—Ordered — None of the other formulas apply - PAID—Paid — N/A | | StockKeepingUnit | Type string Properties Filter, Group, Nillable, Sort Description The stock keeping unit (SKU) of the Product2 associated with the OrderItemSummary. This field is available in API version 49.0 and later. | | TaxTreatmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related tax treatment. This field is available in API version 63.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name TaxTreatment Relationship Type Lookup Refers To TaxTreatment | | TotalAdjusted​LineTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the AdjustedLineAmount. This is a calculated field. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description Total of all price adjustments applied to this OrderItemSummary. This is a calculated field. | | TotalAdjustment​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of all price adjustments applied to this OrderItemSummary, inclusive of tax. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount. This field is available in API version 49.0 and later. This is a calculated field. | | TotalAdjustmentDistAmount | Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to this OrderItemSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. This is a calculated field. | | TotalAdjustmentDist​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the order-level price adjustments applied to this OrderItemSummary, inclusive of tax. This amount is equal to TotalAdjustmentDistAmount + TotalAdjustmentDistTaxAmount. This field is available in API version 49.0 and later. This is a calculated field. | | TotalAdjustmentDist​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentDistAmount. This is a calculated field. | | TotalAdjustmentTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentAmount. This is a calculated field. | | TotalAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total price of the OrderItemSummary, inclusive of tax. This amount is equal to TotalPrice + TotalTaxAmount. This field is available in API version 49.0 and later. This is a calculated field. | | TotalLineAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description Total of all non-order-level price adjustments applied to this OrderItemSummary. This value includes OrderItemAdjustmentLineSummaries that don’t belong to an OrderAdjustmentGroupSummary, or that belong to an OrderAdjustmentGroupSummary of type SplitLine. This is a calculated field. | | TotalLineAdjustment​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total of all non-order-level price adjustments applied to this OrderItemSummary, inclusive of tax. This amount is equal to TotalLineAdjustmentAmount + TotalLineAdjustmentTaxAmount. This field is available in API version 49.0 and later. This is a calculated field. | | TotalLineAdjustment​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalLineAdjustmentAmount. This is a calculated field. | | TotalLineAmount | Type currency Properties Filter, Nillable, Sort Description Total, not including adjustments or tax, of the OrderItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | TotalLineAmount​WithTax | Type currency Properties Filter, Nillable, Sort Description Total unadjusted amount of the OrderItemSummary, inclusive of tax. This amount is equal to TotalLineAmount + TotalLineTaxAmount. This field is available in API version 49.0 and later. This is a calculated field. | | TotalLineTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalLineAmount. This is a calculated field. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description Total, including line and order-level adjustments but not tax, of the OrderItemSummary. This is a calculated field. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalPrice. This is a calculated field. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of the OrderItemSummary. Delivery Charge indicates that the OrderItemSummary represents a delivery charge. Fee indicates that it represents another type of fee, such as a return fee. Order Product indicates that it represents any other type of product, service, or charge. Each type corresponds to one type code, shown here in parentheses. Possible values are: - Delivery Charge (Charge) - Fee (Charge) This value is available in API v56.0 and later. - Order Product (Product) If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | TypeCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type code of the OrderItemSummary. Charge indicates that the OrderItemSummary represents a charge or fee. Product indicates that it represents any other type of product, service, or charge. A type code can be associated with one or more types. Possible values are: - Charge - Product If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | UnitPrice | Type currency Properties Filter, Nillable, Sort Description Unit price of the product represented by the OrderItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | ## 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. [OrderItemSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. #### See Also - [FulfillmentOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderlineitem.htm "Represents a product or delivery charge belonging to a FulfillmentOrder. Corresponds to an OrderItemSummary. This object is available in API version 48.0 and later.") - [OrderItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitem.htm "Represents an order product that your organization sells.") - [OrderItemAdjustmentLineSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemadjustmentlinesummary.htm "Represents the current properties and state of price adjustments on an OrderItemSummary. Corresponds to one or more order item adjustment line item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") - [OrderItemTaxLineItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemtaxlineitemsummary.htm "Represents the current tax on an OrderItemSummary or OrderItemAdjustmentLineSummary. Corresponds to one or more order item tax line items, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") - [OrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm "Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") # OrderItemSummaryChange Represents a change to an OrderItemSummary, usually a reduction in quantity due to a cancel or return. Corresponds to a change order item. This object is available in API version 48.0 and later. This object is used for calculations and doesn’t have a default record page. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is only available in Salesforce Order Management orgs. ## Fields | Field | Details | | --- | --- | | ChangeOrderItemId | Type reference Properties Filter, Group, Sort Description ID of the associated change order item. | | ChangeType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Type of change represented by the OrderItemSummaryChange. Possible values are: - Add - AddTax - Cancel - CancelFee - DeliveryChargeAdjustment - FeeAdjustment - Modify - OrderAdjustmentGroup - OrderDeliveryGroup - ProductAdjustment - Return - ReturnFee | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description ISO code for the currency of the OrderSummary associated with the OrderItemSummaryChange. The default value is USD. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar This field is available in API version 49.0 and later. | | IsPreFulfillment | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the change occurs before the OrderItemSummary has been fulfilled. | | OrderItemSummary​ChangeNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the OrderItemSummaryChange. | | OrderItemSummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderItemSummary to which the change applies. | | OrderSummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderSummary to which the associated OrderItemSummary belongs. | | Reason | Type picklist Properties Defaulted on create, Filter, Group, Sort Description Reason for the change. You can customize this list. The list has one default value: - Unknown | | ReasonText | Type string Properties Filter, Group, Sort Description Details about the reason for change. | ## 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. [OrderItemSummaryChangeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. #### See Also - [OrderItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitem.htm "Represents an order product that your organization sells.") - [OrderItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm "Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") # OrderItemSummaryRelationship Junction object used to track how an original order summary (created before any exchanges have occurred) relates to other order summary objects in a chain of exchange orders. This object is available in API version 60.0 and later. An exchange order is an OrderSummary object whose SourceProcess property is set to Exchange. An original order summary can have an exchange order, which in turn can have yet another exchange order, and so on. The OrderSummaryRelationship object maintains this relationship between OrderSummary objects. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssociatedOrderItemInventory | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Controls whether the inventory of the associated order item is included in the inventory of the main order item. Possible values are: - IncludedInMainInventory—Included in Main Inventory - NotIncludedInMainInventory—Not Included in Main Inventory | | AssociatedOrderItemSumPricing | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description An enum that describes how the related order item summary is priced relative to the primary order item summary. Possible values are: - IncludedInBundlePrice—Included in Bundle Price - NotIncludedInBundlePrice—Not Included in Bundle Price | | AssociatedOrderItemSummaryId | Type reference Properties Create, Filter, Group, Sort Description The related order item summary of this order item summary relationship. For bundle relationships, this denotes the ID of the child order item summary. This field is a relationship field. Relationship Name AssociatedOrderItemSummary Refers To OrderItemSummary | | AssociatedOrderItemSummaryRole | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The role of the associated order item summary of this relationship. Possible values are: - AddOnComponent—Addon Component - BundleComponent—Bundle Component - ClassificationComponent—Product Classification Component - SetComponent—Set Component | | AssociatedQuanScaleMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description An enum that describes how to scale the quantity of the associated order item summary relative to the main order item summary. Possible values are: - Constant - Proportional The default value is Proportional. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency of the OrderSummary. Possible values are: - USD—U.S. Dollar The default value is USD. | | MainOrderItemSummaryId | Type reference Properties Create, Filter, Group, Sort Description The primary order item summary ID of this order item summary relationship. This field is a relationship field. Relationship Name MainOrderItemSummary Relationship Type Master-detail Refers To OrderItemSummary (the master object) | | MainOrderItemSummaryRole | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The role of the primary order item summary of this relationship. Possible values are: - AddOn—Addon Parent - Bundle—Bundle Parent - Set—Set Parent | | MainOrderSummaryId | Type reference Properties Create, Filter, Group, Sort Description The ID of the main order item summary. This field is a relationship field. Relationship Name MainOrderSummary Refers To OrderSummary | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the relationship. | | OrderItemRelationshipId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The order summary ID of the order item summary. This field is a relationship field. Relationship Name OrderItemRelationship Refers To OrderItemRelationship | | ProductRelatedComponentId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The lookup ID from the product related component. This field is a relationship field. Relationship Name ProductRelatedComponent Refers To ProductRelatedComponent | | ProductRelationshipTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The lookup from the product relationship type. This field is a relationship field. Relationship Name ProductRelationshipType Refers To ProductRelationshipType | # OrderItemTaxLineItem The tax amount that has been applied to an order item. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort, Update Description The total amount of the tax line. The value is rounded to the nearest possible amount associated with the currency of the order item. | | CalculationReferenceNumber | Type string Properties Create, Filter, Group, Nillable, Sort Description Reference number provided by the tax provider, such as Stripe, in the tax calculation API response. This field is available in API version 62.0. | | Description | Type textarea Properties Create, Nillable, Update Description Users can add a custom description to the record to provide additional detail. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the tax line. | | OrderId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the parent order for the order item related to the tax line | | OrderItemAdjustmentLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order item adjustment line item that the tax line applies to. | | OrderItemId | Type reference Properties Create, Filter, Group, Sort Description The order item that the tax line applies to. | | Rate | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage value of the tax. Null if the tax is a flat amount. | | ReferenceNumber | Type string Properties Create, Filter, Group, Nillable, Sort Description Reference number provided by the tax provider (like Stripe) for each line item in the tax calculation API call. Use this unique ID to revert taxes during cancellation or return of an order. This field is available in API version 62.0. | | RelatedTaxLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The original order item tax line. Useful for reference in change order scenarios. | | TaxEffectiveDate | Type date Properties Create, Filter, Group, Sort, Update Description The date used to calculate the effective tax rate. This field may require an update to accommodate different buyer time zones. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Shows whether the amount on the tax line is an estimate or the final calculated amount. Doesn’t set a value by default. Users can define automation to set and change the value as needed. Possible values are: - Actual - Estimated | # OrderItemTaxLineItemSummary Represents the current tax on an OrderItemSummary or OrderItemAdjustmentLineSummary. Corresponds to one or more order item tax line items, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Filter, Sort Description Amount of tax represented by the OrderItemTaxLineItemSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | CalculationReferenceNumber | Type string Properties Filter, Group, Nillable, Sort Description Reference number provided by the tax provider, such as Stripe, in the tax calculation API response. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description ISO code for the currency of the OrderSummary associated with the OrderItemTaxLineItemSummary. The default value is USD. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar This field is available in API version 49.0 and later. | | Description | Type textarea Properties Nillable, Update Description Description of the OrderItemTaxLineItemSummary. This field can be edited. | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description Name of the OrderItemTaxLineItemSummary. | | OrderItemAdjustmentLine​SummaryId | Type reference Properties Filter, Group, Nillable, Sort Description If this object represents tax on an adjustment, this value is the ID of the OrderItemAdjustmentLineSummary to which the tax applies. If this value is null, the adjustment applies to an OrderItemSummary. | | OrderItemSummaryId | Type reference Properties Filter, Group, Sort Description If this object represents tax on an OrderItemSummary, this value is the ID of that OrderItemSummary. If this object represents tax on an adjustment, this value is the ID of the OrderItemSummary to which the adjustment applies. | | OrderSummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderSummary that the associated OrderItemSummary or OrderItemAdjustmentLineSummary belongs to. | | OriginalOrderItemTax​LineItemId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the original order item tax line item associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false. | | Rate | Type percent Properties Filter, Nillable, Sort Description Tax rate used to calculate the Amount. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | ReferenceNumber | Type string Properties Filter, Group, Nillable, Sort Description Reference number provided by the tax provider (like Stripe) for each line item in the tax calculation API call. Use this unique ID to revert taxes during cancellation or return of an order. | | TaxEffectiveDate | Type date Properties Filter, Group, Sort Description Date on which the Amount was calculated. Important due to tax rate changes over time. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | TransactionReferenceNumber | Type string Properties Filter, Group, Nillable, Sort, Update Description **Reference number provided by the tax provider, such as Stripe, in the tax transaction commit API request.** | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates whether the Amount is actual or estimated. Possible values are: - Actual - Estimated If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | ## 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. [OrderItemTaxLineItemSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. #### See Also - [FulfillmentOrderItemTax](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderitemtax.htm "Represents the tax on a FulfillmentOrderLineItem or FulfillmentOrderItemAdjustment. Corresponds to an OrderItemTaxLineItemSummary. This object is available in API version 48.0 and later.") - [OrderItemAdjustmentLineSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemadjustmentlinesummary.htm "Represents the current properties and state of price adjustments on an OrderItemSummary. Corresponds to one or more order item adjustment line item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") - [OrderItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm "Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") - [OrderItemTaxLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemtaxlineitem.htm "The tax amount that has been applied to an order item. This object is available in API version 48.0 and later.") # OrderItemType Shows whether the order product is a product line or charge line. This object is available in API version 48.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an id or primary label. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default order item type status value (true) or not (false) in the picklist. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Master label for this order item type status value. This display value is the internal label that doesn’t get translated. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the order item status picklist. These numbers aren’t guaranteed to be sequential, as some previous contract status values might have been deleted. | | TypeCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Code indicating the type of order item. Possible values are: - Charge—API Name DeliveryCharge. - Product—For API Name Product. | # OrderOwnerSharingRule Represents a rule which determines order sharing access for the order’s owners. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## 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 | | --- | --- | | CreatedById | Type reference Properties Defaulted on create, Filter, Group, Sort Description ID of the creator of the order owner sharing rule. | | CreatedDate | Type dateTime Properties Defaulted on create, Filter, Sort Description Date when the order owner sharing rule was created. | | Description | Type string Properties Create, Filter, Nillable, Sort, Update Description Description of the order owner sharing rule. Maximum length is 1,000 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the developer of the order owner sharing rule. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the group whose orders are shared. | | Id | Type ID Properties Defaulted on create, Filter, Group, idLookup, Sort Description ID of the order owner sharing rule. | | LastModifiedById | Type reference Properties Defaulted on create, Filter, Group, Sort Description ID of the user who last modified the order owner sharing rule. | | LastModifiedDate | Type dateTime Properties Defaulted on create, Filter, Sort Description Date when the order owner sharing rule was last modified. | | Name | Type string Properties Create, Filter, Group, idLookup, Namefield, Sort, Update Description Name of the order owner sharing rule. Maximum length is 80 characters. | | OrderAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Access level for the order owner sharing rule. | | SystemModstamp | Type dateTime Properties Defaulted on create, Filter, Sort Description System modification time for the order owner sharing rule. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the user or group with whom order access is shared. | ## Usage Use this object to manage the sharing rules for orders. For example, the following code creates an order owner sharing rule between two public groups, which can also contain portal users. OrderOwnerSharingRule rule = new OrderOwnerSharingRule(); rule.setName("RuleName"); // Set the sharing rule name rule.setDeveloperName("RuleDeveloperName"); // Set the sharing rule developer name rule.setGroupId("00Gx00000000000"); // Set the group of users to share records from rule.setUserOrGroupId("00Gx00000000001"); // Set the group of users to share records to rule.setOrderAccessLevel("Edit"); connection.create(rule); #### See Also - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") # OrderPaymentSummary Represents the current properties and state of payments using a single payment method that are applied to one OrderSummary. This object is available in API version 48.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. Unlike most summary objects, an OrderPaymentSummary isn’t related to a similarly named order payment object. Instead, it combines values from multiple payment objects that use the same payment method and apply to the same OrderSummary. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AuthorizationAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that has been authorized. | | AuthorizationReversal​Amount | Type currency Properties Filter, Nillable, Sort Description Amount of the AuthorizationAmount that has been reversed. | | AvailableToCaptureAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that’s available to be captured. Equal to AuthorizationAmount minus (CapturedAmount and PendingCaptureAmount and AuthorizationReversalAmount and PendingReverseAuthAmount). However, if the calculated amount is a negative number, this value is 0. | | AvailableToRefundAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that’s available to be refunded. Equal to CapturedAmount plus PendingCaptureAmount minus (RefundedAmount and PendingRefundAmount). However, if the calculated amount is a negative number, this value is 0. | | BalanceAmount | Type currency Properties Filter, Nillable, Sort Description Total balance of all payments associated with this summary object. | | CapturedAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that has been captured. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the OrderSummary associated with the OrderPaymentSummary. Order Management APIs and actions that create an OrderPaymentSummary for an OrderSummary set this value. The default value is USD. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar This field is available in API version 49.0 and later. | | FullName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The full name of the payment method user. | | LastPaymentGateway​LogId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the most recent payment gateway log associated with the OrderPaymentSummary. | | LastPaymentGateway​Message | Type string Properties Create, Filter, Nillable, Sort, Update Description The most recent message received from the payment gateway associated with the OrderPaymentSummary. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the current user last viewed a record related to this record. This field is available in API version 49.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the current user last viewed this record. A null value can mean that this record was only referenced (LastReferencedDate) and not viewed. This field is available in API version 49.0 and later. | | Method | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderPaymentSummary. | | OrderSummaryId | Type reference Properties Create, Filter, Group, Sort Description ID of the OrderSummary associated with the OrderPaymentSummary. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who currently owns this OrderPaymentSummary. Default value is the user logged in to the API to perform the create. | | PaymentCreditedAmount | Type currency Properties Filter, Nillable, Sort Description Total amount of credit associated with this OrderPaymentSummary. This field is available in API version 65.0 and later. | | PaymentMethodId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the payment method associated with this OrderPaymentSummary. | | PendingAuthorization​Amount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that’s pending authorization. | | PendingCaptureAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that’s pending capture. | | PendingRefundAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that’s pending refund. | | PendingReverseAuth​Amount | Type currency Properties Filter, Nillable, Sort Description Amount of the AuthorizationAmount that’s pending reversal. | | RefundedAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that was refunded. | | ReservedBalanceTotalAmount | Type currency Properties Filter, Nillable, Sort Description Calculated field that summarizes the ReservedBalanceAmount for all OrderPaymentSummaryReferences for the OrderPaymentSummary. | | Type | Type string Properties Create, Filter, Group, Sort Description The payment method type associated with the OrderPaymentSummary. For example, visa, mastercard, check, or giftcard. | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [OrderPaymentSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [OrderPaymentSummaryFeed](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. [OrderPaymentSummaryOwnerSharingRule](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. [OrderPaymentSummaryShare](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. #### See Also - [OrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm "Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") - [Payment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_payment.htm "Represents a single event when a shopper makes a payment. For credit cards, this event is a payment capture or payment sale, but it doesn't appear on the shopper's credit card statement. This object is available in API version 48.0 and later.") - [PaymentAuthorization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentauthorization.htm "Represents a single payment authorization event where users can capture or reverse a payment against a reserve of funds. This object is available in API version 48.0 and later.") - [PaymentMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentmethod.htm "Represents the method that a buyer uses to compensate the seller of a good or service. Common payment methods include cash, checks, credit or debit cards, money orders, bank transfers, and online payment services. This object is available in API version 48.0 and later.") # OrderPaymentSummaryReference OrderPaymentSummaryReference is a junction object that allows an order payment summary to be shared with another order summary. This object is available in API version 60.0 and later. An order summary can share an order payment summary with any of its child order summaries (exchange order summaries). Each child can share the order payment summary with its children, and so on. Conceptually, the original order summary and its children form a tree structure, with the original order summary as the root node. If a new order payment summary is created for an exchange order summary anywhere in the tree, the new order payment summary can only be shared with that exchange order summary’s children (and their descendents), if any. The purpose of the OrderPaymentSummaryReference object is to establish how order summaries share order payment summaries. This is only possible if the relationship between the two order summaries has already been established. A corresponding OrderSummaryRelationship record must already exist that relates a parent order summary (MainOrderSummary) with its child (AssociateOrderSummary). The record’s AssociatedRelationshipType field must be set to Exchange. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AuthorizationAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that has been authorized. | | CapturedAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that has been captured. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the OrderSummary associated with the OrderPaymentSummary. Order Management APIs and actions that create an OrderPaymentSummary for an OrderSummary set this value. The default value is USD. Possible values are: - EUR—Euro - USD—U.S. Dollar The default value is USD. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the current user last viewed a record related to this record. This field is available in API version 49.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the current user last viewed this record. A null value can mean that this record was only referenced (LastReferencedDate) and not viewed. This field is available in API version 49.0 and later. | | Method | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderPaymentSummary. | | OrderPaymentSummaryId | Type reference Properties Create, Filter, Group, Sort Description ID of the OrderPaymentSummary shared with the OrderSummary (exchange order). This field is a relationship field. Relationship Name OrderPaymentSummary Relationship Type Lookup Refers To OrderPaymentSummary | | OrderSummaryId | Type reference Properties Create, Filter, Group, Sort Description ID of the OrderSummary (exchange order) that the OrderPaymentSummary is shared with. This field is a relationship field. Relationship Name OrderSummary Relationship Type Lookup Refers To OrderSummary | | RefundedAmount | Type currency Properties Filter, Nillable, Sort Description Amount of the OrderPaymentSummary that was refunded. | | ReservedBalanceAmount | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Reserved balance amount for the exchange order for the order payment summary relationship. | | ReservedBalanceTotalAmount | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Summary of all the ReservedBalanceAmount for all the order payment summary references. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Type of reference between the OrderSummary and the OrderPaymentSummary. Possible values are: - Shared | # OrderShare Represents a sharing entry on an Order. This object is available in API version 48.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | OrderAccessLevel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Level of access that the user or group has to the order. Possible values are: - All—Owner. This value isn’t valid when creating, updating, or deleting records. - Edit—Read/Write - Read—Read Only | | OrderId | Type reference Properties Filter, Group, Sort Description ID of the order associated with this sharing entry. This field can't be updated. This is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | | RowCause | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. | | UserOrGroupId | Type reference Properties Filter, Group, Sort Description ID of the user or group that has been given access to the order. This field can't be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object allows you to determine which users and groups can view or edit orders owned by other users. If you attempt to create a record that matches an existing record, any modified fields are updated, the system returns the existing record. # OrderStatus Represents the status of the order entity. This object is available in API version 48.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an id or primary label. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default order status value (true) or not (false) in the picklist. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Master label for this order status value. This display value is the internal label that doesn’t get translated. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the order status picklist. These numbers aren’t guaranteed to be sequential, as some previous contract status values might have been deleted. | | StatusCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of the order. Possible values are: - Activated - Draft - Superseded-This value is applicable only to Revenue Cloud Advanced users and is available in API version 64.0 and later. | ## Usage This object represents a value in the order status picklist. The order status picklist provides additional information about the status of an Order, such as its current state (Draft, Activated, or Superseded). You can query these records to retrieve the set of values in the order status picklist, and then use that information while processing Order objects to determine more information about a given order. For example, the application could test whether a given order is activated based on its Status value and the value of the StatusCode property in the associated OrderStatus object. # OrderSummary Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. For performance and data integrity reasons, CRUD operations on OrderSummary records don't fire Apex triggers. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the account or person account associated with the OrderSummary. It represents the shopper in the storefront. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | ActiveProcess​ExceptionCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of active process exceptions on the OrderSummary. This field is available in API version 50.0 and later. | | BillingAddress | Type address Properties Filter, Nillable Description Billing address associated with the OrderSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address city. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address country. | | BillingCountry​Code | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO country code for the billing address. The default value is US. | | BillingEmail​Address | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address on the billing address. | | BillingGeocode​Accuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The accuracy of the geocode for the billing address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of the billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of the billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | BillingPhoneNumber | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the billing address. | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address postal code. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address state. | | BillingState​Code | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO state or province code for the billing address. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address street. | | BillToContactId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Contact associated with the OrderSummary. It represents the shopper in the storefront when not using person accounts. If the OrderLifeCycleType field is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. This field is available in API version 49.0 and later. Relationship Name BillToContact Relationship Type Lookup Refers To Contact | | BusinessModel | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The business model of the OrderSummary. Possible values are: - B2B - B2C This field is available in API version 53.0 and later. | | ChangeOrderId | Type reference Properties Filter, Group, Nillable, Sort Description Reserved for future use. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only with the multicurrency feature enabled. Contains the ISO code for the currency of the original Order associated with the OrderSummary. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. This field is available in API version 49.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the OrderSummary. This field can be edited. | | EffectiveDate | Type date Properties Create, Filter, Group, Sort, Update Description Date at which the order becomes effective. Label is **Order Start Date**. This field is available in API version 64.0 and later. | | ExternalReference​Identifier | Type string Properties Filter, Group, idLookup, Nillable, Sort, Update Description Used internally to prevent duplicate records. This value is case-sensitive. In API version 56.0 and later, for orders ingested from B2C Commerce, this value is set to B2C realm ID + "\_" + B2C instance ID + "@" + B2C Commerce catalog/domain ID + "@" + B2C Commerce order number. In API version 55.0, the standard B2C Commerce integration set this value to "SFDC" + "@" + nanotime + "@" + UUID and High Scale Orders set it to the value used in later versions. This field is available in API version 54.0 and later. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description Total amount, including adjustments and tax, of the OrderSummary. | | IsSuspended | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the OrderSummary is suspended. The default value is false. This field is available in API version 50.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | OperationInProgress | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Current operation. Possible values are: - Cancellation - None | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed. | | OrderedDate | Type dateTime Properties Filter, Nillable, Sort Description Date of the original order associated with this OrderSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | OrderLifeCycleType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies whether the OrderSummary is managed by Salesforce Order Management (MANAGED) or by an external system (UNMANAGED). An unmanaged OrderSummary is stored in Salesforce for reference purposes. - Some Order Management APIs reject input records that are associated with unmanaged OrderSummaries. - Order Management does not update financial bucket fields on some records that are associated with unmanaged OrderSummaries. - A user with the EditUnmanagedOrderSummaries or B2BCommerceIntegrator permission can edit certain fields on objects related to unmanaged OrderSummaries that are normally only accessible via APIs. Possible values are: - MANAGED—Managed - UNMANAGED—Unmanaged This field is available in API version 49.0 and later. | | OrderNumber | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderSummary. | | OrderProduct​LineCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of unique products ordered on this Order Summary. This field is available in API version 52.0 and later. | | OriginalOrderId | Type reference Properties Filter, Group, Sort Description ID of the original order associated with this OrderSummary. Label is **Original Order**. This field is a relationship field. Relationship Name OriginalOrder Relationship Type Lookup Refers To Order | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this OrderSummary. Default value is the ID of the user who created the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PoDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Purchase order date associated with this OrderSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. This field is available in API version 52.0 and later. | | PoNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Purchase order number associated with this OrderSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | Pricebook2Id | Type reference Properties Filter, Group, Nillable, Sort Description ID of the pricebook associated with this OrderSummary. This field is available in API version 54.0 and later. This field is a relationship field. Relationship Name Pricebook2 Relationship Type Lookup Refers To Pricebook2 | | RoutingAttempts | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The number of attempts that have been made to route the order summary to inventory locations. This field is available in API version 51.0 and later. | | SalesChannelId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the SalesChannel associated with this OrderSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. This field is a relationship field. Relationship Name SalesChannel Relationship Type Lookup Refers To SalesChannel | | SalesStoreId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the RetailStore or WebStore associated with this OrderSummary. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. This field is a relationship field. Relationship Name SalesStore Relationship Type Lookup Refers To WebStore | | SourceProcess | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes the order process that created the OrderSummary. Possible values are: - Exchange The OrderSummary was created by an Exchange process - OrderOnBehalf The OrderSummary was created by an Order on Behalf Of process - Standard The OrderSummary was not created by an Order on Behalf Of or Exchange process This field is available in API version 57.0 and later. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status of the order summary. Unlike the Status and Status Category fields on the order and FulfillmentOrder objects, this field is optional. We recommend that you use the same values in this picklist that you use in the Status picklist for the order object. | | SourceOrderSummaryId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the source order summary that’s associated with this OrderSummary. This field is populated when the SourceProcess of this OrderSummary is an exchange process. Relationship Name SourceOrderSummary Relationship Type Lookup Refers To OrderSummary | | TaxLocaleType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The system used to handle tax on the original Order associated with the OrderSummary. Gross usually applies to taxes like value-added tax (VAT), and Net usually applies to taxes like sales tax. Automatic taxes use currency to determine if the tax is added on top of the price (excluded) or included in the price. Possible values are: - Gross (displays most prices and taxes as combined values) - Net (displays most prices and taxes as separate values) - Automatic (displays most prices and taxes as combined or separate, based on the currency) If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. This field is available in API version 49.0 and later. | | TotalAdjDelivery​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of all OrderItemSummaries of type Delivery Charge belonging to this OrderSummary, inclusive of item-level adjustments and tax. This amount is equal to TotalAdjustedDeliveryAmount + TotalAdjustedDeliveryTaxAmount. This field is available in API version 49.0 and later. | | TotalAdjDistAmount | Type currency Properties Filter, Nillable, Sort Description Total of distributed adjustments applied to OrderItemSummaries belonging to this OrderSummary. This amount is equal to TotalProductAdjDistAmount plus TotalDeliveryAdjDistAmount. | | TotalAdjDist​AmountWithTax | Type currency Properties Filter, Nillable, Sort Description Total of distributed adjustments applied to OrderItemSummaries belonging to this OrderSummary, inclusive of tax. This amount is equal to TotalAdjDistAmount plus TotalAdjDistTaxAmount. This field is available in API version 49.0 and later. | | TotalAdjDist​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjDistAmount. | | TotalAdjFee​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of all OrderItemSummaries of type Fee belonging to this OrderSummary, inclusive of item-level adjustments and tax. This amount is equal to TotalAdjustedFeeAmount plus TotalAdjustedFeeTaxAmount. This field is available in API version 56.0 and later. | | TotalAdjProduct​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of all OrderItemSummaries of type code Product belonging to this OrderSummary, inclusive of item-level adjustments and tax. This amount is equal to TotalAdjustedProductAmount plus TotalAdjustedProductTaxAmount. This field is available in API version 49.0 and later. | | TotalAdjusted​DeliveryAmount | Type currency Properties Filter, Nillable, Sort Description Total, including item-level adjustments but not order-level adjustments or tax, of all OrderItemSummaries of type Delivery Charge belonging to this OrderSummary. | | TotalAdjusted​DeliveryTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustedDeliveryAmount. | | TotalAdjusted​FeeAmount | Type currency Properties Filter, Nillable, Sort Description Total, including item-level adjustments but not order-level adjustments or tax, of all OrderItemSummaries of type Fee belonging to this OrderSummary. This field is available in API version 56.0 and later. | | TotalAdjusted​FeeTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustedFeeAmount. This field is available in API version 56.0 and later. | | TotalAdjusted​Product​Amount | Type currency Properties Filter, Nillable, Sort Description Total, including item-level adjustments but not order-level adjustments or tax, of all OrderItemSummaries of type code Product belonging to this OrderSummary. | | TotalAdjusted​Product​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustedProductAmount. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of all OrderItemSummaries belonging to this OrderSummary. Equal to TotalAdjustedProductAmount plus TotalAdjustedFeeAmount plus TotalAdjustedDeliveryAmount. | | TotalDeliveryAdj​DistAmount | Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type Delivery Charge belonging to this OrderSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. | | TotalDeliveryAdj​DistAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type Delivery Charge belonging to this OrderSummary, inclusive of tax. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. It is equal to TotalDeliveryAdjDistAmount + TotalDeliveryAdjDistTaxAmount. This field is available in API version 49.0 and later. | | TotalDeliveryAdj​DistTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalDeliveryAdjDistAmount. | | TotalDeliveryAmount | Type currency Properties Filter, Nillable, Sort Description Sum of the Total Line Amounts of all OrderItemSummaries of type Delivery Charge belonging to this OrderSummary, not including adjustments or tax. This field is available in API version 54.0 and later. | | TotalDeliveryAmount​WithTax | Type currency Properties Filter, Nillable, Sort Description Total of all OrderItemSummaries of type Delivery Charge belonging to this OrderSummary, including tax but not including adjustments. It is equal to TotalDeliveryAmount + TotalDeliveryTaxAmount. This field is available in API version 54.0 and later. | | TotalDelivery​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalDeliveryAmount. This field is available in API version 54.0 and later. | | TotalFeeAdj​DistAmount | Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type Fee belonging to this OrderSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. This field is available in API version 56.0 and later. | | TotalFeeAdj​DistAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type Fee belonging to this OrderSummary, inclusive of tax. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. It is equal to TotalFeeAdjDistAmount + TotalFeeAdjDistTaxAmount. This field is available in API version 56.0 and later. | | TotalFeeAdj​DistTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalFeeAdjDistAmount. This field is available in API version 56.0 and later. | | TotalFeeAmount | Type currency Properties Filter, Nillable, Sort Description Sum of the Total Line Amounts of all OrderItemSummaries of type Fee belonging to this OrderSummary, not including adjustments or tax. This field is available in API version 56.0 and later. | | TotalFeeAmount​WithTax | Type currency Properties Filter, Nillable, Sort Description Total of all OrderItemSummaries of type Fee belonging to this OrderSummary, including tax but not including adjustments. It is equal to TotalFeeAmount + TotalFeeTaxAmount. This field is available in API version 56.0 and later. | | TotalFeeTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalFeeAmount. This field is available in API version 56.0 and later. | | TotalProductAdj​DistAmount | Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type code Product belonging to this OrderSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. | | TotalProductAdj​DistAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type code Product belonging to this OrderSummary, inclusive of tax. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. It is equal to TotalProductAdjDistAmount + TotalProductAdjDistTaxAmount. This field is available in API version 49.0 and later. | | TotalProductAdj​DistTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalProductAdjDistAmount. | | TotalProductAmount | Type currency Properties Filter, Nillable, Sort Description Sum of the Total Line Amounts of all OrderItemSummaries of type code Product belonging to this OrderSummary, not including adjustments or tax. This field is available in API version 54.0 and later. | | TotalProductAmount​WithTax | Type currency Properties Filter, Nillable, Sort Description Total of all OrderItemSummaries of type code Product belonging to this OrderSummary, including tax but not including adjustments. It is equal to TotalProductAmount + TotalProductTaxAmount. This field is available in API version 54.0 and later. | | TotalProduct​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalProductAmount. This field is available in API version 54.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Total tax on all OrderItemSummaries belonging to this OrderSummary. Equal to TotalAdjustedDeliveryTaxAmount plus TotalAdjustedFeeTaxAmount plus TotalAdjustedProductTaxAmount. | ## 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. [OrderSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [OrderSummaryFeed](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. [OrderSummaryOwnerSharingRule](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. [OrderSummaryShare](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. #### See Also - [FulfillmentOrder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorder.htm "Represents a group of products, fees, and delivery charges on a single order that share the same fulfillment location, delivery method, and recipient. The FulfillmentOrderLineItems belonging to a FulfillmentOrder are associated with OrderItemSummary objects belonging to a single OrderSummary. This object is available in API version 48.0 and later.") - [Order](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_order.htm "Represents an order associated with a contract or an account.") - [OrderItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm "Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") - [OrderPaymentSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderpaymentsummary.htm "Represents the current properties and state of payments using a single payment method that are applied to one OrderSummary. This object is available in API version 48.0 and later.") - [OrderSummaryRoutingSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummaryroutingschedule.htm "Represents an attempt to route an order summary to one or more inventory locations for fulfillment. You can use it to schedule future attempts and to record completed attempts. This object is available in API version 51.0 and later.") - [PendingOrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pendingordersummary.htm "Object representing a B2C Commerce order ingested via High Scale Orders before an OrderSummary is created for it. Optimized for online transaction processing (OLTP). This object is available in API version 55.0 and later.") - [SalesChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_saleschannel.htm "Represents the origin of an order. For example, a web storefront, physical store, marketplace, or mobile app. If you integrate Salesforce Order Management with Salesforce B2C Commerce, set up a SalesChannel corresponding to each Site in your B2C Commerce implementation. This object is available in API version 48.0 and later.") # OrderSummaryAdditionalInfo Stores information related to OrderSummary including context around the order, such as inventory reservation details, order origination, and other values that Einstein uses to perform order analysis. Only reservation details can be stored in this object. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentsVersion | Type text Properties Filter, Group, Nillable, Sort Description Represents the adjustment algorithm that was used to create adjustments for this order | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description ISO code for the currency of the OrderSummary associated with the OrderSummaryAdditionalInfo. Possible values are: - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | InventoryReservationExtRef | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Holds an external reference identifier for tracking the inventory reservation. | | InventoryReservationIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Inventory reservation identifier for the order, if available. Since this value can come from external systems, the value type has no lookup or enforcement. | | InventoryReservationMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Holds any details or other relevant information that can further explain the status of the reservation. | | InventoryReservationState | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the reservation, if available. Possible values are: - DEFERRED - NOT\_APPLICABLE - PERMANENT - TEMPORARY | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderSummaryAdditionalInfo record. | | OrderId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Unique ID of the order associated with this record. This field is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | | OrderSummaryId | Type reference Properties Filter, Group, Nillable, Sort Description Unique ID of the associated OrderSummary to which the specific OrderSummaryAdditionalInfo applies. This field is a relationship field. Relationship Name OrderSummary Relationship Type Lookup Refers To OrderSummary | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this record. Default value is the ID of the user who created the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## 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. [OrderSummaryAdditionalInfoFeed](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. [OrderSummaryAdditionalInfoOwnerSharingRule](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. [OrderSummaryAdditionalInfoShare](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. #### See Also - [OrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm "Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") # OrderSummaryRelationship Junction object used to track how an original order summary (created before any exchanges have occurred) relates to other order summary objects in a chain of exchange orders. This object is available in API version 60.0 and later. An exchange order is an OrderSummary object whose SourceProcess property is set to Exchange. An original order summary can have an exchange order, which in turn can have yet another exchange order, and so on. The OrderSummaryRelationship object maintains this relationship between OrderSummary objects. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AssociatedOrderSummaryId | Type reference Properties Create, Filter, Group, Sort Description ID of the associated OrderSummary. This field is a relationship field. Relationship Name AssociatedOrderSummary Relationship Type Lookup Refers To OrderSummary | | AssociatedOrderSummaryStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description Status of the associated OrderSummary. Possible values are: - Activated - Approved - Canceled - Created - Fulfilled - Returned - Waiting to Fulfill The default value is Created. | | AssociatedRelationshipType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Relationship type of the associated OrderSummary. Possible values are: - Exchange | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. Possible values are: - EUR—Euro - USD—U.S. Dollar The default value is USD. | | MainAttachedToId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of an Order (Change Order) or a ReturnOrder that belongs to the parent OrderSummary (whose ID is stored in the MainOrderSummaryId field). This field is a polymorphic relationship field. Relationship Name MainAttachedTo Relationship Type Lookup Refers To Order, ReturnOrder | | MainOrderSummaryId | Type reference Properties Create, Filter, Group, Sort Description ID of the associated OrderSummary’s parent. This field is a relationship field. Relationship Name MainOrderSummary Relationship Type Lookup Refers To OrderSummary | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the OrderSummaryRelationship. | | RootOrderSummaryId | Type reference Properties Create, Filter, Group, Sort Description ID of the original OrderSummary that existed before any exchange orders were created. This field is a relationship field. Relationship Name RootOrderSummary Relationship Type Lookup Refers To OrderSummary | # OrderSummaryRoutingSchedule Represents an attempt to route an order summary to one or more inventory locations for fulfillment. You can use it to schedule future attempts and to record completed attempts. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the order summary routing schedule. | | OrderSummaryId | Type reference Properties Create, Filter, Group, Sort Description (Master-Detail) The order summary associated with the routing schedule. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who currently owns this order summary routing schedule. Default value is the User logged in to the API to perform the create. | | Reason | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Reason for the routing attempt. You can customize this list. The list has one default value: - Unknown | | ScheduleStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Identifies whether this routing attempt has already run or is scheduled to run. Possible values are: - ABANDONED - COMPLETED - SCHEDULED | | ScheduledDatetime | Type dateTime Properties Create, Filter, Sort, Update Description Identifies when this routing attempt was run or is scheduled to run. If the ScheduleStatus is ABANDONED or COMPLETED, then you can’t modify this value. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [OrderSummaryRoutingScheduleOwnerSharingRule](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. [OrderSummaryRoutingScheduleShare](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. #### See Also - [OrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm "Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") # Organization Represents key configuration information for an organization. Executing a SOQL SELECT query returns the value of fields in this object, but no value is visible for some of the fields. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | Address (beta) | Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | AllowsSelfServiceLogin | Type boolean Properties Defaulted on create, Filter, Update Description Indicates whether the organization allows Self-Service login (true) or not (false). | | City | Type string Properties Filter, Group, Nillable, Sort, Update Description Name of the city for the organization's address. | | ComplianceBccEmail | Type email Properties Filter, Group, Nillable, Sort Description Email address for compliance blind carbon copies. Limit: 80 characters. | | Country | Type string Properties Filter, Group, Nillable, Sort Description Name of the country for the organization's address. Limit: 80 characters. | | CountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the organization’s address. Enable state and country/territory picklists to use this field. For more information, see [Enable and Disable State and Country/Territory Picklists](https://help.salesforce.com/s/articleView?id=xcloud.admin_state_country_picklist_enable.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. | | DailyWebToCaseCount | Type int Properties Filter, Nillable Description The number of web form submissions that have been converted to cases for the day. | | DailyWebToCaseLimit | Type int Properties Filter, Nillable Description The maximum number of web form submissions that can be converted to cases per day. | | DailyWebToLeadCount | Type int Properties Filter, Nillable Description The number of web form submission that have been converted to leads for the day | | DailyWebToLeadLimit | Type int Properties Filter, Nillable Description The maximum number of web form submissions that can be converted to leads per day. | | DefaultAccountAccess | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description In API version 10.0 and later, represents the default access level for accounts, contracts, and assets. The possible values are: - None - Read - Edit - ControlledByLeadOrContact - ControlledByCampaign In versions before 10.0, DefaultAccountAndContactAccess represented this value. | | DefaultAccountAndContactAccess | Type picklist Properties Filter, Nillable, Restricted picklist Description Default access level for accounts, contacts, contracts, and assets. This field is supported for backward compatibility only and is not available in API version 10.0 or later. In version 10.0 and later, use either DefaultAccountAccess or DefaultContactAccess. | | DefaultCalendarAccess | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Default access level for calendars. The possible values are listed, followed by the user interface labels in parentheses: - HideDetails (Hide Details) - HideDetailsInsert (Hide Details and Add Events) - ShowDetails (Show Details) - ShowDetailsInsert (Show Details and Add Events) - AllowEdits (Full Access) | | DefaultCampaignAccess | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Default access level for campaigns. The possible values are: - None - Read - Edit - All | | DefaultCaseAccess | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Default access level for cases. The possible values are: - None - Read - Edit - ReadEditTransfer | | DefaultContactAccess | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Default access level for contacts. The possible values are: - None - Read - Edit - ControlledByParent In versions before 10.0, DefaultAccountAndContactAccess represented this value. When DefaultContactAccess is set to “Controlled by Parent,” you can’t update the ContactAccessLevel field. | | DefaultLeadAccess | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Default access level for leads. The possible values are: - NoneRead - Edit - ReadEditTransfer | | DefaultLocaleSidKey | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description Default locale SID key. For more information on picklist options, see [Supported Number, Name, and Address Formats (ICU)](https://help.salesforce.com/s/articleView?id=xcloud.admin_supported_locales.htm&language=en_US) in Salesforce help. | | DefaultOpportunityAccess | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Default access level for opportunities. The possible values are: - None - Read - Edit - ControlledByLeadOrContact - ControlledByCampaign | | DefaultPricebookAccess | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Default access level for price books. The possible values are listed, followed by the user interface labels in parentheses: - None (No access) - Read (Read only) - ReadSelect (Use) | | DefaultTerritoryCaseAccess | Type picklist Properties Filter, Group, Nillable, Sort Description Default access level for cases associated with accounts in territories. The possible values are: - None - Read - Edit - ControlledByLeadOrContact - ControlledByCampaign | | DefaultTerritoryContactAccess | Type picklist Properties Filter, Group, Nillable, Sort Description Default access level for contacts associated with accounts in territories. The possible values are: - NoneRead - Edit - ControlledByLeadOrContact - ControlledByCampaign When DefaultContactAccess is set to “Controlled by Parent” you can’t update this field. | | DefaultTerritoryOppAccess | Type picklist Properties Filter, Group, Nillable, Sort Description Default access level for opportunities in territories. Valid values: - NoneRead - Edit - ControlledByLeadOrContact - ControlledByCampaign | | Division | Type string Properties Filter, Group, Nillable, Sort, Update Description The name of the division for this organization. This field is not related to the Division object. | | Fax | Type phone Properties Filter, Group, Nillable, Sort, Update Description Fax number. Limit: 40 characters. | | FiscalYearStartMonth | Type int Properties Filter, Group, Nillable, Sort Description Number that corresponds to the month that this organization's fiscal year starts. | | HomepageHtml | Type textarea Properties Nillable, Update Description The Home tab custom links and company message for this organization. | | InstanceName | Type string Properties Filter, Group, Nillable, Sort Description Read-only. The name of the instance. Available in API version 31.0 or later. | | IsSandbox | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the current organization is a sandbox (true) or production (false) instance. Available in API version 31.0 or later. | | LanguageLocaleKey | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The same as Language, the two-to-five character code which represents the language and locale ISO code. This controls the language for labels displayed in an application. | | LastWebToCaseDate | Type dateTime Properties Filter, Nillable Description The last date that a web form submission was converted to a case. | | LastWebToLeadDate | Type dateTime Properties Filter, Nillable Description The last date that a web form submission was converted to a lead. | | Latitude | Type double Properties Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | Longitude | Type double Properties Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | MaxActionsPerRule | Type int Properties Filter, Nillable Description Maximum number of actions per workflow, assignment, escalation, and auto-response rules. This field is unavailable in version 15.0 and later. | | MaxRulesPerEntity | Type int Properties Filter, Nillable Description Maximum number of rules per object, inclusive of workflow, assignment, escalation, and auto-response rules. This field is unavailable in version 15.0 and later. | | MonthlyPageViewsEntitlement | Type int Properties Filter, Group, Nillable, Sort Description The number of page views allowed for the current calendar month for the sites in your organization. To access this field, Salesforce Sites must be enabled for your organization. This field is generally available in API versions 18.0 and later. | | MonthlyPageViewsUsed | Type int Properties Filter, Group, Nillable, Sort Description The number of page views used in the current calendar month for the sites in your organization. To access this field, Salesforce Sites must be enabled for your organization. This field is generally available in API versions 18.0 and later. | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description The name of the organization. | | NamespacePrefix | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | OrganizationType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Edition of the organization, for example Enterprise Edition or Unlimited Edition. | | Phone | Type phone Properties Filter, Group, Nillable, Sort, Update Description Phone number for the organization. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort, Update Description Postal code for the address of the organization. Limit: 20 characters. | | PreferencesEventScheduler | Type boolean Properties Update Description Indicates whether opportunities require products (true) or not (false). | | PreferencesPublicSectorTaxRevEnabled | Type boolean Properties Filter, Update Description Indicates whether Public Sector Tax and Revenue Management is enabled for all users in your organization (true) or is disabled for all users (false). This field is available in API version 68.0 or later. | | PreferencesRequireOpportunityProducts | Type boolean Properties Filter, Update Description Indicates whether opportunities require products (true) or not (false). | | PreferencesS1BrowserEnabled | Type boolean Properties Filter, Update Description Indicates whether the Salesforce mobile web is enabled for all users in your organization (true) or is disabled for all users (false). This field is available in API version 29.0 or later. | | PreferencesTerminateOldestSession | Type boolean Properties Filter, Update Description Indicates whether the oldest login session is automatically closed when a policy specifying the maximum number of sessions is triggered. This field is available in API version 35.0 — 49.0. As of API version 50.0, this field is removed. | | PreferencesTransactionSecurityPolicy | Type boolean Properties Filter, Update Description Indicates whether the Transaction Security feature has been enabled. This field is available in API version 35.0 — 49.0. As of API version 50.0, this field is removed. | | PrimaryContact | Type string Properties Filter, Group, Nillable, Sort, Update Description Name of the primary contact for the organization. Limit: 80 characters. | | ReceivesAdminInfoEmails | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the organization receives administrator emails (true) or not (false). | | ReceivesInfoEmails | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the organization receives informational email from Salesforce (true) or not (false). | | SelfServiceCasePlural | Type string Properties Filter, Nillable, Update Description The plural version of the term used to represent the Case object in the Self-Service portal. | | SelfServiceCaseSingle | Type string Properties Filter, Nillable, Update Description The singular version of the term used to represent the Case object in the Self-Service portal. | | SelfServiceCaseSubmitRecordTypeId | Type reference Properties Filter, Nillable, Update Description The ID of the record type associated with a case submitted via the Self-Service portal. | | SelfServicDefaultCaseOrigin | Type string Properties Filter, Nillable, Update Description The default origin of a case submitted via the Self-Service portal. | | SelfServiceEmailSenderAddress | Type email Properties Filter, Nillable, Update Description The Self-Service email address from which new Self-Service user and password email messages are sent, such as support@acme.com. | | SelfServiceEmailSenderName | Type string Properties Filter, Nillable, Update Description The name associated with the email address in the SelfServiceEmailSenderAddress field, such as Acme Customer Support. | | SelfServiceEmailUserOnCaseCreation‍TemplateId | Type reference Properties Filter, Nillable, Update Description The ID of the email template used when email is sent to a Self-Service user when he or she creates a case. | | SelfServiceEnabledForResponseRules | Type boolean Properties Filter, Nillable, Update Description Indicates whether the Self-Service portal is enabled for auto-response rules (true) or not (false). | | SelfServiceFeatureConfig | Type int Properties Filter, Nillable, Update Description An integer representing the active Self-Service feature configuration for this organization. | | SelfServiceLogoutUrl | Type url Properties Filter, Nillable, Update Description The Web page that displays when a Self-Service user logs out of the Self-Service portal. | | SelfServiceMaxNumSuggestions | Type int Properties Filter, Nillable, Update Description The maximum number of suggested solutions allowed for a Self-Service case. | | SelfServiceNewCommentCheckedByDefault | Type boolean Properties Defaulted on create, Filter, Update Description If true, When a customer notification is automatically sent when a new comment is added to a case. | | SelfServiceNewCommentTemplateId | Type reference Properties Filter, Nillable, Update Description The ID of the email template used to send a notification to Self-Service users when a public comment is added to one of their cases. | | SelfServiceNewPassTemplateId | Type reference Properties Filter, Nillable, Update Description The ID of the email template used when new passwords are generated for Self-Service users. | | SelfServiceNewUserTemplateId | Type reference Properties Filter, Nillable, Update Description The ID of the email template used when new Self-Service users are enabled. | | SelfServicePageHeight | Type int Properties Filter, Nillable, Update Description The maximum height in pixels of Self-Service pages. | | SelfServicePageWidth | Type int Properties Filter, Nillable, Update Description The maximum width in pixels of Self-Service pages. | | SelfServiceSelfClosedCaseStatus | Type picklist Properties Filter, Nillable, Update Description The default status for cases closed by Self-Service users. | | SelfServiceSolutionCategoryAvailable | Type boolean Properties Defaulted on create, Filter, Update Description Indicates whether solution categories are available in the Self-Service portal (true) or not (false). | | SelfServiceSolutionCategoryStartNodeId | Type reference Properties Filter, Nillable, Update Description The ID of the top-level category in the Self-Service portal. | | SelfServiceSolutionPlural | Type string Properties Filter, Nillable, Update Description The plural version of the term used to represent the Solution object in the Self-Service portal. | | SelfServiceSolutionSingle | Type string Properties Filter, Nillable, Update Description The singular version of the term used to represent the Solution object in the Self-Service portal. | | SelfServiceStyleSheetUrl | Type url Properties Filter, Nillable, Update Description The public URL of your organization's Self-Service portal stylesheet. | | SelfServiceWelcomePageConfig | Type int Properties Filter, Nillable, Update Description Integer that represents the welcome page configuration for the Self-Service portal. | | SelfServiceWelcomeText | Type string Properties Filter, Nillable, Update Description The custom welcome message displayed at the top of the Self-Service home page when Self-Service users log in. Limit: 32,000 characters. | | SignupCountryIsoCode | Type string Properties Filter, Group, Nillable, Sort Description The ISO country code specified by the user for a sign-up request. | | State | Type string Properties Filter, Group, Nillable, Sort, Update Description State of the address of the organization. Limit: 80 characters. | | StateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the organization’s address. | | Street | Type textarea Properties Filter, Group, Nillable, Sort, Update Description Street address for the organization. Limit: 255 characters. | | TrialExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description The date that this organization's trial license expires. | | TimeZoneSidKey | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description Identifies the default time zone of the organization. | | UiSkin | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The user interface theme selected for the organization. | | UsesStartDateAsFiscalYearName | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the calendar year when the fiscal year begins is referred to as the year of the company's fiscal year (true) or not (false). For example, if the fiscal year begins in February 2006, a true value means the fiscal year is FY2006, and a false value means the fiscal year is FY2007. | | UsesWebToCase | Type boolean Properties Filter, Nillable, Update Description Indicates whether this organization can use Web-to-Case (true) or not (false). | | UsesWebToLead | Type boolean Properties Filter, Nillable, Update Description Indicates whether this organization can use Web-to-Lead (true) or not (false). | | WebToCaseAssignedEmailTemplateId | Type reference Properties Filter, Nillable, Update Description The ID of the email template used when a new case is assigned to a user via Web-to-Case. | | WebToCaseCreatedEmailTemplateId | Type reference Properties Filter, Nillable, Update Description The ID of the email template used when a new case is created via Web-to-Case. | | WebToCaseDefaultCreatorId | Type reference Properties Filter, Nillable, Update Description The ID of the user specified as the default creator of cases created via Web-to-Case. | | WebToCaseDefaultOrigin | Type string Properties Filter, Group, Nillable, Sort, Update Description The default value for the **Case Origin** field on cases submitted via Web-to-Case. Limit: 40 characters. | ## Usage Query this object to obtain information about an organization's settings. Only one organization object exists per organization. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # OrgDeleteRequest Represents a request to delete a developer edition (DE) org. This object is available in API version 42.0 and later. It is available only in Developer and Database.com editions. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated ID of this OrgDeleteRequest object. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort Description The ID of the user who initiated the org delete request. | | RequestType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Specifies whether you want to deactivate or reactivate the org. When you deactivate an org, you have 30 days to change your mind and reactivate it. After 30 days, the org is locked, and you must contact Salesforce Customer Support to reactivate it. After 60 days, the org is permanently deleted from Salesforce servers. Valid values: - Deactivate - Reactivate | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [OrgDeleteRequestOwnerSharingRule](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. [OrgDeleteRequestShare](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. # OrgEmailAddressSecurity Defines the assignment of a user profile to an org-wide email address. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Only authenticated users with the View Setup and Configuration permission can access this object. ## Fields | Field | Details | | --- | --- | | OrgWideEmailAddressId | Type reference Properties Create, Filter, Group, Sort Description The ID of an organization-wide email address. This field is a relationship field. Relationship Name OrgWideEmailAddress Relationship Type Lookup Refers To OrgWideEmailAddress | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The profile ID that’s allowed to use an organization-wide email address. This field is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Profile | ## Usage You can use this object with OrgWideEmailAddress and Profile objects to retrieve user profiles that have access to a specific org-wide email address. To find specific users, use the ProfileId field on the User object. You can also retrieve the org-wide email addresses that a specific user can access. Note that any users assigned to those org-wide email addresses via permission set aren’t returned. # OrgMetric Represents a feature or metric that Salesforce Optimizer evaluates. This object is available in API version 47.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in orgs where Salesforce Optimizer is enabled. Requires the Modify All Data and Customize Application user permissions. ## Fields | Field | Details | | --- | --- | | Category | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The category of the feature evaluated. Possible values are: - Custom Code - Custom Layouts - Fields - Improve Org Security - Improve User Experience - Increase User Adoption - Object Limits - Org Limits - Reports And Dashboards - Usage - User Management - Workflow The default value is Org Limits. | | FeatureType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The feature evaluated. For a full list, see [Features Evaluated in Salesforce Optimizer](https://help.salesforce.com/s/articleView?id=xcloud.optimizer_included_features.htm&type=5&language=en_US "HTML (New Window)"). The default value is Unassigned Page Layouts. | | LatestOrgMetricScanSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The feature’s OrgMetricScanSummaryID from the most recent Optimizer evaluation. This field is a relationship field. Relationship Name LatestOrgMetricScanSummary Refers To [OrgMetricScanSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgmetricscansummary.htm "Represents the results summary for a specific feature in a Salesforce Optimizer evaluation. This object is available in API version 47.0 and later.") | | Name | Type string Properties Filter, Group, idLookup, Sort Description A unique number that identifies the feature. | #### See Also - [_Salesforce Help_: Improve Your Implementation with Salesforce Optimizer](https://help.salesforce.com/s/articleView?id=xcloud.optimizer_introduction.htm&type=5&language=en_US "Salesforce Help: Improve Your Implementation with Salesforce Optimizer - HTML (New Window)") # OrgMetricScanResult Represents data or an item associated with a feature’s results in a Salesforce Optimizer evaluation. For example, for the Custom Field Limit feature, an OrgMetricScanResult object represents an object flagged for approaching the custom field limit. This object is available in API version 47.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), upsert() ## Special Access Rules This object is only available in orgs where Salesforce Optimizer is enabled. Requires the Modify All Data and Customize Application user permissions. ## Fields | Field | Details | | --- | --- | | Date | Type dateTime Properties Create, Filter, Nillable, Sort Description The date associated with an item in a feature’s Optimizer evaluation. Example For the Unsupported Browsers feature, Date indicates the date that the user last logged in with an unsupported browser. | | Flags | Type int Properties Create, Filter, Group, Nillable, Sort Description The flags associated with an item in a feature’s Optimizer evaluation. Example For the API Versions feature, Flags indicates the API version of an object that Optimizer evaluates as outdated. | | ItemStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The recommended action for an item in a feature’s Optimizer evaluation. Possible values are: - Action Required - Immediate Action Required - No Action Required - Not Currently Enabled - Review Required - Unable to Analyze The default value is No Action Required. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort Description The name of the item in a feature’s Optimizer evaluation, such as an object name. Example For the Unassigned Roles feature, Name refers to the name of the unassigned role. | | Object | Type string Properties Create, Filter, Group, Nillable, Sort Description The object ID associated with the item in a feature’s Optimizer evaluation. For the Release Update feature only, Object indicates the release that the update is scheduled for. Example For the Unused Reports feature, Object refers to the ID of the unused report. | | OrgMetricScanSummaryId | Type reference Properties Create, Filter, Group, Sort Description The feature’s OrgMetricScanSummary ID from the most recent Optimizer run. This field is a relationship field. Relationship Name OrgMetricScanSummary Relationship Type Master-detail Refers To [OrgMetricScanSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgmetricscansummary.htm "Represents the results summary for a specific feature in a Salesforce Optimizer evaluation. This object is available in API version 47.0 and later.") (the master object) | | Profile | Type int Properties Create, Filter, Group, Nillable, Sort Description The profile ID associated with the item in a feature’s Optimizer evaluation. | | Quantity | Type int Properties Create, Filter, Group, Nillable, Sort Description A quantity associated with the item in a feature’s Optimizer evaluation. Example For the Custom Field Limits feature, Quantity indicates the total number of fields on an object that approaches the custom field limit. | | Type | Type string Properties Create, Filter, Group, Nillable, Sort Description The type of item or data in a feature’s Optimizer evaluation. Example For the Unsupported Browsers feature, Type indicates the unsupported browser and platform used. | | Url | Type url Properties Create, Filter, Group, Nillable, Sort Description The URL associated with the item in a feature’s Optimizer evaluation. Example For the Unassigned Page Layouts feature, the URL represents a link to the unassigned layout. | | User | Type string Properties Create, Filter, Group, Nillable, Sort Description The user ID or username associated with the item in a feature’s Optimizer evaluation. For the Release Update feature only, User indicates the name of the release update that requires review. Example For the User Logins feature, User indicates the username of a user who hasn’t recently logged in. | #### See Also - [_Salesforce Help_: Improve Your Implementation with Salesforce Optimizer](https://help.salesforce.com/s/articleView?id=xcloud.optimizer_introduction.htm&type=5&language=en_US "Salesforce Help: Improve Your Implementation with Salesforce Optimizer - HTML (New Window)") # OrgMetricScanSummary Represents the results summary for a specific feature in a Salesforce Optimizer evaluation. This object is available in API version 47.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), upsert() ## Special Access Rules This object is only available in orgs where Salesforce Optimizer is enabled. Requires the Modify All Data and Customize Application user permissions. ## Fields | Field | Details | | --- | --- | | ErrorMessage | Type picklist Properties Create, Filter, Group, Nillable, Sort Description The message returned if an error occurred during the most recent Optimizer evaluation. | | FeatureLimit | Type int Properties Create, Filter, Group, Nillable, Sort Description The numerical limit of a feature. Example For the Custom Field Limits feature, FeatureLimit is 500 for Developer Edition orgs. | | ImplementationEffort | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The estimated time needed to complete the recommended actions for the feature. Possible values are: - 1 - 2 hours - 30 - 60 minutes - < 30 minutes - \> 2 hours The default value is 30 minutes. | | ItemCount | Type int Properties Create, Filter, Group, Nillable, Sort Description The number of issues found for the feature. Corresponds to the number of OrgMetricScanResult objects generated for the feature in an Optimizer evaluation. | | Name | Type string Properties Filter, Group, idLookup, Sort Description A number that identifies the feature’s results summary. | | OrgMetricId | Type reference Properties Create, Filter, Group, Sort Description The OrgMetric ID that represents the feature analyzed in the Optimizer evaluation. This field is a relationship field. Relationship Name OrgMetric Relationship Type Master-detail Refers To [OrgMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgmetric.htm "Represents a feature or metric that Salesforce Optimizer evaluates. This object is available in API version 47.0 and later.") (the master object) | | PercentUsage | Type percent Properties Create, Filter, Nillable, Sort Description A percentage associated with a feature. Example For the Incomplete Chatter Profiles feature, the PercentUsage value is 100 if 100% of users have complete Chatter profiles. | | ScanDate | Type dateTime Properties Create, Filter, Nillable, Sort Description The time that the report for the Optimizer evaluation was generated. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The recommended action for the feature. Possible values are: - Action Required - Immediate Action Required - No Action Required - Not Currently Enabled - Review Required - Unable to Analyze The default value is No Action Required. | | Unit | Type string Properties Create, Filter, Group, Nillable, Sort Description The unit of measurement used in the feature’s results summary. Example For the Data Storage feature, the Unit is MB. | #### See Also - [_Salesforce Help_: Improve Your Implementation with Salesforce Optimizer](https://help.salesforce.com/s/articleView?id=xcloud.optimizer_introduction.htm&type=5&language=en_US "Salesforce Help: Improve Your Implementation with Salesforce Optimizer - HTML (New Window)") # OrgSnapshot Represents a snapshot of a scratch org. Snapshots capture the state of a scratch org so that you can use it to quickly spin up new scratch orgs using its configuration. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules A snapshot must belong to the Dev Hub org that you’re using to create the scratch org. You must enable the scratch org snapshot feature in your Dev Hub org using Setup. ## Fields | Field | Details | | --- | --- | | Content | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reserved for future use. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort Description A free-form text field (maximum 255 characters) for you to enter a description of this scratch org snapshot. | | Error | Type string Properties Filter, Group, Nillable, Sort Description Reserved for future use. | | ExpirationDate | Type date Properties Filter, Group, Nillable, Sort Description Date when the scratch org snapshot expires. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the scratch org snapshot. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Provider | Type picklist Properties Filter, Group, Restricted picklist, Sort Description For internal use only. | | ProviderSnapshot | Type string Properties Filter, Group, Nillable, Sort Description For internal use only. | | ProviderSnapshotVersion | Type string Properties Filter, Group, Sort Description For internal use only. | | SnapshotName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the scratch org snapshot. This field value is unique within your org. | | SourceOrg | Type string Properties Create, Filter, Group, Sort Description The org ID of the scratch org that the snapshot was created from. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Status of the snapshot. Possible values are: - Active—The snapshot is created and can be used to create scratch orgs. - Error—The snapshot couldn’t be created. - Expired—The snapshot has expired. - In Progress—The snapshot is in the process of being created. - New—The snapshot creation request has been received. The default value is New. | ## 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. [OrgSnapshotFeed](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. [OrgSnapshotHistory](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. [OrgSnapshotShare](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. # OrgWideEmailAddress Represents an organization-wide email address for user profiles. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Only authenticated users with the View Setup and Configuration permission can access this object. ## Fields | Field | Details | | --- | --- | | Address | Type email Properties Create, Filter, Sort, Update Description An email alias that can be used by users of your org. | | DisplayName | Type string Properties Create, Filter, Sort, Update Description The name used to identify the sender of the email. | | IsAllowAllProfiles | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, any user profile in your organization can use this object. If false, only specified user profiles can use this object when sending email. If you do not have the appropriate user profile, you can’t use this object. The default value is false.. | | IsVerified | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the email address has been verified by its owner. The default value is false. This field is available in API version 58.0 and later. Purpose Picklist Possible values are DefaultNoreply, UserSelection, UserSelectionAndDefaultNoReply | | Purpose | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates how an email address can be used. UserSelection allows users with the correct profile to select the address as the From address for an email. Possible values are DefaultNoreply, UserSelection, UserSelectionAndDefaultNoReply. | ## Usage This object represents an email alias to use as the From address for an email, which can be selected by users with a user profile. You can pass in the OrgWideEmailAddress ID when calling [sendEmail()](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_sendemail.htm) for a SingleEmailMessage. # OSAsyncChgCompletedEvent An event that allows the processing of the credit memo, invoices, and other entities after a bulk action has successfully completed. The event provides all of the values that would exist on the synchronous APIs. This object is available in API version 63.0 and later. ## Supported Calls create(), describeSObjects() ## Special Access Rules This object is only available in Salesforce Order Management orgs. ## Fields | Field | Details | | --- | --- | | ActionType | Type string Properties Create, Nillable Description The type of the action that gets applied to Order Summary Possible values are: - CANCEL\_ALL - RETURN\_ALL | | AsyncOperationLogId | Type reference Properties Create, Nillable Description The ID of the AsyncOperationLog. This field is a relationship field. Relationship Name AsyncOperationLog Refers To AsyncOperationLog | | CurrencyIsoCode | Type string Properties Create, Nillable Description The ISO code for the currency of the OrderSummary that's associated with the FulfillmentOrder. This field is available only for orgs with multicurrencies enabled. Possible values are: - CNY—Chinese Yuan - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | EventUuid | Type string Properties Nillable Description Uniquely identifies an event message. The ID used to match the events that are returned in the callback result with the events in the publish call. | | FeeChangeOrderId | Type reference Properties Create, Nillable Description The change order for the fee ID. This order usually used for invoices. This field is a relationship field. Relationship Name FeeChangeOrder Refers To Order | | GrandTotalAmount | Type double Properties Create, Nillable Description The new order summary's grand total. This amount is equal to TotalAmount + TotalTaxAmount. | | InFulfillmentChangeOrderId | Type reference Properties Create, Nillable Description The change order for any items during fulfillment. This field is a relationship field. Relationship Name InFulfillmentChangeOrder Refers To Order | | OrderSummaryId | Type reference Properties Create, Nillable Description The foreign key for the master Order Summary entity. This field is a relationship field. Relationship Name OrderSummary Refers To OrderSummary | | PostFulfillmentChangeOrderId | Type reference Properties Create, Nillable Description The change order for any items post-fulfillment. This ID is used for credit memos refunds This field is a relationship field. Relationship Name PostFulfillmentChangeOrder Refers To Order | | PreFulfillmentChangeOrderId | Type reference Properties Create, Nillable Description The change order for any items that haven't been fulfilled. This field is a relationship field. Relationship Name PreFulfillmentChangeOrder Refers To Order | | TotalAdjDistAmount | Type double Properties Create, Nillable Description The total distributed adjustment amount without taxes. | | TotalAdjDistTaxAmount | Type double Properties Create, Nillable Description The total distributed adjustment taxes. | | TotalAdjustedDeliveryAmount | Type double Properties Create, Nillable Description The total delivery adjusted amount without taxes. | | TotalAdjustedDeliveryTaxAmount | Type double Properties Create, Nillable Description The total delivery adjusted tax amount . | | TotalAdjustedProductAmount | Type double Properties Create, Nillable Description The total adjusted product amount without tax. | | TotalAdjustedProductTaxAmount | Type double Properties Create, Nillable Description The total adjusted product tax amount. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount. | | TotalAmount | Type double Properties Create, Nillable Description The total amount, not including taxes. | | TotalExcessFundsAmount | Type double Properties Create, Nillable Description The amount used to determine if a refund is needed pre-fulfillment. | | TotalFeeAmount | Type double Properties Create, Nillable Description Total fee amount, not including taxes. | | TotalFeeTaxAmount | Type double Properties Create, Nillable Description The total fee tax amount. | | TotalRefundableAmount | Type double Properties Create, Nillable Description The amount that can be refunded to the client. | | TotalRequiredFundsAmount | Type double Properties Create, Nillable Description The total amount of required funds. | | TotalTaxAmount | Type double Properties Create, Nillable Description The combined total of all taxes. | # OutgoingEmail For internal use only. # OutgoingEmailRelation For internal use only. # OutOfOffice Represents a user-set value on a profile that shows when the user intends to be out of the office. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), query(), undelete(), upsert(), update() ## Special Access Rules In Lightning Experience, lets users set a message next to their name in Chatter to show when they plan to be out of the office. The message appears in Lightning Experience, Salesforce Classic, and mobile views. Messages expire automatically after their end date. You can control whether out-of-office functionality is available to your users. Set it up in the Out of Office section in **Setup** | **Chatter Settings**. Only internal users can set an out-of-office message. ## Fields | Field Name | Details | | --- | --- | | EndDate | Type dateTime Properties Create, Filter, Sort, Update Description The date of the last day a person is out of the office. After the message expires, it goes away automatically. | | IsEnabled | Type [boolean](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/primitive_data_types.htm) Properties Create, Defaulted on create Description Indicates whether an out-of-office message can be displayed for a user. The default value is true. | | Message | Type string Properties Create, Filter, Group, Sort, Update Description The message portion of the out-of-office message. This text, along with start and end dates, is appended to the user’s name in the Salesforce user interface. The maximum length of this string is 40 characters. | | StartDate | Type dateTime Properties Create, Filter, Sort, Update Description The date of the first day a person is out of the office. | | UserId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user associated with the out-of-office message. | ## Usage - Maximum message length is 60 characters. - Users can set only their own out-of-office message. An admin can set an out-of-office message for any user. - The out-of-office message can be set only for internal users. # Overview of Salesforce Objects and Fields Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors. The term “record” describes a particular occurrence of an object (such as a specific account like “IBM” or “United Airlines” that is represented by an Account object). A record is analogous to a row in a database table. Objects already created for you by Salesforce are called standard objects. Objects that you create in your organization with the user interface or with the Metadata API are called custom objects. Objects you create that map to data stored outside your organization are called external objects. While this document describes all of the objects available in the API, your applications work with only the objects that you are authorized to access. Programmatic access to objects is determined by the objects defined in your organization, your organization configuration, your user permissions and access settings (which are configured by your organization’s Salesforce admin), your data sharing model, and other factors related specifically to the object. Most of the objects accessible through the API are read-write objects. However, there are a few objects that are read-only. This fact is noted in the description for the object. For details about the data types and size restrictions for each object’s fields, see the [Salesforce Field Reference Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference.htm "HTML (New Window)"). - **[Salesforce Objects Release Notes](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/objects_rns.htm)** Use the Salesforce Release Notes to learn about the most recent updates and changes to Salesforce Objects. - **[Primitive Data Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/primitive_data_types.htm)** - **[Field Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm)** In addition to the primitive data types, the API defines the following data types for fields. - **[API Field Properties](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/access_for_fields.htm)** - **[Required Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/required_fields.htm)** - **[System Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/system_fields.htm)** System fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example, the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies a record. - **[Frequently Occurring Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fequently_occurring_fields.htm)** In addition to system fields, these fields are found on many objects. - **[Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields.htm)** Compound fields group together multiple elements of primitive data types, such as numbers or strings, to represent complex data types, such as a location or an address. Compound fields are an abstraction that can simplify application code that handles the values, leading to more concise, understandable code. - **[Custom Objects](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custom_objects.htm)** In the user interface, you can extend your org’s data by defining custom objects. Custom objects are custom database tables that allow you to store information unique to your organization. For custom objects, the custom flag—a Boolean field in the describe results—is true. - **[Custom Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/custom_fields.htm)** - **[AppExchange Object Prefixes and the API](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/appexchange_api_prefix.htm)** - **[Relationships Among Standard Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/relationships_among_objects.htm)** - **[Factors that Affect Data Access](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/obj_ref_data_access.htm)** Some factors affect access to your organization's data. - **[Field and Type Differences in Salesforce Apps and APIs](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/api_ui_datatype_map.htm)** - **[External Objects](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_external_objects.htm)** External objects are supported in API version 32.0 and later. External objects are similar to custom objects, but external object record data is stored outside your Salesforce organization. For example, perhaps you have data that’s stored on premises in an enterprise resource planning (ERP) system. Instead of copying the data into your org, you can use external objects to access the data in real time via web service callouts. - **[Big Objects](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/obj_ref_big_objects.htm)** A big object stores and manages massive amounts of data on the Salesforce platform. - **[Object Interfaces](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/object_interface.htm)** An object interface defines the business logic that an object implements. The object that implements the interface, called the **implementor**, stores the data and implements the business logic. # OwnedContentDocument Represents a file owned by a user. This object is available in version 30.0 and later. ## Supported Calls describeSObjects() ## Fields | Field Name | Details | | --- | --- | | ContentDocumentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the document. This is a relationship field. Relationship Name ContentDocument Relationship Type Lookup Refers To ContentDocument | | ContentSize | Type int Properties Filter, Group, Nillable, Sort Description The size of the document in bytes for documents smaller than 2 GB. In API version 66.0 and later, we recommend that you use the ContentSizeLong field even for documents smaller than 2 GB. | | ContentSizeLong | Type long Properties Filter, Group, Nillable, Sort Description The size of the document in bytes up to 10 GB. This field is available in API version 66.0 and later. | | ContentUrl | Type url Properties Filter, Group, Nillable, Sort Description URL for links and Google Docs. This field is set only for links and Google Docs, and is one of the fields that determine the FileType. This field is available in API version 31.0 and later. | | ExternalDataSourceName | Type string Properties Filter, Group, Nillable, Sort Description The name of the external data source in which the document is stored. This field is set only for external documents that are connected to Salesforce. This field is available in API version 32.0 and later. | | ExternalDataSourceType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of external data source in which the document is stored. This field is set only for external documents that are connected to Salesforce. This field is available in API version 35.0 and later. | | FileExtension | Type string Properties Filter, Group, Nillable, Sort Description File extension of the document. This field is available in API version 31.0 and later. | | FileType | Type string Properties Filter, Group, Nillable, Sort Description Type of document, which is determined by the file extension. | | OwnerId | Type reference Properties Filter, Group, Sort Description ID of the owner of the document. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | Title | Type string Properties Filter, Group, idLookup, Sort Description Title of the document. | # OwnerChangeOptionInfo Represents default and optional actions that can be performed when a record’s owner is changed. Available in API version 35.0 and later, but to query for change owner metadata, use the OwnerChangeOptionInfo object in Tooling API instead. For more information, see [OwnerChangeOptionInfo](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_ownerchangeoptioninfo.htm) in the Tooling API. ## Supported Calls describeSObjects(), query(), retrieve() Use EntityId or DurableId when querying this object. # Package Install Event Type Package Install events contain details about package installation in the organization. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
EVENT_TYPE
Type
String
Description
The type of event. The value is always PackageInstall.
FAILURE_TYPE
Type
String
Description
A general categorization of any error that’s encountered.
IS_MANAGED
Type
Boolean
Description
True if the operation is performed on a managed package.
IS_PUSH
Type
Boolean
Description
True if the package was installed as a result of a push upgrade.
IS_RELEASED
Type
Boolean
Description
True if the operation is performed on a released package.
IS_SUCCESSFUL
Type
Boolean
Description
True if the package was successfully installed.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
OPERATION_TYPE
Type
String
Description
The type of package operation.
Possible Values
  • INSTALL
  • UPGRADE
  • EXPORT
  • UNINSTALL
  • VALIDATE_PACKAGE
  • INIT_EXPORT_PKG_CONTROLLER
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
PACKAGE_NAME
Type
String
Description
The name of the package that’s being installed.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # PackageInstallEventLog PackageInstallEventLog stores details about package installation in the organization. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | ErrorType | Type string Properties Filter, Group, Nillable, Sort Description A general categorization of any error that’s encountered. | | IsManaged | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if the operation is performed on a managed package. The default value is false. | | IsPush | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if the package was installed as a result of a push upgrade. The default value is false. | | IsReleased | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if the operation is performed on a released package. The default value is false. | | IsSuccessful | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if the package was successfully installed. The default value is false. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The type of package operation. Possible Values - INSTALL - UPGRADE - EXPORT - UNINSTALL - VALIDATE\_PACKAGE - INIT\_EXPORT\_PKG\_CONTROLLER | | PackageName | Type string Properties Filter, Group, Nillable, Sort Description The name of the package that’s being installed. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 18-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943YAS | # PackageLicense Represents a license for an installed managed package. This object is available in API version 31.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field Name | Details | | --- | --- | | AllowedLicenses | Type int Properties Filter, Group, Sort Description The number of users allowed to use the package. | | ExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the package license expires. | | IsAvailableForIntegrations | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Reserved for future use. | | IsProvisioned | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Reserved for internal use. | | NamespacePrefix | Type string Properties Filter, Group, Sort Description The namespace prefix associated with the package. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the license. Possible values are: Active, Expired, Free, and Trial. | | UsedLicenses | Type int Properties Filter, Group, Sort Description The number of users who have a license to the package. | ## Usage Use this object to determine the number of licenses allowed and in use for a managed package installed in your organization. The following example demonstrates the use of the API to manage licenses for a package. The example defines an Apex class that does the following. - Retrieves the PackageLicense record for the specified package (identified by its namespace prefix). - Defines a function that returns a list of all users with the specified profile. - Creates a UserPackageLicense record for each user with that profile, which has the effect of assigning a license for the package to all users with that profile. - Returns an error message if the number of users exceeds the number of available licenses. public class AssignPackageLicense { static String PACKAGE\_NAMESPACE\_PREFIX = 'acme\_101'; static String PROFILE\_ID = '00exx000000jz1SAAQ'; public static String exceptionText {get; set;} public AssignPackageLicense() { exceptionText = 'Initialized'; } static List getUsersWithProfile(){ String userQuery = 'SELECT Id FROM User WHERE ProfileId = :PROFILE\_ID'; List matchingUsers = new List(); matchingUsers = \[SELECT Id FROM User WHERE ProfileId = :PROFILE\_ID\]; return matchingUsers; } public static void assignLicenseByProfile() { //find the PackageLicense Id PackageLicense pl = \[SELECT Id, NamespacePrefix, AllowedLicenses, UsedLicenses, ExpirationDate,Status FROM PackageLicense WHERE NamespacePrefix = :PACKAGE\_NAMESPACE\_PREFIX\]; System.assert(pl != null, 'PackageLicense cannot be null.'); List usersToAssignLicenses = getUsersWithProfile(); List firstUPLs = new List(); //create a new UserPackageLicense record for each user with the specified profile for (Integer i = 0; i< usersToAssignLicenses.size(); i++){ UserPackageLicense upl = new UserPackageLicense(); upl.PackageLicenseId = pl.Id; upl.UserId = usersToAssignLicenses\[i\].Id; firstUPLs.add(upl); } try { //bulk insert insert(firstUPLs); } catch(DmlException e) { for (Integer i = 0; i < e.getNumDml(); i++) { // process exception here System.debug(e.getDmlMessage(i)); String status = e.getDmlStatusCode(i); System.debug(status + ' ' + e.getDmlMessage(i)); if(status.equals('LICENSE\_LIMIT\_EXCEEDED')){ exceptionText = 'You tried to assign more licenses than available. ' +' You tried to create '\+ firstUPLs.size()+' licenses but only have ' + (pl.AllowedLicenses - pl.UsedLicenses) + ' licenses free.'; System.debug(exceptionText); } } } } } # PackagePushError Represents an error encountered during a push request. The number of PackagePushError records created depends on the number of push jobs in the request that result in an error. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To initiate a push upgrade for a first-generation managed package, the Upload AppExchange Packages user permission is required. To initiate a push upgrade for an unlocked or second-generation managed package, the Create and Update Second-Generation Packages user permission is required. The push upgrade feature is only available to first- and second-generation managed packages that have passed AppExchange security review. To enable push upgrades for your managed package, log a support case in the [Salesforce Partner Community.](https://partners.salesforce.com/) For unlocked packages, push upgrades are enabled by default. ## Fields | Field Name | Details | | --- | --- | | ErrorDetails | Type string Properties Nillable, Sort Description Explanation of the error. | | ErrorMessage | Type string Properties Nillable, Sort Description The error code that appears in the API. | | ErrorSeverity | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Valid values are: - Error - Warning | | ErrorTitle | Type string Properties Nillable, Sort Description The error message title that appears in the API. | | ErrorType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Valid values are: - ApexTestFailure - DeployError - FeatureMissing - IneligibleUpgrade - LimitExceeded - LockingFailure - PACError - UnclassifiedError | | PackagePushJobId | Type reference Properties Filter, Group, Nillable, Sort Description Required. The parent push job record ID. | ## Usage Suppose that your push upgrade request wasn’t successful due to some of its jobs failing. Let’s write some code to find out what those errors were. This code sample uses the Web Services Connector (WSC). // Retrieves all PackagePushError objects associated with the PackagePushJob with the given // ID final String PACKAGE\_PUSH\_ERROR\_QUERY = "Select ErrorMessage, ErrorDetails, ErrorTitle," + " ErrorSeverity, ErrorType from PackagePushError where PackagePushJobId = '%s'"; // job is a PackagePushJob instance QueryResult queryResult = conn.query(String.format(PACKAGE\_PUSH\_ERROR\_QUERY, job.getId())); StringBuilder errorMessages = new StringBuilder(); errorMessages.append("Errors for PackagePushJob \[").append(job.getId()).append("\]:") .append("\\n"); // There can be multiple PackagePushErrors for a given PackagePushJob for(SObject r : queryResult.getRecords()) { PackagePushError e = (PackagePushError) r; errorMessages.append("Title: ").append(e.getErrorTitle()).append("\\n"); errorMessages.append("Severity: ").append(e.getErrorSeverity()).append("\\n"); errorMessages.append("Type: ").append(e.getErrorType()).append("\\n"); errorMessages.append("Message: ").append(e.getErrorMessage()).append("\\n"); errorMessages.append("Details: ").append(e.getErrorDetails()).append("\\n"); errorMessages.append("\\n"); } String errors errorMessages.toString(); # PackagePushJob Represents an individual push job for upgrading a package in an org from one version to another version. There can be multiple push jobs created for one push request. For example, if you want to upgrade five orgs as part of one push, you have one PackagePushRequest record and five PackagePushJob records. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To initiate a push upgrade for a first-generation managed package, the Upload AppExchange Packages user permission is required. To initiate a push upgrade for an unlocked or second-generation managed package, the Create and Update Second-Generation Packages user permission is required. The push upgrade feature is only available to first- and second-generation managed packages that have passed AppExchange security review. To enable push upgrades for your managed package, log a support case in the [Salesforce Partner Community.](https://partners.salesforce.com/) For unlocked packages, push upgrades are enabled by default. ## Fields | Field Name | Details | | --- | --- | | DurationSeconds | Type int Properties Group, Nillable Description The length of time in seconds, that the push upgrade took to complete. This field is new in API version 51.0. | | EndTime | Type dateTime Properties Create, Nillable, Update Description The date and time (UTC) at which the push upgrade ended, in ISO 8601 format. This field is new in API version 51.0. | | PackagePushRequestId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The ID of the parent push request record that must have been created. | | StartTime | Type dateTime Properties Create, Nillable, Update Description The date and time (UTC) at which the push upgrade started, in ISO 8601 format. This field is new in API version 51.0. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The status of the job. Valid values are: - Canceled - Created (default) - Failed - In Progress - Pending - Succeeded Don’t specify this value when you create the push job. The default value of Created is used. | | SubscriberOrganizationKey | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The organization key of the org where the package is upgraded. This references orgKey in PackageSubscriber. | ## Usage Suppose that you want to push version 3.4.6 of your package to all orgs. You’ve already identified the orgs eligible for the upgrade by using MetadataPackageVersion and created the push request using PackagePushRequest. Now let’s write some code to create a push job for each eligible org. This code sample uses the Web Services Connector (WSC). PackageSubscriber\[\] subscribers = new PackageSubscriber\[\]; // ... populate eligible and desired subscribers // Create the PackagePushJob array PackagePushJob\[\] jobs = new PackagePushJob\[subscribers.length\]; for (int i = 0; i < subscribers.length; i++) { // create a job for each subscriber... PackagePushJob job = new PackagePushJob(); // ... associate it to the PackagePushRequest ppr... job.setPackagePushRequestId(ppr.getId()); // ... and add the orgKey job.setSubscriberOrganizationKey(subscribers\[i\].getOrgKey()); jobs\[i\] = job; } // Save the jobs SaveResult\[\] saveResults = conn.create(jobs); // Add the newly generated id's to the PackagePushJob objects for (int i = 0; i < saveResults.length; i++) { if (saveResults\[i\].isSuccess()) { jobs\[i\].setId(saveResults\[i\].getId()); } } Or, if you’re using REST API, submit a POST request to the PackagePushJob sObject endpoint, as in the following example. SOAP API is also supported. This example returns the push job ID (starting with 0DX) that is required to query the status of the job. POST /services/data/v38.0/sobjects/packagepushjob/ { "PackagePushRequestId" : "0DV...", "SubscriberOrganizationKey" : "00DR00..." } **Checking the Status of a Push Job** To check the job status, simply query the Status field. For example: SELECT Id, Status FROM PackagePushJob WHERE PackagePushRequestId ='0DV...' Here’s an example in Java. // Finds the status of the PackagePushJob with the given id String PACKAGE\_PUSH\_JOB\_STATUS\_QUERY = "Select status from PackagePushJob where Id = '%s'"; // job is a PackagePushJob instance QueryResult queryResult = conn.query(String.format(PACKAGE\_PUSH\_JOB\_STATUS\_QUERY, job.getId())); // extract the status from the QueryResult String status = ((PackagePushJob) queryResult.getRecords()\[0\]).getStatus(); // optionally, update the PackagePushJob instance with the latest status job.setStatus(status); You can also continuously poll the job status until the job is done. The following Java example polls the status every 10 seconds. // The set of states that indicate a PackagePushJob has completed final Set TERMINAL\_STATES = new HashSet<>(); TERMINAL\_STATES.add("Succeeded"); TERMINAL\_STATES.add("Failed"); TERMINAL\_STATES.add("Canceled"); String status = queryJobStatus(job); // this method returns the status as retrieved in the previous code sample // If the status is not one of the completed statuses... while(!TERMINAL\_STATES.contains(status)) { Thread.sleep(10 \* 1000); // ... wait 10 seconds and try again status = queryJobStatus(job); } # PackagePushRequest Represents the push request for upgrading a package in one or many orgs from one version to another version. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To initiate a push upgrade for a first-generation managed package, the Upload AppExchange Packages user permission is required. To initiate a push upgrade for an unlocked or second-generation managed package, the Create and Update Second-Generation Packages user permission is required. The push upgrade feature is only available to first- and second-generation managed packages that have passed AppExchange security review, and unlocked packages. To enable push upgrades for your managed package, log a support case in the [Salesforce Partner Community.](https://partners.salesforce.com/) For unlocked packages, push upgrades are enabled by default. ## Fields | Field Name | Details | | --- | --- | | DurationSeconds | Type int Properties Group, Nillable Description The length of time in seconds, that the push upgrade took to complete. This field is new in API version 51.0. | | EndTime | Type dateTime Properties Create, Nillable, Update Description The date and time (UTC) at which the push upgrade ended, in ISO 8601 format. This field is new in API version 51.0. | | IsMigration | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required for package upgrades from 1GP to 2GP. If true, indicates that the push request is for upgrading a package from 1GP to 2GP. This field is new in API version 63.0. The default value is false. | | PackageVersionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The non-beta, non-deprecated package version that the package is being upgraded to. | | ScheduledStartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time (UTC) at which the push request is processed, in ISO 8601 format. Set this value to the earliest time that you want Salesforce to attempt to start the push. As a best practice, schedule pushes at off-peak hours like 1:00 AM Saturday. If you don’t specify a value, the push starts when the package push request’s Status is set to Pending. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Scheduled push upgrades begin as soon as resources are available on the Salesforce instance, which is either at or after the start time you specify. In certain scenarios, the push upgrade could start a few hours after the scheduled start time. | | StartTime | Type dateTime Properties Create, Nillable, Update Description The date and time (UTC) at which the push upgrade actually started, in ISO 8601 format. This field is new in API version 51.0. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the push. Valid values are: - Canceled - Created (default) - Failed - In Progress - Pending - Succeeded Don’t specify this value when you create the push request. The default value of Created is used. Later, change the status to Pending to schedule the push upgrade. | ## Usage Suppose that you want to push version 3.4.6 of your package to all orgs. You’ve already identified the orgs eligible for the upgrade by using MetadataPackageVersion. Now let’s write some code to create a push request, which holds a push job for each eligible org. This code sample uses the Web Services Connector (WSC). // Create a new PackagePushRequest for the versionId to upgrade to // (for example, versionId is the "04t..." id of version // 3.4.6 of the package PackagePushRequest ppr = new PackagePushRequest(); ppr.setPackageVersionId(versionId); // Optionally, set the start time of the PackagePushRequest to schedule it to begin // automatically; scheduledStartTime is a java.util.Calendar instance ppr.setScheduledStartTime(scheduledStartTime); // Save the PackagePushRequest SaveResult\[\] saveResults = conn.create(new SObject\[\] { ppr }); if (saveResults\[0\].isSuccess()) { // Add the newly generated Id to the object ppr.setId(saveResults\[0\].getId()); } else { for (Error error : saveResults\[0\].getErrors()) { System.out.println(error.getMessage()); } } Or, if you’re using REST API, submit a POST request to the PackagePushRequest sObject endpoint, as in the following example. SOAP API is also supported. This example returns the push request ID (starting with 0DV) that’s required to create push jobs. POST /services/data/v38.0/sobjects/packagepushrequest/ { "PackageVersionId" : "04t...", "ScheduledStartTime" : "2016-08-24T21:00:00" } As your next step, create a push job for each eligible subscriber you want to upgrade using PackagePushJob. **Scheduling the Push Upgrade** To signal that the push upgrade is ready to be processed, change the status of the push request to Pending. If you didn’t set a ScheduledStartTime, the push upgrade starts immediately after you change the status. See the following Java example. // ppr is the PackagePushRequest instance ppr.setStatus("Pending"); conn.update(new SObject\[\] { ppr }); If you’re using REST API, submit a PATCH request to the PackagePushRequest sObject endpoint, as in the following example. SOAP API is also supported. PATCH /services/data/v38.0/sobjects/packagepushrequest/0DV... { "Status" : "Pending" } **Checking the Status of a Push Request** The PackagePushRequest status is Succeeded if all its associated jobs are successful; it’s Failed if at least one job failed. // Finds the status of the PackagePushRequest for a given Id final String PACKAGE\_PUSH\_REQUEST\_STATUS\_QUERY = "Select status from PackagePushRequest" + " where Id = '%s'"; // ppr is a PackagePushRequest instance QueryResult queryResult = conn.query(String.format(PACKAGE\_PUSH\_REQUEST\_STATUS\_QUERY, ppr.getId())); // extract the status from the QueryResult String status = ((PackagePushRequest) queryResult.getRecords()\[0\]).getStatus(); // optionally, update the PackagePushRequest instance with the latest status ppr.setStatus(status); You can also check the status of a job by querying the PackagePushJob’s Status field. **Aborting a Push Request** You can abort a package push request by changing its status to Canceled. For example, if you’re using the REST API, submit a PATCH request to the PackagePushRequest sObject endpoint. PATCH /services/data/v38.0/sobjects/packagepushrequest/0DV... { "Status" : "Canceled" } The following example is for Java. // ppr is the PackagePushRequest instance ppr.setStatus("Canceled"); You can abort a package push request only if its status is Created or Pending. If the abort succeeds, all associated push jobs are also canceled. If you try to abort when the current PackagePushRequest status is Canceled, Succeeded, Failed, or In Progress, the abort doesn’t occur, and an error message is returned. # PackageSubscriber Represents an installation of a package in an org. This object contains installation information for managed or unlocked packages developed in the org you’re logged in to. One record is created per installation. For example, if 5 orgs installed 2 packages, 10 records are created. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To initiate a push upgrade for a first-generation managed package, the Upload AppExchange Packages user permission is required. To initiate a push upgrade for an unlocked or second-generation managed package, the Create and Update Second-Generation Packages user permission is required. The push upgrade feature is only available to first- and second-generation managed packages that have passed AppExchange security review. To enable push upgrades for your managed package, log a support case in the [Salesforce Partner Community.](https://partners.salesforce.com/) For unlocked packages, push upgrades are enabled by default. ## Fields | Field Name | Details | | --- | --- | | CustomUpgradeType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of push upgrade customization. Possible values are: - BlockedBySubscriber—Blocked By Subscriber - None The default value is None. | | HasRestrictionEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the subscriber org has blocked push upgrades. The default value is false. | | InstalledStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description If the package is installed in the org, the value is i. | | InstanceName | Type string Properties Filter, Group, Nillable, Sort Description The instance that hosts the subscriber org. | | IsCustomUpgradeAllowed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the package developer has allowed a subscriber to opt into customized push upgrades. The default value is false. | | MetadataPackageId | Type reference Properties Filter, Group, Nillable, Sort Description The package ID. Package Ids have a prefix of 033. This field is available in API version 49.0 and later. | | MetadataPackageVersionId | Type reference Properties Filter, Group, Nillable, Sort Description The 18-character package version ID starting with 04t. | | OrgKey | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID that represents the Salesforce org. | | OrgName | Type string Properties Filter, Group, Nillable, Sort Description The name of the org where the package is installed. | | OrgStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Valid values are: - Active - Demo - Free - Inactive - Trial Orgs with an OrgStatus of Inactive can’t receive push upgrades. | | OrgType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Valid values are: - Production - Sandbox | | ParentOrg | Type string Properties Filter, Group, Nillable, Sort Description The production org from which a sandbox was created. | ## Usage Here are examples of the types of API queries you can perform. | Query | String | | --- | --- | | Get all package subscriber orgs with a specific package ID | SELECT Id, OrgKey, OrgStatus, OrgName, OrgType FROM PackageSubscriber WHERE MetadataPackageVersionId = '04t...' | | Get all package subscriber orgs that have an installed package created by the org you’re logged in to | SELECT Id, OrgKey, OrgStatus, OrgName, OrgType FROM PackageSubscriber WHERE InstalledStatus = 'i' | **Filter PackageSubscriber Objects by Instance** If you have packages with many subscribers, querying PackageSubscriber objects can take a while. To improve query performance, add filters to your PackageSubscriber queries, such as an InstanceName filter. InstanceName is a field that represents the instance that the subscriber org is hosted on. 1. Get the org’s package and the latest released version of the package. /\*\* \* Get the MetadataPackage object corresponding to this org's managed package \*/ public MetadataPackage getMetadataPackage() throws ConnectionException { // retrieve the managed package, which won’t have an empty namespace QueryResult result = conn.query("select id from MetadataPackage where namespaceprefix <> ''"); return (MetadataPackage) result.getRecords()\[0\]; } /\*\* \* Get the latest MetadataPackageVersion object of the given MetadataPackage \*/ public MetadataPackageVersion getLatestMetadataPackageVersion(MetadataPackage metadataPackage) throws ConnectionException { // get the latest released version of the given package String query = "Select id, ReleaseState, MajorVersion, MinorVersion, PatchVersion, MetadataPackageId" + " From MetadataPackageVersion" + " Where MetadataPackageId = '%s' and ReleaseState = 'Released'" + " Order by majorversion desc, minorversion desc, patchversion desc"; QueryResult result = conn.query(String.format(query, metadataPackage.getId())); return (MetadataPackageVersion) result.getRecords()\[0\]; } 2. Get eligible subscribers. The following query strings and methods are modified to allow querying for PackageSubscribers filtered by an instance. static final String PACKAGE\_SUBSCRIBER\_ORG\_KEY\_QUERY = "Select OrgKey from PackageSubscribers where OrgStatus = 'Active'" + " and InstalledStatus = 'I'" + " and InstanceName = '%s'"; // placeholder for instance values static final String METADATA\_PACKAGE\_VERSION\_QUERY = "Select Id, Name, ReleaseState, (%s) from MetadataPackageVersion" + " where MetadataPackageId = '%s' AND ReleaseState = 'Released'" + " AND (MajorVersion < %s OR (MajorVersion = %s and MinorVersion < %s)" + " OR (MajorVersion = %s and MinorVersion = %s and PatchVersion < %s))"; /\*\* \* Get all PackageSubscribers on the given instance that are eligible to upgrade to the given \* MetadataPackageVersion \*/ public PackageSubscriber\[\] getEligibleSubscriberIds(MetadataPackageVersion version, String instanceName) throws ConnectionException { String allPackageId = version.getMetadataPackageId(); Integer major = version.getMajorVersion(); Integer minor = version.getMinorVersion(); Integer patch = version.getPatchVersion(); return getEligibleSubscriberIds(major, minor, patch, allPackageId, instanceName); } public PackageSubscriber\[\] getEligibleSubscriberIds(Integer major, Integer minor, Integer patch, String packageId, String instanceName) throws ConnectionException { String subscriberQuery = String.format(PACKAGE\_SUBSCRIBER\_ORG\_KEY\_QUERY, instanceName); QueryResult results = conn.query(String.format(METADATA\_PACKAGE\_VERSION\_QUERY, subscriberQuery, packageId, major, major, minor, major, minor, patch)); return Arrays.stream(results.getRecords()).map(MetadataPackageVersion.class::cast) .filter(mpv -> mpv.getPackageSubscribers() != null) .flatMap(mpv -> Arrays.stream(mpv.getPackageSubscribers().getRecords())) .map(PackageSubscriber.class::cast) .toArray(PackageSubscriber\[\]::new); } 3. Put it all together. The following code sample shows how to use the previous methods to modify the workflow to perform package pushes by instance. String\[\] instances = { "NA4" }; // Here we list the instances we would like to push to MetadataPackage metadataPackage = api.getMetadataPackage(); MetadataPackageVersion version = api.getLatestMetadataPackageVersion(metadataPackage); // do pushes by instance to avoid API timeouts retrieving PackageSubscribers for (String instanceName : instances) { PackageSubscriber\[\] eligibleSubscribers = api.getEligibleSubscriberIds(version, instanceName); // ... proceed with creating PushRequests and PushJobs as before # Participant Represents a participant in a ConversationParticipant. An existing or new Participant is referenced each time a new ConversationParticipant is created. This object is available in API version 57.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available for Einstein Conversation Insights customers whose data is stored natively on the Salesforce Platform. If you turned on Einstein Conversation Insights for the first time starting in Spring ’26, this object is available to query and access using Salesforce tools. For existing ECI customers, data migration and access to related Salesforce Platform objects is scheduled to begin in Summer ’26. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ParticipantAppType | Type string Properties Filter, Group, idLookup, Sort Description The type of app used by the participant, such as messaging, chatbot, live\_message, agent. | | ParticipantRole | Type string Properties Filter, Group, Nillable, Sort Description The role of this participant in the conversation, such as System, Agent, Chatbot, EndUser, Supervisor, or Router. | | ParticipantSubject | Type string Properties Filter, Group, Nillable, Sort Description The subject of this participant in the conversation. | # Partner Represents a partner relationship between two Account records or between an Opportunity record and an Account record. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | AccountFromId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Required if OpportunityId is null. ID of the main account in a partner relationship between two accounts. Specifying this field when creating a Partner record creates two AccountPartner records, one for each direction of the relationship. If you specify the OpportunityId field, you can’t specify this field as well. This is a relationship field. Relationship Name AccountFrom Relationship Type Lookup Refers To Account | | AccountToId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Partner Account related to either an opportunity or an account. You must specify this field when creating an Opportunity Partner or an Account Partner record. This is a relationship field. Relationship Name AccountTo Relationship Type Lookup Refers To Account | | IsPrimary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Valid for Opportunity Partners only. Indicates that the account is the primary partner for the opportunity. Only one account can be marked as primary for an opportunity. If you set this field to 1 (true) upon insert of a new opportunity partner, this field is automatically set to 0 (false) for any other primary partners for that opportunity. Label is **Primary**. | | OpportunityId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Required if AccountFromId is null. ID of the opportunity in a partner relationship between an account and an opportunity. Specifying this field when creating a record creates an OpportunityPartner record. If you specify the AccountFromId field, you can’t also specify this field. This is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity | | ReversePartnerId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the reciprocal Parnter record in a partner relationship. | | Role | Type picklist Properties Create, Filter, Group, Nillable, Sort Description UserRole that the account has toward the related opportunity or account, such as consultant or distributor. | ## Roles In the Salesforce user interface, system administrators can set up the valid role values and their corresponding reverse role values in the PartnerRole object. Each account in the relationship is assigned a Role (such as Consultant or Distributor) designating that account’s role toward the related account or opportunity. ## Creating an Account-Opportunity Partner Relationship When you create a partner relationship between an account and an opportunity (when you create a Partner record and specify the OpportunityId field), the API automatically creates two OpportunityPartner records, one for the forward relationship and one for the reverse. - The value of the Partner field AccountToId maps to the value of the OpportunityPartner field AccountToId. - The values of the OpportunityId, Role, and IsPrimary fields in both the Partner and OpportunityParnter records are the same. - If you set the IsPrimary value to 1 (true) upon insert of a new OpportunityPartner, the IsPrimary value is automatically set to 0 (false) for any existing primary partners for that opportunity. This mapping allows the API to manage the records and their relationships efficiently. ## Creating an Account-Account Partner Relationship When you create a partner relationship between two accounts (when you create a Partner record and specify the AccountFromId), the API automatically creates two AccountPartner records, one for the forward relationship and one for the reverse. For example, if you create a Partner relationship with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId, the API automatically creates two AccountPartner records: - The forward relationship AccountPartner with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId. - The reverse relationship AccountPartner with “Acme Consulting” as the AccountFromId and “Acme, Inc.” as the AccountToId. - The value of the Role field in the reverse relationship AccountPartner is set to the PartnerRole record ReverseRole value associated with the value of the Role field in the forward relationship AccountPartner. This mapping allows the API to manage the records and their relationships efficiently. #### See Also - [AccountPartner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountpartner.htm "This object represents a partner relationship between two Account records. An AccountPartner record is created automatically when a Partner record is created for a partner relationship between two accounts. An AccountPartner record is also created automatically between an account and an opportunity’s account when a Partner record is created between an account and an opportunity.") - [OpportunityPartner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitypartner.htm "This object represents a partner relationship between an Account and an Opportunity. An OpportunityPartner record is created automatically when a Partner record is created for a partner relationship between an account and an opportunity.") - [UserRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_role.htm "Represents a user role in your organization.") - [PartnerRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnerrole.htm "Represents a role for an account Partner, such as consultant, supplier, and so on.") # PartnerFundAllocation Represents allocated funds from a partner marketing budget for channel partners. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort, Update Description Total amount of the allocation. | | BudgetId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the partner marketing budget. | | ChannelPartnerId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the channel partner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The ChannelPartnerId field isn’t supported for formula fields, custom buttons, or custom links for the PartnerFundAllocation object. This limitation also applies to the PartnerMarketingBudget and PartnerFundRequest objects. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the allocation. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the allocation. | | Title | Type string Properties Create, Filter, Group, Sort, Update Description The title of the allocation. | | TotalApprovedFcs | Type currency Properties Filter, Nillable, Sort Description Total amount of approved fund claims. | | TotalApprovedFrs | Type currency Properties Filter, Nillable, Sort Description Total amount of approved fund requests. | | TotalReimbursedFcs | Type currency Properties Filter, Nillable, Sort Description Total amount of reimbursed fund claims. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PartnerFundAllocationFeed](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. [PartnerFundAllocationHistory](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. [PartnerFundAllocationOwnerSharingRule](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. [PartnerFundAllocationShare](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. # PartnerFundClaim Represents a claim of funds from the partner marketing budget by a channel partner. This object is available in API version 41.0 and later. ## Supported Calls create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve() search()update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AllocationId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the partner fund allocation. | | Amount | Type currency Properties Create, Filter, Sort, Update Description Amount of the claim. | | BudgetId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the partner marketing budget. | | ChannelPartnerId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the channel partner. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the fund claim. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the fund claim. | | RequestId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the partner fund request. | | Status | Type picklist Properties Create, Filter, Group, Nillable Restricted picklist, Sort, Update Description Status of the fund claim. Values are: - Draft - Approved - Rejected - Paid | | Title | Type string Properties Create, Filter, Group, Sort, Update Description Title of the fund claim. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PartnerFundClaimFeed](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. [PartnerFundClaimHistory](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. [PartnerFundClaimOwnerSharingRule](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. [PartnerFundClaimShare](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. # PartnerFundRequest Represents a request for funds from the partner marketing budget by a channel partner. This object is available in API version 41.0 and later. ## Supported Calls create(), delete()describeLayout()describeSObjects() getDeleted()getUpdated()query()retrieve()search() update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Activity | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Activity that is covered by the funds, for example, a trade show or seminar. | | AllocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the partner fund allocation. | | Amount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Approved amount of request. | | BudgetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the partner marketing budget. | | ChannelPartnerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the channel partner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The ChannelPartnerId field isn’t supported for formula fields, custom buttons, or custom links for the PartnerFundRequest object. This limitation also applies to the PartnerFundAllocation and PartnerMarketingBudget objects. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the fund request. | | DesiredOutcome | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Desired outcome if requested funds are used. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the fund request. | | RequestedAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Amount of the fund request. | | Status | Type picklist Properties Create, Filter, Nillable, Group, Restricted picklist, Sort, Update Description Status of the fund request. Values are: - Draft - Approved - Rejected | | Title | Type string Properties Create, Filter, Group, Sort, Update Description Title of the fund request. | | TotalApprovedFcs | Type currency Properties Filter, Nillable, Sort Description Total amount of approved fund claims. | | TotalReimbursedFcs | Type currency Properties Filter, Nillable, Sort Description Total amount of reimbursed fund claims. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PartnerFundRequestFeed](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. [PartnerFundRequestHistory](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. [PartnerFundRequestOwnerSharingRule](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. [PartnerFundRequestShare](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. # PartnerMarketingBudget Represents a budget that provides funds to channel partners for selling and marketing products and services. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort, Update Description Total amount of the budget. | | ChannelPartnerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the channel partner. This field is available in API version 45.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The ChannelPartnerId field isn’t supported for formula fields, custom buttons, or custom links for the PartnerMarketingBudget object. This limitation also applies to the PartnerFundAllocation and PartnerFundRequest objects. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the budget. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when the budget is no longer available. | | IsIgnoreValidation | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description When enabled, ignores restrictions related to the child objects connected to the budget. Note that individual totals for allocation amounts, request amounts, and claims amounts cannot exceed the total of their parent budget. Field is default off (false) on create. Once enabled (true), this field cannot be disabled. This field is available in API version 44.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the budget. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when the budget becomes available. | | Title | Type string Properties Create, Filter, Group, Sort, Update Description Title of the budget. | | TotalAllocatedAmount | Type currency Properties Filter, Nillable, Sort Description Total funds allocated to channel partners or as a fund pool. | | TotalApprovedFcs | Type currency Properties Filter, Nillable, Sort Description Total amount of approved fund claims. | | TotalApprovedFrs | Type currency Properties Filter, Nillable, Sort Description Total amount of approved fund requests. | | TotalReimbursedFcs | Type currency Properties Filter, Nillable, Sort Description Total amount of reimbursed fund claims. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Type of budget. Values are: - Co-Operated Budget—Funds accrue based on a percentage of partner sales. The funds are available based on previous activity. - Marketing Funds—Funds are issued to partners in advance of sales. The funds are awarded based on predicted or expected behavior. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PartnerMarketingBudgetFeed](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. [PartnerMarketingBudgetHistory](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. [PartnerMarketingBudgetOwnerSharingRule](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. [PartnerMarketingBudgetShare](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. # PartnerNetworkConnection Represents a Salesforce to Salesforce connection between Salesforce organizations. ## Supported Calls create(), describeSObjects(), query(), retrieve() ## Special Access Rules As of Winter ’21 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Account associated with this connection. | | ConnectionName | Type string Properties Filter, idLookup, Sort Description A descriptive name for the connection. Limit: 295 characters. | | ConnectionStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the Salesforce to Salesforce connection. The picklist includes the following values: - Sent - Received - Pending - Accepted - Rejected - Inactive - Disconnecting - ConnectionSuspended - SubscribeInProgress - UsersInitialSync - BulkSyncMetadata | | ConnectionType | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of Salesforce to Salesforce connection. The picklist includes the following values: - Standard - Replication This field is available in API version 30.0 and later. | | ContactId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Contact associated with this connection. | | IsSyncAuditFields | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether audit fields are synced between the primary and secondary organization in a replication connection. This field is available in API version 32.0 and later, and is only accessible in Salesforce organizations where Organization Sync is enabled. | | IsSyncMetadata | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether supported types of metadata are synced from the primary to the secondary organization in a replication connection. This field is available in API version 33.0 and later, and is only accessible in Salesforce organizations where Organization Sync is enabled. | | IsSyncUsers | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether users with standard Salesforce user licenses are synced between the primary and secondary organization in a replication connection. This field is available in API version 35.0 and later, and is only accessible in Salesforce organizations where Organization Sync is enabled. | | PrimaryContactId | Type reference Properties Filter, Group, Sort Description ID of the User associated with this connection. | | ReplicationRole | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The role of this Salesforce organization in the replication connection. The picklist includes the following values: - Primary - Secondary This field is available in API version 30.0 and later, and is only accessible in Salesforce organizations where Organization Sync is enabled. | | ResponseDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the connection was accepted or rejected. | ## Usage Represents Salesforce to Salesforce standard and replication connections. This object is referenced by all objects that have been shared with other organizations, enabling you to determine which connections shared a record with you. If the organization does not have Salesforce to Salesforce enabled, the PartnerNetworkConnection object is not available, and you can’t access it via the API. #### See Also - [PartnerNetworkRecordConnection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnernetworkrecordconnection.htm "Represents a record shared between Salesforce organizations using Salesforce to Salesforce.") # PartnerNetworkRecordConnection Represents a record shared between Salesforce organizations using Salesforce to Salesforce. ## Supported Calls create(), query() ## Special Access Rules As of Winter ’21 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | ConnectionId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Required. ID of the connection a record is shared with. | | EndDate | Type dateTime Properties Filter, Nillable, Sort Description Date that sharing of the record was stopped. | | LocalRecordId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the shared record. | | ParentRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the parent record of the shared record. | | PartnerRecordId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the shared record in the connection's organization. | | RelatedRecords | Type string Properties Create, Filter, Nillable, Sort Description A comma-separated list of API names for child records to be shared with a parent record. | | SendClosedTasks | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Forwards closed tasks related to the shared record. | | SendEmails | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Sends an email notifying the connection's representative that you have forwarded the record to them. Only new recipients of a record will receive a notification email. | | SendOpenTasks | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Forwards open tasks related to the shared record. | | StartDate | Type dateTime Properties Filter, Nillable, Sort Description Date that the shared record was accepted. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the shared record. One of the following values: - Active (received) - Active (sent) - Connected - Inactive - Inactive (converted) - Inactive (deleted) - Pending (sent) | ## Usage When you create a PartnerNetworkRecordConnection, you forward a record to a connection. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Attempting to forward a record from an object to which the connection is not subscribed results in an Invalid Partner Network Status error. When you delete a PartnerNetworkRecordConnection, you stop sharing a record with a connection. - To share a record, use the following fields: LocalRecordID and ConnectionId - To share a child of a parent record, use the following fields: LocalRecordID, ConnectionId, and ParentRecordID - To share a child of a parent record and its child records, use the following fields: LocalRecordID, ConnectionId, ParentRecordID, and RelatedRecords If the organization does not have Salesforce to Salesforce enabled, the PartnerNetworkRecordConnection object is not available, and you can’t access it using the API. #### See Also - [PartnerNetworkConnection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnernetworkconnection.htm "Represents a Salesforce to Salesforce connection between Salesforce organizations.") # PartnerNetworkSyncLog Represents the Org Sync Log tab in Salesforce, where Salesforce administrators can track the replication of record inserts and updates being performed in Organization Sync. The Connection Detail page for the replication connection also displays the Org Sync Log’s twenty most recent entries, and provides a link to the log. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules The Org Sync Log tab can only be added in organizations where Organization Sync has been enabled. To add the tab to the Salesforce user interface, users must also have the “Manage Connections” user permission. ## Fields | Field Name | Details | | --- | --- | | ConnectionEvent | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The action being replicated to the partner organization, such as a record insertion. | | ConnectionId | Type reference Properties Filter, Group, Sort Description The ID of the Salesforce to Salesforce replication connection in which the replication event succeeded or failed. | | Description | Type textarea Properties Nillable Description A description of the replication event. | | EntityType | Type string Properties Filter, Group, Nillable, Sort Description The type of record being inserted or updated. | | Error | Type string Properties Filter, Group, Nillable, Sort Description The code used to describe the replication failure or success. | | LocalRecord | Type string Properties Filter, Group, Sort Description The record being inserted or updated. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description An item is added to the Organization Sync Log if it failed to be replicated to the linked organization. This picklist includes the following values: - Failed: The replication continued to fail after multiple retries, and won’t be retried further. - Resolved: The replication succeeded after retrying. - Retrying: Salesforce is retrying the replication. This field is available in API version 35.0 and later. | # PartnerRole Represents a role for an account Partner, such as consultant, supplier, and so on. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an id or master label. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Master label for this partner role value. This display value is the internal label that does not get translated. Limit: 255 characters. | | ReverseRole | Type picklist Properties Filter, Group, Nillable, Sort Description Name of the reverse role that corresponds to this partner role. For example, if the role is “subcontractor,” then the reverse role might be “general contractor.” In the user interface, assigning a partner role to an account creates a reverse partner relationship so that both accounts list the other as a partner. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the partner role picklist. These numbers are not guaranteed to be sequential, as some previous partner role values might have been deleted. | ## Usage This object represents a value in the partner role picklist. In the user interface, the partner role picklist provides additional information about the role of a Partner, such as their corresponding reverse role. Query this object to retrieve the set of values in the partner role picklist, and then use that information while processing PartnerRole records to determine more information about a given partner role. For example, the application could determine the reverse role of a given Partner Role value and the value of the ReverseRole property in the associated PartnerRole object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # PartyConsent Represents consent preferences for an individual. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Action | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The action that the Individual is consenting to. Possible values are: - CrossDevice - DataCollection - Reidentification - Segment - ShareData - Target | | CaptureContactPointType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Indicates how you captured consent. Possible values are: - Email - MailingAddress - Phone - Social - Web | | CaptureDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Required. Date when consent was captured. | | CaptureSource | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. Indicates how you captured consent. For example, a website or online form. | | DoubleConsentCaptureDate | Type dateTime Properties Filter, Group, Nillable, Sort Description The specific date and time the consent was confirmed for the data subject via a secondary verification method (for example, clicking a link in a confirmation email). Essential for high-standard Double Opt-In audit trails. | | EffectiveFrom | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the data subject's consent becomes valid. Use this field to track the beginning of the legal period for which the party has agreed to data processing or communication. | | EffectiveTo | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the data subject's consent expires or is scheduled to end. This field helps automate compliance by identifying when consent should no longer be honored. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the party consent record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account owner associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PartyId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. Represents the record based on the Individual object you want to associate consent with. This is a relationship field. Relationship Name Party Relationship Type Lookup Refers To Individual | | PrivacyConsentStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. Identifies whether the individual associated with this record agrees to this form of contact. Possible values are: - NotSeen - OptIn - OptInPending—Available in API version 58.0 and later. - OptOut - OptOutPending—Available in API version 58.0 and later. - Seen | ## 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. [PartyConsentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [PartyConsentFeed](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. [PartyConsentHistory](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. [PartyConsentOwnerSharingRule](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. [PartyConsentShare](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. # Payment Represents a single event when a shopper makes a payment. For credit cards, this event is a payment capture or payment sale, but it doesn't appear on the shopper's credit card statement. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can edit or delete a payment only in draft state, which you specify with the **Status** field. ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account of the customer who made the payment. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | Amount | Type currency Properties Create, Filter, Sort, Update Description The amount to be debited or captured. | | Balance | Type currency Properties Filter, Nillable, Sort Description The total amount – the net applied amount. | | CancellationDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date that the payment was voided. | | CancellationEffectiveDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the cancellation of this payment takes effect. | | CancellationGatewayDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The gateway provides this date following a successful cancellation request. | | CancellationGatewayRefNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description System-provided unique transaction ID from the payment gateway. | | CancellationGatewayResultCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Gateway-specific result code. Must be mapped to a Salesforce-specific result code. | | CancellationSfResultCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A Salesforce result code that can be mapped to one or more gateway result codes. We recommend that the payment gateway adapter layer maps gateway-specific codes to the Salesforce result code. | | ClientContext | Type textarea Properties Nillable Description Contains caller context for payment APIs. Useful for re-establishing context during an asynchronous payment transaction. | | Comments | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Users can provide additional details about the payment record. Supports a maximum of 1000 characters. | | CorporateCurrencyCvsnDate | Type date Properties Filter, Group, Nillable, Sort, Update Description The date on which the invoiceʼs total amount with tax was converted to the corporate currency. Available in API version 63.0 and later. | | CorporateCurrencyCvsnRate | Type double Properties Filter, Nillable, Sort, Update Description The exchange rate thatʼs used to convert the invoiceʼs total amount with tax to the corporate currency. Available in version 63.0 and later. | | CorporateCurrencyISOCode | Type string Properties Filter, Group, Nillable, Sort, Update Description The currency ISO code of the corporate currency. Available in version 63.0 and later. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the payment group record. | | Date | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when this payment record was created. | | EffectiveDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date that this payment takes effect. | | Email | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the user who initiated the payment. | | GatewayDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The gateway provides this date for reference following a successful gateway communication. | | GatewayRefDetails | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Additional data that can’t be stored in other fields on the payment record. You can use this field for transactions following the initial transaction that creates the payment record. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML. | | GatewayRefNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique transaction ID created by the payment gateway. | | GatewayResultCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Gateway-specific result code that must map to a Salesforce-specific result code. One Salesforce result code can map to multiple gateway result codes. | | GatewayResultCodeDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the gateway’s result code. | | ImpactAmount | Type currency Properties Filter, Nillable, Sort Description Shows the payment’s financial impact against the customer’s accounts receivable. If the payment is valid, this value is the negative of the payment amount. If the payment is voided, this value is 0. | | IpAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The IP address of the user who initiated the payment. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record is possibly referenced (LastReferencedDate) but not viewed. | | LegalEntityId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The legal entity used in this invoice. Available in API version 65.0 and later. This field is a relationship field. Relationship Name LegalEntity Refers To LegalEntity | | MacAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The MAC address of the person who initiated the payment. | | NetApplied | Type currency Properties Filter, Nillable, Sort Description Total payment amount that has been applied, including adjustments. | | NetPaymentCreditApplied | Type currency Properties Filter, Sort Description Total payment amount that has been credited. This amount is equal to TotalPaymentCreditApplied - TotalPaymentCreditUnapplied. This field is a calculated field. This field is available in API version 65.0 and later. | | NetRefundApplied | Type currency Properties Filter, Nillable, Sort Description Total refund amount that has been applied to the payment, including adjustments. | | OrderPaymentSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Order payment summaries show the balances of each authorization, capture, and refund made against an order. | | PaymentAuthorizationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The authorization record for this payment. If there's a delayed capture (when the capture occurs after the authorization), all captures must be made against a previously successful authorization transaction. This field is a relationship field. Relationship Name PaymentAuthorization Relationship Type Lookup Refers To PaymentAuthorization | | PaymentGatewayId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the payment gateway that processed the payment. If there’s a delayed payment, the field is populated from the authorization record. This field is a relationship field. Relationship Name PaymentGateway Relationship Type Lookup Refers To PaymentGateway | | PaymentGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Payment groups organize all the payment transactions that have been made against a record such as an account or contract. If there’s a delayed payment, the field is populated from the authorization record. This field is a relationship field. Relationship Name PaymentGroup Relationship Type Lookup Refers To PaymentGroup | | PaymentIntentGuid | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort Description Unique ID of the payment sent to Stripe or PayPal. Links the Payments Merchant Account record with the payment at the payment provider. | | PaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The payment method that the customer used to provide this payment information. This field is a relationship field. Relationship Name PaymentMethod Relationship Type Lookup Refers To PaymentMethod | | PaymentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-created unique ID for this payment record. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the customer who initiated the payment. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Defines whether the payment has been made outside of the payment platform. Possible values are: - External: Transactions happened outside of the Salesforce payments platform. - Salesforce: Salesforce made and recorded an external call to the payment gateway. | | SfResultCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Salesforce-specific result code that can map to one or more gateway result codes. We recommend configuring the payment gateway adapter layer to map gateway result codes to the appropriate Salesforce result code. Possible values are: - Decline: The gateway call failed, but if the problem is fixed and the transaction is retried, it can work. For example, the customer had insufficient funds or briefly lost their connection. - Indeterminate: The gateway didn’t respond to the call. This response usually happens when Salesforce times out while waiting for a response from the gateway. - PermanentFail: The gateway call failed. If tried again, it still doesn't work. Gateway calls fail permanently for one of two reasons: - Hard Decline: The customer’s payment account has been closed or terminated. - Fraud: The gateway recognized the payment or payment method as known fraud. - RequiresReview: The customer bank requires more information before completing the payment. - Success: The gateway call succeeded. - SystemError: Salesforce ended the payment request before receiving a response. For example, Salesforce lost credentials or access to its server. Salesforce ends payment calls if it doesn’t receive a response from the gateway within two minutes. - ValidationError: Customer payment data was incorrect, such as a misspelling in the credit card address or an incorrect CVV. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines the state of this payment. Possible values are: - Canceled: This payment has been unapplied from its target and can no longer be allocated. - Draft: The payment can be edited before posting it and allocating it to a target. The payment can also be deleted. - Processed: This payment has been finalized and can be allocated against a target. Users can manually change the Status field’s values as follows: - Draft to Processed - Processed to Canceled - Draft to Canceled | | TotalApplied | Type currency Properties Filter, Nillable, Sort Description The total amount of this payment’s balance that has been applied against an invoice. | | TotalPaymentCreditApplied | Type currency Properties Filter, Sort Description The total amount of all credit types that have been applied against this payment. This field is a calculated field. This field is available in API version 65.0 and later. | | TotalPaymentCreditUnapplied | Type currency Properties Filter, Sort Description The total amount of all credit types that haven't been applied against this payment. This field is a calculated field. This field is available in API version 65.0 and later. | | TotalRefundApplied | Type currency Properties Filter, Nillable, Sort Description The total amount of a refund that has been applied against this payment. | | TotalRefundUnapplied | Type currency Properties Filter, Nillable, Sort Description The total amount of a previously applied refund that has since been unapplied from this payment. | | TotalUnapplied | Type currency Properties Filter, Nillable, Sort Description The total amount of this payment that was previously applied and then unapplied. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines how the customer used this payment. Possible values are: - Capture - Sale | #### See Also - [OrderPaymentSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderpaymentsummary.htm "Represents the current properties and state of payments using a single payment method that are applied to one OrderSummary. This object is available in API version 48.0 and later.") # PaymentAuthAdjustment Shows information about an adjustment made to an authorized transaction. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can only delete a payment in draft state, which you specify in the **Status** field. ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account for the payment authorization adjustment. Inherited from the payment authorization. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | Amount | Type currency Properties Create, Filter, Sort, Update Description Amount of adjustment applied to the parent payment authorization. | | Comments | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Users can add comments to provide additional details about a record. Maximum of 1000 characters. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the payment authorization adjustment record. | | Date | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date that the adjustment occurred. | | EffectiveDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date that the adjustment takes effect on the authorization. | | Email | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the parent payment authorization owner. | | GatewayDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that the reversal transaction occurred in the payment gateway. | | GatewayRefDetails | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Additional data that can’t be stored in other fields on the payment record. You can use this field for transactions following the initial transaction that creates the payment record. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML. | | GatewayRefNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique transaction ID created by the payment gateway. | | GatewayResultCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Gateway-specific result code. Must be mapped to a Salesforce-specific result code | | GatewayResultCodeDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the gateway’s result code. This field is useful for providing more information around why the gateway returned a certain result code. | | IpAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The IP address of the user who initiated the payment adjustment. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | MacAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The MAC address of the person who initiated the payment. | | PaymentAuthAdjustmentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-provided unique ID for a payment authorization adjustment record. | | PaymentAuthorizationId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the payment authorization on which the adjustment occurred. This is a relationship field. Relationship Name PaymentAuthorization Relationship Type Lookup Refers To PaymentAuthorization | | PaymentIntentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the payment intent record. This field is a relationship field. Relationship Name PaymentIntent Relationship Type Lookup Refers To PaymentIntent | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the customer who initiated the authorization adjustment. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines whether the payment has been made outside of the payment platform. Possible values are: - External—Transactions happened outside of the Salesforce payments platform. - Salesforce—Salesforce made and recorded an external call to the payment gateway. | | SfResultCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Salesforce-specific result code that can map to one or more gateway result codes. We recommend configuring the payment gateway adapter layer to map gateway result codes to the appropriate Salesforce result code. Possible values are: - Decline—The gateway call failed, but it might work if the transaction is attempted again. For example, the customer had insufficient funds or briefly lost their connection. - Indeterminate—The gateway didn’t respond to the call. This response usually happens when Salesforce times out while waiting for a response from the gateway. - PermanentFail—The gateway call failed and won’t work even if tried again. Gateway calls fail permanently for one of two reasons: - Hard Decline: The customer’s payment account has been closed or terminated. - Fraud: The gateway recognized the payment or payment method as known fraud. - RequiresReview—The customer bank requires more information before completing the payment. - Success—The gateway call succeeded. - SystemError—Salesforce ended the payment request before receiving a response. For example, Salesforce lost credentials or access to its server. Salesforce ends payment calls if it doesn’t receive a response from the gateway within two minutes. - ValidationError—Customer payment data was incorrect, such as a misspelling in the credit card address or an incorrect CVV. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines the state of the payment authorization reversal. Possible values are: - Canceled—The payment authorization reversal has been canceled. The parent authorization has returned to its pre-reversal balance. - Draft: The payment authorization reversal can be edited before applying it against the parent authorization. - Pending: The payment authorization reversal is pending. This value is available in API version 61.0 and later. - Processed—The payment authorization reversal has been finalized. Users can manually change the Status field’s values as follows: - Draft to Processed - Processed to Canceled - Draft to Canceled | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines how the customer used the reversal. Possible value is: - Reversal | # PaymentAuthorization Represents a single payment authorization event where users can capture or reverse a payment against a reserve of funds. This object is available in API version 48.0 and later. A common type of payment authorization occurs when a user sees a pending transaction against their credit card account. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can only delete a payment in draft state, which you specify in the **Status** field. ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Customer account. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | Amount | Type currency Properties Create, Filter, Sort, Update Description The amount authorized for the payment event. | | Balance | Type currency Properties Filter, Nillable, Sort Description Authorized amount – total processed captured amount – total processed authorization reversal amount. Balance can be positive or negative. | | Comments | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Users can enter comments to provide additional details about the authorization. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the payment authorization record. | | Date | Type dateTime Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description By default, the day the authorization record was created. Users can also enter a different date. Editable only when the payment authorization’s status is Draft. | | EffectiveDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the authorization takes effect. Editable only when the payment authorization’s status is Draft. | | Email | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the person who initiated the payment. | | ExpirationDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Authorizations can’t be captured after their expiration dates. | | GatewayAuthCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Authorization approval code from the payment gateway. | | GatewayDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that of the gateway communication that leads to the successful payment authorization. | | GatewayRefDetails | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Additional data that can’t be stored in other fields on the payment record. You can use this field for transactions following the initial transaction that creates the payment record. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML. | | GatewayRefNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique transaction ID from the payment gateway. | | GatewayResultCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Gateway-specific result code. Must be mapped to a Salesforce-specific result code. | | GatewayResultCodeDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the gateway’s result code. This field is useful for providing more information around why the gateway returned a certain result code. | | IpAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The IP address of the user who initiated the payment authorization. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | MacAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The MAC address of the person who initiated the payment. | | OrderPaymentSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Order payment summaries show the balances of each authorization, capture, and refund made against an order. | | PaymentAuthorizationNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-provided unique ID for a payment authorization record. | | PaymentGatewayId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Salesforce payment gateway record that created this authorization. This gateway will be used for subsequent captures. This is a relationship field. Relationship Name PaymentGateway Relationship Type Lookup Refers To PaymentGateway | | PaymentGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Payment groups organize all the payment transactions that have been made against a record such as an account or contract. Populated from the authorization record if there is delayed payment. This is a relationship field. Relationship Name PaymentGroup Relationship Type Lookup Refers To PaymentGroup | | PaymentIntentGuid | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort Description Unique ID of the payment sent to Stripe or PayPal. Links the Payments Merchant Account record with the payment at the payment provider. | | PaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The customer payment method provided during this authorization. This is a relationship field. Relationship Name PaymentMethod Relationship Type Lookup Refers To PaymentMethod | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the person who initiated the payment. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Defines whether the payment has been made outside of the payment platform. Possible values are: - External—Transactions happened outside of the Salesforce payments platform. - Salesforce—Salesforce made and recorded an external call to the payment gateway. | | SfResultCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Salesforce-specific result code that can map to one or more gateway result codes. We recommend configuring the payment gateway adapter layer to map gateway result codes to the appropriate Salesforce result code. Possible values are: - Decline—The gateway call failed, but it may still work if the transaction is attempted again. For example, the customer had insufficient funds or briefly lost their connection. - Indeterminate—The gateway didn’t respond to the call. This response usually happens when Salesforce times out while waiting for a response from the gateway. - PermanentFail—The gateway call failed and won’t work even if tried again. Gateway calls fail permanently for one of two reasons: - Hard Decline: The customer’s payment account has been closed or terminated. - Fraud: The gateway recognized the payment or payment method as known fraud. - RequiresReview—The customer bank requires more information before completing the payment. - Success—The gateway call succeeded. - SystemError—Salesforce ended the payment request before receiving a response. For example, Salesforce lost credentials or access to its server. Salesforce ends payment calls if it doesn’t receive a response from the gateway within two minutes. - ValidationError—Customer payment data was incorrect, such as a misspelling in the credit card address or an incorrect CVV. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines the state of this payment. Possible values are: - Canceled—This payment has been unapplied from its target and can to longer be allocated. - Draft—The payment can be edited before posting it and allocating it to a target. - Failed—Authorization for the payment failed. - Pending— - Processed—This payment has been finalized and can be allocated against a target. Users can manually change the Status field’s values as follows: - Draft to Processed - Processed to Canceled - Draft to Canceled | | TotalAuthReversalAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all processed authorization reversals against the payment authorization. This is a calculated field. | | TotalPaymentCaptureAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all authorization captures related to this payment authorization. | #### See Also - [OrderPaymentSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderpaymentsummary.htm "Represents the current properties and state of payments using a single payment method that are applied to one OrderSummary. This object is available in API version 48.0 and later.") # PaymentCredit Tracks the amount of money returned to the customer. The return can be a store credit, a gift card, or another type of credit. It's linked to the original payment record and includes the total credit amount issued. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce or D2C Commerce license is enabled. Users require the PaymentCredit and PaymentPlatform permission sets. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account of the customer who made the payment. This field is a relationship field. This is a required field. Relationship Name Account Refers To Account | | Amount | Type currency Properties Create, Filter, Sort Description The amount to be credited. This is a required field. | | Balance | Type currency Properties Filter, Nillable, Sort Description Balance of payment credits (NetApplied - TotalCredit TransactionAmount - TotalCredit PendingTransactionAmount). | | Comments | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Provide additional details about the payment credit transaction. | | CreditMemoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the credit memo associated with the payment credit. This field is a relationship field. Relationship Name CreditMemo Refers To CreditMemo | | CreditType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Credit types available. This is a dynamic picklist that the user can define. Possible values are: - Credit - Gift Card - Gift Certificate | | CreditTypeCategory | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A static enum showing the credit category type. Possible value is: - Credit | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Contains the ISO code for any currency allowed by the organization. Possible values are: - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | EffectiveDate | Type dateTime Properties Create, Filter, Sort, Update Description Effective date of the payment credit. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | NetApplied | Type currency Properties Filter, Nillable, Sort Description Total of all credit amounts apllied for this payment credit (TotalCreditApplied - TotalCreditUnapplied). | | OrderPaymentSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the order payment summary. This field is a relationship field. Relationship Name OrderPaymentSummary Refers To OrderPaymentSummary | | PaymentCreditNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the payment credit record. This field is automatically generated. Example: PC-{000000000}. | | PaymentId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the payment associated with the payment credit. This field is a relationship field. Relationship Name Payment Refers To Payment | | ReturnOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the return order associated with the payment credit. This field is a relationship field. Relationship Name ReturnOrder Refers To ReturnOrder | | TotalApplied | Type currency Properties Filter, Nillable, Sort Description Sum of all applied amounts from the payment credit line payment. | | TotalCreditPendingTxnAmt | Type currency Properties Filter, Nillable, Sort Description Sum of pending payment credits. | | TotalCreditTxnAmt | Type currency Properties Filter, Nillable, Sort Description Sum of processed payment credits. | | TotalUnapplied | Type currency Properties Filter, Nillable, Sort Description Sum of all the unapplied amounts from the payment credit line payment. | # PaymentCreditLinePayment A payment credit line payment. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce or D2C Commerce license is enabled. Users require the PaymentCredit and PaymentPlatform permission sets. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort Description Amount to apply to or unapply from the payment to the credit. This is a required field. | | AppliedDate | Type dateTime Properties Filter, Nillable, Sort Description Date payment was applied. Can be the current date or a provided date. | | AssociatedAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the customer account. This field is a relationship field. Relationship Name AssociatedAccount Refers To Account | | AssociatedLineId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the associated line. This field is a relationship field. Relationship Name AssociatedLine Refers To PaymentCreditLinePayment | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Contains the ISO code for any currency allowed by the organization. Possible values are: - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description regarding the payment credit. | | HasBeenUnapplied | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the refund line record with type Applied has been unapplied. Not applicable for a refund line record with type Unapplied. This is a required field. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | PaymentCreditId | Type reference Properties Create, Filter, Group, Sort Description ID of the payment credit. This field is a relationship field. This is a required field. Relationship Name PaymentCredit Refers To PaymentCredit | | PaymentCreditLine PaymentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Number of the payment credit line payment. This field is automatically generated. Example: PCLP-{000000000}. | | PaymentId | Type reference Properties Create, Filter, Group, Sort Description ID of the applied payment credit. This field is a relationship field. Relationship Name Payment Relationship Type Master-detail Refers To Payment (the master object) | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Payment credit type. This is a required field. Possible values are: - Applied - Unapplied | | UnappliedDate | Type dateTime Properties Filter, Nillable, Sort Description Date payment was unapplied. Can be the current date or a provided date. | # PaymentCreditTransaction A payment credit transaction. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce or D2C Commerce license is enabled. Users require the PaymentCredit and PaymentPlatform permission sets. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort Description Amount of the payment credit transaction. This is a required field. | | AssociatedAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the customer account. This field is a relationship field. Relationship Name AssociatedAccount Refers To Account | | ClientContext | Type textarea Properties Nillable Description Additional information about the payment credit transaction. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Contains the ISO code for any currency allowed by the organization. Possible values are: - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | ExternalReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reference ID used to track the payment credit transaction. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | PaymentCreditId | Type reference Properties Create, Filter, Group, Sort Description ID of the payment credit. This field is a relationship field. This is a required field. Relationship Name PaymentCredit Relationship Type Master-detail Refers To PaymentCredit (the master object) | | PaymentCreditTransactionNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Number of the payment credit transaction. This field is automatically generated. Example: PCT-{000000000}. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Credit transaction processing mode. Possible values are: - External - Salesforce This is a required field. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A static enum showing the status of the credit transaction. Possible values are: - Canceled - Draft - Failed - Pending - Processed | | TransactionMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Message describing the transaction. | # PaymentGateway Platform object that represents the connection to an external payment gateway. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | Comments | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Admin-provided details about a record. Maximum of 1000 characters. | | DefaultTapToPayLocation | Type string Properties Filter, Group, Nillable, Sort Description Stores the locationId of the location record created at Stripe. The Field Service app uses the location to process where tap-to-pay transactions are made. | | ExternalReference | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Identifier of an external payment gateway. This field is unique within your organization. | | GatewayMode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The operational mode of the payment gateway. This field determines the payment gateway’s ability to accept payments. For production orgs, the gateway must be in Live mode. Possible values are: - Connected– Payment gateway is active but it can’t accept payments. This option is only valid in production orgs. - Live– Payment gateway is active and can accept payments. This option is only valid in production orgs. - Test –Payment gateway is active but not able to accept payments. This option is only valid in sandbox orgs, and the account can accept only test transactions. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it's possible this record is only referenced (LastReferencedDate) but not viewed. | | MerchantAccountId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the merchant account used by the payment gateway. This merchant account links to a merchant account at a payment processor. This field is a relationship field. Relationship Name MerchantAccount Relationship Type Lookup Refers To MerchantAccount | | MerchantCredentialId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the merchant credential setup entity to reference merchant information. This field is a relationship field. Relationship Name MerchantCredential Relationship Type Lookup Refers To NamedCredential | | PaymentGatewayName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Admin-defined name for the payment gateway. | | PaymentProcessor | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Name of payment gateway provider. Possible values are: - Paypal - Stripe | | PaymentStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The payment gateway is active and can accept payments. Possible values are: - Enabled - Disabled The default value is Disabled. | | PayoutStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Money can be moved from the payment provider account to the merchant bank account linked to it. Possible values are: - Enabled - Disabled The default value is Disabled. | | PaymentGatewayProviderId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the payment gateway that handles transactions between the merchant account and the payment processor. This field is a relationship field. Relationship Name PaymentGatewayProvider Relationship Type Lookup Refers To PaymentGatewayProvider | | ProviderAccount | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Account ID assigned by the payment provider that identifies the linked Salesforce Payments account. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines whether Salesforce Payments can use this payment gateway for calls to the external payment gateway. Inactive payment gateways can’t be used. Possible values are: - Active - the merchant account can accept payments. - Complete – PaymentStatus and DepositStatus are enabled and the account provided all the required information. - Enabled – PaymentStatus and PayoutStatus are enabled, but the payment provider can require more information later. If the merchant doesn't provide the information then the account can become restricted. The time limit that the merchant has to provide the information is longer than the RestrictedSoon state. - Pending–The merchant account exists but it can’t accept payments. This option maintains backward compatibility for accounts that were created with API version 55.0 and earlier. Pending is no longer in use for API version 57.0 and higher. - Rejected – The payment provider has rejected the merchant account with an explanation. - Restricted – merchant account functionality is limited. This state is only applicable if PaymentStatus, PayoutStatus, or both are disabled. - RestrictedSoon – PaymentStatus and PayoutStatus are enabled, but the payment provider requires more information. If the merchant doesn't provide the information in a specific time period, then the merchant account becomes restricted. | # PaymentGatewayLog Stores information exchanged between the Salesforce payments platform and external payment gateways. Gateway logs can also record payloads from external payment entities. This object is available in API version 48.0 and later. Deleting or archiving a payment gateway log doesn’t impact financial data on other payment entities. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | GatewayAuthCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Authorization approval code from the gateway. | | GatewayAVSCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Code sent by gateways that use an address verification system. | | GatewayDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that of the gateway communication that leads to the creation of this gateway log. | | GatewayMessage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Information or error messages sent from the gateway. | | GatewayRefNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique transaction ID created by the payment gateway. | | GatewayResultCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Gateway-specific result code. Must be mapped to a Salesforce-specific result code. | | GatewayResultCodeDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the gateway’s result code. This field is useful for providing more information around why the gateway returned a certain result code. | | InteractionStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Describes the result of communication between the payments platform and a payment gateway. Possible values are: - Failed - Initiated - NoOp - Success - Timeout | | InteractionType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Describes the type of interaction with the gateway. This field is required for logs created in Salesforce. Possible values are: - Authorization - AuthorizationReversal - Avs - Capture - CheckGiftCardBalance - PostAuth - ReferencedRefund - Sale - Tokenize - Void | | IsNotification | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description For asynchronous transactions, shows whether the gateway log belongs to the notification (yes) or the initial transaction (no). Possible values are: - No - Yes | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | PaymentGatewayId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Payments Platform payment gateway record used for communication with the external payment gateway. This field is a relationship field. Relationship Name PaymentGateway Relationship Type Lookup Refers To PaymentGateway | | PaymentGatewayLogNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique ID for this payment gateway log record. | | ReferencedEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Foreign key with DomainSet of PaymentAuth and Payment. This field is a polymorphic relationship field. Relationship Name ReferencedEntity Relationship Type Lookup Refers To CardPaymentMethod, Payment, PaymentAuthAdjustment, PaymentAuthorization, Refund | | Request | Type textarea Properties Create, Nillable, Update Description Raw payload. No sensitive attributes are stored. | | Response | Type textarea Properties Create, Nillable, Update Description Raw payload. | | RetryCategory | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The retry category returned by the payment gateway for the failed payment. This field is available in API version 66.0 and later. Possible values are: - CardLimit— Insufficient funds, exceeded spending limits, or other restrictions on the card. - GatewayConnection— Connectivity or communication errors between systems, including upstream gateway errors. - PaymentInformation— Missing or incorrect data such as incorrect card numbers, addresses, or currencies. - PaymentProcessing— Payment account is invalid, closed, restricted, or the transaction was declined for reasons other than insufficient funds. - Security— Security violations or issues such as fraud, risk, authentication, verification, and authorization. - Unknown— Payment gateway error code isn't recognized or isn't mapped to a specific category. | | SfRefNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If an IdempotencyKey was passed in the API request, its value is stored here in text format. | | SfResultCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Salesforce-specific result code that can map to one or more gateway result codes. We recommend configuring the payment gateway adapter layer to map gateway result codes to the appropriate Salesforce result code. Possible values are: - Decline: The gateway call failed. If the transaction is attempted again, it can still work. For example, the customer has insufficient funds or briefly lost their connection. - Indeterminate: The gateway didn’t respond to the call. This response usually happens when Salesforce times out while waiting for a response from the gateway. - PermanentFail: The gateway call failed and can’t work. Gateway calls fail permanently for one of two reasons: - Hard Decline: The customer’s payment account has been closed or terminated. - Fraud: The gateway recognized the payment or payment method as known fraud. - RequiresReview: The customer bank requires more information before completing the payment. - Success: The gateway call succeeded. - SystemError: Salesforce ended the payment request before receiving a response. For example, Salesforce lost credentials or access to its server. Salesforce ends payment calls if it doesn’t receive a response from the gateway within two minutes. - ValidationError: Customer payment data was incorrect, such as a misspelling in the credit card address or an incorrect CVV. | # PaymentGatewayProvider Setup entity for payment gateways. Defines the connection to a payment gateway Apex adapter. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | ApexAdapterId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of an APEX adapter class. The adapter interacts with your payment gateway to complete transactions. This field is unique within your organization. This field is a relationship field. Relationship Name ApexAdapter Relationship Type Lookup Refers To ApexClass | | Comments | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Additional details about a record. Maximum of 1000 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description (Optional) An internal name you assign the adapter. For reference only. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IdempotencySupported | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If the same payment request is made in rapid succession, this field defines whether the Payments platform charges the customer or merchant’s card multiple times for the same transaction. This situation can occur when a user clicks a Pay button twice, or the gateway’s server goes down after fulfilling a payment request and the client immediately tries making another payment. If this field has a value of Yes, the Payments platform ignores identical payment requests made immediately after an original request. Different payment gateways have varying levels of idempotency support. When configuring a new payment gateway integration, plan accordingly. Possible values are: - No - Yes | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Customer language used for the payment gateway. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description User-friendly name of the payment gateway provider. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Namespace for the payment gateway platform. | # PaymentGroup Top-level object that groups all payment transactions that are processed for an order or invoice. PaymentGroup is a standalone object, so it isn’t required for users to execute payment transactions (authorizations, captures, refunds, and sales). This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access Commerce Payments entities, your org must have a Salesforce Order Management license with the Payment Platform org permission activated. Commerce Payments entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | PaymentGroupNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-defined unique ID for the payment group. | | SourceObjectId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order or invoice related to all the payment transactions in the payment group. This is a relationship field. Relationship Name SourceObject Relationship Type Lookup Refers To Order | # PaymentInitiationSource Represents the originating source of a payment. This information helps other Salesforce products integrate with Salesforce Payments. This object is available in API version 63.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license with the Payments permission enabled for your org. Salesforce Payments entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The account record that initiated this payment. This field is a relationship field. Relationship Name Account Refers To Account | | Application | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description Salesforce application initiating the payment. Possible values are: - Collections - Commerce - Custom - FieldService - OrderManagement - Payments - Revenue - Sales - Scheduler - Service | | Channel | Type string Properties Filter, Group, Nillable, Sort, Update Description The origin of the submitted payment. For example, D2C, virtual terminal, or merchant MOTO (mail order or phone order). | | CollectionPlanId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The collection plan record that submitted payment. This field is available only for merchant-initiated payment collections. For example, a merchant collects an outstanding balance using a Pay Now payment link or over the phone. This field is a relationship field. Relationship Name CollectionPlan Refers To CollectionPlan | | ContactId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The contact record of the contact that made the payment. This field is a relationship field. Relationship Name Contact Refers To Contact | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. This field contains the ISO code for any currency allowed by the organization. Possible values are: - AUD—Australian Dollar - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description Name of the payment initiation source record. For example, d9e01178-b6878-2f4b-a14d-b0132b7ret67 | | OpportunityId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The opportunity record that made the payment. This field is a relationship field. Relationship Name Opportunity Refers To Opportunity | | OrderSummaryId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The order summary record that initiated the payment. This field is available with Salesforce Order Management and Commerce applications. This field is a relationship field. Relationship Name OrderSummary Refers To OrderSummary | | PaymentScheduleItemId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The payment schedule item record that initiated the payment. This field is available only with the Scheduler application. This field is a relationship field. Relationship Name PaymentScheduleItem Refers To PaymentSchedleItem | | Process | Type string Properties Filter, Group, Nillable, Sort, Update Description Component within the application that’s initiating the payment. Maximum length of the string is 255 characters. For example, managed or custom checkout, product description page (PDP). | | QuoteId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The quote record that initiated the payment. This field is a relationship field. Relationship Name Quote Refers To Quote | | ServiceAppointmentId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The service appointment record that initiated the payment. This field is available only with the Field Service application. This field is a relationship field. Relationship Name ServiceAppointment Refers To Appointment | | SiteId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The site record that initiated the payment. This field is for applications that don't have a web store, but created a digital experience site to accept payments This field is a relationship field. Relationship Name Site Refers To Site | | WebCartId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The web cart record that submitted the payment. This field is a relationship field. Relationship Name WebCart Refers To WebCart | | WebStoreId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The web store record that initiated the payment. For example, a B2B, D2C, or Pay Now store. This field is a relationship field. Relationship Name WebStore Refers To WebStore | | WorkOrderId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The work order record that submitted the payment. This field is available only for the Field Service application. This field is a relationship field. Relationship Name WorkOrder Refers To WorkOrder | | WorkOrderLineItemId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The work order line item record that made the payment. This field is only available with the Field Service application. This field is a relationship field. Relationship Name WorkOrderLineItem Refers To WorkOrderLineItem | # PaymentIntent Represents data temporarily stored during a transaction’s lifecycle that can identify the buyer, the merchant, and the amount the buyer is sending to the merchant. Data such as timestamp and amount returned can also be stored in PaymentIntent. This object is available in API version 58.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license with the Payments permission enabled for your org. Salesforce Payments entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description The account record of the buyer. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | AmountCapturable | Type currency Properties Filter, Nillable, Sort Description Payment amount that a merchant can collect after the fulfillment of an order. | | AmountRefundable | Type currency Properties Filter, Nillable, Sort Description The amount of the payment that the merchant can refund. | | AuthorizationReversal​Amount | Type currency Properties Filter, Nillable, Sort Description Amount canceled before completing the transfer of funds from buyer to merchant. | | AuthorizedAmount | Type currency Properties Filter, Nillable, Sort Description Amount authorized by the payer’s bank. | | BillingAddress | Type address Properties Filter, Nillable Description The billing address of the account holder. This field is the compound form of the billing address. Read-only. For details on compound address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. The maximum size is 40 characters. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. The maximum size is 80 characters. | | BillingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the billing address. | | BillingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the billing address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 20 characters. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 80 characters. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. | | CapturedAmount | Type currency Properties Filter, Nillable, Sort Description Total amount that a merchant secured from a buyer. | | ContextData | Type string Properties Nillable Description Additional metadata or information about a payment, such as the source of the payment, user data, or any other relevant information that can help in processing or tracking the payment. | | CurrencyIsoCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description ISO code for any currency allowed by the organization. Available only for orgs with the multicurrency feature enabled. Possible values are: - Euro - USD The default is USD. | | DisputeEvidenceDueDate | Type dateTime Properties Filter, Nillable, Sort Description Date by which the merchant must submit information related to the dispute. | | DisputeFee | Type currency Properties Filter, Nillable, Sort Description The amount that the credit card company charges the merchant for each disputed payment. The fee is also known as a chargeback fee. | | DisputeStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The state of the disputed transaction. Possible values are: - Closed—The dispute inquiry is closed. - Created—The payment gateway opens a payment dispute. - Lost—The bank ruled in the account owner’s favor and refunded the charge. The refund is permanent and the dispute fee isn’t returned. - Won—The bank ruled in the merchant's favor. The issuing bank returns the debited chargeback amount to the payment gateway, who passes this amount back to the merchant. | | DisputedAmount | Type currency Properties Filter, Nillable, Sort Description The amount the customer is challenging. | | EntryMode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how the payment information was provided. Possible values are: - Flow—Salesforce flow that initiated the payment. - Merchant—The credit card isn’t available so the merchant entered the payment information via the phone or an email. - Payer\_Online—The payer entered their payment information online. - Place\_Order\_V2—The payment was initiated from the Place Order V2 Orchestration. - TapToPay—The card was available and the payer tapped that card or device on the payment terminal. | | Guid | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Unique ID of the payment sent to Stripe or PayPal. This ID links the Payments Merchant Account record with the payment at the payment provider. | | IncurrenceStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of an orphaned payment. An orphaned payment occurs when a payment transaction is complete, but the workflow is disrupted, and the payment isn't recorded in the consuming flow. An unexpected error can cause an orphaned payment. For example, a payment is accepted at checkout, but the order doesn't get placed because of a network issue. Possible values are: - Canceled—The workflow was disrupted and the payment was canceled or refunded. - Claimed—The payment was recorded and the workflow was completed. - Pending—The consuming workflow hasn't recorded the payment yet. If there isn't a value for this field, it means that the consumer doesn't rely on it to track orphaned payments. | | IntentAmount | Type currency Properties Filter, Nillable, Sort Description Total amount that a merchant expects to receive from a buyer. | | IsCaptureComplete | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Verification whether the funds for a given payment are paid. The default value is false. | | IsEvidenceSubmitted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Status of the requested information that the merchant provides to the bank about the dispute. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced but not viewed. | | MerchantAccountId | Type reference Properties Filter, Group, Sort Description Required field. The merchant account record associated with a payment intent record. This field is a relationship field. Relationship Name MerchantAccount Relationship Type Lookup Refers To MerchantAccount | | PaymentGatewayId | Type reference Properties Filter, Group, Nillable, Sort Description The payment gateway record that processed the payment. Relationship Name PaymentGateway Relationship Type Lookup Refers To PaymentGateway | | PaymentGroupId | Type reference Properties Filter, Group, Nillable, Sort Description Payment groups organize all the payment transactions that have been made against a record such as an account or contract. This is a relationship field. This field is available in API version 65.0 and later. Relationship Name PaymentGroup Relationship Type Lookup Refers To PaymentGroup | | PaymentInitiationSourceId | Type reference Properties Filter, Group, Nillable, Sort Description The payment initiation source record associated with the payment. The record identifies the originating application and object of the payment..lo Relationship Name PaymentInitiationSource Relationship Type Lookup Refers To PaymentInitiaionSource | | PaymentIntentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Autogenerated number assigned to the payment record, for example PI-000000001. | | PaymentLinkGmvDate | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Date the payment is captured from a payment link transaction. The total amount paid is expressed as the Gross Merchandise Value (GMV). | | PaymentLinkId | Type reference Properties Filter, Group, Nillable, Sort Description The payment link record. This field is a relationship field. Relationship Name PaymentLink Relationship Type Lookup Refers To PaymentLink | | PaymentMethodDetails | Type string Properties Filter, Group, Nillable, Sort Description Additional information about the payment method type such as the four last digits of a card number. | | PaymentMethodId | Type reference Properties Filter, Group, Nillable, Sort Description The payment method record, indicating a card payment method, digital wallet, or alternative payment method. This field is a polymorphic relationship field. Relationship Name PaymentMethod Relationship Type Lookup Refers To PaymentMethod | | PaymentMethodSubType | Type string Properties Filter, Group, Nillable, Sort Description A payment method that exists as a subtype of a payment method type. For example, Visa, Mastercard, and American Express exist as subtypes of payment method types such as Apple Pay and Google Pay. | | PaymentMethodType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Payment method used for the transaction. | | ProviderReference | Type string Properties Filter, Group, Nillable, Sort Description A payment record at the payment gateway that identifies the payment provider. | | RefundedAmount | Type currency Properties Filter, Nillable, Sort Description Total or partial amount refunded to the buyer due to product return, merchant’s lack of inventory, or shipping and delivering problems. | | ShippingAddress | Type address Properties Filter, Nillable Description Delivery address for the purchase. The compound form of the shipping address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | ShippingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address. City maximum size is 40 characters. | | ShippingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address. Country maximum size is 80 characters. | | ShippingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the shipping address. | | ShippingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the shipping address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | ShippingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | ShippingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | ShippingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address. The maximum size of the postal code is 20 characters. | | ShippingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address. State maximum size is 80 characters. | | ShippingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Details of the shipping address. Maximum of 255 characters. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of the payment record. Possible values are: - Authorized - Canceled - Created - Expired - Failed - PartiallyCaptured - PartiallyRefunded - Pending - Refunded - Succeeded | | SubmittedById | Type reference Properties Filter, Group, Nillable, Sort Description The submitted by record, which identifies who processes the payment on the customer's behalf. The customer provides the authorization to submit the payment over the phone or through the mail. This field is a relationship field. Relationship Name SubmittedBy Relationship Type Lookup Refers To User | # PaymentIntentEvent Represents a payment intent platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later. For more information about platform events, see the [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_intro.htm "HTML (New Window)"). ## Supported Calls describeSObjects() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license and Payments must be enabled for your org. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | ChangeType | Type picklist Properties Restricted picklist Description Type of payment intent event that triggers an event notification. You can write code to operate conditionally on the value of this field. For example, you can ignore an authorization but get notified of captures. Possible values are: - Authorize–Payment is authorized. - AuthorizeFailure–There’s an error preventing the payment authorization - Capture–Payment is captured. - CaptureFailure– An error prevented the payment capture. - Refund–Payment is refunded. - RefundFailure–An error prevented the payment refund. | | PaymentInitiationSourceApplication | Type picklist Properties Nillable, Restricted picklist Description Salesforce application initiating the payment. This field is available in API version 63.0 and later. Possible values are: - Collections - Commerce - Custom - FieldService - OrderManagement - Payments - Revenue - Sales - Scheduler - Service | | PaymentInitiationSourceChannel | Type string Properties Nillable Description Identifies the channel in the Payment Initiation Source record for which the event occurs. This field is available in API version 63.0 and later. | | PaymentInitiationSource | Type reference Properties Nillable Description Identifies the Payment Initiation Source record for which the event occurs. This field is available in API version 63.0 and later. This field is a relationship field. Relationship Name PaymentInitiationSource Refers To PaymentInitiationSource | | PaymentInitiationSourceProcess | Type string Properties Nillable Description Identifies the process in the Payment Initiation Source record for which the event occurs. | | PaymentIntentGuid | Type string Properties Nillable Description Identifies the GUID in the Payment Initiation Source record for which the event occurs. This field is available in API version 63.0 and later. | | PaymentIntent | Type reference Properties Nillable Description Identifies the PaymentIntent record for which the event occurs. This field is available in API version 63.0 and later. This field is a relationship field. Relationship Name PaymentIntent Relationship Type Lookup Refers To PaymentIntent | | PaymentLink | Type reference Properties Nillable Description Identifies the payment link record for which the event occurs. This field is available in API version 63.0 and later. This field is a relationship field. Relationship Name PaymentLink Refers To PaymentLink | # PaymentLineInvoice Represents a payment allocated to or unallocated from an invoice. This object is available in API version 48.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To access Commerce Payments entities, your org must have a Salesforce Order Management license with the Payment Platform org permission activated. Commerce Payments entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort Description Total amount applied or unapplied by this payment line. | | AppliedDate | Type dateTime Properties Create, Filter, Nillable, Sort Description The date that this line was applied to an invoice or payment. If this field is null, it inherits the value of the payment line invoice’s Date field. | | AssociatedAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The account for this payment line’s target invoice. This is a relationship field. Relationship Name AssociatedAccount Relationship Type Lookup Refers To Account | | AssociatedPaymentLineId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The paymentLine that was unapplied. Populated only when PaymentLineInvoice’s Type field has a value of Unapplied. This is a relationship field. Relationship Name AssociatedPaymentLine Relationship Type Lookup Refers To PaymentLineInvoice | | Comments | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Users can add comments to provide additional details about a record. Maximum of 1000 characters. | | Date | Type dateTime Properties Create, Filter, Nillable, Sort Description The date and time that this payment line was created. | | EffectiveDate | Type dateTime Properties Create, Filter, Nillable, Sort Description Defines the date and time when the payment line application or unapplication becomes effective. | | EffectiveImpactAmount | Type currency Properties Filter, Nillable, Sort Description Shows how this payment invoice line impacts a customer’s accounts receivable. This value is positive when PaymentLineInvoice’s Type field is Applied, and negative when PaymentLineInvoice’s Type is Unapplied. If there’s an unapplied line related to this record, EffectiveImpactAmount has a value of 0. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note EffectiveImpactAmount evaluates only the applied and unapplied line pair. Therefore, the effective impact amount could be different for different lines within the same payment. | | HasBeenUnapplied | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Defines whether this payment line has been unapplied from the target invoice. Has a value of NA when PaymentInvoiceLine’s Type field has a value of Unapplied. Can be No or Yes if Type has a value of Applied. Possible values are: - NA - No - Yes | | ImpactAmount | Type currency Properties Filter, Nillable, Sort Description Shows the payment’s financial impact against the customer’s accounts receivable. If PaymentLineInvoice has a Type of Applied, the ImpactAmount is the negative equivalent of the line’s Amount field. Otherwise, ImpactAmount equals Amount. | | InvoiceId | Type reference Properties Create, Filter, Group, Sort Description Target invoice for this payment line. This is a relationship field. Relationship Name Invoice Relationship Type Lookup Refers To Invoice | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | PaymentBalance | Type currency Properties Filter, Nillable, Sort Description Total balance of this line’s parent payment record following the application or unapplication of this payment line. | | PaymentId | Type reference Properties Create, Filter, Group, Sort Description Parent payment for this payment line. This is a relationship field. Relationship Name Payment Relationship Type Lookup Refers To Payment | | PaymentLineInvoiceNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-defined unique ID for this payment line. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Defines whether this payment line has been applied or unapplied to the target invoice. Possible values are: - Applied - Unapplied | | UnappliedDate | Type dateTime Properties Create, Filter, Nillable, Sort Description The date that this payment line was unapplied from the target invoice. Populated only when the Type field equals Unapplied. Inherits the value of the Date field. | ## Usage Use a payment line to apply all or part of a payment’s balance to an invoice. The PaymentLineInvoice object represents the balance taken from the payment and applied toward the invoice. You can apply a payment’s balance when you create the payment record or afterward. The payment line must have the same currency as the parent payment. A payment line has an amount, which represents the total amount taken from the payment, and balance, which represents the remaining amount after the payment line has been applied to an invoice. A payment’s amount can’t be less than the sum of all of its payment line amounts. One payment can have multiple payment lines. A payment line must be related to only payment. You can create multiple payment lines on a payment apply each line to different invoices on the same account, or to invoices on different accounts. ![An image showing how one payment's payment lines can apply to invoices across different accounts.](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/Sforce_payment_flow.png) Here’s one way you could use Salesforce API to apply a payment to an invoice using a payment line. # PaymentLink A link that a merchant can share with customers to collect payments for products and services. The payment link, which you can embed into a Salesforce app or send directly to a customer, directs the customer to a Pay Now payment page. The page can show a total amount owed or an itemized list or products, shipping and tax charges, and a total amount owed. The customer enters their contact and payment details, and submits their payment. The amounts are shown in the store's currency. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license with the Payments permission enabled for your org. Salesforce Payments entities are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Payer account. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | Amount | Type currency Properties Create, Filter, Sort, Update Description Amount the payer owes. | | CartId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the cart record. Relationship Name Cart Relationship Type Lookup Refers To Webcart | | CollectionPlanId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The collection plan associated with the payment link. This field is a relationship field. Available in API version 63.0 and later with Financial Services and Automotive Cloud. Relationship Name CollectionPlan Refers To CollectionPlan | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description 3-digit ISO code for the payment currency that is shown on the Pay Now page. Possible values are: - EUR – Euro - GBP – British Pound - USD – US Dollar The default value is USD. | | CustomMetadata | Type textarea Properties Create, Nillable, Update Description The metadata that merchants specify when creating a payment link. This metadata is sent to payment gateways so merchants can use this data to reconcile transactions against their own invoices or internal IDs. | | Description | Type textarea Properties Create, Nillable, Update Description Text on the Pay Now payment page that’s visible to your customers. This text can communicate any information you want. | | Expiry Time | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that the payment link expires. The time is based on the user’s time zone, not the org’s time zone. | | IsBusinessAccountPayment | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the payment link is for a business account (true) or not (false). The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record can be referenced and not viewed directly. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this record. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaymentInitiationSource | Type string Properties Create, Filter, Nillable, Sort, Update Description The origin of the payment, based on the information in the Payment Link record. | | PaymentLinkNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated number that identifies the payment link. | | PaymentMethodSetId | Type reference Properties Create, Filter, Group, Sort, Update Description Reference to the PaymentMethodSet object, which determines what payment methods are shown to the payer. This field is a relationship field. Relationship Name PaymentMethodSet Relationship Type Lookup Refers To MerchAccPaymentMethodSet | | PaymentScheduleItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The payment schedule item associated with the payment link. This field is a relationship field. Available in API version 63.0 and later with Financial Services and Automotive Cloud. Relationship Name PaymentScheduleItem Refers To PaymentScheduleItem | | PaymentUrl | Type url Properties Filter, Group, Sort Description Unique URL of the Pay Now page. This URL IS auto-generated, and not editable. | | QrCodeImageId | Type reference Properties Filter, Group, Nillable, Sort Description Reference to the QR code image included in the payment link record. This field is a relationship field. Relationship Name QrCodeImage Relationship Type Lookup Refers To ContentVersion | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the payment link is active and can be used. Possible values are: - Active - Disabled The default value is Active. | | TaxAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Amount of the tax for the purchase. This amount is shown on the Pay Now page. | | Title | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Title of the Pay Now page, indicating what is being paid. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Indicates the type of payment link created, which the merchant can share with the customer to receive payment. The payment link also determines which Pay Now page is generated and what’s included on that page. Possible values are: - CheckoutWithOrder (only for orgs with Payments and Commerce)—includes the amount owed based on the products you select, lists the products purchased, and calculates tax using the billing address and selected shipping options. After a customer makes a payment, this link type creates an order record. - PredefinedAmount—shows only an amount due for products purchased. The merchant enters the amount due when creating the payment link. - WithProducts—Deprecated. New payment links can't be created with this link type. The default value is PredefinedAmount. | | UsageType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Determines whether the payment link is used one time or multiple times before the configured expiration date and time. Possible values are: - MultiUse - SingleUse The default value is MultiUse. | ## Associated Objects This object has these 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. [PaymentLinkOwnerSharingRule](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. [PaymentLinkShare](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. # PaymentLinkEvent Represents a payment link platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later. For more information about platform events, see the [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_intro.htm "HTML (New Window)"). ## Supported Calls describeSObjects() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license and Payments must be enabled for your org. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | ChangeType | Type picklist Properties Restricted picklist Description Type of payment link event, which triggers and event notification. Possible values are: - Create–Payment link created. - Delete–Payment link deleted. - Update–Payment link property changed. | | PaymentLinkId | Type reference Properties Nillable Description Type of payment link event. You can write code to operate conditionally on the value of this field. For example, you can ignore a create change but get notified of updates. This field is a relationship field. Relationship Name PaymentLink Relationship Type Lookup Refers To PaymentLink | # PaymentMethod Represents the method that a buyer uses to compensate the seller of a good or service. Common payment methods include cash, checks, credit or debit cards, money orders, bank transfers, and online payment services. This object is available in API version 48.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description The account entity linked to this payment method. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | Comments | Type textarea Properties Nillable Description Users can add comments to provide additional details about a record. Maximum of 1000 characters. | | CompanyName | Type string Properties Filter, Group, Nillable, Sort Description Company name for this payment method. Part of the payment method’s address. | | ImplementorType | Type string Properties Filter, Group, Nillable, Sort Description Shows the type of payment method. | | IsAutoPayEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the payment method can be used for recurring payments (True) or not (False). The default value is False. This field is available in API v55.0 and later. For orgs that upgraded from v54.0, you must add this field to the Payment Method page layout in the UI. It isn't automatically added. | | Name | Type string Properties Filter, Group, idLookup, Sort Description A unique number assigned to the payment method. Numbers start at 1000 and are read only, but administrators can change the format. | | NickName | Type string Properties Filter, Group, Nillable, Sort Description User-defined nickname for this payment method. | | PaymentMethodAddress | Type address Properties Filter, Nillable Description Full address related to the alternative payment method. For more information about address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | PaymentMethodCity | Type string Properties Filter, Group, Nillable, Sort Description Payment method address details. | | PaymentMethodCountry | Type string Properties Filter, Group, Nillable, Sort Description Payment method address details. | | PaymentMethodDetails | Type string Properties Filter, Group, Nillable, Sort Description Optional information about the payment method type. This field is available in API version 57.0 and later. | | PaymentMethodGeocodeAccuracy | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Accuracy level of the geocode for the payment method address. An accuracy level contains information about the location of a latitude and longitude. For more information about geolocation fields, see [Geolocation Compound Field](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_geolocation.htm "Geolocation fields are accessible in the SOAP and REST APIs as a Location—a structured compound data type—or as individual latitude and longitude elements."). Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | PaymentMethodLatitude | Type double Properties Filter, Nillable, Sort Description Latitude of the payment method address. Used with the PaymentMethodLongitude to specify the precise geolocation of the address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | PaymentMethodLongitude | Type double Properties Filter, Nillable, Sort Description Longitude of the payment method address. Used with the PaymentMethodLatitude to specify the precise geolocation of the address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | PaymentMethodPostalCode | Type string Properties Filter, Group, Nillable, Sort Description Part of the address for this payment method. | | PaymentMethodState | Type string Properties Filter, Group, Nillable, Sort Description Payment method address details. | | PaymentMethodStreet | Type textarea Properties Filter, Group, Nillable, Sort Description Payment method address details. | | PaymentMethodSubType | Type string Properties Filter, Group, Nillable, Sort Description More information about the payment method. For example, if the PaymentMethodType is Visa, this field can be a digital wallet. This field is available in API version 57.0 and later. | | PaymentMethodType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The payment method used for the transaction, such as Visa, Mastercard, EPS, SepaDebit, UnionPay, and Klarna. Method types can also be direct debit payments like ACH, Becs, and BACS. This field is available in API version 57.0 and later. | | SavedPaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the saved payment method record. Relationship Name SavedPaymentMethod Relationship Type Lookup Refers To SavedPaymentMethod | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The state of the payment method. Possible values are: - Active—The Payments platform can use the payment method to make payments. - Canceled—The Payments platform can no longer use the payment method to make payments. - InActive—The Payments platform currently can’t use the payment method to make payments. Admins can change this value to Active when needed. | # PaymentSchedule The payment schedule represents a collection of payments that a customer wants to collect at different times for a certain record. A schedule contains one or more payment schedule items, where each item represents one payment to be processed. Each of a schedule’s items can have different payment configuration fields, such as payment methods, payment dates, and payment accounts. When a payment scheduler launches a payment run, the run evaluates active payment schedule items, and picks them up for payment processing if they align with the scheduler’s payment criteria. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_paymentschedule.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | AvailableRequestedAmount | Type currency Properties Filter, Nillable, Sort Description The payment schedule’s remaining amount available for the creation of payment schedule items. Equals TotalRequestedAmount–TotalLineRequestedAmount. | | Comments | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Optional user-defined comments. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the payment group record. | | DefaultPaymentAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description When a payment run creates payments from a payment schedule item, it sets the payment’s account to the item’s PaymentAccountId. Upon payment schedule item creation, the item’s PaymentAccountId inherits the schedule’s DefaultPaymentAccountId. However, you can override the PaymentAccountId with a different account as needed. If you do, future payments made from the item use the new account. This is a relationship field. Relationship Name DefaultPaymentAccount Relationship Type Lookup Refers To Account | | DefaultPaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description When a payment run creates payments from a payment schedule ID, it sets the payment’s account to the item’s PaymentMethodId. Upon payment schedule item creation, the item’s PaymentMethoId inherits the schedule’s DefaultPaymentMethodId. However, you can override the PaymentMethodId with a different account as needed. If you do, future payments made from the item will use the new account. Relationship Name DefaultPaymentMethod Relationship Type Lookup Refers To CardPaymentMethod, DigitalWallet | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who created the payment schedule. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaymentScheduleNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated reference number for the payment schedule. | | PaymentScheduleTreatmentDtlId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The payment schedule treatment detail associated with the payment schedule record. This field is a relationship field. Available in API version 65.0 and later with Financial Services and Automotive Cloud. Relationship Name PaymentScheduleTreatmentDtl Refers To PaymentScheduleTreatmentDtl | | PaymentSource | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the name of the funding source that is used to fulfill a payment commitment. Available in API version 63.0 and later with Financial Services and Automotive Cloud. | | ReferenceEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The object that receives payments as a result of payment schedule items processed from the payment schedule. This is a polymorphic relationship field. Relationship Name ReferenceEntity Relationship Type Lookup Refers To API version 55.0 and later: - Contract - Order - Invoice API version 62.0 and later with Financial Services and Automotive Cloud: CollectionPlan | | RemainingAmountToBeProcessed | Type currency Properties Filter, Nillable, Sort Description The total pending amount of payment schedule items that haven’t yet been processed for payment. Equals TotalLineRequestedAmount – TotalProcessedAmount. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the payment schedule. Possible values are: - Accepted: The payment schedule is approved and is ready for payment run evaluation. Available in API version 65.0 and later with Financial Services and Automotive Cloud. - Approval Pending: The payment schedule needs approval. Available in API version 65.0 and later with Financial Services and Automotive Cloud. - Canceled: Payment runs can’t evaluate payment schedules or use them to create payments. - Completed: All of the payment schedule’s payment schedule items have been processed for payments. - Draft: The payment schedule can be edited and configured. Payment runs don’t evaluate draft payment schedules. - On Hold: The payment schedule can't be considered for payment runs due to missing information, the need for additional review, or other unresolved external factors. Available in API version 65.0 and later with Financial Services and Automotive Cloud. - Open: The payment schedule is available for payment run evaluation. - Rejected: The payment schedule isn't approved and can't be considered for payment run evaluation. Available in API version 65.0 and later with Financial Services and Automotive Cloud. | | TotalAppliedAmount | Type currency Properties Filter, Nillable, Sort Description The amount of all payment schedule items that have been applied to payments. This is a calculated field. | | TotalCanceledAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all RequestedAmount values on payment schedule items with a status of Canceled. | | TotalPaymentsReceived | Type currency Properties Filter, Nillable, Sort Description The cumulative sum of payments received for all payment schedule items linked to a payment schedule. This field is a calculated field. Available in API version 63.0 and later with Financial Services and Automotive Cloud. | | TotalPaymentScheduleItemAmount | Type currency Properties Filter, Nillable, Sort\\ Description The total amount allocated from the payment schedule to its payment schedule items. Equals the sum of each payment schedule item’s RequestedAmount – the sum of each payment schedule item’s Canceled Amount. | | TotalProcessedAmount | Type currency Properties Filter, Nillable, Sort Description The sum of ProcessedAmount values on payment schedule items with a status of Processed. | | TotalRequestedAmount | Type currency Properties Create, Filter, Sort, Update Description The total amount available for a payment schedule to distribute to its payment schedule items. The sum of payment schedule items can’t be greater than the TotalLineRequestedAmount of the parent payment schedule. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of payment for which the payment schedule is created. Available in API version 65.0 and later with Financial Services and Automotive Cloud. Possible values are: - PaymentPlan—Payment Plan - PromiseToPay—Promise to Pay | | UsageType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the usage type for the record. Possible value is: - CollectionPlan Available in API version 62.0 and later with Financial Services and Automotive Cloud. | # PaymentScheduleItem A payment schedule contains one or more payment schedule items, where each item represents one payment to be processed. Each of a schedule’s items can have different payment configuration fields, such as payment methods, payment dates, and payment accounts. When a payment scheduler launches a payment run, the run evaluates active payment schedule items, and picks them up for payment processing if they align with the scheduler’s payment criteria. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_paymentscheduleitem.htm "HTML (New Window)"). ## Fields
Field Details
Comments
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Optional user-defined comments.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Three-letter ISO 4217 currency code associated with the payment schedule item record.
LastPaymentGatewayLogId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The most recent payment gateway log created following a payment gateway request to make a payment based on the payment schedule item.
This is a relationship field.
Relationship Name
LastPaymentGatewayLog
Relationship Type
Lookup
Refers To
PaymentGatewayLog
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
PaymentAccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account assigned to payments made from the payment schedule item. When a payment schedule item is created, its PaymentAccountId inherits the payment schedule’s DefaultPaymentAccountId. However, you can provide a new PaymentAccountId at any time. If you change the PaymentAccountId, only payments made after the change use the new account.
This is a relationship field.
Relationship Name
PaymentAccount
Relationship Type
Lookup
Refers To
Account
PaymentBatchRunId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The payment batch run that evaluated the payment schedule item for payment processing.
This is a relationship field.
Relationship Name
PaymentBatchRun
Relationship Type
Lookup
Refers To
PaymentBatchRun
PaymentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The payment that a payment run created for the payment schedule item after picking up the parent payment schedule. This field is unique within your organization
This is a relationship field.
Relationship Name
Payment
Relationship Type
Lookup
Refers To
Payment
PaymentMethodId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The payment method assigned to payments created from the payment schedule item. When a payment schedule item is created, its PaymentMethodId inherits the payment schedule’s DefaultPaymentMethodId. However, you can provide a new PaymentMethodId at any time. If you change the PaymentMethodId, only payments made after the change use the new account.
Relationship Name
PaymentMethod
Relationship Type
Lookup
Refers To
CardPaymentMethod, DigitalWallet
PaymentProcessingMessage
Type
string
Properties
Filter, Nillable, Sort
Description
Shows information about whether the payment creation process has completed.
PaymentsReceived
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The payment received from the borrower for the payment schedule item.
PaymentRunMatchingValue
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The value used to match a payment schedule item to a payment run based on the payment run’s matching criteria.
PaymentScheduleId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The parent payment schedule for the payment schedule item.
This is a relationship field.
Relationship Name
PaymentSchedule
Relationship Type
Lookup
Refers To
PaymentSchedule
PaymentScheduleItemNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
User-defined reference number for the payment schedule item.
PaymentSource
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The feature that caused a payment to be created from the payment schedule item.
Possible values are:
  • PaymentRun
PaymentsReceived
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The payment received from the borrower for the payment schedule item.

Available in API version 63.0 and later with Financial Services and Automotive Cloud.
ProcessedAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount of the payment schedule item that has been processed for payment and converted to a payment record.
RequestedAmount
Type
currency
Properties
Create, Filter, Sort, Update
Description
The initial amount of the payment schedule item upon creation.
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the payment schedule item.
Possible values are:

  • Applied: The payment schedule item has been successfully applied.

  • Apply Failed: The payment run encountered an error when attempting to process the payment schedule item for payment. For more information, review the payment run’s revenue transaction error log.

  • Approval PendingThe payment schedule item is waiting for approval before it can be processed by payment runs.

    Available in API version 65.0 and later with Financial Services and Automotive Cloud.

  • Canceled: The payment schedule item can’t be picked up by payment runs for processing. When a user or process changes the item’s status to Canceled, the item’s CanceledAmount becomes RequestedAmount – ProcessedAmount.

  • Deferred PaymentThe payment schedule item has been postponed and will be processed at a later date.

    Available in API version 65.0 and later with Financial Services and Automotive Cloud.

  • Payment Waived OffThe payment schedule item has been canceled, and the payment will not be processed.

    Available in API version 65.0 and later with Financial Services and Automotive Cloud.
TargetPaymentProcessingDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
The date after picking up a payment schedule item that the payment run makes a payment request to the payment gateway.
UsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the usage type for the record.
Possible value is:
  • CollectionPlan

Available in API version 62.0 and later with Financial Services and Automotive Cloud.
# PaymentSchedulePolicy Contains configuration information for the payment schedule policy. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and the PaymentScheduleAutomation permission, and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_paymentschedulepolicy.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | DefaultTreatmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The default payment schedule treatment. This field is a relationship field. Relationship Name DefaultTreatment Relationship Type Lookup Refers To PaymentScheduleTreatment | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description User-entered description of the payment schedule policy. | | IsOrgDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description true if the payment schedule policy is the default policy for the org, otherwise false. An org can have a maximum of one default payment policy. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The user-entered name of the payment policy. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the creator of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The payment schedule policy’s status. Possible values are: - Active - Canceled - Draft - Inactive | | TreatmentSelection | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the payment schedule treatment. Possible values are: - Default—use the payment schedule treatment indicated by DefaultTreatmentId. | # PaymentScheduleTreatment Contains configuration information for the payment schedule. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_paymentscheduletreatment.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The user-entered description of the payment schedule treatment. | | IsApprovalRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this payment schedule treatment requires approval or not. Available in API version 65.0 and later with Financial Services and Automotive Cloud. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The user-entered name of the payment schedule treatment. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaymentPlanTag | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A list of key annotations or insights about the payment plan, such as requires approval or recommended, to help guide the user in selecting the most suitable payment plan. Available in API version 65.0 and later with Financial Services and Automotive Cloud. | | PaymentSchedulePolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related payment schedule policy. This field is a relationship field. Relationship Name PaymentSchedulePolicy Relationship Type Lookup Refers To PaymentSchedulePolicy | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The payment schedule treatment’s status. Possible values are: - Active - Canceled - Draft - Inactive | | TriggerSource | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the action that caused the payment schedule treatment to be created. Possible values are: - InvoicePosted—an invoice is posted - UserAction—User Action Available in API version 65.0 and later with Financial Services and Automotive Cloud. | # PaymentScheduleTreatmentDtl Contains configuration information for the payment schedule treatment detail. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_paymentscheduletreatmentdtl.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | DateOffset | Type int Properties Create, Filter, Group, Sort, Update Description A number equal to or less than 0. The date offset is subtracted from the processing date reference to determine the processing date. For example, suppose that the invoice due date is 01/17/2022 and offset is -7. In this case, the payment schedule item is processed by the jobs that run on or before 01/10/2022. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The user-entered description of the payment schedule treatment detail. | | InstallmentPaymentType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates how the payment amount is divided into multiple payments. Possible values are: - Percentage | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | PaymentMethodSelectionType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates how the payment method is specified. Possible values are: - Manual—the payment method is entered by a user - MostRecentAutopay—the payment method is the most recent automatic payment method used | | PaymentRunMatchingValue | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Possible values are: - AMER - APAC - EMEA | | PaymentScheduleTreatmentDetailNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated unique identifier for this payment schedule treatment detail. | | PaymentScheduleTreatmentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related payment schedule treatment. This field is a relationship field. Relationship Name PaymentScheduleTreatment Relationship Type Lookup Refers To PaymentScheduleTreatment | | Percentage | Type percent Properties Create, Filter, Nillable, Sort, Update Description Indicates the percentage of the source amount that is used to create the payment schedule. | | ProcessingDateReference | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the source of the reference date. Possible values are: - InvoiceDueDate—use the invoice’s due date as the date reference - UserInputDate—User Input Date Available in API version 65.0 and later with Financial Services and Automotive Cloud. | | PymtSchdDistributionMethodId | Type reference Properties Create, Filter, Group, Sort, Update Description The distribution method that contains the information on how to create the payment schedule items. This field is a relationship field. Relationship Name PymtSchdDistributionMethod Relationship Type Lookup Refers To PymtSchdDistributionMethod | # PaymentTerm Defines your company's method and expectations for receiving payment. This object is available in API version 55.0 and later. Timely payment helps your company maintain cash flow. Payment terms are used to determine the payment due date on invoices. Use with the PaymentTermItem object. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_paymentterm.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description User-defined field that describes the payment term. For example, use Net 30 to describe a payment term where the payment is due within 30 days of the billing date. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this payment term is the default term for your org. A default payment term must be defined in your org. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the payment term. For example, Net 30 or Cash on delivery (COD). This name appears on the invoice. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the payment term is available for use on invoices. Possible values are: - Active—The payment term is available for use and can be applied to an order. Only active payment terms can be applied to transactions or orders. - Draft—The payment term exists but isn't activated yet. - Inactive—The payment term exists but can't be applied to new transactions or orders. The default value is Draft. | ## Usage A payment term is applied to an order or transaction, and is passed on to the billing schedule that’s used to generate the invoice. The due date on the invoice is derived from the payment. For example, a Net 30 payment term means that the customer has 30 days to pay from the invoice date. Suppose that an invoice with a Net 30 payment term is generated on January 1. The invoice date is January 1, and the due date is January 31 (1 + 30 days = 31). # PaymentTermItem Defines the attributes of a payment term that your company uses. The PaymentTermItem is used to determine the due date on invoices. 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 This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_paymenttermitem.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description User-defined field that describes the details of the payment term item. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated sequential number, such as PTI-000001. | | PaymentTermId | Type reference Properties Create, Filter, Group, Sort Description The ID of the payment term that this payment term item is associated with. This field is a relationship field. Relationship Name PaymentTerm Relationship Type Lookup Refers To PaymentTerm | | PaymentTimeframe | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the time period when the payment is expected. Possible values are: - Standard—Indicates that payment is expected by the date specified in the payment term. If payment isn't received by the due date, the payment becomes overdue. The default value is Standard. | | Period | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the number of units in the payment period. Used with the PeriodUnit field. For example, to define a payment term of Net 30, enter 30 as the Period and select Days as the PeriodUnit. | | PeriodUnit | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the unit of time for the payment period. Used with the Period field. For example, to define a payment term of Net 30, enter 30 as the Period and select Days as the PeriodUnit. Possible values are: - Days | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies how the payment term and invoice due date are derived. Possible values are: - Period-Based—Tells the system to use the Period and PeriodUnit fields to calculate the invoice due date. The default value is Period-Based. | # PendingOrderSummary Object representing a B2C Commerce order ingested via High Scale Orders before an OrderSummary is created for it. Optimized for online transaction processing (OLTP). This object is available in API version 55.0 and later. ## Supported Calls describeLayout(), query() ## Special Access Rules This object is only available in Salesforce Order Management orgs where the High Scale Orders feature is enabled. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the account or person account associated with the PendingOrderSummary. It represents the shopper in the storefront. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | BillToContactId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Contact associated with the PendingOrderSummary. It represents the shopper in the storefront when not using person accounts. This field is a relationship field. Relationship Name BillToContact Relationship Type Lookup Refers To Contact | | BillingEmailAddress | Type email Properties Filter, Group, Sort Description Email address on the billing address. | | BillingPhoneNumber | Type phone Properties Filter, Group, Nillable, Sort Description Phone number of the billing address. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the original Order associated with the PendingOrderSummary. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | Description | Type string Properties Filter, Group, Nillable, Sort Description Description of the PendingOrderSummary. | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description This field is used internally. This field isn’t synced with ZOS, so you can’t use it in a query or insert operation. | | ExternalReferenceIdentifier | Type string Properties Filter, Group, Sort Description Used internally to prevent duplicate records. This value is case-sensitive. On creation, this value is set to B2C realm ID + "\_" + B2C instance ID + "@" + B2C Commerce catalog/domain ID + "@" + B2C Commerce order number. When the OrderSummary is created, this value is copied to its ExternalReferenceIdentifier field. If you ingest orders from multiple sources, you can maintain uniqueness by including a prefix based on the source. | | GrandTotalAmount | Type currency Properties Filter, Sort Description Total amount, including adjustments and tax, of the PendingOrderSummary. | | OrderNumber | Type string Properties Filter, Group, Sort Description Name of the PendingOrderSummary. | | OrderedDate | Type dateTime Properties Filter, Sort Description Date of the original order associated with this PendingOrderSummary. | | Payload | Type textarea Properties Description The order data payload. | | PayloadType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The datatype of the Payload. Possible values are: - JSON\_GZIP - JSON\_RAW | | ProcessingInstructions | Type textarea Properties Nillable Description Instructions about how the HSOI service should create the order summary. Options include using the default without customizations or using a custom flow. Also includes instructions about how the HSOI service should dedupe account and contact information using platform duplication and matching rules or by using simple email methods. | | SalesChannelId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the SalesChannel associated with this PendingOrderSummary. The SalesChannel Name matches the B2C Commerce catalog/domain ID. This field is a relationship field. Relationship Name SalesChannel Relationship Type Lookup Refers To SalesChannel | | SalesStoreId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the RetailStore or WebStore associated with this PendingOrderSummary. This field is a relationship field. Relationship Name SalesStore Relationship Type Lookup Refers To WebStore | | ShopperName | Type string Properties Filter, Group, Sort Description The first name and last name of the shopper that placed the original order. | ## Usage If you need to view or service an ingested B2C Commerce order before the automated High Scale Orders process has created an OrderSummary for it, you can manually trigger creation of the OrderSummary. In Salesforce, open the PendingOrderSummaries list, find the record, and click **Import**. PendingOrderSummary only supports certain methods and queries. It doesn’t support Apex triggers. Supported Apex Methods: - Database.query(queryString) - Database.query(queryString, accessLevel) Supported SOAP API Methods: - create() - delete() - describeLayout() - query() - queryMore() Supported REST API Methods: - /services/data/vXX.X/sobjects/sObject/ GET - /services/data/vXX.X/sobjects/sObject/id/ GET - /services/data/vXX.X/sobjects/sObject/id/ DELETE - /services/data/vXX.X/sobjects/sObject/id/ POST - /services/data/vXX.X/sobjects/sObject/describe/compactLayouts/ GET - /services/data/vXX.X/sobjects/sObject/quickActions/ GET Supported Queries: convertCurrency() function Example: SELECT Id, convertCurrency(AnnualRevenue) FROM Account Child-to-Parent subquery Example: SELECT ExternalReferenceIdentifier, Account.Name FROM PendingOrderSummary WHERE ExternalReferenceIdentifier = 'a' Limit clause Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE ExternalReferenceIdentifier = 'a' LIMIT 1 Filter by index Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE ExternalReferenceIdentifier = 'a' Filter by secondary index Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE AccountId = 'xxx' ORDER BY clause When using ORDER BY, you don’t need to specify a direction. However, if you sort ASC, you can’t use NULLS LAST. If you sort DESC, you can only use NULLS LAST. Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary ORDER BY ExternalReferenceIdentifier Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary ORDER BY ExternalReferenceIdentifier ASC NULLS FIRST Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary ORDER BY ExternalReferenceIdentifier DESC NULLS LAST Equality filter Range filters aren’t supported. Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE ExternalReferenceIdentifier = 'realm\_tenant@storesite@0000001' Invalid example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE ExternalReferenceIdentifier < 'a' #### See Also - [OrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm "Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") - [Order](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_order.htm "Represents an order associated with a contract or an account.") # PendingServiceRouting Represents the routing details of a work item that’s waiting to be routed or assigned. This object is available in API version 40.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. ## Fields | Field | Details | | --- | --- | | BotId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the Enhanced Einstein Bot or AI agent that performed the work. This is a relationship field. This field is available in API version 52.0 and later. This field is a relationship field. Relationship Name Bot Relationship Type Lookup Refers To BotDefinition | | BotType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the type of bot. Valid values are: - Bot. Refers to an Einstein bot. - ExternalCopilot. Refers to an AI agent with whom your customers can interact. The default value is Bot. This field is available in API version 63.0 and later. | | CapacityPercentage | Type percent Properties Create, Filter, Nillable, Sort, Update Description Indicates the amount of work that this work item represents as a percentage. Valid values are from 0 to 100. Voice calls must have a capacity percentage of 100. If an agent receives a voice call, the agent won’t receive new work items until the call ends, because at that point the agent’s capacity will have reached 100%. | | CapacityWeight | Type double Properties Create, Filter, Nillable, Sort, Update Description Indicates the amount of work that this work item represents as a whole number. Voice calls must use the entire capacity weight. | | CustomRequestedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Retains the datetime of this work item’s initial request, so work items are rerouted using the datetime of the initial work request. When left blank, work items are rerouted using the datetime when they’re rerouted. | | DropAdditionalSkillsTimeout | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Time to wait before a skill marked as additional is dropped from Omni-Channel routing. The case is then routed to the best-matched agent even if they don’t have all the skills. If CustomRequestedDateTime is set in the [PendingServiceRouting object](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_pendingservicerouting.htm), DropAdditionalSkillsTimeout uses CustomRequestedDateTime as the start time. If CustomRequestedDateTime + DropAdditionalSkillsTimeout has already passed, Omni-Channel immediately drops the additional skills after the pending service request is created. | | ExternalBotId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the third-party bot that handles the work item. This is a relationship field. This field is available in API version 64.0 and later. Relationship Name ExternalBot Relationship Type Lookup Refers To ExternalConversationBotDef | | GroupId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Omni-Channel queue. | | IsInterruptible | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a work item consumes interruptible or primary capacity. The default value is false. Available in version 57.0 and later when the Interruptible Capacity feature is enabled. | | IsOwnerChangeInitiated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a work item owner change triggered the direct assignment of this work item to the agent. The default value is false. | | IsPreferredUserRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether this work item stays with the preferred user even when the user isn’t available. The default value is false. This field is available in API version 50.0 and later. When a specific agent is required, don’t set PushTimeout. These options aren’t supported in this case. | | IsPushAttempted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a push has been attempted. true if this work item was pushed to an agent at least one time and false otherwise. | | IsPushed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this work item is pushed to an agent. | | IsReadyForRouting | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this work item is ready to be routed to an agent. If true, you can’t edit this PendingServiceRouting record. | | IsStatusChangeInitiated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a work item status change triggered the direct assignment of this work item to the agent. The default value is false. This field is available in API version 50.0 and later. | | IsTransfer | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this work item routing is a transfer request. | | LastDeclinedAgentSession | Type string Properties Filter, Group, Nillable, Sort Description Chat session ID of the agent who last declined this work item. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the PendingServiceRouting record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this PendingServiceRouting record. | | PausedCapacityPercentage | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of capacity that’s consumed when this work item is paused. The paused capacity feature is available with status-based capacity and Enhanced Omni-Channel only. This field is available in API version 62.0 and later. | | PausedCapacityWeight | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The amount of capacity that’s consumed when this work item is paused. The paused capacity feature is available with status-based capacity and Enhanced Omni-Channel only. This field is available in API version 62.0 and later. | | PreferredUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the preferred user to handle the work item. | | PushTimeout | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The time limit set for an agent to respond to an item before it’s rerouted and the agent’s status is changed accordingly. The time limit is measured in seconds. This field is available in API version 36.0 and later. Effective API version 57.0, for inbound Voice calls, this field represents the time limit set for an agent to respond to a call before it’s declined. The value must be from 0 through 20. The value is capped at 20, so any number greater than that is treated as 20 seconds. Latency on the part of the telephony provider can result in agents having less than 20 seconds to answer a call before it’s rerouted. When an agent attempts to answer a call within 20 seconds and finds that the call was rerouted, the agent’s status remains unchanged. This scenario applies to these telephony models. - Salesforce Voice with Amazon Connect - Salesforce Voice with Partner Telephony from Amazon Connect When IsPreferredUserRequired is set to true, don’t set this option. When a specific agent is required, this option isn’t supported. | | QueueId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Omni-Channel queue. Due to API changes, QueueId is no longer recommended. Use GroupId instead. | | RoutingModel | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of routing model. Possible values are: - ExternalRouting - LeastActive - MostAvailable | | RoutingPriority | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Order in which work items are routed to agents. This field is considered with skills-based routing only. Queue-based routing sets a work item's priority from the routing configuration. | | RoutingType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the work item is routed by queue or by skills-based routing. Possible values are: - QueueBased - SkillsBased | | SecondaryRoutingPriority | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the secondary routing priority. | | Serial | Type int Properties Filter, Group, Nillable, Sort Description Serial number of the PendingServiceRouting record. The serial number is automatically incremented each time the PendingServiceRouting record is modified. | | ServiceChannelId | Type reference Properties Create, Filter, Group, Sort Description ID of the service channel. | | TargetAcceptDateTime | Type dateTime Properties Filter, Nillable, Sort, Update Description The date and time by when a rep must accept a work item. Influences backlog ordering by prioritizing work items with earlier target acceptance deadlines. The field can be dynamically set using Flow for each work item during the routing process. This allows for flexible prioritization based on case urgency, customer tier, or other business rules. Available in API version 65.0 and later. | | TransferRequesterId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user ID of the rep who reassigned the work using the Reassign action. This field is populated in reassigned AgentWork records only, not the original AgentWork record. This is a relationship field. This field is available in API version 63.0 and later. Relationship Name TransferRequester Relationship Type Lookup Refers To User | | WorkItemId | Type reference Properties Create, Filter, Group, Sort Description ID of the work item. Refers To Custom objects and these standard objects: Account, Activity, Case, Claim, ClaimCoverage, ClaimRecovery, Contact, ContactRequest, CustomEntityData, Incident, Lead, LiveChatTranscript, MessagingSession, Opportunity, Orchestration Work Items, Order, Order, PaymentRequest, PersonTraining, Referral, SocialPost, SwarmMember, and VoiceCall. WorkOrder is available in version 58.0 and later. | ## Usage When you use the PendingServiceRouting object for queue-based routing, the object doesn’t invoke triggers before or after insert, or any action (trigger, workflow rule, validation) that could interfere with the creation of the record. ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [PendingServiceRoutingChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [PendingServiceRoutingOwnerSharingRule](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. [PendingServiceRoutingShare](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. ## Limits You can view the number of Pending Service Routing records that are currently in use in your org, as well as the current hourly use rate. From Setup, enter Omni-Channel in the Quick Find box and select **Limits**. The Limits page also displays the current Pending Service Routing record usage percentage and the Pending Service Routing record limits for your org. # PendingServiceRoutingInteractionInfo Represents PendingServiceRouting interaction information that’s used when work is routed to an agent. For a screen pop, it specifies which records to open when work is routed to an agent from a specific channel. PendingServiceRoutingInteractionInfo is read-only. This object is available in API version 53.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. To view this object, you must have the “Manage Flow” user permission. ## Fields | Field | Details | | --- | --- | | IsFocused | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this record shows on the agent’s screen when multiple records open at the same time. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the PendingServiceRoutingInteractionInfo. | | PendingServiceRoutingId | Type reference Properties Filter, Group, Sort Description The ID of the [PendingServiceRouting](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pendingservicerouting.htm "Represents the routing details of a work item that’s waiting to be routed or assigned. This object is available in API version 40.0 and later.") from which the [AgentWork](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_agentwork.htm "Represents a work assignment that’s been routed to an agent. If the work is transferred to another agent, a new AgentWork record is created. This object is available in API version 32.0 and later.") is created. This is a relationship field. Relationship Name PendingServiceRouting Relationship Type Lookup Refers To PendingServiceRouting | | PrimaryRecordId | Type reference Properties Filter, Group, Sort Description The ID of the object that’s routed to the agent through Omni-Channel. Relationship Name PrimaryRecord Relationship Type Lookup | | TargetFlowName | Type string Properties Filter, Group, Nillable, Sort Description The API name and namespace prefix, if any, of the screen flow to open when work is routed to the agent. This field and the TargetFlowId field can't be populated at the same time. Available in API version 57.0 and later. | | TargetObjectId | Type reference Properties Filter, Group, Nillable, Sort Description The record to open when work is routed to the agent. This field is required in API version 56.0 and earlier. In API version 57.0 and later, this field is optional and can’t be populated at the same time as the TargetFlowName field. Relationship Name TargetObject Relationship Type Lookup | # Period Represents a fiscal period defined in FiscalYearSettings. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only Chatter Free users and standard users can access this object. ## Fields | Field | Details | | --- | --- | | EndDate | Type date Properties Filter, Group, Sort Description The last date of the fiscal period. | | FiscalYearSettingsId | Type reference Properties Filter, Nillable, Group, Sort Description The parent record for this period. This is a relationship field. Relationship Name FiscalYearSettings Relationship Type Lookup Refers To FiscalYearSettings | | FullyQualifiedLabel | Type string Properties Group, Nillable Description Represents the period’s complete name in the UI. For example, “September FY 2016”. | | IsForecastPeriod | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the period is associated with Salesforce Forecasting (true) or not (false). | | Number | Type int Properties Filter, Nillable, Group, Sort Description If the labeling scheme of your fiscal year's quarters or months is numbered, this field indicates the relative number of the row. | | PeriodLabel | Type picklist Properties Filter, Group, Nillable, Sort Description If the months in your fiscal year use custom names, then this field contains the appropriate name for rows of type Month. | | QuarterLabel | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description If the quarters in your fiscal year use custom names, then this field contains the appropriate name for rows of type Quarter. | | StartDate | Type date Properties Filter, Group, Sort Description The first date of the fiscal period. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the period is of type Month, Quarter, Week, or Year. Label is the field value. | ## Usage In API version 36.0 and earlier, querying the Period object yields no results. In API version 37.0 and later, a query returns period records. #### See Also - [FiscalYearSettings](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fiscalyearsettings.htm "Settings to define a custom or standard fiscal year for your organization. This object has a parent-child relationship with the Period object.") # Permission Update Event Type Permission update events represent changes to object, field, and user permissions and setup entity access that occur in profiles and permission sets. The event type also tracks if you clone profiles or change whether session activation is required in permission sets or permission set groups. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This event type tracks if Salesforce updates object or field permissions in standard profiles, in addition to changes you make to your custom profiles, permission sets, and permission set groups. ## Fields | Field | Details | | --- | --- | | CONTEXT | Type String Description Reserved for future use. | | DESCRIPTION | Type String Description A description of the update that occurred in the profile, permission set, or permission set group. Example UserPerm: ConvertLeads disabled | | EVENT\_TYPE | Type String Description The type of event. The value is always PermissionUpdate. | | FEATURE\_ID | Type Id Description The ID of the feature, such as a profile, permission set, or permission set group, that was updated. | | LOGIN\_KEY | Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. Example 00DXXXXXXXXXXXX | | PERMISSION\_TYPE | Type String Description The type of permission, such as user, object, or field, or setup entity access, such as tab settings or Apex class access, that was updated. Example EntityObject | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 3nWgxWbDKWWDIk0FKfF5DV | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. Example d7DEq/ANa7nNZZVD | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. Example 20130715233322.670 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z | | UPDATE\_TYPE | Type String Description For object permissions, user permissions, and setup entity access, the type of update that occurred. For example, a permission was updated or deleted. For other changes in profiles, permission sets, or permission set groups, this information is tracked in the DESCRIPTION field. Example delete | | USER\_ID | Type Id Description The 15-character ID of the user who made the permission update. Example 005XXXXXXXXXXXX | # PermissionSet Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later. PermissionSet has a read-only child relationship with PermissionSetGroup. PermissionSet contains the aggregated permissions for the group. You can use permission sets to grant access, but not to deny access. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only users who have one of these permissions can access this object: - View Setup and Configuration - Manage Session Permission Set Activations - Assign Permission Sets - Manage Profiles and Permission Sets To view the following settings, assignments, and permissions for standard and custom objects in a specified permission set, the View Setup and Configuration permission is required. - Client settings - Field permissions - Layout assignments - Object permissions - Permission dependencies - Permission set tab settings - Permission set group components - Record types ## Fields | Field Name | Details | | --- | --- | | Description | Type string Properties Create, Filter, Nillable, Group, Sort, Update Description A description of the permission set. Limit: 255 characters. | | HasActivationRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the permission set requires an associated active session (true) or not (false). | | IsCustom | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the permission set is custom (created by an admin); if false, the permission set is standard and related to a specific permission set license. | | IsOwnedByProfile | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the permission set is owned by a profile. Available in API version 25.0 and later. | | Label | Type string Properties Create, Filter, Group, Sort, Update Description The permission set label, which corresponds to **Label** in the user interface. Limit: 80 characters. | | LicenseId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of either the related PermissionSetLicense or UserLicense associated with this permission set. Available in API version 38.0 and later. Use this field instead of UserLicenseId, which is deprecated and only available up to API Version 37.0. This is a polymorphic relationship field. Relationship Name License Relationship Type Lookup Refers To PermissionSetLicense, UserLicense | | Name | Type string Properties 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. Corresponds to **API Name** in the user interface. Limit: 80 characters. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix for a permission set that's been installed as part of a managed package. If the permission set isn't packaged or is part of an unmanaged package, this value is empty. Available in API version 23.0 and later. | | PermissionsPermissionName | Type boolean Properties Create, Filter, Update Description One field for each permission. If true, users assigned to this permission set have the named permission. The number of fields varies depending on the permissions for the organization and license type. To get a list of available permissions in the SOAP API, use describeSObjects(). | | PermissionSetGroupId | Type reference Properties Filter, Group, Nillable, Sort Description If the permission set is owned by a permission set group, this field returns the ID of the permission set group. If the permission set isn’t owned by a permission set group, this field returns a null value. Available in API version 45.0 and later. This is a relationship field. Relationship Name PermissionSetGroup Relationship Type Lookup Refers To PermissionSetGroup | | ProfileId | Type reference Properties Filter, Group, Nillable, Sort Description If the permission set is owned by a profile, this field returns the ID of the Profile. If the permission set isn’t owned by a profile, this field returns a null value. Available in API version 25.0 and later. This is a relationship field. Relationship Name Profile Relationship Type Lookup Refers To Profile | | Type | Type reference Properties Filter, Group, Nillable, Sort Description Available in API version 46.0 and later. | | UserLicenseId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the UserLicense associated with this permission set. This field is nillable in API version 26.0 and later and available up to API version 37.0 In API version 38.0 and later, use LicenseId. | ## Usage Use the PermissionSet object to query existing permission sets. For example, to search for all permission sets that contain the “Modify All Data” permission: SELECT Name, PermissionsModifyAllData FROM PermissionSet WHERE PermissionsModifyAllData=true When combined with the PermissionSetAssignment object, you can create a nested query that returns all users assigned to a particular permission like “Modify All Data”: SELECT Name, (SELECT AssigneeId FROM Assignments) FROM PermissionSet WHERE PermissionsModifyAllData=true If the permission set isn’t assigned to a user, you can also create or delete a permission set. ## User Licenses The user license controls the permissions that are available in a permission set. Every permission set can be associated with a user license or permission set license. If you plan to assign a permission set to multiple users with different user and permission set licenses, leave LicenseId empty. If only users with one type of license use this permission set, set the LicenseId to that single user or permission set license. If you want a permission set associated with a permission set license, then set LicenseId to the permission set license. To get the LicenseId, run this query: SELECT Id, Name FROM UserLicense Alternatively, to query a user or profile for the LicenseId. SELECT Id, Profile.UserLicenseId FROM User ## Child Objects When using the API, think of each permission set or related set of access controls as an empty container that you fill with permission records. In the API, a permission set can contain user, object, and field permissions, and setup entity access settings for other settings, such as Apex classes. - ObjectPermissions and FieldPermissions objects are available in API version 24.0 and later. - The SetupEntityAccess object is available in API version 25.0 and later. - The PermissionSetGroupComponent object is available in API version 45 and later. Only user permissions are managed in the PermissionSet API object; all other permission types are managed in child API objects. In these child objects, access is stored in a record, while the absence of a record indicates no access. To return a record in a SOQL query, a minimum permission or setting is required for each child object. Because permissions are stored in related objects, it’s important to understand what questions to ask when using SOQL. For example, let’s say you want to know which permission sets have “Delete” on an object. You also want to know which ones include permissions that allow approval of a return merchandise authorization (where the approval checkbox is controlled with field permissions). Asking the right questions when using SOQL with permission sets ensures that you get the information you need, such as whether to migrate permissions or assign a permission set to a user. For example, the following returns all permission sets where the “Read” permission is enabled for the Merchandise\_\_c object. SELECT SobjectType, ParentId, PermissionsRead FROM ObjectPermissions WHERE PermissionsRead = True AND SobjectType = 'Merchandise\_\_c' You can query for all permission sets that have “Read” on an object. However, you can’t query for permission sets that have no access on an object, because no records exist for that object. For example, the following returns no records because the object must have at least “Read” to return any records. SELECT SobjectType, ParentId, PermissionsRead FROM ObjectPermissions WHERE PermissionsRead = False AND SobjectType = 'Merchandise\_\_c' If you have at least the “Read” permission on an object, you can create a conditional query on other permissions in the same object. For example, the following returns any records where the object has at least the “Read” permission but not the “Edit” permission. SELECT ParentId, PermissionsRead, PermissionsEdit FROM ObjectPermissions WHERE PermissionsEdit = False AND SobjectType = 'Merchandise\_\_c' To set an object or field permission to no access, delete the record that contains the permission. For example, to disable all object permissions in the Merchandise\_\_c object for a particular permission set, first query to retrieve the ID of the object permission record. SELECT Id FROM ObjectPermissions WHERE SobjectType = 'Merchandise\_\_c' Then delete the IDs returned from the query. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you try to update the object or field permissions by setting all permissions to false, the permission record is automatically deleted. Any subsequent queries for the record ID won’t return results and you must add a new permission record to grant access. ## View a Permission Set with Nested Queries You can build on the PermissionSet object using child relationships that show all of the permissions in a single permission set. For example, the following returns all permission sets and displays the “Transfer Leads” permission, as well as any “Read” permissions on any objects and fields. SELECT Label, PermissionsTransferAnyLead, (SELECT SobjectType, PermissionsRead FROM ObjectPerms), (SELECT SobjectType, Field, PermissionsRead FROM FieldPerms) FROM PermissionSet ## Associated Profiles In API version 25.0 and later, every profile is associated with a permission set that stores the profile’s user, object, and field permissions, as well as setup entity access settings. You can query permission sets that are owned by profiles but not modify them. The following example returns all permission sets, including those owned by a profile. SELECT Id, Label, ProfileId, Profile.Name FROM PermissionSet The following returns all permission sets except those permissions owned by profiles. SELECT Id, Label, ProfileId, Profile.Name, IsOwnedByProfile FROM PermissionSet WHERE IsOwnedByProfile = FALSE Because permission sets have child objects in the API, you can query their values on permission sets owned by a profile. For example, the following returns all enabled object permission records for profiles only. SELECT Id,ParentId, PermissionsRead, SobjectType, Parent.ProfileId FROM ObjectPermissions WHERE Parent.IsOwnedByProfile = TRUE Once you have the IDs for permission sets that are owned and not owned by profiles, use the [PermissionSetAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetassignment.htm "Represents a user’s assignment to a permission set or permission set group. This object is available in API version 22.0 and later.") object to see if users can access objects or fields via their profile permissions or their permission sets. For example, the following SOQL query returns all users who have the “Read” permission on the Merchandise\_\_c object. It also specifies whether the permission is granted through a profile or permission set. SELECT Assignee.Name, PermissionSet.Id, PermissionSet.isOwnedByProfile FROM PermissionSetAssignment WHERE PermissionSetId IN (SELECT ParentId FROM ObjectPermissions WHERE SObjectType = 'Merchandise\_\_c' AND PermissionsRead = true) ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For permission sets that are owned by profiles, don’t use Name and Label values that are returned in a query. Name and Label values from queries can change. #### See Also - [ObjectPermissions](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectpermissions.htm "Represents the enabled object permissions for the parent PermissionSet. This object is available in API version 24.0 and later.") - [FieldPermissions](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fieldpermissions.htm "Represents the enabled field permissions for the parent PermissionSet. This object is available in API version 24.0 and later.") - [SetupEntityAccess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_setupentityaccess.htm "Represents the enabled setup entity access settings (such as for Apex classes) for the parent PermissionSet. This object is available in API version 25.0 and later.") - [PermissionSetAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetassignment.htm "Represents a user’s assignment to a permission set or permission set group. This object is available in API version 22.0 and later.") - [Profile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profile.htm "Represents a profile, which defines a set of permissions to perform different operations. Operations can include creating a custom profile or querying, adding, updating, or deleting information.") # PermissionSetAssignment Represents a user’s assignment to a permission set or permission set group. This object is available in API version 22.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update() ## Special Access Rules As of Summer ’20 and later, only users who have one of these permissions can access this object: - View Setup and Configuration - Assign Permission Sets - Manage User ## Fields | Field Name | Details | | --- | --- | | AssigneeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user that is assigned the permission set indicated in PermissionSetId or the permission set group indicated in PermissionSetGroupId. This is a relationship field. Relationship Name Assignee Relationship Type Lookup Refers To User | | ExpirationDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date that the assignment of the permission set or permission set group expires for the specified user. This field is available in API version 52.0 and later. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the assignment is active (true) or not (false). Defaults to false. This field is available in API version 52.0 and later. | | IsRevoked | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the assignment was revoked (true) or not (false). Defaults to false. This field is available only if user access policies are enabled. This field is available in API version 57.0 and later. | | LastCreatedByChangeId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user access change record related to this permission set or permission set group assignment. This field is available only if user access policies are enabled. This field is available in API version 57.0 and later. This field is a relationship field. Relationship Name LastCreatedByChange Relationship Type Lookup Refers To UserAccessChange | | LastDeletedByChangeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user access change record related to this permission set or permission set group assignment being revoked. This field is available only if user access policies are enabled. This field is available in API version 57.0 and later. This field is a relationship field. Relationship Name LastCreatedByChange Relationship Type Lookup Refers To UserAccessChange | | PermissionSetGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the permission set group assigned to the user specified in AssigneeId. This field is available in API version 45.0 and later. This is a relationship field. Relationship Name PermissionSetGroup Relationship Type Lookup Refers To PermissionSetGroup | | PermissionSetId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the permission set assigned to the user specified in AssigneeId. This is a relationship field. Relationship Name PermissionSet Relationship Type Lookup Refers To PermissionSet | ## Usage Finding Permission Set Assignments Use the PermissionSetAssignment object to query permission set assignments to find out which permission sets are assigned to which users. Because each user can be assigned to many permission sets and each permission set can be assigned to many users, each PermissionSetAssignment ID represents the association of a single user and single permission set. For example, to search for all permission sets assigned to a particular user: SELECT Id, PermissionSetId FROM PermissionSetAssignment WHERE AssigneeId = '005600000017cKt' To search for all users assigned to a particular permission set: SELECT Id, AssigneeId FROM PermissionSetAssignment WHERE PermissionSetId = '0PS30000000000e' You can also create a new permission set assignment, or use delete to remove a permission set that's assigned to a user. To update an assignment, delete an existing assignment and insert a new one. User Licenses When assigning a permission set, if the PermissionSet has a UserLicenseId, its UserLicenseId and the Profile UserLicenseId must match. To determine a user's license assignment, query the user's profile and then query the profile's license. For example, to find a user's profile ID: SELECT Id, ProfileId FROM User WHERE Id = '005D0000001GMAT' To find a permission set's UserLicenseId: SELECT Id, LicenseId FROM PermissionSet WHERE Id = '0PS30000000000e' If the IDs match, the assignment succeeds. To find all the permission sets with no license that are assigned to any user: SELECT Id, Assignee.Name, PermissionSet.Name FROM PermissionSetAssignment WHERE PermissionSet.LicenseId = null Revoked Assignments from User Access Policies After you revoke a permission set or permission set group assignment via a user access policy, the IsRevoked field is updated to true. The PermissionSetAssignment record isn’t deleted. If the permission set or permission set group is assigned to the user again, the IsRevoked field is then updated to false. To find permission set or permission set group assignments that were revoked: SELECT Id, ExpirationDate, Assignee.Name, PermissionSet.Name FROM PermissionSetAssignment WHERE IsRevoked=true ALL ROWS #### See Also - [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.") # PermissionSetGroup Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeObject(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, to view this object, users must have one of these permissions: - View Setup and Configuration - Manage Session Permission Set Activations - Assign Permission Sets To edit this object, users must have the Manage Profiles and Permission Sets permission. ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The Permission Set Group description. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The permission set group name used in the API. | | HasActivationRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the permission set group requires an associated active session (true) or not (false). The default value is false. This field is available in API version 53.0 and later. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The Permission Set Group language. Possible values are: - da (Danish) - de (German) - en\_US (English) - es (Spanish) - es\_MX (Spanish - Mexican) - fi (Finnish) - fr (French) - it (Italian) - ja (Japanese) - ko (Korean) - nl\_NL (Dutch) - no (Norwegian) - pt\_BR (Portuguese - Brazilian) - ru (Russian) - sv (Swedish) - th (Thai) - zh\_CN (Chinese - Simplified) - zh\_TW (Chinese - Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The permission set group label for the aggregated permissions. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The permission set group namespace prefix. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Indicates permission set group recalculation status. - Updated. The group is current. - Outdated. The group requires recalculation. - Updating. The group is in recalculation mode. - Failed. The group recalculation failed. | ## Usage Use the PermissionSetGroup object to query existing permission set groups and to find which aggregated permissions are included in the group. For example, to search for all object permissions in a permission set group named StandardAccountingUsers: SELECT SObjectType FROM ObjectPermissions WHERE Parent.PermissionSetGroup.DeveloperName = 'StandardAccountingUsers' To create a permission set group using REST API, you can submit a POST request. POST /services/data/v45.0/tooling/sobjects/PermissionSetGroup/ { "DeveloperName":"Sales", "MasterLabel": "sales\_label" } # PermissionSetGroupComponent A junction object that relates the PermissionSetGroup and PermissionSet objects via their respective IDs; enables permission set group recalculation to determine the aggregated permissions for the group. This object is available in API version 45.0 and later. PermissionSetGroupComponent is a child object of PermissionSet and PermissionSetGroup. ## Supported Calls create(), delete(), describeSObject(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only users with the "View Setup and Configuration" permission can access this object. ## Fields | Field Name | Details | | --- | --- | | PermissionSetGroupId | Type reference Properties Create, Filter, Group, Sort Description The unique permission set group ID. This is a relationship field. Relationship Name PermissionSetGroup Relationship Type Lookup Refers To PermissionSetGroup | | PermissionSetId | Type reference Properties Create, Filter, Group, Sort Description The unique permission set ID of a permission set in a permission set group. This is a relationship field. Relationship Name PermissionSet Relationship Type Lookup Refers To PermissionSet | ## Usage Use the PermissionSetGroupComponent object to add members to or delete members from a permission set group, or to query for group members. # PermissionSetLicense Represents a license that’s used to enable one or more users to receive a specified permission without changing their profile or reassigning profiles. You can use permission set licenses to grant access, but not to deny access. This object is available in API version 29.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | ExpirationDate | Type date Properties Filter, Group, Nillable, Sort Description The date at which the permission set license expires. | | IsAvailableForIntegrations | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the permission set license is enabled for integrations (true) or not (false). When this field is set to true, Salesforce integration features can access data. The default value is false. This field is read-only in the API and can be edited only in Setup. If integrations are required for feature functionality and the license isn't enabled for integrations, you receive an error when setting up the session-based permission set or executing the feature. Only enable integrations if necessary for the feature. | | IsSupplementLicense (Developer Preview) | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a custom permission set license is a supplement license (true) or a foundation license (false). The default value is false. This field is only available if the Partner Licensing Platform developer preview is enabled. This field is available in API version 55.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The Partner Licensing Platform is available as a developer preview. The Partner Licensing Platform isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Don't implement functionality developed with these commands or tools in your production package. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the permission set license. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label of the permission set license. Label is **Permission Set License Label**. | | MaximumPermissionsPermissionName | Type boolean Properties Filter Description One field for each permission. For example, MaximumPermissionsIdentityConnect corresponds to the “Use Identity Connect” permission. If true, this PermissionSetLicense grants the specified permission. The number of fields varies depending on the permissions available for the organization. | | PermissionSetLicenseKey | Type string Properties Filter, Group, idLookup, Sort Description A string that uniquely identifies a particular permission set license. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of a permission set license. If Active, the permission set license is available. If Disabled, the permission set license has expired. | | TotalLicenses | Type int Properties Filter, Group, Sort Description The total number of this permission set license that are available to your organization. | | UsedLicenses | Type int Properties Filter, Group, Sort Description The number of this permission set license that are currently assigned to users. | ## Usage Users with the “View Setup and Configuration” permission can use the PermissionSetLicense object to view the set of currently defined permission set licenses in your organization. Use the PermissionSetLicense object to query existing permission licenses. For example, to return a list of all active permission set licenses: SELECT MasterLabel FROM PermissionSetLicense WHERE Status = 'Active' When combined with the PermissionSetLicenseAssign object, you can create a nested query that returns all users assigned to a particular permission set license like “Identity Connect”: SELECT MasterLabel, (SELECT AssigneeId FROM PermissionSetLicenseAssign) FROM PermissionSetLicense WHERE MaximumPermissionsIdentityConnect=true #### See Also - [PermissionSetLicenseAssign](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetlicenseassign.htm "Represents the association between a User and a PermissionSetLicense. This object is available in API version 29.0 and later.") # PermissionSetLicenseAssign Represents the association between a User and a PermissionSetLicense. This object is available in API version 29.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The relationship name for PermissionSetLicenseAssign is PermissionSetLicenseAssignments. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only users who have one of these permissions can access this object: - View Setup and Configuration - Assign Permission Sets ## Fields | Field Name | Details | | --- | --- | | AssigneeId | Type reference Properties Create, Filter, Group, Sort Description ID of the User to assign the permission set license specified in PermissionSetLicenseId. This is a relationship field. Relationship Name Assignee Relationship Type Lookup Refers To User | | IsRevoked | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Reserved for internal use. This field is available in API version 58.0 and later. | | LastCreatedByChangeId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user access change record related to this permission set license assignment. This field is available only if user access policies are enabled. This field is available in API version 58.0 and later. This field is a relationship field. Relationship Name LastCreatedByChange Relationship Type Lookup Refers To UserAccessChange | | LastDeletedByChangeId | Type reference Properties Create, Filter, Group, Sort Description ID of the user access change record related to this permission set license assignment being revoked. This field is available only if user access policies are enabled. This field is available in API version 58.0 and later. This field is a relationship field. Relationship Name LastCreatedByChange Relationship Type Lookup Refers To UserAccessChange | | PermissionSetLicenseId | Type reference Properties Create, Filter, Group, Sort Description The ID of the permission set license the user is assigned to. This is a relationship field. Relationship Name PermissionSetLicense Relationship Type Lookup Refers To PermissionSetLicense | ## Usage Use the PermissionSetLicenseAssign object for querying permission set license assignments to find out which permission set licenses are assigned to which users. Because each user can be assigned to many permission set licenses, each PermissionSetLicenseAssign ID represents the association of a single user and single permission set license. For example, to search for all of the permission sets assigned to a particular user: SELECT Id, PermissionSetLicenseId FROM PermissionSetLicenseAssign WHERE AssigneeId = '005D0000001RFek' To search for all users assigned to a particular permission set license: SELECT AssigneeId FROM PermissionSetLicenseAssign WHERE PermissionSetLicenseId = '0PLD000000003mwOAA' You can also create a new permission set license assignment, or use delete to remove a permission set license that’s been assigned to a user. To update an assignment, delete an existing assignment and insert a new one. #### See Also - [PermissionSetLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetlicense.htm "Represents a license that’s used to enable one or more users to receive a specified permission without changing their profile or reassigning profiles. You can use permission set licenses to grant access, but not to deny access. This object is available in API version 29.0 and later.") # PermissionSetLicenseDefinition Represents the definition of a custom permission set license, which entitles specified features in a package. This object is available in API version 66.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), query(), retrieve(), upsert() ## Fields | Field | Details | | --- | --- | | ComponentAccess | Type picklist Properties Create, Filter, Group, Sort, Update Description Allows access to an associated component. Possibel values include: - None - Namespace | | CreatedById | Type reference Properties Defaulted on create, Filter Description ID of the [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm "HTML (New Window)") who created this record. | | CreatedDate | Type dateTime Properties Defaulted on create, Filter Description Date and time when this record was created. | | DefaultTrialLengthInDays | Type int Properties Create, Filter, Group, Sort, Update Description Required. Default trial length in days. | | DefaultTrialLicenseCount | Type int Properties Create, Filter, Group, Sort, Update Description Required. Default number of trial licenses provisioned for a trial. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, must be unique in your organization, and has a limit of 80 characters. 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. | | Id | Type id Properties Create, Filter, Group, Sort, Update Description Unique record ID. | | IsDeleted | Type boolean Properties Create, Filter, Group, Sort, Update Description When true, the record has been deleted. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The two- to five-character code that represents the language and locale ISO. This code controls the language for labels displayed in an application. | | LastModifiedById | Type reference Properties Defaulted on create, Filter Description ID of the [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm "HTML (New Window)") who last updated this record. | | LastModifiedDate | Type dateTime Properties Defaulted on create, filter Description Date and time when a user last modified this record. | | LicenseExpirationPolicy | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The license expiration policy of the custom permission set license. Possible values are: - BlockNamespaceAccess—Package access is blocked for existing users when all custom permission set licenses expire. This is the default value. - AllowNamespaceAccess—Package access isn’t blocked for existing users when all custom permission set licenses expire. This field is available in API version 55.0 and later. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for this PermissionSetLicenseDefinition value. This display value is the internal label that does not get translated. Limit: 80 characters. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | SystemModstamp | Type dateTime Properties Defaulted on create, filter Description In general, SystemModstamp shows the date and time when a user or automated process last modified the record. However, in certain cases, SystemModstamp doesn’t capture every field change. For example, if object A retrieves values from object B, then the changes to field values in records on object B are reflected in the SystemModstamp field for records on object B, but not on object A. | | UserLicenseRestrictions | Type textarea Properties Create, Nillable, Update Description The user license categories that can be assigned the custom permission set license. If no user license categories are specified, all users can be assigned the license. Possible values include: - ${communities} - ${communitiesLogin} - ${customerCommunities} - ${customerCommunitiesLogin} - ${internal} - ${partnerCommunity} - ${partnerCommunityLogin} - ${platform} | ## Usage After the PermissionSetLicenseDefinition is created, it must be referenced in [LicenseDefinitonCustomPermission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_licensedefinitioncustompermission.htm "Represents a licensed custom permission that controls access to a license's features when included in a custom permission set license definition. This object is available in API version 66.0 and later."). # PermissionSetTabSetting Represents a permission set tab setting. Requires the View Setup permission. Use this object to query all tab settings of the permission set. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only users with "View Setup and Configuration" permission can access this object. ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, Sort Description The tab name. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The permission set Id. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To PermissionSet | | Visibility | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the tab is visible by default. Possible values are: - DefaultOff - DefaultOn | ## Usage Use the PermissionSetTabSetting object to find tab setting visibility settings, parent permission sets, and so forth. For example, to find the visibility setting of a tab named “standard-Lead,” do something like the following. SELECT Visibility FROM PermissionSetTabSetting WHERE Name = 'standard-Lead' # PermissionUpdateEventLog Permission update events represent changes to object, field, and user permissions and setup entity access that occur in profiles and permission sets. The event type also tracks if you clone profiles or change whether session activation is required in permission sets or permission set groups. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | Context | Type string Properties Filter, Group, Nillable, Sort Description The context for what is happening for this update. | | Description | Type string Properties Filter, Group, Nillable, Sort Description A description of the update that occurred in the profile, permission set, or permission set group. | | FeatureIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the feature, such as a profile, permission set, or permission set group, that was updated. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | PermissionType | Type string Properties Filter, Group, Nillable, Sort Description The type of permission, such as user, object, or field, or setup entity access, such as tab settings or Apex class access, that was updated. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | UpdateType | Type string Properties Filter, Group, Nillable, Sort Description For object permissions, user permissions, and setup entity access, the type of update that occurred. For example, a permission was updated or deleted. For other changes in profiles, permission sets, or permission set groups, this information is tracked in the DESCRIPTION field. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who made the permission update. | # PersnlBatchDecision Represents a batch personalization that delivers personalization decisions (content or recommendations) to a customer segment. Available in API version 64.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ActivationTriggerType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Type of trigger that activates the batch personalization decision. The default value is None and possible values are: - Automatic—Automatically On Job Completion - None | | BatchStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Status of the batch personalization decision. The default value is Active and possible values are: - Active - Error - Paused | | DataSpaceId | Type reference Properties Filter, Group, Sort Description The ID of the data space from where batch personalization decision resources originate. Relationship Name DataSpace Refers To DataSpace | | Description | Type string Properties Filter, Group, Nillable, Sort Description Text description of the batch personalization decision. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description The unique name of the batch personalization decision in the API. | | ErrorCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The issue that’s causing an error. The default value is None and possible values are: - ConfigurationMissingError—A required configuration setting is missing. - DpcJobError—A problem occurred during processing. - Internal Error—An internal error occurred during processing. - ModelValidationError—The model is invalid. - None | | RefreshMode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description How the batch personalization data is refreshed. The default value is FULL\_REFRESH and possible values are: - FULL\_REFRESH—Generates new decisions for all members in a segment. - INCREMENTAL—Generates decisions only for the new members added to the segment after the last run. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the batch personalization decision. | ## Usage PersnlBatchDecision provides details about refresh modes, model versions, and refresh states for specific market segments. # PersonAccountOwnerPowerUser Represents a user who can own more than 50,000 customer or partner portal accounts. Person account owner power users can own a large number of either customer or partner users. Their role can’t be changed and they must be at the root of the role hierarchy. Person account owner power user objects can't be created if deferred sharing is turned on for your org. Person account owner power user objects can be created while deferred sharing is turned off for an org. Deferred sharing can be turned back on after person account owner power user objects have been created. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Create a PersonAccountOwnerPowerUser object. Enter the user ID of the power user and the type of users that they can own, Customer Portal or Partner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users at the highest level of a hierarchy can be added to the PersonAccountOwnerPowerUser object. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language that the user’s account is set to. The user is specified using the UserId field. See Salesforce Help for a full list of languages. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label entered when the person account owner power user is created. | | PortalType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of portal user account that the person account owner power user can own. A possible value is: - CustomerPortal—Customer Portal | | UserId | Type reference Properties Create, Filter, Group, Sort Description The unique ID associated with the person account owner power user. This field is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | # PersonalizationDecision Represents a set of targeting rules within a personalization point that determine an individual's eligibility to receive personalized content and the content to deliver. Available in API version 62.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Three letter ISO currency codes for supported currencies. The default value is USD. This is an optional field. | | DataSpaceId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the data space from where a personalization decision's resources originate. This is a required field. Relationship Name DataSpace Refers To DataSpace | | Description | Type String Properties Filter, Group, Nillable, Sort Description Text description of the personalization decision. This is an optional field. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description System or user-generated API name for the personalization decision. This is a required field. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The text label that identifies the personalization decision. | | PersonalizationPointId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to a personalization point. Relationship Name PersonalizationPoint **Relationship Type** Primary-detail Refers To PersonalizationPoint (the primary object) | | PersonalizerId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to the personalizer service called at runtime, which retrieves the necessary information for a decision response. Relationship Name Personalizer Refers To PersonalizationRecommender | | Priority | Type int Properties Filter, Group, Nillable, Sort Description Represents the order in which personalization decisions are evaluated. If an individual qualifies for multiple decisions, the one with the highest priority is returned. The possible values are positive integers such as 1, 2, and 3. | | State | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Picklist value that indicates the state of the decision. The default value is Draft, and accepted values are Draft and Live. Personalization evaluates only live decisions. | ## Usage Use this object for defining and managing personalized responses. It includes targeting rules to determine eligibility and specifies the content to return, such as product recommendations. ## Associated Objects This object has these 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. [PersonalizationDecisionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [PersonalizationDecisionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [PersonalizationDecisionHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [PersonalizationDecisionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm) Sharing rules are available for the object. [PersonalizationDecisionShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm) Sharing is available for the object. # PersonalizationObjective Represents a specific business outcome that you want to achieve when creating a recommender. Available in API version 62.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Three letter ISO currency codes for supported currencies. The default value is USD. This is an optional field. | | DataSpaceId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the data space where an objective's resources originate. This is a required field. Relationship Name DataSpace Refers To DataSpace | | Description | Type String Properties Filter, Group, Nillable, Sort Description Text description of the personalization objective. This is an optional field. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description System or user-generated API name for the personalization objective. This is a required field. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the personalized objective was referenced by another resource. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time a user viewed the personalization objective. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The text label that identifies the personalization objective. | ## Usage Use this object to define a business objective. The personalized, targeted recommendations generated using deep learning algorithms are intended to help achieve this objective. For example, the objective “maximizing revenue” can return recommendations that aim to increase checkout frequency, increase cart value at checkout, or both. ## Associated Objects This object has these 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. [PersonalizationObjectiveChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [PersonalizationObjectiveFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [PersonalizationObjectiveHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [PersonalizationObjectiveOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm) Sharing rules are available for the object. [PersonalizationObjectiveShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm) Sharing is available for the object. # PersonalizationPoint Represents a specific touch point in an experience where a personalization decision can be made. It connects a data space, profile data graph, personalization type, and response template to deliver personalized content at that time in a customer journey. Available in API version 62.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AbnExperimentId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to a related experiment. Relationship Name AbnExperiment Refers To AbnExperiment | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Three letter ISO currency codes for supported currencies. The default value is USD. This is an optional field. | | DataSpaceId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the data space where a personalization point's resources originate. This is a required field. Relationship Name DataSpace Refers To DataSpace | | Description | Type String Properties Filter, Group, Nillable, Sort Description Text description of the personalization point. This is an optional field. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description System or user-generated API name for the personalization point. This is a required field. | | IsAuthenticationRequired | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the personalization point must use authenticated endpoints for real-time data capture and recommendation requests. When set to true, all interactions with Data Cloud are secured and verified. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the personalized point was referenced by another resource. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time a user viewed the personalization point. | | MaxItemsCount | Type int Properties Filter, Group, Nillable, Sort Description Indicates the maximum number of recommendations to return. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The text label that identifies the personalization point. | | PersonalizationSchemaEnum | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Picklist value that indicates the type of personalization schema, which is related to where a personalization decision is created. The accepted values are - DecisionDefined - ExperienceVariation - FlowPath | | PersonalizationSchemaId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to the schema that’s related to the personalization point. Relationship Name PersonalizationSchema Refers To PersonalizationSchema | | ProfileDataGraphId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the profile data graph that’s used with the personalization point. Relationship Name ProfileDataGraph Refers To DataGraph | | RootPersonalizationPoint | Type string Properties Filter, Group, Nillable, Sort Description Indicates the personalization point from where data is gathered‌. | | Source | Type string Properties Filter, Group, Nillable, Sort Description Indicates the personalization point from where data is gathered‌. | | SourceRecordId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier that refers to the specific record that contains the personalization point. Relationship Name SourceRecord Refers To FlowRecordElement, ManagedContent | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Indicates the state of the personalization point. The default value is Processing, and the accepted values are: - Active - CreateError—Error - DeleteError—Error - Deleting - EditError—Error - Processing | ## Usage Use this object to define a specific touch point in an experience where personalization decisions can be made. For example, a personalization point can be an banner on a webpage. After setting up data space, profile data graph, personalization type, and schema, you can add decisions and targeting rules to the personalization point to tailor the user experience. ## 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. [PersonalizationPointChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [PersonalizationPointFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [PersonalizationPointHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [PersonalizationPointOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm) Sharing rules are available for the object. [PersonalizationPointShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm) Sharing is available for the object. # PersonalizationSchema Represents a personalization response template that’s used when you build a personalization decision. Available in API version 62.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Three letter ISO currency codes for supported currencies. The default value is USD. This is an optional field. | | DataSpaceId | Type reference Properties Filter, Group, Sort Description Unique identifier that refers to the data space where a response template's resources originate. This is a required field. Relationship Name DataSpace Refers To DataSpace | | Description | Type String Properties Filter, Group, Nillable, Sort Description Text description of the response template. This is an optional field. | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description System or user-generated API name for the personalization response template. This is a required field. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time the personalized response template was referenced by another resource. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates the last time a user viewed the response template. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The text label that identifies the personalization response template. | | PersonalizationType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the kind of personalization content to present. The default value is Recommendations, and the accepted values are ManualContent and Recommendations. | ## Usage A response template outlines the attributes that ‌marketers use to configure the personalization response. It defines an expected format and shape for all decision response data. - For a recommendation-focused personalization, the response template can include an optional placeholder attribute to include header text before a set of recommendations. - For a ‌manual content personalization, the response template can include placeholders for background images, links, call-to-action text, and so on. ## Associated Objects This object has these 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. [PersonalizationSchemaChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [PersonalizationSchemaFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [PersonalizationSchemaHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [PersonalizationSchemaOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm) Sharing rules are available for the object. [PersonalizationSchemaShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm) Sharing is available for the object. # PersonalizationTargetInfo Represents a target for an audience. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ContainerId | Type reference Properties Filter, Group, Sort Description ID of the Experience Cloud site or org that contains the target. | | DraftRowId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the draft PersonalizationTargetInfo. | | GroupName | Type string Properties Filter, Group, Sort Description Group name of the target. Groups bundle related targets. You can have up to 2,000 groups and 500 targets per group. | | PublishStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Publish status of the target. Possible values are: - Draft - Live | | TargetType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of the target. Possible values are: - ExperienceVariation - NavigationLinkSet - Topic - CollaborationGroup - KnowledgeArticle - ContentDocument - ManagedContent - Report - Dashboard - Custom objects You can have up to 2,500 ExperienceVariation targets and 25,000 record targets. | | TargetValue | Type string Properties Filter, Group, Sort Description Value of the target. For ExperienceVariation, this is the developer name of the Experience Variation or the record ID for the object. | # PersonalOrgInfo Represents the information for a Tableau Next personal org. This object is available in API version 64.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules To access this object, you must have Tableau Next enabled in your org and a Tableau Next permission set. ## Fields | Field | Details | | --- | --- | | DeletedBy | Type string Properties Filter, Group, Nillable, Sort Description The user ID that deleted the personal org. | | DeletedDate | Type date Properties Filter, Group, Nillable, Sort Description The date the personal org was deleted. | | Description | Type textarea Properties Create, Nillable Description The description for the personal org. | | Details | Type string Properties Create, Filter, Group, Nillable, Sort Description The details for the personal org. | | ErrorCode | Type string Properties Filter, Group, Nillable, Sort Description The error code for the personal org. | | IsPersonalOrgDeleted | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the personal org is deleted (true) or not (false). The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the personal org was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the personal org was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The API name of the personal org. | | OrgName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the personal org. | | PersonalOrg | Type string Properties Filter, Group, Nillable, Sort Description The ID of the personal org. | | PrimaryOrgUser | Type string Properties Create, Filter, Group, Sort, Update Description The email for the primary user of the personal org. | | PrimaryOrgUserIdentifier | Type string Properties Filter, Group, Sort Description The user ID for the primary user of the personal org. | | SignupCountry | Type string Properties Filter, Group, Sort Description The country of the personal org signup. | | SignupEmail | Type email Properties Filter, Group, Sort Description The user email used for personal org signup. | | SignupInstance | Type string Properties Filter, Group, Nillable, Sort Description The Salesforce org instance used for personal org signup. | | SignupLanguage | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language used for personal org setup. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | SignupUsername | Type string Properties Filter, Group, Sort Description The user name used for personal org signup. | | SourceType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The source of the personal org. Possible values are: - TableauEinstein—Tableau Next | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The status of the personal org. Possible values are: - Active - Creating - Deleted - Error - New The default value is New. | ## 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. [PersonalOrgInfoFeed](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. [PersonalOrgInfoHistory](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. # PersonTraining Represents an assignment of a learning module in Workforce Engagement. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org requires a Workforce Engagement license and an Enablement Sites (myTrailhead) license. The user requires at least one Workforce Engagement permission set assigned to them: Workforce Engagement Admin, Workforce Engagement Analyst, Workforce Engagement Planner, or Workforce Engagement Agent. Workforce Engagement Management uses this object to route training to agents. To assign modules to agents, users with the Learning Manager profile require Read, Create, and View All Records access to this object. To receive routed modules, users with the Learner profile require Read access to this object. ## Fields | Field | Details | | --- | --- | | AssigneeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A valid user ID for the user who’s assigned the training. AssigneeId can’t be empty if the Status field is Assigned. We recommend that you set AssigneeId to the value in OwnerId. This is a relationship field. Relationship Name Assignee Relationship Type Lookup Refers To User | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the learning module. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who owns the person training. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the training. Possible values are: - A—Assigned; when the Status is assigned, the AssigneeId field can’t be empty. - C—Completed - I—In Progress - N—New - P—Paused The default value is 'N'. | | TrainingId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the learning module. This is a relationship field. Relationship Name Training Relationship Type Lookup Refers To LearningContent | | TrainingType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of training. Possible values are: - T—Trailhead | ## Usage In version 54.0 and later releases, Workforce Engagement uses this object instead of the AgentTraining object to route learning modules to agents. If you set up agent engagement in your org in an earlier release, we rename AgentTraining records as PersonTraining records. # PicklistValueInfo Represents the active picklist values for a given picklist field. This object is available in API version 40.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the field. | | EntityParticleId | Type string Properties Filter, Group, Nillable, Sort Description Represents the picklist field to which this value is related. Relationship Name EntityParticle Relationship Type Lookup Refers To EntityParticle | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the picklist value is active or not. | | IsDefaultValue | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this value is the default for the picklist field. Only one value can be the default value. | | Label | Type string Properties Filter, Group, Nillable, Sort Description The label for the picklist value. | | ValidFor | Type string Properties Filter, Group, Nillable, Sort Description A set of bits where each bit indicates a controlling value for which this picklist value is valid. | | Value | Type string Properties Filter, Group, Nillable, Sort Description The API name of the picklist value. | # PickTicket A PickTicket represents quantities of one or more products to be picked for fulfillment at a location. It can include products belonging to one or more fulfillment orders. This object is available in API version 57.0 and later. A PickTicket is associated with one or more PickTicketAssignments and one or more PickTicketProducts. Each PickTicketAssignment represents the relationship between the PickTicket and a FulfillmentOrder. Each PickTicketProduct represents the quantity of a product to be picked as part of the PickTicket. If multiple FulfillmentOrders associated with the PickTicket include the same product, one PickTicketProduct can represent the total quantity of that product to be picked for all of those FulfillmentOrders. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available with an Order Management Growth license. ## Fields | Field | Details | | --- | --- | | AssignedToId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user assigned to pick the items associated with the PickTicket. This field is a relationship field. Relationship Name AssignedTo Relationship Type Lookup Refers To User | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed data in this record, a record related to this record, or a list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user accessed data in this record or list view but didn't view it directly. | | LocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location fulfilling the items to be picked. This field is a relationship field. Relationship Name Location Relationship Type Lookup Refers To Location | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the PickTicket record. By default, the asset owner is the user who created the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PickTicketNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the PickTicket. | | Status | Type picklist Properties Create, Filter, Group, Printed, Sort, Update Description Status of the PickTicket. Each status corresponds to one status category, shown here in parentheses. You can customize the status picklist to represent your business processes, but the status category picklist is fixed because processing is based on those values. If you customize the status picklist, include at least one status value for each status category. Default values are: - Assigned (Active) - Canceled (Canceled) - Completed (Completed) - Created (Active) - Draft (Draft) - Picked (Active) - Picking (Active) | | StatusCategory | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Status category of the PickTicket. Processing of the PickTicket depends on this value. Each status category corresponds to one or more status values. Possible values are: - ACTIVE - CANCELED - COMPLETED - DRAFT The default value is DRAFT. | ## 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. [PickTicketFeed](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. [PickTicketShare](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. #### See Also - [PickTicketAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pickticketassignment.htm "Represents the association of a FulfillmentOrder with a PickTicket. A PickTicket has one PickTicketAssignment for each FulfillmentOrder containing products to be picked as part of that PickTicket. This object is available in API version 57.0 and later.") - [PickTicketProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pickticketproduct.htm "Represents a quantity of a product to be picked as part of a PickTicket. It can include quantities for multiple FulfillmentOrders. This object is available in API version 57.0 and later.") # PickTicketAssignment Represents the association of a FulfillmentOrder with a PickTicket. A PickTicket has one PickTicketAssignment for each FulfillmentOrder containing products to be picked as part of that PickTicket. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available with an Order Management Growth license. ## Fields | Field | Details | | --- | --- | | AttachedToId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the FulfillmentOrder to associate with a PickTicket. This field is a relationship field. Relationship Name AttachedTo Relationship Type Lookup Refers To FulfillmentOrder | | PickTicketAssignmentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the PickTicketAssignment. | | PickTicketId | Type reference Properties Create, Filter, Group, Sort Description ID of the PickTicket to associate with a FulfillmentOrder. This field is a relationship field. Relationship Name PickTicket Relationship Type Lookup Refers To PickTicket | #### See Also - [PickTicket](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pickticket.htm "A PickTicket represents quantities of one or more products to be picked for fulfillment at a location. It can include products belonging to one or more fulfillment orders. This object is available in API version 57.0 and later.") - [FulfillmentOrder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorder.htm "Represents a group of products, fees, and delivery charges on a single order that share the same fulfillment location, delivery method, and recipient. The FulfillmentOrderLineItems belonging to a FulfillmentOrder are associated with OrderItemSummary objects belonging to a single OrderSummary. This object is available in API version 48.0 and later.") - [PickTicketProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pickticketproduct.htm "Represents a quantity of a product to be picked as part of a PickTicket. It can include quantities for multiple FulfillmentOrders. This object is available in API version 57.0 and later.") # PickTicketProduct Represents a quantity of a product to be picked as part of a PickTicket. It can include quantities for multiple FulfillmentOrders. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available with an Order Management Growth license. ## Fields | Field | Details | | --- | --- | | PickTicketId | Type reference Properties Create, Filter, Group, Sort Description ID of the PickTicket associated with the PickTicketProduct. This field is a relationship field. Relationship Name PickTicket Relationship Type Lookup Refers To PickTicket | | PickTicketProductNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the PickTicketProduct. | | PickedQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description Quantity of the PickTicketProduct that has been picked. | | Product2Id | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the product associated with the PickTicketProduct. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductCode | Type string Properties Filter, Group, Nillable, Sort Description Product code of the product associated with the PickTicketProduct. | | Quantity | Type double Properties Create, Filter, Sort, Update Description Total quantity that’s requested to be picked of the associated product. | | RejectReason | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The reason why some or all of the requested quantity isn’t being picked. Possible values are: - Defected - Other - Out of stock | | RejectedQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description The requested quantity that hasn’t been picked. When the status category of the associated PickTicket is set to Completed, this value is automatically calculated as Quantity - PickedQuantity. | | StockKeepingUnit | Type string Properties Filter, Group, Nillable, Sort Description The stock keeping unit (SKU) of the associated product. | ## 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. [PickTicketProductFeed](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. #### See Also - [PickTicket](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pickticket.htm "A PickTicket represents quantities of one or more products to be picked for fulfillment at a location. It can include products belonging to one or more fulfillment orders. This object is available in API version 57.0 and later.") - [PickTicketAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pickticketassignment.htm "Represents the association of a FulfillmentOrder with a PickTicket. A PickTicket has one PickTicketAssignment for each FulfillmentOrder containing products to be picked as part of that PickTicket. This object is available in API version 57.0 and later.") - [Product2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_product2.htm "Represents a product that your company sells.") # PipelineInspectionListView Represents a pipeline view, an intelligence view, or a saved filter. A pipeline view shows a set of opportunity records, based on specific criteria. An intelligence view shows a set of account, lead, or contact records, based on specific criteria. This object is available in API version 53.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, enable the Pipeline Inspection user permission and the Pipeline Inspection setting. To create and modify list views, users must have the Create and Customize List Views permission. To create and modify public list views, users must have the Manage Public List Views permission. ## Fields
Field Details
ChangePeriodLiteralType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The date literal associated with the pipeline changes metrics group, used for filtering by a custom time period.
Possible values are:
  • CUSTOM_DATE
  • FOUR_WEEKS_AGO
  • ONE_MONTH_AGO
  • ONE_WEEK_AGO
  • START_OF_THE_PERIOD
  • THIS_MONTH
  • THIS_WEEK
  • THREE_MONTHS_AGO
  • THREE_WEEKS_AGO
  • TWO_MONTHS_AGO
  • TWO_WEEKS_AGO
ChangePeriodStartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The start date used when filtering by a custom time period for pipeline changes metrics and forecast category metrics groups.
DateLiteralType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The date literal associated with the pipeline and intelligence views, used for filtering by the close date, created date, or activity date.
Possible values are:
Accounts Contacts & Leads Opportunities
ALL_TIME Checkmark icon Checkmark icon * * Checkmark icon * *
CUSTOM_DATE Checkmark icon Checkmark icon Checkmark icon
DATE_NONE * Checkmark icon
LAST_180_DAYS * Checkmark icon
LAST_365_DAYS * Checkmark icon
LAST_90_DAYS * Checkmark icon
LAST_MONTH Checkmark icon
NEXT_FISCAL_QUARTER Checkmark icon
NEXT_MONTH Checkmark icon
NEXT_WEEK Checkmark icon
THIS_FISCAL_QUARTER Checkmark icon Checkmark icon
THIS_MONTH Checkmark icon Checkmark icon
THIS_WEEK Checkmark icon Checkmark icon
* Available in API version 60.0 and later.
** Available on the "My Important" list views.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The end date used when filtering by a custom time period for close dates.
IsSystemManaged
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the system is managing changes to visibility and deletion of a pipeline view (true) or not (false).
The default value is false.
ListViewId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the associated ListView record. This field is unique within your organization.
This is a relationship field.
Relationship Name
ListView
Relationship Type
Lookup
Refers To
ListView
MarketSegments
Type
textarea
Properties
Create, Nillable, Update
Description
The customer segments selected in the Prospecting Center view.
This field is available in API version 61.0 and later.
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The start date used when filtering by a custom time period for close dates.
SummaryField
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The opportunity field specified in a pipeline view to summarize pipeline inspection metrics.
Possible values are standard field names or custom field IDs for custom currency and number fields.
  • Amount
  • ExpectedRevenue
  • TotalOpportunityQuantity
  • custom_field_ID

This field is available in API version 56.0 and later.
UserId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the user whose records you want to see by default in the list view. This field is a relationship field.
This field is available in API version 58.0 and later.
Relationship Name
User
Relationship Type
Lookup
Refers To
User
ViewType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The corresponding API name for the pipeline or intelligence view type.
Possible values are:
  • MY_ACCOUNTS–Available in API version 60.0 and later.
  • MY_AGENTFORCE_SDR_CONTACTS–Available in API version 64.0 and later.
  • MY_AGENTFORCE_SDR_LEADS–Available in API version 63.0 and later.
  • MY_CONTACTS
  • MY_IMPORTANT_ACCOUNTS–Available in API version 60.0 and later.
  • MY_IMPORTANT_CONTACTS
  • MY_IMPORTANT_LEADS
  • MY_IMPORTANT_OPPORTUNITIES
  • MY_LEADS
  • MY_PIPELINE
  • MY_PROSPECTING_CENTER_ACCOUNTS–Available in API version 61.0 and later.
## Usage Use this object to retrieve the metadata for a pipeline inspection view. # PipelineInspectionSumField Use this object to learn which field from the opportunity object is used to aggregate Pipeline Inspection metrics on a pipeline view. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To use PipelineInspectionSumField, enable Pipeline Inspection. Users with a Pipeline Inspection user permission, the Customize Application permission or the Modify All Data permission can access this object. To create and modify records, users must have either the Customize Application permission or the Modify All Data permission. ## Fields | Field | Details | | --- | --- | | SobjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The object that stores the summary fields. Possible values are: - Opportunity | | SummaryField | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The field used to summarize Pipeline Inspection metrics. Possible values are standard field names or custom field IDs for custom currency and number fields. - Amount - ExpectedRevenue - TotalOpportunityQuantity - custom\_field\_ID | # PipelineInspMetricConfig Represents the configuration of a forecast category metric that appears in the Pipeline Inspection view. This object is available in API version 55.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Read only. The unique name of a Pipeline Inspection metric configuration in the API. | | IsCumulative | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read only. Whether the metric is cumulative. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Read only. The language of the Pipeline Inspection metric. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Customized label of the Pipeline Inspection metric. Limit: 50 characters. | | Metric | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The Pipeline Inspection metric. Possible values are: - BestCase - ClosedLost - ClosedWon - Commit - MostLikely - OpenPipeline - TotalPipeline | # PipelineInspMetricConfigLocalization Represents the translated label of a Pipeline Inspection metric. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language of the Pipeline Inspection metric. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix of the Pipeline Inspection metric language. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related Pipeline Inspection metric. This field is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To PipelineInspMetricConfig | | Value | Type textarea Properties Create, Filter, Sort, Update Description The value of the Pipeline Inspection metric. | # Platform Encryption Event Type Platform Encryption event contains information about tenant secret and derived encryption key usage. This event type is available in API versions 41.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
ACTION
Type
String
Description
The name and type of the event.
Possible Values
  • TS Imported: A tenant secret generated by the Shield Key Management Service (KMS), or customer-supplied key material, imported by a customer.
  • TS Generated: A tenant secret generated by the Shield Key Management Service (KMS).
  • Key Derived: An encryption key derived from a tenant secret for encryption or decryption.
  • TS Wrapped: A tenant secret generated by the Shield Key Management Service (KMS), or customer-supplied key material, encrypted for storage.
  • Key Delivered: A data encryption key delivered for encryption or decryption.
  • TS Stored: A tenant secret generated by the Shield Key Management Service (KMS), or customer-supplied key material, stored encrypted in the database.
  • TS Read: An encrypted tenant secret generated by the Shield Key Management Service (KMS), or encrypted customer-supplied key material, that is loaded for encryption or decryption.
  • TS Unwrapped: An encrypted tenant secret generated by the Shield Key Management Service (KMS), or encrypted customer-supplied key material, unwrapped for use by the KMS.
  • TS Exported: An encrypted tenant secret exported by a customer.
  • TS Destroyed: A tenant secret and related data encryption key destroyed by a customer.
BOT_IDENTIFIER
Type
String
Description
The ID of the bot.
BOT_SESSION_IDENTIFIER
Type
String
Description
The bot session ID.
CLIENT_IP
Type
String
Description
The IP address of the client that is using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
EVENT_TYPE
Type
String
Description
The type of event. The value is always PlatformEncryption.
KEY_ID
Type
String
Description
The 15-character ID of the tenant secret.
Example
02GD000000096Cb
KEY_ID_DERIVED
Type
String
Description
The 18-character ID of the derived encryption key.
Example
02GD000000096CbMAI
KEY_TYPE
Type
String
Description
The type of tenant secret.
Possible Values
  • Data
  • DeterministicData
  • Analytics
  • OauthSecret (internal use only)
  • SearchIndex
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
METHOD
Type
String
Description
The string that identifies a change in tenant secret Active state. For example, tenant secrets become active when they’re created, and are made inactive when they’re exported.
Examples
  • TS Exported: User ID
  • TS Generated: HSM or BYOK
  • TS Unwrapped: Tenant Secret or BYOK
ORGANIZATION_ID
Type
ID
Description
The 15-character ID of the organization.
For example: 00D000000000123.
PLANNER_IDENTIFIER
Type
String
Description
The ID of the agent planner.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
ID
Description
The 18-character case insensitive ID of the user who is using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the user who is using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # PlatformAction PlatformAction is a virtual read-only object. It enables you to query for actions displayed in the UI, given a user, a context, device format, and a record ID. Examples include standard and custom buttons, quick actions, and productivity actions. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | ActionListContext | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Required. The list context this action applies to. Valid values are: - Assistant - BannerPhoto - Chatter - Dockable - FeedElement - Flexipage - Global - ListView - ListViewDefinition - ListViewRecord - Lookup - MruList - MruRow - ObjectHomeChart - Photo - Record - RecordEdit - RelatedList - RelatedListRecord | | ActionTarget | Type textarea Properties Nillable Description The URL to invoke or describe the action when the action is invoked. If the action is a standard button overridden by a Visualforce page, the ActionTarget returns the URL of the Visualforce page, such as /apex/pagename. This field is available in API version 35.0 and later. | | ActionTargetType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the target when this action is triggered. Valid values are: - Describe—applies to actions with a user interface, such as quick actions - Invoke—applies to actions with no user interface, such as action links or invocable actions - Visualforce—applies to standard buttons overridden by a Visualforce page | | ActionTargetUrl | Type string Properties Filter, Group, Nillable, Sort Description URL to invoke or describe the action when the action is invoked. This field is deprecated in API version 35.0 and later. Use ActionTarget instead. | | Category | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Applies only to action links. Denotes whether the action link shows up in the feed item list of actions or the overflow list of actions. Valid values are: - Primary - Overflow | | ConfirmationMessage | Type string Properties Filter, Group, Nillable, Sort Description Applies only to action links. The message to display before the action is invoked. Field is null if no confirmation is required before invoking the action. | | DeviceFormat | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies which action icon the PlatformAction query returns. If this field isn’t specified, it defaults to Phone. Valid values are: - Aloha - Desktop - Phone - Tablet | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description The unique ID for the PlatformAction. If the action doesn’t have an ID, its API name is used. | | GroupId | Type reference Properties Filter, Group, Nillable, Sort Description The unique ID of a group of action links. | | IconContentType | Type string Properties Filter, Group, Nillable, Sort Description The content type—such as .jpg, .gif, or .png—of the icon for this action. Applies to both custom and standard icons assigned to actions. | | IconHeight | Type int Properties Filter, Group, Nillable, Sort Description The height of the icon for this action. Applies only to standard icons. | | IconUrl | Type url Properties Filter, Group, Nillable, Sort Description The URL of the icon for this action. | | IconWidth | Type int Properties Filter, Group, Nillable, Sort Description The width of the icon for this action. Applies only to standard icons. | | InvocationStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the action within the feed item. Applies to action links only. Valid values are: - Failed - New - Pending - Successful | | InvokedByUserId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who most recently invoked this action within the current feed item. Applies to action links only. This is a relationship field. Relationship Name InvokedByUser Relationship Type Lookup Refers To User | | IsGroupDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Denotes whether this action is the default in an action link group. False for other action types. Applies to action links only. | | IsMassAction | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the action can be performed on multiple records. This field is available in API version 38.0 and later. | | Label | Type string Properties Filter, Group, Sort Description The label to display for this action. | | PrimaryColor | Type string Properties Filter, Group, Nillable, Sort Description The primary color of the icon for this action. | | RelatedListRecordId | Type string Properties Filter, Group, Nillable, Sort Description Represents the ID of a record in an object’s related list. This field is available in API version 38.0 and later. | | RelatedSourceEntity | Type string Properties Filter, Group, Nillable, Sort Description When the ActionListContext is RelatedList or RelatedListRecord, this field represents the API name of the related list to which the action belongs. | | Section | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The section of the user interface the action resides in. Applicable only to Lightning Experience. Valid values are: - ActivityComposer - CollaborateComposer - NotesComposer - Page - SingleActionLinks This field is available in API version 35.0 and later. | | SourceEntity | Type string Properties Filter, Group, Sort Description Required. The object or record with which this action is associated. | | Subtype | Type string Properties Filter, Group, Nillable, Sort Description The subtype of the action. For quick actions, the subtype is QuickActionType. For custom buttons, the subtype is WebLinkTypeEnum. For action links, subtypes are Api, ApiAsync, Download, and Ui. Standard buttons and productivity actions have no subtype. | | TargetObject | Type string Properties Filter, Group, Nillable, Sort Description The type of object record the action creates, such as a contact or opportunity. This field is available in API version 41.0 and later. | | TargetUrl | Type string Properties Filter, Nillable, Sort Description The URL that a custom button or link points to. This field is available in API version 41.0 and later. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of the action. Valid values are: - ActionLink—An indicator on a feed element that targets an API, a web page, or a file, represented by a button in the Salesforce Chatter feed UI. - CustomButton—When clicked, opens a URL or a Visualforce page in a window or executes JavaScript. - InvocableAction - ProductivityAction—Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions. - QuickAction—A global or object-specific action. - StandardButton—A predefined Salesforce button such as New, Edit, and Delete. | ## Usage PlatformAction can be described using describeSObject(). You can directly query for PlatformAction. For example, this query returns all fields for actions associated with each of the records of the listed objects: SELECT ExternalId, ActionTargetType, ActionTargetUrl, ApiName, Category, ConfirmationMessage, ExternalId, GroupId, UiTheme, IconUrl, IconContentType, IconHeight, IconWidth, PrimaryColor, InvocationStatus, InvokedByUserId, IsGroupDefault, Label, LastModifiedDate, Subtype, SourceEntity, Type FROM PlatformAction WHERE SourceEntity IN ('001xx000003DGsH', '001xx000003DHBq', ‘Task’) AND ActionListContext = ‘Record’; ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To query PlatformAction, provide the ActionListContext and SourceEntity. If you query for ActionListContext with a value of RelatedList, and don't specify a RelatedSourceEntity, the query returns the API name of the related list. In API v43.0 and before, SourceEntity = 'Object API Name' and ActionListContext = 'ListView' is an invalid combination to fetch quick actions in a SOQL query. Use SourceEntity = 'Object ID' and ActionListContext = 'ListView' instead. This query uses multiple ActionListContext values in its WHERE clause to return all actions in the Lightning Experience user interface (DeviceFormat = 'Desktop') for the specified object: SELECT ActionListContext, Label, Type, Subtype, Section, SourceEntity, RelatedSourceEntity, ActionTarget, ActionTargetType, ApiName, Category, ConfirmationMessage, DeviceFormat, ExternalId, GroupId, IconContentType, IconHeight, IconUrl, IconWidth, Id, InvocationStatus, InvokedByUserId, IsGroupDefault, LastModifiedDate, PrimaryColor FROM PlatformAction WHERE ActionListContext IN ('Record','Chatter','RelatedList') AND SourceEntity = '001xx000003DlvX' AND DeviceFormat = 'Desktop' # PlatformEventUsageMetric Contains usage data for event publishing and delivery to CometD and Pub/Sub API clients, empApi Lightning components, and event relays. If Enhanced Usage Metrics isn't enabled, usage data is available for the last 24 hours, ending at the last hour, and for historical daily usage. In API 58.0 and later, you can enable Enhanced Usage Metrics to get usage data by event name and client for granular time intervals. PlatformEventUsageMetric contains separate usage metrics for platform events and change data capture events. This object is available in API version 50.0 and later. ## Supported Calls describeSObjects(), query() ## Fields
Field Details
Client
Type
string
Properties
Filter, Group, Nillable, Sort
Description
This field is available only when Enhanced Usage Metrics is enabled. The ID of the client. The Client field is populated with one of the following values.
The Client field can be one of these values.
  • For a Streaming API (CometD) client and the empApi Lightning component, the client value is the ID of the CometD session.
  • For a Pub/Sub API client, the client value is PUB_SUB_API.
  • For an event relay, the client value is EVENT_RELAY.
  • For the publish usage of Change Data Capture events, the client value is SYSTEM.
  • For publish usages using REST API, the client value is REST_API.
  • For publish usages using Flow, the client value is FLOW.
  • For publish usages using SOAP API, the client value is SOAP_API.
  • For publish usages using Bulk API, the client value is BULK_API.
  • For Apex, the publish usage client value is APEX and the delivery usage client value is the Apex Trigger ID starting with 01q.
EndDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The end date and time in UTC used for querying usage metrics. The date granularity is hourly.
To get usage data for the last 24 hours, the end date is the current date in UTC. The time is the current time in UTC rounded down to the previous hour. For example, 11:23 is 11:00 and the date format is: 2020-08-04T11:00:00.000Z
To get historical data, the end date in UTC is the end of the date range with hours specified as 0. For example: 2020-08-04T00:00:00.000Z. To query a date range, you can use the < or <= operators.
For the date format to use, see Date Formats and Date Literals in the SOQL and SOSL Reference.
EventName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
This field is available only when Enhanced Usage Metrics is enabled. The API name of a custom platform event or a change event.
  • Custom platform event with the label My Event: My_Event__e
  • Change event example: AccountChangeEvent
When you query usage metrics for EventName, specify the UsageType field in the SELECT or WHERE clause.
EventType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
This field is available when Enhanced Usage Metrics is enabled. The type of event you would like to query usage metrics for, such as a change event or a custom platform event.
Possible values are:
  • CHANGE_EVENT—A Change Data Capture event.
  • CUSTOM_PLATFORM_EVENT—A platform event that an admin defined in your Salesforce org.
When you query usage metrics for EventType, specify the UsageType field in the SELECT or WHERE clause.
ExternalId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
This field is not in use.
Name
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The name of the metric to get usage for.
Possible values are:
  • CHANGE_EVENTS_DELIVERED—Number of change data capture events delivered to CometD and Pub/Sub API clients, empApi Lightning components, and event relays
  • CHANGE_EVENTS_PUBLISHED—Number of change data capture events published
  • PLATFORM_EVENTS_DELIVERED—Number of platform events delivered to CometD and Pub/Sub API clients, empApi Lightning components, and event relays
  • PLATFORM_EVENTS_PUBLISHED—Number of platform events published
StartDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The start date and time in UTC used for querying usage metrics. The date granularity is hourly.
To get usage data for the last 24 hours, the start date is the previous day in UTC. The time is the current time in UTC rounded down to the previous hour. For example, 11:23 is 11:00 and the date format is: 2020-08-03T11:00:00.000Z
To get historical data, the start date is the start of the date range with hours specified as 0. For example: 2020-08-03T00:00:00.000Z. To specify a date range, you can use the > or >= operators.
If Enhanced Usage Metrics is enabled, keep in mind these tips.
  • Make sure the time span between StartDate and EndDate is valid for the TimeSegment value chosen.
  • The maximum date range that you can specify between StartDate and EndDate is 60 days.
For the date format to use, see Date Formats and Date Literals in the SOQL and SOSL Reference.
TimeSegment
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
This field is available when Enhanced Usage Metrics is enabled.  The time interval used for aggregating usage data returned in the query results. Valid TimeSegment values depend on the time range specified with StartDate and EndDate.
Possible values are:
Daily Usage data is aggregated for each day within the specified time range. Valid only if the time range specified with StartDate and EndDate in the query is at least 24 hours.
Hourly Usage data is aggregated for each hour within the specified time range. Valid only if the time range specified with StartDate and EndDate in the query is between one hour and 24 hours.
FifteenMinutes Usage data is aggregated for each 15-minute period within the specified time range. Valid only if the time range specified with StartDate and EndDate in the query is between 15 minutes and one hour.
UsageType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
This field is available when Enhanced Usage Metrics is enabled. The type of event usage metrics to query for, such as event publishing or event delivery. Use this field with the EventName or EventType fields.
Possible values are:
  • PUBLISH—Usage metrics for published events.
  • DELIVERY—Usage metrics for events that were delivered to subscribers.
Value
Type
long
Properties
Filter, Group, Nillable, Sort
Description
The usage value for the specified metric and date range.
## Usage For more information, see [Monitor Platform Event Publishing and Delivery Usage](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_monitor_usage.htm "HTML (New Window)") in the Platform Events Developer Guide. # PlatformStatusAlertEvent The documentation has moved to [PlatformStatusAlertEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_platformstatusalertevent.htm "HTML (New Window)") in the Platform Events Developer Guide. # PortalDelegablePermissionSet PortalDelegablePermissionSet is a base platform object used to store permission sets that can be assigned by a delegated portal/external user admin (DPUA) to portal users. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. The unique string used to identify the record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language used in the org. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Required. The unique string to identify the record. | | PermissionSetId | Type reference Properties Create, Filter, Group, Sort, Update Description The unique ID of the permission set the DPUA profile can assign to other portal users. | | ProfileId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the DPUA profile. | # PplnInspListViewCalcClmn Represents a column configuration for a pipeline inspection list view. Determines which calculated columns appear in a pipeline or intelligence view and their display order. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, enable the Pipeline Inspection user permission and the Pipeline Inspection setting. ## Fields | Field | Details | | --- | --- | | ColumnName | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of calculated column to display in the pipeline or intelligence view. Possible values are: - ActivityHeatmap–Activity metrics for the record. - AgentActivity–Agentforce activity associated with the record. - Contacts–Contacts associated with the record. - CriticalInsights–Alerts and critical insights for the record. - NextOpportunityDate–Next close date for an associated opportunity. - OpenOpportunityValue–Total value of open opportunities associated with the record. - SalesMethodology–Sales methodology progress for the record. | | ColumnWidth | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The width of the column in pixels. If null, the default column width is used. | | PipelineInspectionListViewId | Type reference Properties Create, Filter, Group, Sort Description The ID of the pipeline inspection list view that this calculated column belongs to. This is a relationship field. Relationship Name PipelineInspectionListView Relationship Type Lookup Refers To PipelineInspectionListView | | SortOrder | Type int Properties Create, Filter, Group, Sort, Update Description The position of the calculated column in the list view. Determines the display order of columns from left to right. | ## Usage Use this object to configure which calculated columns appear in a pipeline inspection list view and in what order. Each record represents one column in a specific view. Query this object to retrieve the column configuration for a given PipelineInspectionListView record. # PresenceConfigDeclineReason Represents the settings for a decline reason that a presence user provides when declining work. This object is available in API version 37.0 and later. ## Supported Calls create(), delete(), describeSObjects(), update(), query(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | PresenceDeclineReasonId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the [PresenceDeclineReason](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_presencedeclinereason.htm#sforce_api_objects_presencedeclinereason "Represents an Omni-Channel decline reason that agents can select when declining work requests. This object is available in API version 37.0 and later.") record. | | PresenceUserConfigId | Type reference Properties Create, Filter, Group, Sort Description The ID of the [PresenceUserConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_presenceuserconfig.htm#sforce_api_objects_presenceuserconfig "Represents a configuration that determines a presence user’s settings. This object is available in API version 32.0 and later.") record where the decline reasons are added. | # PresenceDeclineReason Represents an Omni-Channel decline reason that agents can select when declining work requests. This object is available in API version 37.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls create(), delete(), describeSObjects(), update(), query(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the [PresenceDeclineReason](#sforce_api_objects_presencedeclinereason "Represents an Omni-Channel decline reason that agents can select when declining work requests. This object is available in API version 37.0 and later."). | | MasterLabel | Type string Properties Create, Filter, Group, Sort Description The label for the [PresenceDeclineReason](#sforce_api_objects_presencedeclinereason "Represents an Omni-Channel decline reason that agents can select when declining work requests. This object is available in API version 37.0 and later."). | # PresenceUserConfig Represents a configuration that determines a presence user’s settings. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeSObjects(), update(), query(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | AcwExtensionDuration | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum length of time, measured in seconds, an agent can spend on After Conversation Work (ACW) each time they extend the timer. You must set this field if HasAcwExtensionEnabled is set to true. Specify a value from 10 through 3600. This field is available in API version 56.0 and later. | | AfterConvoWorkMaxTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum length of time, measured in seconds, an agent has to complete After Conversation Work (ACW). You must set this field if HasAfterConvoWorkTimer is set to true. Specify a value from 10 through 3600. This field is available in API version 56.0 and later. | | Capacity | Type int Properties Create, Filter, Group, Sort Description The maximum number of work units an agent can be assigned at one time. | | | | | CustomSoundId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Relationship Name CustomSound Relationship Type Lookup Refers To StaticResource Description The ID of the static resource for the custom sound selected to play for the PresenceUserConfig object. | | | | | DeveloperName | Type string Properties Create, Filter, Group, Sort 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | HasAcwExtensionEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If set to true, agents can extend their After Conversation Work (ACW) time. Available only if HasAfterConvoWorkTimer is set to true. If set to true, you must also set the AcwExtensionDuration and MaxExtensions fields. The default value is true. This field is available in API version 56.0 and later. | | HasAfterConvoWorkTimer | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If set to true, After Conversation Work (ACW) time can be configured for the channel. If set to true, you must also set the AfterConvoWorkMaxTime field. The default value is false. This field is available in API version 56.0 and later. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the presence configuration. | | MasterLabel | Type string Properties Create, Filter, Group, Sort Description The label of the presence configuration. | | MaxExtensions | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The maximum number of times an agent can extend their After Work Conversation (ACW) time. Specify a value from 1 through 10. You must set this field if HasAcwExtensionEnabled is set to true. This field is available in API version 56.0 and later. | | OptionsIsAllowAnyDestinationQueueForTransferEnabled | Type boolean Properties Create, Filter, Update Description Indicates that a rep can transfer a message from an enhanced Messaging channel to any queue (true) or only the selected queues (false). This field is available in API version 61.0 and later. | | OptionsIsAllowAnyDestinationFlowForTransferEnabled | Type boolean Properties Create, Filter, Update Description Indicates that a rep can transfer a message from an enhanced Messaging channel to any flow (true) or only the selected flows (false). This field is available in API version 61.0 and later. | | OptionsIsAllowAnyDestinationProfileForTransferEnabled | Type boolean Properties Create, Filter, Update Description Indicates that a rep can transfer a message from an enhanced Messaging channel to any profile (true) or only the selected profiles (false). This field is available in API version 61.0 and later. | | OptionsIsAutoAcceptEnabled | Type boolean Properties Create, Filter Description Indicates whether work items that are routed to agents are automatically accepted (true) or not (false). Available only if OptionsIsDeclineEnabled is set to false. | | OptionsIsDeclineEnabled | Type boolean Properties Create, Filter Description Indicates whether agents can decline work items that are routed to them (true) or not (false). Available only if OptionsIsAutoAcceptEnabled is set to false. | | OptionsIsDeclineReasonEnabled | Type boolean Properties Create, Filter Description Indicates whether agents can select a reason for declining work requests (true) or not (false). This can be selected only if decline reasons are enabled. | | OptionsIsDisconnectSoundEnabled | Type boolean Properties Create, Filter Description Indicates whether a sound is played when agents are disconnected from Omni-Channel (true) or not (false). | | OptionsIsRequestSoundEnabled | Type boolean Properties Create, Filter Description Indicates whether a sound plays with incoming work requests (true) or not (false). Set to true by default. | | PresenceStatusOnDeclineId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the presence status that’s automatically assigned to the agent when the agent declines a work item. Available only if OptionsIsDeclineEnabled is set to true. | | PresenceStatusOnPushTimeoutId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the presence status that’s automatically assigned to the agent when the agent doesn’t respond to a work item before push timeout occurs. Available in API version 36.0 and later. | | SoundLength | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The length of time that a sound plays when new work is assigned to an agent. | # PresenceUserConfigProfile Represents a configuration that determines the settings that are assigned to presence users who are assigned to a specific profile. User-level configurations override profile-level configurations. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), query(), update(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | PresenceUserConfigId | Type reference Properties Create, Filter, Group, Sort Description If an individual user is also assigned a presence configuration through the PresenceUserConfigProfile, this configuration will override that. | | ProfileId | Type reference Properties Create, Filter, Group, Sort Description The ID of the profile that’s associated with this presence configuration. A profile can be associated with only one presence configuration. | # PresenceUserConfigUser Represents a configuration that determines the settings that are assigned to a presence user. These user-level configurations override profile-level configurations. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), query(), update(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | PresenceUserConfigId | Type reference Properties Create, Filter, Group, Sort Description The ID of the presence configuration. | | UserId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user who’s associated with this presence configuration. A user can be associated with only one presence configuration. | # PriceAdjustmentGroup Defines the business logic for a top-level price adjustment, for example, a discount applied to an entire order. This object interface is available in API version 55.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules This object interface is available with Subscription Management or B2B Commerce. ## Fields ### AdjustmentSource - **Type**: picklist - **Properties**: Filter, Restricted picklist, Sort - **Description**: Indicates the source of the adjustment. This field is available with B2B Commerce. - **Possible values**: - Discretionary—The adjustment is entered manually, for example, by a sales rep. - Promotion—The adjustment is part of a promotion. - Rule—Reserved for future use. - System—The adjustment is configured by the system data, for example, as part of a pricing rule or discount schedule. ### AdjustmentType - **Type**: picklist - **Properties**: Filter, Restricted picklist, Sort - **Description**: Indicates whether the adjustment is a percentage, an amount, or an override. - **Possible values**: - AdjustmentAmount—Reserved for future use. - AdjustmentPercentage - OverrideAmount ### AdjustmentValue - **Type**: double - **Properties**: Filter, Sort - **Description**: The value of the adjustment. To indicate a discount, use a negative number. ### Description - **Type**: textarea - **Properties**: Nillable - **Description**: User-entered description of the price adjustment group. Available in API versions 55.0 to 57.0. ### ImplementorType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The object that is implementing this entity interface, for example, a WebCartAdjustmentGroup object. ### PriceAdjustmentCauseId - **Type**: reference - **Properties**: Filter, Nillable, Sort - **Description**: The ID of the record that is the source of the adjustment. For example, if the price adjustment is due to a promotion, this field contains the ID of the promotion record. If the price adjustment is due to a price adjustment tier, this field contains the ID of the price adjustment tier record. This field is a relationship field. - **Relationship Name**: PriceAdjustmentCause - **Relationship Type**: Lookup - **Refers To**: PriceAdjCauseInterface ### Priority - **Type**: int - **Properties**: Filter, Nillable, Sort - **Description**: A positive integer indicating the order in which this price adjustment group is applied, relative to other price adjustment groups. A Priority of 1 indicates this price adjustment group is applied first. Price adjustments with a null priority are applied after price adjustments with a specified priority. If two or more price adjustments have a null priority, percentage adjustments are applied **before** amount adjustments. Applying a percentage adjustment before an amount adjustment results in a larger total adjustment. The value of Priority must be unique among price adjustment groups in the same sales transaction. ### SalesTransactionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the sales transaction that the price adjustment group belongs to. This field is a relationship field. - **Relationship Name**: SalesTransaction - **Relationship Type**: Lookup - **Refers To**: SalesTransaction ### TotalAmount - **Type**: currency - **Properties**: Filter, Sort - **Description**: The total amount of adjustments of all related price adjustment items, inclusive of quantity, prorated for the duration of the subscription. This field is a calculated field equal to the sum of the TotalAmount fields in the related price adjustment items. # PriceAdjustmentGroupShape Defines the business logic for a top-level price adjustment, for example, a discount applied to an entire order. This object is available in API version 57.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated()query(), retrieve() ## Special Access Rules This object is available with Subscription Management, B2B Commerce, or B2C Commerce. ## Fields | Field | Details | | --- | --- | | AdjustmentSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the source of the adjustment. This field is available with B2B Commerce. Possible values are: - Discretionary—The adjustment is entered manually, for example, by a sales rep. - Promotion—The adjustment is part of a promotion. - Rule—Reserved for future use. - System—The adjustment is configured by the system data, for example, as part of a pricing rule or discount schedule. | | AdjustmentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the adjustment is a percentage, an amount, or an override. Possible values are: - AdjustmentAmount—Reserved for future use. The adjustment value is a numerical amount. - AdjustmentPercentage— The adjustment value is a percentage. - OverrideAmount— The override value is a numerical amount. | | AdjustmentValue | Type double Properties Create, Filter, Nillable, Sort Description The value of the adjustment. To indicate a discount, use a negative number. | | Description | Type textarea Properties Create, Nillable Description User-entered description of the price adjustment group. Available in API versions 57.0. | | PriceAdjustmentCauseId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the record that is the source of the adjustment. For example, if the price adjustment is due to a promotion, this field contains the ID of the promotion record. If the price adjustment is due to a price adjustment tier, this field contains the ID of the price adjustment tier record. This field is a polymorphic relationship field. Relationship Name PriceAdjustmentCause Relationship Type Lookup Refers To PriceAdjustmentTier | | PriceAdjustmentGroupShapeName | Type string Properties Create, Filter, Group, idLookup, Sort Description Name of the price adjustment group shape. | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort Description A positive integer indicating the order in which this price adjustment group is applied, relative to other price adjustment groups. A Priority of 1 indicates this price adjustment group is applied first. Price adjustments with a null priority are applied after price adjustments with a specified priority. If two or more price adjustments have a null priority, percentage adjustments are applied **before** amount adjustments. Applying a percentage adjustment before an amount adjustment results in a larger total adjustment. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The value of Priority must be unique among price adjustment groups in the same sales transaction. | | SalesTransactionShapeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the sales transaction that the price adjustment group belongs to. This field is a relationship field. Relationship Name SalesTransactionShape Relationship Type Lookup Refers To SalesTransactionShape | | TotalAmount | Type currency Properties Create, Filter, Nillable, Sort Description The total amount of adjustments of all related price adjustment items, inclusive of quantity, prorated for the duration of the subscription. This field is a calculated field equal to the sum of the TotalAmount fields in the related price adjustment items. | # PriceAdjustmentItem Defines the business logic for an item-level price adjustment, for example, a discount on an order item. This object interface is available in API version 55.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules This object interface is available with Subscription Management or B2B Commerce. ## Fields ### AdjustmentAmountScope - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Used with AdjustmentValue to determine the amount of the adjustment. - **Possible values**: - Total—The adjustment applies to the line item's total and isn’t multiplied by the quantity, prorated for the duration of the subscription. For example, let's say a sales transaction item quantity is 10 and the TotalLineAmount is 1000. If the price adjustment item has an AdjustmentValue of \-10, an AdjustmentType of AdjustmentAmount, and an AdjustmentAmountScope of Total, the $10 discount is applied to the total line amount. The TotalAmount of the price adjustment item is $1000 + (-$10) = $990. - Unit—The adjustment is multiplied by the line item’s quantity. For example, let's say a sales transaction item quantity is 5 and the TotalLineAmount is 1000. If the price adjustment item has an AdjustmentValue of \-10, an AdjustmentType of AdjustmentAmount, and an AdjustmentAmountScope of Unit, the $10 discount is applied to each line amount. The TotalAmount of the price adjustment item is $1000 + (-$10 x 5) = $950. ### AdjustmentSource - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Indicates the source of the adjustment. - **Possible values**: - Discretionary—The adjustment is entered manually; for example, by a sales rep. - Promotion—The adjustment is a promotion. - Rule—Reserved for future use. - System—The adjustment is determined by the pricing configuration for the product; for example, as part of a discount schedule. ### AdjustmentType - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Indicates whether the adjustment is a percentage, an amount, or an override. - **Possible values**: - AdjustmentAmount - AdjustmentPercentage - OverrideAmount ### AdjustmentValue - **Type**: double - **Properties**: Filter, Sort - **Description**: The value of the adjustment. Used together with AdjustmentAmountScope to determine the amount of the adjustment. ### Description - **Type**: textarea - **Properties**: Nillable - **Description**: The user-entered description of the price adjustment item. Available in API version 55.0 to 57.0. ### ImplementorType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The object that is implementing this object interface, for example, a CartItemPriceAdjustment object. ### PriceAdjustmentCauseId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the record that caused the adjustment. For example, if the price adjustment is due to a promotion, this field contains the ID of the Promotion record. If the price adjustment is due to a price adjustment tier, this field contains the ID of the PriceAdjustmentTier record. This field is a relationship field. - **Relationship Name**: PriceAdjustmentCause - **Relationship Type**: Lookup - **Refers To**: PriceAdjCauseInterface ### PriceAdjustmentGroupId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: A reference to the object interface or object that summarizes the values from multiple price adjustment items. If the related entity is an object, the object must implement the PriceAdjustmentGroup object interface. - **Relationship Name**: PriceAdjustmentGroup - **Relationship Type**: Lookup - **Refers To**: PriceAdjustmentGroup ### Priority - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: A positive integer indicating the order in which this price adjustment item is applied, relative to other price adjustment items. A Priority of 1 indicates this price adjustment item is applied first. Price adjustments with a null priority are applied after price adjustments with a specified priority. If two or more price adjustments have a null priority, percentage adjustments are applied **before** amount adjustments. Applying a percentage adjustment before an amount adjustment results in a larger total adjustment. The value of Priority must be unique among price adjustment items related to the same price adjustment group. For example, you can’t have two price adjustment items with a priority of 1. For example, let’s say that two price adjustment items apply to the same item to be priced. The first price adjustment, Spring\_Promotion, defines a 10% discount and has Priority of 1. The second price adjustment, Early\_Renewal\_Discount, defines a $2,000 discount and has a Priority of 2. In this case, the Spring\_Promotion price adjustment is applied before the Early\_Renewal\_Discount price adjustment. ### SalesTransactionItemId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the sales transaction item that the price adjustment item applies to. This field is a relationship field. - **Relationship Name**: SalesTransactionItem - **Relationship Type**: Lookup - **Refers To**: SalesTransactionItem ### TotalAmount - **Type**: currency - **Properties**: Filter, Sort - **Description**: The total amount of the adjustment that applies to the item to be priced, inclusive of quantity, prorated for the duration of the subscription. For example, let’s say the price adjustment item has an AdjustmentAmountScope of Unit, an AdjustmentType of AdjustmentAmount, and an AdjustmentValue of \-10. This configuration indicates a $10 per-unit discount. If the subscription is priced for 12 months and the pricing term is 1, the PricingTermCount on the sales transaction item is 12. If the quantity is 5, the value of TotalAmount is 5 x 12 x -10 = -600 # PriceAdjustmentItemShape Defines the business logic for an item-level price adjustment, for example, a discount on an order item. This object is available in API version 57.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available with Subscription Management, B2B Commerce, or B2C Commerce. ## Fields | Field | Details | | --- | --- | | AdjustmentAmountScope | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Used with AdjustmentValue to determine the amount of the adjustment. Possible values are: - Total—The adjustment applies to the line item's total and isn’t multiplied by the quantity. For example, let's say a sales transaction item quantity is 10 and the TotalLineAmount is 1000. If the price adjustment item has an AdjustmentValue of \-10, an AdjustmentType of AdjustmentAmount, and an AdjustmentAmountScope of Total, the $10 discount is applied to the total line amount. The TotalAmount of the price adjustment item is $1000 + (-$10) = $990. - Unit—The adjustment is multiplied by the line item’s quantity. For example, let's say a sales transaction item quantity is 5 and the TotalLineAmount is 1000. If the price adjustment item has an AdjustmentValue of \-10, an AdjustmentType of AdjustmentAmount, and an AdjustmentAmountScope of Unit, the $10 discount is applied to each line amount. The TotalAmount of the price adjustment item is $1000 + (-$10 x 5) = $950. - UnproratedTotal—No adjustment is applied to the line items. | | AdjustmentSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the source of the adjustment. Possible values are: - Discretionary— The adjustment is entered manually; for example, by a sales rep. - Promotion— The adjustment is a promotion. - Rule— Reserved for future use. - System— The adjustment is determined by the pricing configuration for the product; for example, as part of a discount schedule. | | AdjustmentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the adjustment is a percentage, an amount, or an override. Possible values are: - AdjustmentAmount—The adjustment value is a numerical amount. - AdjustmentPercentage— The adjustment value is a percentage. - OverrideAmount— The override value is a numerical amount. | | AdjustmentValue | Type double Properties Create, Filter, Nillable, Sort Description The value of the adjustment. Used together with AdjustmentAmountScope to determine the amount of the adjustment. | | Description | Type textarea Properties Create, Nillable Description The user-entered description of the price adjustment item. Available in API version 57.0. | | PriceAdjustmentCauseId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the record that caused the adjustment. For example, if the price adjustment is due to a promotion, this field contains the ID of the Promotion record. If the price adjustment is due to a price adjustment tier, this field contains the ID of the PriceAdjustmentTier record. This field is a polymorphic relationship field. Relationship Name PriceAdjustmentCause Relationship Type Lookup Refers To PriceAdjustmentTier | | PriceAdjustmentGroupShapeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description A reference to the object interface or object that summarizes the values from multiple price adjustment items. If the related entity is an object, the object must implement the PriceAdjustmentGroupShape object. This field is a relationship field. Relationship Name PriceAdjustmentGroupShape Relationship Type Lookup Refers To PriceAdjustmentGroupShape | | PriceAdjustmentItemShapeName | Type string Properties Create, Filter, Group, idLookup, Sort Description The name of the price adjustment item shape. | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort Description A positive integer indicating the order in which this price adjustment item is applied, relative to other price adjustment items. A Priority of 1 indicates this price adjustment item is applied first. Price adjustments with a null priority are applied after price adjustments with a specified priority. If two or more price adjustments have a null priority, percentage adjustments are applied **before** amount adjustments. Applying a percentage adjustment before an amount adjustment results in a larger total adjustment. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The value of Priority must be unique among price adjustment items related to the same price adjustment group. For example, you can’t have two price adjustment items with a priority of 1. For example, let’s say that two price adjustment items apply to the same item to be priced. The first price adjustment, Spring\_Promotion, defines a 10% discount and has Priority of 1. The second price adjustment, Early\_Renewal\_Discount, defines a $2,000 discount and has a Priority of 2. In this case, the Spring\_Promotion price adjustment is applied before the Early\_Renewal\_Discount price adjustment. | | SalesTransactionItemShapeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the sales transaction shape item that the price adjustment item applies to. This field is a relationship field. Relationship Name SalesTransactionItemShape Relationship Type Lookup Refers To SalesTransactionItemShape | | TotalAmount | Type currency Properties Create, Filter, Nillable, Sort Description The total amount of the adjustment that applies to the item to be priced, inclusive of quantity, prorated for the duration of the subscription. For example, let’s say the price adjustment item has an AdjustmentAmountScope of Unit, an AdjustmentType of AdjustmentAmount, and an AdjustmentValue of \-10. This configuration indicates a $10 per-unit discount. If the subscription is priced for 12 months and the pricing term is 1, the PricingTermCount on the sales transaction item is 12. If the quantity is 5, the value of TotalAmount is 5 x 12 x -10 = -600 | # PriceAdjustmentSchedule Represents a series of discounts offered depending on your product's configuration, quantity, and when they’re purchased in combination with other products. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available when the B2B Commerce license is enabled or when Subscription Management is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The method for applying tiered pricing. Possible values are: - Range—All items receive the discount of the highest tier the quantity falls in. - Slab—Items receive the discount defined for the tier they fall in. The default value is Range. Term-based discounts can’t be of type Slab. This field is available in API version 51.0 and later. The Slab method functions in the same way as the Range method. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the price adjustment schedule. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the price adjustment schedule is active (true) or not (false). You can change this field’s value as often as necessary. Label is **Active**. The default value is False. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates whether the price adjustment schedule has been archived (true) or not (false). This field is read-only. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the price adjustment schedule. This field is read-only. Label is **Price Adjustment Schedule Name**. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The Salesforce ID of the sales representative who owns the price adjustment schedule. | | ScheduleType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates how the price adjustment is determined. This field is available when Subscription Management is enabled. This field is available in API version 55.0 and later. Possible values are: - Attribute—The characteristics or properties of a product determine the price adjustment. - Bundle—The price adjustment that is determined when you want to sell a group of products or services as a unit. - Custom—The price adjustment that can be customized for the user's needs. - Term—The length of the subscription determines the price adjustment. Available in API version 58.0 and later. - Volume—The quantity purchased determines the price adjustment. The default value is Volume. | ## Usage When you create a PriceAdjustmentSchedule, you associate PriceAdjustmentTiers with it. A PriceAdjustmentSchedule is inactive until at least one PriceAdjustmentTier is added to it. A PriceAdjustmentSchedule comprises all related PriceAdjustmentTiers, with a maximum limit of 25 PriceAdjustmentTiers for Subscription Management. To use PriceAdjustmentSchedule, associate it with a PriceBookEntry. - You can associate a PriceBookEntry with up to five PriceAdjustmentSchedules, but only one PriceAdjustmentSchedule can be associated with a PriceBookEntry. - When you activate or deactivate a PriceAdjustmentSchedule, its PriceBookEntry association is also activated or deactivated. - An adjustment to a PriceBookEntry is applied only if the associated PriceAdjustmentSchedule is active. - After a PriceAdjustmentSchedule is associated with a PriceBookEntry, if multicurrency is enabled, the currencyIsoCode field can’t be modified. - When you associate a PriceAdjustmentSchedule with a PricebookEntry, a junction object PricebookEntryAdjustment is created. You can modify the PriceAdjustmentTier object, and the ScheduleType and AdjustmentMethod fields, only when a PriceAdjustmentSchedule is inactive. ## Code Sample public void priceAdjustmentScheduleSample() {try /\* This code snippet will do the following: \* \* 1. Create a new Price Adjustment Schedule \* 2. Create and attach a Price Adjustment Tier to the Schedule \* 3. Activate the Schedule \* 4. Create a new PricebookEntry Adjustment. This will associate the Schedule to a Pricebook Entry. \*/ //Create a Price Adjustment Schedule PriceAdjustmentSchedule pas = new PriceAdjustmentSchedule(); pas.Name = 'Sample PAS'; pas.Description = 'Sample Price Adjustment Schedule'; pas.AdjustmentMethod = 'Range'; insert pas; //Attach a valid Price Adjustment Tier PriceAdjustmentTier pat = new PriceAdjustmentTier(); pat.PriceAdjustmentScheduleId = pas.Id; pat.LowerBound = 1.0; pat.UpperBound = 100.0; pat.TierType = 'AdjustmentPercentage'; pat.TierValue = 5.0; insert pat; //Activate the Schedule pas.IsActive = true; upsert pas; //Create a new PricebookEntry Adjustment PricebookEntryAdjustment pbea = new PricebookEntryAdjustment(); pbea.PricebookEntryId = '01uRM0000007Hb5YAE'; pbea.PriceAdjustmentScheduleId = pas.Id; insert pbea; } catch (ConnectionException ce) { ce.printStackTrace(); } } #### See Also - [PriceAdjustmentTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceadjustmenttier.htm "Represents a discount tier in a price adjustment schedule. This object is available in API version 47.0 and later.") - [PricebookEntryAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pricebookentryadjustment.htm "Read-only junction object created when you associate a price adjustment schedule with a price book entry. This object is available in API version 47.0 and later.") # PriceAdjustmentTier Represents a discount tier in a price adjustment schedule. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | LowerBound | Type double Properties Create, Filter, Sort, Update Description The minimum quantity the discount can be applied to. It must be a positive integer and less than or equal to the upper bound of the tier. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. | | PriceAdjustmentScheduleId | Type reference Properties Create, Filter, Group, Sort Description The ID of the price adjustment schedule that the discount is applied to. | | TierType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The unit of the discount. Possible values are: - AdjustmentAmount—An amount discounted from an item’s list price. Label is Amount. - AdjustmentPercentage—A percentage discounted from an item’s list price. Label is Percentage. - AdjustmentOverride—An override of an item’s list price. Label is Override. | | TierValue | Type double Properties Create, Filter, Sort, Update Description The value of the discount. | | UpperBound | Type double Properties Create, Filter, Nillable, Sort, Update Description The maximum quantity the discount can be applied to. The quantity must be a positive integer. Not inclusive. Set this value one digit higher than the quantity you want the tier to include. For example, if a tier’s upper bound is 99, set the value of UpperBound to 100. For the last tier, the value is optional. | ## Usage To use PriceAdjustmentTiers, associate them with a PriceAdjustmentSchedule. Tiers can’t overlap, and no gaps are allowed between tiers. #### See Also - [PriceAdjustmentSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceadjustmentschedule.htm "Represents a series of discounts offered depending on your product's configuration, quantity, and when they’re purchased in combination with other products. This object is available in API version 47.0 and later.") # Pricebook2 Represents a price book that contains the list of products that your org sells. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Price books are represented by Pricebook2 objects. As of API version 8.0, the Pricebook object is no longer available. Requests containing Pricebook are refused, and responses don’t contain the Pricebook object. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the price book. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the price book is active (true) or not (false). Inactive price books are hidden in many areas in the user interface. You can change this field’s value as often as necessary. Label is **Active**. | | IsArchived | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the price book has been archived (true) or not (false). This field is read only. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the price book has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsStandard | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the price book is the standard price book for the org (true) or not (false). Every org has one standard price book—all other price books are custom price books. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of this object. This field is read-only for the standard price book. Label is **Price Book Name**. | | ValidFrom | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when a Commerce price book is initially valid. If this field is null, the price book is valid immediately when active. Available in API version 48.0 and later. | | ValidTo | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when a Commerce price book is valid to. If this field is null, the price book is valid until it’s deactivated. Available in API version 48.0 and later. | ## Usage A price book is a list of products that your org sells. - Each org has one standard price book that defines the standard or generic list price for each product or service that it sells. - An org can have multiple custom price books to use for specialized purposes, such as for discounts, different channels or markets, or select accounts or opportunities. While your client application can create, delete, and update custom price books, your client application can only update the standard price book. - For some orgs, the standard price book is the only price needed. If you set up other price books, you can reference the standard price book when setting up list prices in custom price books. Use this object to query standard and custom price books that have been configured for your org. A common use of this object is to allow your client application to obtain valid Pricebook2 object IDs for use when configuring PricebookEntry records via the API. Your client application can perform the following tasks on PricebookEntry objects: - Query - Create for the standard price book or custom price books. - Update - Delete - Change the IsActive field when creating or updating records ## PriceBook2, Product2, and PricebookEntry Relationships In the API: - Price books are represented by Pricebook2 records (as of version 8.0, the Pricebook object is no longer available). - Products are represented by Product2 records (as of version 8.0, the Product object is no longer available). - Each price book contains zero or more entries (represented by PricebookEntry records) that specify the products that are associated with the price book. A price book entry defines the price for which you sell a product at a particular currency. These objects are defined only for those orgs that have products enabled as a feature. If the org doesn’t have the products feature enabled, the Pricebook2 object doesn’t appear in the describeGlobal() call, and you can’t access it via the API. If you delete a Pricebook2 while a line item references PricebookEntry in the price book, the line item is unaffected, but the Pricebook2 is archived and unavailable from the API. For a visual diagram of the relationships between Pricebook2 and other objects, see Product and Schedule Objects. ## Price Book Setup The process of setting up a price book via the API usually means: 1. Load product data into Product2 records (creating one Product2 record for each product that you want to add). 2. For each Product2 record, create a PricebookEntry that links the Product2 record to the standard Pricebook2. Define a standard price for a product at a given currency (if you have multicurrency enabled) before defining a price for that product in the same currency in a custom price book. 3. Create a Pricebook2 record to represent a custom price book. 4. For each Pricebook2 record, creating a PricebookEntry for every Product2 that you want to add, specifying unique properties for each PricebookEntry (such as the UnitPrice and CurrencyIsoCode) as needed. ## Code Sample—Java public void pricebookSample() { try { //Create a custom pricebook Pricebook2 pb = new Pricebook2(); pb.setName("Custom Pricebok"); pb.setIsActive(true); SaveResult\[\] saveResults = connection.create(new SObject\[\]{pb}); pb.setId(saveResults\[0\].getId()); // Create a new product Product2 product = new Product2(); product.setIsActive(true); product.setName("Product"); saveResults = connection.create(new SObject\[\]{product}); product.setId(saveResults\[0\].getId()); // Add product to standard pricebook QueryResult result = connection.query( "select Id from Pricebook2 where isStandard=true" ); SObject\[\] records = result.getRecords(); String stdPbId = records\[0\].getId(); // Create a pricebook entry for standard pricebook PricebookEntry pbe = new PricebookEntry(); pbe.setPricebook2Id(stdPbId); pbe.setProduct2Id(product.getId()); pbe.setIsActive(true); pbe.setUnitPrice(100.0); saveResults = connection.create(new SObject\[\]{pbe}); // Create a pricebook entry for custom pricebook pbe = new PricebookEntry(); pbe.setPricebook2Id(pb.getId()); pbe.setProduct2Id(product.getId()); pbe.setIsActive(true); pbe.setUnitPrice(100.0); saveResults = connection.create(new SObject\[\]{pbe}); } catch (ConnectionException ce) { ce.printStackTrace(); } } ## 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. [Pricebook2ChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 48.0) Change events are available for the object. [Pricebook2History](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. # Pricebook2History Represents historical information about changes that have been made to the standard fields of the associated Pricebook2, or to any custom fields with history tracking enabled. This object is available in API version 68.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules This object is always read-only. ## Fields | Field | Details | | --- | --- | | Pricebook2Id | Type reference Properties Filter, Group, Sort Description ID of the Pricebook2 associated with this record. This is a relationship field. Relationship Name Pricebook2 Relationship Type Lookup Refers To Pricebook2 | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name of the price book field that was modified, or a special value to indicate some other modification to the price book. | | IsDeleted | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). This is a standard system field. Label is **Deleted**. | | NewValue | Type anyType Properties Nillable, Sort Description New value of the modified price book field. Maximum of 255 characters. | | OldValue | Type anyType Properties Nillable, Sort Description Previous value of the modified price book field. Maximum of 255 characters. | ## Usage Price book history entries are indirectly created each time a price book is modified. Two rows are added to this record when foreign key fields change. One row contains the foreign key object names that display in the online application. For example, Jane Doe is recorded as the name of a Contact. The other row contains the actual foreign key ID that is only returned to and visible from the API. This object respects field level security on the parent object. #### See Also - [Pricebook2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pricebook2.htm "Represents a price book that contains the list of products that your org sells.") # PricebookEntry Represents a product entry (an association between a Pricebook2 and Product2) in a price book. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Salesforce Object Search Language (SOSL) allows you to search records across standard and custom objects. When filtering records in the PriceBookEntry object using SOSL, you can only sort by fields related to Product2. | Field | Details | | --- | --- | | ActivePriceAdjustmentQuantity | Type int Properties Filter, Group, Nillable, Sort Description The count of active price adjustment schedules associated with the price book entry. This field is available in API version 49.0 and later. This field is available with a B2B or D2C Commerce license. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this price book entry is active (true) or not (false). Although you can never delete PricebookEntry records, your client application can set this flag to false. Inactive PricebookEntry records are hidden in many areas in the user interface. You can change this flag on a PricebookEntry record as often as necessary. | | IsArchived | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the PricebookEntry has been archived (true) or not (false). This field is set to true when the Product2 record it’s associated with is archived, or when the Pricebook2 record is archived. This field is read only. Available in API version 45.0 and later. Label is **Archived**. | | Name | Type string Properties Filter, Group, Nillable, Sort Description Name of this PricebookEntry record. This read-only field references the value in the Name field of the Product2 record. Label is **Product Name**. | | Pricebook2Id | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Pricebook2 record with which this record is associated. This field must be specified when creating Pricebook2 records. It can’t be changed in an update. This field is a relationship field. Relationship Name Pricebook2 Relationship Type Lookup Refers To Pricebook2 | | Product2Id | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Product2 record with which this record is associated. This field must be specified when creating Product2 records. It can’t be changed in an update. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductCode | Type string Properties Filter, Group, Nillable, Sort Description Product code for this record. This read-only field references the value in the **ProductCode** field of the associated Product2 record. | | ProductSellingModelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related product selling model. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. Relationship Name ProductSellingModel Relationship Type Lookup Refers To ProductSellingModel | | UnitPrice | Type currency Properties Create, Filter, Sort, Update Description Required. Unit price for this price book entry. You can specify a value only if UseStandardPrice is set to false. Label is **List Price**. | | UseStandardPrice | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this price book entry uses the standard price defined in the standard Pricebook2 record (true) or not (false). If set to true, then the UnitPrice field is read-only, and the value is the same as the UnitPrice value in the corresponding PricebookEntry in the standard price book (that is, the PricebookEntry record whose Pricebook2Id refers to the standard price book and whose Product2Id and CurrencyIsoCode are the same as this record). For PricebookEntry records associated with the standard Pricebook2 record, this field must be set to true. | ## Usage Use this object to define the association between your organization’s products (Product2) and your organization’s standard price book or to custom price books ( Pricebook2). Create one PricebookEntry record for each standard or custom price and currency combination for a product in a Pricebook2. When creating these records, you must specify the IDs of the associated Pricebook2 record and Product2 record. Once these records are created, your client application can’t update these IDs. This object is defined only for those organizations that have products enabled as a feature. If the organization doesn’t have the products feature enabled, then the PricebookEntry object doesn’t appear in the describeGlobal call, and you can’t access it. If you delete a PriceBookEntry that is referenced by a line item, the line item is unaffected, but the PriceBookEntry is archived and unavailable from the API. Deleted PriceBookEntry records can’t be recovered. You must load the standard price for a product before you’re permitted to load its custom prices. ## Associated Objects This object has the following associated objects. Unless otherwise noted, they’re available in the same API version as this object. [PricebookEntryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.")(API version 57.0) Change events are available for the object. [PricebookEntryHistory](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. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # PricebookEntryAdjustment Read-only junction object created when you associate a price adjustment schedule with a price book entry. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description For internal use only. | | PriceAdjustmentScheduleId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the price book entry adjustment. | | PricebookEntryId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the price book entry that this price book entry adjustment is associated with. | #### See Also - [PriceAdjustmentSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceadjustmentschedule.htm "Represents a series of discounts offered depending on your product's configuration, quantity, and when they’re purchased in combination with other products. This object is available in API version 47.0 and later.") # PriceProtectExecLineItem Represents a line item created as part of a Price Protection Execution. This object is available in API version 63.0 and later. A PriceProtectExecLineItem record is automatically generated by the Data Processing Engine when eligible product transactions are processed for price protection. It links to execution records, products, and pricing terms, and stores per-unit pricing, eligibility, and calculation details. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Sort, Update Description References the partner account related to the transaction being evaluated for price protection. This field is a relationship field. Relationship Name Account Refers To Account | | CalculatedAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Total protected amount calculated based on the applicable price difference and quantity. | | CalculationReferenceRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the rebate or pricing rule used to compute the claim. This field is a relationship field. Relationship Name CalculationReferenceRecord Refers To ProgramRebateType | | ClaimReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Links to the related rebate claim, if one has been generated. This field is a polymorphic relationship field. Relationship Name ClaimReference Refers To RebateClaim | | HasWarnings | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the execution line item has associated warnings. The default value is false. | | InTransitQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description Quantity of the product in transit. | | IsEligible | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the record qualifies for price protection. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the record was last referenced by a user or system. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and timestamp when the record was last opened in the UI. | | LocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the inventory or sales location relevant to the line item. This field is a relationship field. Relationship Name Location Refers To Location | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated identifier for the line item record. | | NewSalePricePerUnit | Type currency Properties Create, Filter, Nillable, Sort, Update Description The new sale price per unit after the price change. | | NewSalePriceType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Type of sale price applied post-adjustment (e.g., List Price, Net Price). | | PriceDifference | Type currency Properties Filter, Nillable, Sort Description Difference between the old and new sale price per unit. This field is a calculated field. | | PriceProtectionExecutionId | Type reference Properties Create, Filter, Group, Sort Description Links to the parent Price Protection Execution record. This field is a relationship field. Relationship Name PriceProtectionExecution Relationship Type Master-detail Refers To PriceProtectionExecution (the master object) | | PriceProtectionTermId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the Price Protection Term used for evaluating eligibility and calculations. This field is a relationship field. Relationship Name PriceProtectionTerm Refers To PriceProtectionTerm | | ProductId | Type reference Properties Create, Filter, Group, Sort, Update Description References the product involved in the price protection claim. This field is a relationship field. Relationship Name Product Refers To Product2 | | RemainingQuantity | Type double Properties Create, Filter, Sort, Update Description Quantity of product still eligible for claim after partial adjustments. | | SalePricePerUnit | Type currency Properties Create, Filter, Sort, Update Description Original sale price per unit before the price adjustment. | | SalePriceType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Type of sale price recorded during the original transaction. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Current processing state of the line item. Possible values are: - Complete - Error - New - ReadyForClaim—Ready For Claim - ReadyForPricing—Ready For Pricing - ReadyForSimulation—Ready For Simulation | | StatusReason | Type string Properties Create, Filter, Nillable, Sort, Update Description Additional explanation or message associated with the current status. | | TransactionDate | Type date Properties Create, Filter, Group, Sort, Update Description Date when the original sale or transaction occurred. | | TransactionReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to the transaction record from which this line item originates. This field is a polymorphic relationship field. Relationship Name TransactionReference Refers To PartnerUnsoldInventory | | WarningMessage | Type string Properties Create, Filter, Nillable, Sort, Update Description Descriptive warning associated with this line item, if applicable. | # PriceProtectionExecution Represents an instance of running the price protection process, capturing execution time, status, and the effective date of price changes. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ExecutionJobId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Data processing engine instance responsible for creating price protection records. This field is a relationship field. Relationship Name ExecutionJob Refers To BatchCalcJobDefinition | | ExecutionReferenceNumber | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Unique reference number generated by the Data Processing Engine for this execution. This can be used to associate related line items to the same execution. | | LastExecutionTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when the price protection execution was last performed by the Data Processing Engine. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the record was last referenced. This is used internally to optimize performance and user experience. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and timestamp when the record was last viewed in the Salesforce UI. Helps track user engagement. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated name for the price protection execution record. Used as the primary identifier within the system. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifier for the user or group that owns this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | PriceChangeEffectiveDate | Type date Properties Create, Filter, Group, Sort, Update Description Date when the new price goes into effect as part of the price protection execution. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Represents the current lifecycle status of the price protection execution process. Possible values are: - Completed - New - Processing | # PriceProtectionTerm Represents a configuration record that defines the rules, types, and eligible conditions for price protection. This object is available in API version 63.0 and later. A PriceProtectionTerm record is referenced during claims processing to calculate supported price and quantity adjustments based on predefined terms. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields
Field Details
CalculationReferenceRecordId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Rebate type that's applicable for the claim amount calculation. This field is a relationship field.
Relationship Name
CalculationReferenceRecord
Refers To
ProgramRebateType
IsPayable
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the inventory is eligible for payment or refund after a price protection adjustment.
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description

The timestamp when the record was last referenced by the current user. Useful for activity tracking.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description

Date and the timestamp when the record was last viewed by the user. Helps in understanding record engagement.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Unique name for the Price Protection Term. This is typically used as a primary identifier for UI display or business logic.
NewSalePriceType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Defines the type of new sale price applicable after a price protection scenario. This helps classify how the adjusted sale price can be handled.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Identifier for the user or group who owns the record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
PriceProtectionType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Defines the type of price protection applied.
Possible values are:
  • PriceProtection—Price Protection
  • ReversePriceProtection—Reverse Price Protection
The default value is PriceProtection.
SalePriceType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of sale price before price protection is applied. This helps calculate the protection delta during claim processing.
SupportedPricePercent
Type
percent
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Indicates the percentage of the price that is supported for price protection. Helps calculate eligible claim amounts.
SupportedQuantityPercent
Type
percent
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Indicates the percentage of quantity that is eligible for price protection. Used to determine prorated reimbursement.
# Pricing Event Type Pricing events contain information about pricing procedures that were executed, including details such as pricing procedures used, the pricing APIs, and pricing details and status. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. If the user’s session context isn't available, this field returns a blank value.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
EVENT_TYPE
Type
String
Description
The type of event. The value is always Pricing.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000062.
PRICING_API_ENDPOINT
Type
String
Description
The starting point of the Pricing API or Headless Pricing API.
For example: Pricing API.
PRICING_DETAILS
Type
String
Description
The details of the pricing event that describes if the pricing API was executed or failed.
For example: Pricing element was processed..
PRICING_ERROR_CODE
Type
String
Description
The API error code that appears when‌ pricing execution fails. If there is no error, the value is null.
For example: INTERNAL_ERROR.
PRICING_LOG_NAME
Type
String
Description
The detailed pricing log message generated.
For example: The Headless Pricing API was run in:{0}.
PRICING_PROCEDURE
Type
String
Description
The name of the pricing procedure used to perform pricing calculations.
For example: Default Pricing Procedure.
PRICING_STATUS
Type
String
Description
The status of the request for pricing execution.
For example: Completed or Failed.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
For example: 1851629863.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
TIMESTAMP
Type
String
Description
The time that the pricing was executed in GMT.
For example: 20170606170000.000.
TIMESTAMP_DERIVED
Type
DateTime
Description
The time that the pricing was executed in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2017-06-06T1700.000Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who executed pricing through the UI or the API.
For example: 005SG000000eu6j
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 001xx0000000useAAA.
# Primitive Data Types The API uses the following primitive data types:
Value Details
base64 Base 64-encoded binary data. Fields of this type are used for storing binary files in Attachment records, Document records, and Scontrol records. In these objects, the Body or Binary field contains the (base64 encoded) data, while the BodyLength field defines the length of the data in the Body or Binary field. In the Document object, you can specify a URL to the document instead of storing the document directly in the record.
boolean Boolean fields have one of these values: true (or 1), or false (or 0).
byte A set of bits.
date Date data. Fields of this type contain date values, such as ActivityDate in the Event object. Unlike dateTime fields, date fields contain no time value—the time portion of a date field is not relevant and is always set to midnight in the Coordinated Universal Time (UTC) time zone.

If you specify a date value in a query, you can filter on date fields only.
dateTime Date/time values (timestamps). Fields of this type handle date/time values (timestamps), such as ActivityDateTime in the Event object or the CreatedDate, LastModifiedDate, or SystemModstamp in many objects. Regular dateTime fields are full timestamps with a precision of one second. They are always transferred in the Coordinated Universal Time (UTC) time zone. In your client application, you might need to translate the timestamp to or from a local time zone.

If you specify a dateTime value in a query, you can filter on dateTime fields only.

Development tools differ in the way that they handle time data. Some development tools report the local time, while others report only the Coordinated Universal Time (UTC) time zone. To determine how your development tool handles time values, refer to its documentation.

The Event object has a DurationInMinutes field that specifies the number of minutes for an event. Even though this is a temporal value, it is an integer type—not a dateTime type.

double Double values. Fields of this type can contain fractional portions (digits to the right of the decimal place), such as ConversionRate in CurrencyType. In the API, all non-integer values (such as Currency Field Type and Percent Field Type) contain values of type double. Some restrictions may be applied to double values:
  • scale: Maximum number of digits to the right of the decimal place.
  • precision: Total number of digits, including those to the left and the right of the decimal place

The maximum number of digits to the left of the decimal place is equal to precision minus scale. In the Salesforce user interface, precision is defined differently—it is the maximum number of digits allowed to the left of the decimal place.

Values can be stored in scientific notation if the number is large enough (or, for negative numbers, small enough), as indicated by the W3C XML Schema Part 2: Datatypes Second Edition specification.

When the user sets the precision in custom fields in the Salesforce application, it displays the precision set by the user, even if the user enters a more precise value than defined for those fields. However, when you set the precision in custom fields using the API, no rounding occurs when the user retrieves the number field.
int Fields of this type contain numbers with no fractional portion (digits to the right of a decimal place), such as the NumberOfEmployees in an Account. For integer fields, digits specifies the maximum number of digits that an int can have.
long Large integers. They are similar to the int type but can hold a wider range of numbers. The smallest possible value for long is -9223372036854775808 and the largest possible value is 9223372036854775807. For long fields, digits specifies the maximum number of digits that the number can have.
string Character strings. Fields that are of data type string contain text and some have length restrictions depending on the data being stored. For example, in the Contact object, the FirstName field is 40 characters, the LastName field is 80 characters, the MailingStreet is 255 characters.

For fields that contain strings, behavior is different beginning with API version 15.0. In API versions previous to 15.0, if you specify a value for a field, and that value is too large, the value is truncated. For API version 15.0 and later, if a value is specified that is too large, the operation fails and the fault code STRING_TOO_LONG is returned. AllowFieldTruncationHeader allows you to specify that the previous behavior, truncation, be used instead of the new behavior in API versions 15.0 and later. This header has no effect in versions 14.0 and earlier. The affected fields are: anyType, email, encryptedstring, multipicklist, phone, picklist, string, and textarea.

time Time values. Fields of this type handle time values, such as FridayEndTime in the BusinessHours object, with a precision of one millisecond.

Development tools differ in the way that they handle time data. Some development tools report the local time, while others report only the Coordinated Universal Time (UTC) time zone. To determine how your development tool handles time values, refer to its documentation.
These data types are used in the SOAP messages that are exchanged between your client application and the API. When writing your client application, follow the data typing rules defined for your programming language and development environment. Your development tool handles the mapping of typed data in your programming language with these SOAP data types. The primitive data types are: - specified in the World Wide Web Consortium’s publication _XML Schema Part 2: Data Types_ at the following URL: [http://www.w3.org/TR/xmlschema-2/](http://www.w3.org/TR/xmlschema-2/). - enumerated in the SOAPType field of the Field type, which is described in the fields property of the DescribeSObjectResult. Primitive types are used as a standardized way to define, send, receive, and interpret basic data types in the SOAP messages exchanged between client applications and the API. In addition, primitive data types are interpreted in a Salesforce-specific way, which is useful for display formatting and for numeric conversion (adding values of different currencies). For example, Salesforce chooses to interpret a double value passed via SOAP as a double in a number of possible ways, depending on the field definition. If the field type for that data is currency, Salesforce handles the display of the data by prepending it with a currency symbol and inserting a decimal for precision. Similarly, if the field type is percent, Salesforce handles the display of the data by appending a percent sign (%). Regardless of the field type, however, the value is sent in the SOAP message as a double. The API uses data types called field types that are defined in the WSDLs. For more information, see [Field Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm "In addition to the primitive data types, the API defines the following data types for fields."). # PrivacyHold Represents a Privacy Hold that indicates that a record should be preserved from masking or deletion by Data Management policies in Privacy Center. This object is available in API version 59.0 and later. Use Privacy Hold with Data Management policies in Privacy Center. Add a condition to your policy to exclude records with an active Privacy Hold status from masking or deletion actions. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available for users with the Privacy Center license and the Manage Privacy Hold user permission. ## Fields | Field | Details | | --- | --- | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the Privacy Hold ends. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if Privacy Hold is active on the record. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Privacy Hold. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PrivacyHoldReasonId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the associated Privacy Hold Reason. This field is a relationship field. Relationship Name PrivacyHoldReason Relationship Type Lookup Refers To PrivacyHoldReason | | ReferenceRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the record marked for the Privacy Hold. This field is a polymorphic relationship field. Relationship Name ReferenceRecord Relationship Type Lookup Refers To Account, Contact, Individual, Lead, User | | ReferenceRecordType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of object the record with the Privacy Hold is associated with. Possible values are: - Account - Contact - Individual - Lead - User | | RegisteredDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the Privacy Hold was added to the record. | # PrivacyHoldReason Represents the business or legal purpose for why a record has a Privacy Hold. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available for users with the Privacy Center license and the Manage Privacy Hold user permission. ## Fields | Field | Details | | --- | --- | | Detail | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The details of the Privacy Hold Reason, such as the business or legal purpose for the hold. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Privacy Hold Reason. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | # PrivacyJobSession Represents the status of past, ongoing, and scheduled policy jobs in Privacy Center. This object is available in API version 59.0 and later. This object is Read-only. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available for users with the Privacy Center license and the Manage Privacy Center Policies user permission. ## Fields | Field | Details | | --- | --- | | CreationDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time the policy job was created. | | CurrentObject | Type string Properties Filter, Group, Nillable, Sort Description The name of the object that the policy job is currently processing. | | EndTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time the policy job finished executing. | | FailureLog | Type textarea Properties Nillable Description The description of why the policy job failed to execute. | | JobStartType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description How the policy job session was started. Possible values are: - manual - scheduled | | JobStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Represents the status of the policy job session. Possible values are: - cancelled - completed - failures - inactive - running - running\_next - scheduled - suspended | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Represents the job session record. This is a serialized, automatically generated number field. | | OptionsProcessingFailed | Type boolean Properties Filter Description Indicates that the policy job session failed to process the records with the deletion or masking rules in the policy. | | OptionsTraversalComplete | Type boolean Properties Filter Description Indicates that the policy job session was completed without errors. | | OptionsTraversalFailed | Type boolean Properties Filter Description Indicates that the policy job session was completed with errors. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the owner of the account associated with this customer. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PolicyDescription | Type string Properties Filter, Group, Nillable, Sort Description The description of the policy the job session is associated with. | | PolicyName | Type string Properties Filter, Group, Nillable, Sort Description The name of the policy the job session is associated with. | | PolicyType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of policy the job session is associated with. Possible values are: - datamanagement—Data Management. - datamask—This policy type is reserved for future use. - rtbf— Right to Be Forgotten. | | PrivacyPolicyDefinitionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the policy the job session is executing for. This field is a relationship field. Relationship Name PrivacyPolicyDefinition Relationship Type Lookup Refers To PrivacyPolicyDefinition | | PrivacyRtbfRequestId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Right to Be Forgotten request the policy job is executing for. This field is a relationship field. Relationship Name PrivacyRtbfRequest Relationship Type Lookup Refers To PrivacyRTBFRequest | | ScheduledTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time the policy job session is scheduled to run. | | SerializedPolicy | Type textarea Properties Nillable Description The serial ID of a snapshot of the policy the job session is for. A snapshot of the policy is taken to maintain consistent metadata for the policy the job is for, in case changes are made to the policy while the job is executing. | | StartTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time the policy job session started executing. | ## 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. [PrivacyJobSessionOwnerSharingRule](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. [PrivacyJobSessionShare](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. # PrivacyObjectSession Represents the status of each object being processed in past, ongoing, and scheduled policy jobs in Privacy Center. This object is available in API version 59.0 and later. See the status of each object as a policy executes. For example, if a Data Management policy includes an Account object and a Contact object, then a PrivacyObjectSession record is created for each object. Each object in a policy has five potential queues to enter. The first queue captures and stores records targeted by the policy filters. If the first queue run fails to capture every record, then the object goes through three retry attempts to capture the remaining records. The fifth queue stores the record IDs of any records that weren’t captured in any of the four attempts. This object is Read-only. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available for users with the Privacy Center license and the Manage Privacy Center Policies user permission. ## Fields | Field | Details | | --- | --- | | CurrentEntity | Type string Properties Filter, Group, Nillable, Sort Description The name of the object in the policy. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Represents the job session record. This is a serialized, automatically generated number field. | | ObjectFailureLog | Type textarea Properties Nillable Description This field is reserved for later use. | | ObjectStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The policy execution status for the object. Possible values are: - processing\_completed - processing\_failed - processing\_ongoing - processing\_pending - traversal\_completed - traversal\_failed - traversal\_ongoing | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the owner of the account associated with the customer that the policy was executed for. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PolicyNode | Type string Properties Filter, Group, Nillable, Sort Description The ID of the object in the serialized policy. This field associates the object session in the policy execution with the coordinating object in the Privacy Center policy. | | Position | Type int Properties Filter, Group, Nillable, Sort Description Represents a record’s position in the batch queue for the object being processed. | | PrivacyJobSessionObjectId | Type reference Properties Filter, Group, Sort Description The ID of the policy job session. This field is a relationship field. Relationship Name PrivacyJobSessionObject Relationship Type Lookup Refers To PrivacyJobSession | | ProcessType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of action being executed on the object in the policy. Possible values are: - delete - mask - retry\_delete - retry\_mask | | ProcessedFailures | Type int Properties Filter, Group, Nillable, Sort Description The number of records the policy execution failed to process. | | ProcessedSuccesses | Type int Properties Filter, Group, Nillable, Sort Description The number of records the policy execution successfully processed. | | ProcessedTotal | Type int Properties Filter, Group, Nillable, Sort Description The total number of records processed in the policy job. | | Processor | Type string Properties Filter, Group, Nillable, Sort Description The name of the deletion, masking, or traversal processor executing the policy job. | | Queue | Type string Properties Filter, Group, Nillable, Sort Description This field is reserved for later use. | | QueueLength | Type int Properties Filter, Group, Nillable, Sort Description The total number of records in the queue to be processed by the policy job. | | RecordsAffected | Type int Properties Filter, Group, Nillable, Sort Description The number of records processed by the policy job. | | Retry | Type int Properties Filter, Group, Nillable, Sort Description The queue number of the retry session after a failed policy execution attempt. Each attempt to retry the policy execution is put into a retry queue. | | TraversalEndTime | Type dateTime Properties Filter, Nillable, Sort Description The end time of the record-capturing phase for the object session. | | TraversalStartTime | Type dateTime Properties Filter, Nillable, Sort Description The start time of the record-capturing phase for the object session. | | UniqueConstraint | Type string Properties Filter, Group, idLookup, Nillable, Sort Description For internal use only. | ## 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. [PrivacyObjectSessionOwnerSharingRule](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. [PrivacyObjectSessionShare](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. # PrivacyRequest See details and monitor the status of Data Subject Access Requests made in Privacy Center. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is for Privacy Center customers with the ReadAllData or PrivacyDataAccess permissions. ## Fields | Field | Details | | --- | --- | | CompletedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the request was completed. | | DataSubjectEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the data subject. | | DueDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the request is due. | | ExecutionStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The execution status of the request. - completed — Completed - in\_progress — In Progress - new — New | | FirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description First name of the data subject. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | LastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Last name of the data subject. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Privacy Request. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RelatedRecord | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Data Subject Access Request (DSAR) or Right to Be Forgotten request (RTBF) record related to the request. | | StartedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the request was started. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the status of the request. Possible values are: - Approved - Cancelled - Completed - Created - In Progress - Rejected | | TargetRecord | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The record that is listed in the request. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the type of request that was made. Possible values are: - DSAR - GlobalOptOut - RTBF | ## 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. [PrivacyRequestFeed](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. [PrivacyRequestHistory](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. [PrivacyRequestOwnerSharingRule](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. [PrivacyRequestShare](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. ## Usage In API version 66.0 and later, users can click **New Privacy Request** to create privacy requests directly from the Privacy Requests page. This action supports Right to Be Forgotten (RTBF) request types. The New Privacy Request button uses a custom dialog based on search criteria defined in Setup. The standard New button uses the default record creation dialog. To streamline the user interface and avoid redundancy, hide the standard New button. # PrivacyRTBFRequest Represents a Right to Be Forgotten Request made in Privacy Center. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available for users with the Privacy Center license and the Manage Privacy Center Policies user permission. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the customer’s Right to Be Forgotten request. | | JobRecord | Type string Properties Create, Filter, Group, Sort, Update Description The record ID that is processed by the Right to Be Forgotten request. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the Right to Be Forgotten request. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the account associated with this customer. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PolicyNameId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the Right to Be Forgotten policy applied to this request. This field is a relationship field. Relationship Name PolicyName Relationship Type Lookup Refers To PrivacyPolicyDefinition | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents the status of the request. Possible values are: - Cancelled - Complete - Error - Pending - Scheduled | ## 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. [PrivacyRTBFRequestHistory](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. [PrivacyRTBFRequestOwnerSharingRule](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. [PrivacyRTBFRequestShare](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. # PrivacyRtntStoreDelStatus Represents the status of retention store deletion operations in Privacy Center. This object is available in API version 67.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields With certain page layout and field-level security settings, some fields aren't visible or editable. | Field | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Assigned automatically when each retention store deletion status record is inserted. It can't be set directly, and it can't be modified after the record is created. | | ObjectState | Type textarea Properties Nillable Description Stores state information for the deletion operation. | | PrivacyRetentionStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The current status of the retention store deletion operation. Possible values are: - del\_req\_invalid — Delete Request Is Invalid - obj\_del\_cancelled — Object Delete Request Is Canceled - obj\_del\_complete — Object Deletion Complete - obj\_del\_failures — Object Deletes Completed with failures - obj\_del\_in\_progress — Object Deletion In Progress - store\_del\_cancelled — Store Delete Request Is Canceled - store\_del\_complete — Store Deletion Complete - store\_del\_enqueued — Store Deletion Enqueued - store\_del\_failures — Store Delete Completed with failures - store\_del\_in\_progress — Store Deletion In Progress | | PrivacyRetentionStoreType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of retention store being tracked for deletion. Possible values are: - Object - Organization | | RetentionStoreOrganizationId | Type reference Properties Filter, Group, Sort Description The ID of the Organization associated with this retention store deletion operation. This is a relationship field. Relationship Name RetentionStoreOrganization Refers To Organization | # PrivacySessionRecordFailure Represents error messages encountered during policy job executions in Privacy Center. This object is available in API version 59.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available for users with the Privacy Center license and the Manage Privacy Center Policies user permission. ## Fields | Field | Details | | --- | --- | | ErrorMessage | Type textarea Properties Nillable Description The description of the error encountered during the policy job execution. | | ErrorType | Type string Properties Filter, Group, Nillable, Sort Description The type of error encountered during the policy job execution. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Represents the job session record. This is a serialized, automatically generated number field. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the owner of the account associated with the customer that the policy was executed for. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PrivacyObjectSessionId | Type reference Properties Filter, Group, Sort Description The ID of the object in the policy job session. This field is a relationship field. Relationship Name PrivacyObjectSession Relationship Type Lookup Refers To PrivacyObjectSession | | RecordIdNumber | Type string Properties Filter, Group, Nillable, Sort Description The ID of the record that failed to be processed by the policy job. | ## 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. [PrivacySessionRecordFailureOwnerSharingRule](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. [PrivacySessionRecordFailureShare](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. # Problem Problems represent the root cause data of one or more incidents. This object contains all the details of a problem, documenting the history of the problem from detection to closure. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Category | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of problem. Administrators set field values. | | Description | Type textarea Properties Create, Nillable, Update Description A description of the problem. This field can store up to 32 KB of data, but only the first 255 characters appear in reports. | | Impact | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The problem's impact. Possible values are: - High - Low - Medium The default value is 'High'. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time (in UTC) 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 The date and time (in UTC) 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. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description This is a polymorphic relationship field that represents the user or group assigned to resolve the problem. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentProblemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of a problem above one or more related problems in a problem hierarchy. This is a relationship field. Relationship Name ParentProblem Relationship Type Lookup Refers To Problem | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The impact and urgency of the problem. Possible values are: - Critical - High - Low - Moderate The default value is 'Critical'. | | PriorityOverrideReason | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason why the priority should be changed or edited. | | ProblemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique, system-generated problem number. | | ResolutionDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time (in UTC) when the problem was resolved. | | ResolutionSummary | Type textarea Properties Create, Nillable, Update Description A description of the steps needed to resolve the incident. | | ResolvedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who resolved the problem. This is a relationship field. Relationship Name ResolvedBy Relationship Type Lookup Refers To User | | RootCauseSummary | Type textarea Properties Create, Nillable, Update Description A description of the problem resolution or root cause. This field can store up to 32 KB of data, but only the first 255 characters display in reports. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Any custom or granular stages customers wants to track. This will be a dependent picklist. Possible values are: - Closed - Fix in Progress - Known Error - New - Open - Pending Change - Resolved - Root Cause Analysis - Work In Progress The default value is 'New'. | | StatusCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status of the problem. Possible values are: - Closed - FixInProgress - KnownError - New - Open - PendingChange - Resolved - RootCauseAnalysis - WorkInProgress The default value is 'New'. | | SubCategory | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of problem. One level deeper than Category. Administrators set field values. | | Subject | Type string Properties Create, Filter, Group, Sort, Update Description A brief description of the problem. | | Urgency | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description A measure of how long a resolution can be delayed until an incident, problem, or change has a significant business impact. Possible values are: - High - Low - Medium The default value is 'High'. | # ProblemIncident Represents a junction object that relates a Problem to an Incident. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | IssueId | Type reference Properties Create, Filter, Group, Sort Description A polymorphic relationship field that represents a related Problem or Incident. This field is a polymorphic relationship field. Relationship Name Issue Relationship Type Lookup Refers To Incident, Problem | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated ID of the incident that's related to the problem. | | RelatedEntityType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The object type of the related entity. Possible values are: - Incident - Problem | | RelatedIssueId | Type reference Properties Create, Filter, Group, Sort Description A polymorphic relationship field that represents a related Problem or Incident. This field is a polymorphic relationship field. Relationship Name RelatedIssue Relationship Type Lookup Refers To Incident, Problem | | RelationshipType | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Shows how the Problem and Incident records relate to each other. Possible values are: - Caused By - Similar The default value is Caused By. | ## 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. [ProblemIncidentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProblemIncidentFeed](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. [ProblemIncidentHistory](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. # ProblemRelatedItem Represents a junction object that relates a Problem to an Asset. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Sort Description The Asset ID that’s linked to the Problem. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | Comment | Type textarea Properties Create, Nillable, Update Description A description of the problem as it relates to the item. | | ImpactLevel | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The related item’s impact on the problem. Possible values are: - High - Low - Medium The default value is High. | | ImpactType | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The effect of the problem-related item on business operations. Possible values are: - Business-Blocking - Not Business-Blocking - Partially Business-Blocking The default value is Business-Blocking. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated ID of the problem-related item. | | ProblemId | Type reference Properties Create, Filter, Group, Sort Description The Problem ID that’s related to the Asset. This field is a relationship field. Relationship Name Problem Relationship Type Lookup Refers To Problem | ## 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. [ProblemRelatedItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProblemRelatedItemFeed](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. [ProblemRelatedItemHistory](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. # ProcessDefinition Represents the definition of a single approval process. ## Supported Calls describeSObjects(), query(), retrieve(), search() Portal and communities users with the Customer Community Plus and Partner Community licenses can access this object. All users in org with approvals enabled have read access to ProcessDefinition. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Filter, Nillable, Sort Description A description of this process, with a maximum of 3,000 characters. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique process name, used internally. | | LockType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of lock applied to the record being approved. When a record is in the approval process, it’s always locked, and only an administrator can edit it. However, the currently assigned approver can also be allowed to edit the record. - Total - Admin - Owner - Workitem - Node - none | | Name | Type string Properties Filter, Group, idLookup, Sort Description The external name of the process; the name seen by users. | | State | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The current state of this process. - Active - Inactive - Obsolete | | TableEnumOrId | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies the object associated with the approval process, such as Account or Contact. | | Type | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of this process. - Approval Process—Used to control the action taken for a record. - State-based Process—Used internally to track various control processes, such as for developing Salesforce Knowledge articles. | ## Usage Use this object to read the description of an approval process. The definition is read-only. # ProcessException Represents a business exception, such as a processing failure on an order summary. A separate process is required to resolve the failure that caused the process exception before processing can continue. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AttachedToId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the object associated with the ProcessException. This field is a polymorphic relationship field. Relationship Name AttachedTo Relationship Type Lookup Refers To AsyncOpSyndicationFeedFile, AsyncOperationTracker CreditMemo, FulfillmentOrder, Invoice, Order, OrderItem, OrderItemSummary, OrderPaymentSummary, OrderSummary, Payment, PaymentAuthorization, Refund, ReturnOrder | | CaseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the case associated with the ProcessException. This field is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | Category | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description ProcessingException type. You can customize the category picklist to represent your business processes. Possible values are: - Fulfillment - Invoicing - Order Activation - Order Approval - Order To Asset - Order Item Summary To Asset - Order To Billing Schedule - Payment The default value is Order Activation. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the OrderSummary associated with the ProcessException. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | Description | Type textarea Properties Create, Nillable, Update Description Detailed description of the ProcessException. | | ExternalReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of external entities associated with the ProcessException. | | FlowOrchestrationInstRelaObj | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The flow orchestration instance related object associated with this record. This field is a relationship field. Relationship Name FlowOrchInstRelaObj Relationship Type Lookup Refers To FlowOrchestrationInstRelaObj | | GroupById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID used in the entity to group exceptions, such as the Async Operation Tracker. This field is a polymorphic relationship field. Relationship Name GroupBy Refers To AsyncOperationTracker | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed this record. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed. | | Message | Type string Properties Create, Filter, Group, Sort, Update Description Short description of the ProcessException | | OrderSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the OrderSummary associated with the ProcessException. The ProcessException component is displayed on this OrderSummary. This field is a relationship field. Relationship Name OrderSummary Relationship Type Lookup Refers To OrderSummary | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who currently owns this ProcessException. Default value is the User who created the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Resolution priority for the ProcessException. You can customize the priority picklist to represent your business processes. Possible values are: - High - Low The default value is Low. | | ProcessExceptionNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name of the ProcessException, formatted as PE-(00000000). | | Severity | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Severity of the ProcessException. Each severity value corresponds to one severity category. You can customize the severity picklist to represent your business processes. If you customize the severity picklist, include at least one severity value for each severity category. Possible values are: - High - Low The default value is High. | | SeverityCategory | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Severity category of the ProcessException. Each severity category corresponds to one or more severity values. The severity category is used to show the severity icon in the ProcessException list view. Possible values are: - HIGH - LOW - MEDIUM | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Status of the ProcessException. Each status corresponds to one status category, shown here in parentheses. You can customize the status picklist to represent your business processes. If you customize the status picklist, include at least one status value for each status category. Possible values are: - Ignored (Inactive) - New (Active) - Paused (Inactive) - Resolved (Resolved) - Triaged (Active) - Voided (Inactive) The default value is New. | | StatusCategory | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Status category of the ProcessException. Each status category corresponds to one or more statuses. Possible values are: - ACTIVE - INACTIVE - RESOLVED | ## 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. [ProcessExceptionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [ProcessExceptionOwnerSharingRule](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. [ProcessExceptionOwnerSharingRule](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. # ProcessFlowMigration Represents a process's migrated criteria and the resulting migrated flow. This object is available in API version 58.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Lanaguage of the MasterLabel. Possible values are: - af—Afrikaans - am—Amharic - ar—Arabic - ar\_AE—Arabic (United Arab Emirates) - ar\_BH—Arabic (Bahrain) - ar\_DZ—Arabic (Algeria) - ar\_EG—Arabic (Egypt) - ar\_IQ—Arabic (Iraq) - ar\_JO—Arabic (Jordan) - ar\_KW—Arabic (Kuwait) - ar\_LB—Arabic (Lebanon) - ar\_LY—Arabic (Libya) - ar\_MA—Arabic (Morocco) - ar\_OM—Arabic (Oman) - ar\_QA—Arabic (Qatar) - ar\_SA—Arabic (Saudi Arabia) - ar\_SD—Arabic (Sudan) - ar\_SY—Arabic (Syria) - ar\_TN—Arabic (Tunisia) - ar\_YE—Arabic (Yemen) - bg—Bulgarian - bn—Bengali - bs—Bosnian - ca—Catalan - cs—Czech - cy—Welsh - da—Danish - de—German - de\_AT—German (Austria) - de\_BE—German (Belgium) - de\_CH—German (Switzerland) - de\_LU—German (Luxembourg) - el—Greek - el\_CY—Greek (Cyprus) - en\_AE—English (United Arab Emirates) - en\_AU—English (Australian) - en\_BE—English (Belgium) - en\_CA—English (Canadian) - en\_CY—English (Cyprus) - en\_DE—English (Germany) - en\_GB—English (UK) - en\_HK—English (Hong Kong) - en\_IE—English (Ireland) - en\_IL—English (Israel) - en\_IN—English (Indian) - en\_MT—English (Malta) - en\_MY—English (Malaysian) - en\_NL—English (Netherlands) - en\_NZ—English (New Zealand) - en\_PH—English (Philippines) - en\_SG—English (Singapore) - en\_US—English - en\_ZA—English (South Africa) - es—Spanish - es\_AR—Spanish (Argentina) - es\_BO—Spanish (Bolivia) - es\_CL—Spanish (Chile) - es\_CO—Spanish (Colombia) - es\_CR—Spanish (Costa Rica) - es\_DO—Spanish (Dominican Republic) - es\_EC—Spanish (Ecuador) - es\_GT—Spanish (Guatemala) - es\_HN—Spanish (Honduras) - es\_MX—Spanish (Mexico) - es\_NI—Spanish (Nicaragua) - es\_PA—Spanish (Panama) - es\_PE—Spanish (Peru) - es\_PR—Spanish (Puerto Rico) - es\_PY—Spanish (Paraguay) - es\_SV—Spanish (El Salvador) - es\_US—Spanish (United States) - es\_UY—Spanish (Uruguay) - es\_VE—Spanish (Venezuela) - et—Estonian - eu—Basque - fa—Farsi - fi—Finnish - fr—French - fr\_BE—French (Belgium) - fr\_CA—French (Canadian) - fr\_CH—French (Switzerland) - fr\_LU—French (Luxembourg) - fr\_MA—French (Morocco) - ga—Irish - gu—Gujarati - haw—Hawaiian - hi—Hindi - hmn—Hmong - hr—Croatian - ht—Haitian Creole - hu—Hungarian - hy—Armenian - in—Indonesian - is—Icelandic - it—Italian - it\_CH—Italian (Switzerland) - iw—Hebrew - ja—Japanese - ji—Yiddish - ka—Georgian - kk—Kazakh - kl—Greenlandic - km—Khmer - kn—Kannada - ko—Korean - lb—Luxembourgish - lt—Lithuanian - lv—Latvian - mi—Te reo - mk—Macedonian - ml—Malayalam - mr—Marathi - ms—Malay - mt—Maltese - my—Burmese - nl\_BE—Dutch (Belgium) - nl\_NL—Dutch - no—Norwegian - pa—Punjabi - pl—Polish - pt\_BR—Portuguese (Brazil) - pt\_PT—Portuguese (European) - rm—Romansh - ro—Romanian - ro\_MD—Romanian (Moldova) - ru—Russian - ru\_AM—Russian (Armenia) - ru\_BY—Russian (Belarus) - ru\_KG—Russian (Kyrgyzstan) - ru\_KZ—Russian (Kazakhstan) - ru\_LT—Russian (Lithuania) - ru\_MD—Russian (Moldova) - ru\_PL—Russian (Poland) - ru\_UA—Russian (Ukraine) - sh—Serbian (Latin) - sh\_ME—Montenegrin - sk—Slovak - sl—Slovene - sm—Samoan - sq—Albanian - sr—Serbian (Cyrillic) - sv—Swedish - sw—Swahili - ta—Tamil - te—Telugu - th—Thai - tl—Tagalog - tr—Turkish - uk—Ukrainian - ur—Urdu - vi—Vietnamese - xh—Xhosa - zh\_CN—Chinese (Simplified) - zh\_HK—Chinese (Hong Kong) - zh\_MY—Chinese (Malaysia) - zh\_SG—Chinese (Singapore) - zh\_TW—Chinese (Traditional) - zu—Zulu | | MasterLabel | Type string Properties Filter, Group, Sort Description The label for the ProcessFlowMigration. | | MigratedCriteriaLabel | Type string Properties Filter, Group, Nillable, Sort Description The label of the criteria that was migrated. | | MigratedCriteriaName | Type string Properties Filter, Group, Nillable, Sort Description The name of the criteria that was migrated. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace of the package containing the process flow migration object. | # ProcessInstance Represents an instance of a single, end-to-end approval process. Use this and the node, step, and workitem process instance objects to create approval history reports. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Exceptions apply to approval history data retrieved with this object and are available only via SOAP API. For each approval process instance that was pending when Summer '14 became available for your organization, some field values are never populated or are populated only after the rollout. Other fields are populated only after the approval process instance is next acted upon—such as when a user approves, rejects, or reassigns an approval request—after the Summer '14 rollout. For approval process instances that were completed before the Summer '14 rollout, all Process Instance fields are automatically populated, with one exception: CompletedDate is never populated for approval process instances that were completed before January 1, 2013. For approval process instances that were pending during the Summer '14 rollout, all ProcessInstance fields are automatically populated, with two exceptions: CompletedDate and LastActorId are populated only after the approval process instance is complete. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CompletedDate | Type dateTime Properties Filter, Nillable, Sort Description The completion date and time of the approval process. The ElapsedTimeDay, ElapsedTimeHours, and ElapsedTimeMinutes field values are calculated using CompletedDate. | | ElapsedTimeInDays | Type double Properties Filter, Nillable, Sort Description The total elapsed time in days between when the approval process instance was started and now. | | ElapsedTimeInHours | Type double Properties Filter, Nillable, Sort Description The total elapsed time in hours between when the approval process instance was started and now. | | ElapsedTimeInMinutes | Type double Properties Filter, Nillable, Sort Description The total elapsed time in minutes between when the approval process instance was started and now. | | LastActorId | Type reference Properties Group, Filter, Nillable, Sort Description The last actor that approved, rejected, or recalled the process. This is a relationship field. Relationship Name LastActor Relationship Type Lookup Refers To User | | ProcessDefinitionId | Type reference Properties Group, Filter, Sort Description The ID of this approval process instance. This is a relationship field. Relationship Name ProcessDefinition Relationship Type Lookup Refers To ProcessDefinition | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of this approval process instance. Possible values are: - Approved - Fault - Held - NoResponse - Pending - Reassigned - Rejected - Removed - Started | | SubmittedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who submitted the approval process. This is a relationship field. Relationship Name SubmittedBy Relationship Type Lookup Refers To User | | TargetObjectId | Type reference Properties Filter, Group, Sort Description ID of the object affected by this approval process instance. This is a polymorphic relationship field. Relationship Name TargetObject Relationship Type Lookup Refers To Account, Accreditation, ActivationTarget, Address, AlternativePaymentMethod, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, AuthorizationForm, AuthorizationFormConsent, AuthorizationFormDataUse, AuthorizationFormText, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CodeSetBundle, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionRate, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContactPointAddress, ContactPointConsent, ContactPointEmail, ContactPointPhone, ContactPointTypeConsent, Contract, CoverageBenefit, CoverageBenefitItem, CreditMemo, CreditMemoLine, DataStream, DataUseLegalBasis, DataUsePurpose, DelegatedAccount, DigitalSignature, DocumentChecklistItem, DuplicateRecordItem, DuplicateRecordSet, EmailMessage, EngagementChannelType, EnrollmentEligibilityCriteria, ExternalEventMapping, HealthCareDiagnosis, HealthCareProcedure, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Identifier, IdentityDocument, Image, IndividualApplication, Invoice, InvoiceLine, Lead, Location, LocationTrustMeasure, MarketSegment, MarketSegmentActivation, MemberPlan, MessagingEndUser, MessagingSession, MktCalculatedInsight, Opportunity, Order, OrgMetricScanResult, OrgMetricScanSummary, OtherComponentTask, PartyConsent, PaymentAuthAdjustment, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, ProcessException, Product2, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, PromptAction, PurchaserPlan, PurchaserPlanAssn, QuickTextUsage, Quote, ReceivedDocument, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderItemAdjustment, ReturnOrderItemTax, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SharingRecordCollection, SharingRecordCollectionItem, SharingRecordCollectionMember, Shift, Shipment, ShipmentItem, SkillRequirement, SocialPost, Solution, StreamingChannel, UnitOfMeasure, UserProvisioningRequest, VideoCall, VideoCallParticipant, VideoCallRecording, Visit, VisitedParty, Visitor, VolunteerProject, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup, WorkTypeGroupMember | ## Usage Use this object to query or retrieve an approval process. The following SOQL query returns details for all the ProcessInstanceStep records related to individual ProcessInstance records. The nested query references Steps, which is the child relationshipName for ProcessInstanceStep in the ProcessInstance object. SELECT Id, (SELECT Id, StepStatus, Comments FROM Steps) FROM ProcessInstance The following SOQL query returns details for all the ProcessInstanceWorkItem records related to individual ProcessInstance records. The nested query references Workitems, which is the child relationshipName for ProcessInstanceWorkItem in the ProcessInstance object. SELECT Id, (SELECT Id, ActorId, ProcessInstanceId FROM Workitems) FROM ProcessInstance ProcessInstanceHistory can help provide a unified read-only view of the ProcessInstanceStep and ProcessInstanceWorkItem objects. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProcessInstanceHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancehistory.htm "This read-only object shows all steps and pending approval requests associated with an approval process (ProcessInstance).") History is available for tracked fields of the object. [ProcessInstanceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 58.0) Change events are available for the object. #### See Also - [ProcessInstanceHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancehistory.htm "This read-only object shows all steps and pending approval requests associated with an approval process (ProcessInstance).") - [ProcessInstanceStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancestep.htm "Represents one work item in an approval process (ProcessInstance).") - [ProcessInstanceWorkitem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstanceworkitem.htm "Represents a user’s pending approval request.") # ProcessInstanceHistory This read-only object shows all steps and pending approval requests associated with an approval process (ProcessInstance). ## Supported Calls describeSObjects() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ActorId | Type reference Properties Filter, Group, Sort Description ID of the user who is assigned to this ProcessInstance. This is a polymorphic relationship field. Relationship Name Actor Relationship Type Lookup Refers To Group, User | | Comments | Type string Properties Filter, Nillable, Sort Description Comments for a ProcessInstanceStep . This field doesn't apply to ProcessInstanceWorkitem records. | | ElapsedTimeInDays | Type double Properties Filter, Nillable, Sort Description The total time in days between when the approval process instance was started and when it was completed. | | ElapsedTimeInHours | Type double Properties Filter, Nillable, Sort Description The total time in hours between when the approval process instance was started and when it was completed. | | ElapsedTimeInMinutes | Type double Properties Filter, Nillable, Sort Description The total time in minutes between when the approval process instance was started and when it was completed. | | IsPending | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the ProcessInstance is pending (true) or not (false). | | OriginalActorId | Type reference Properties Filter, Group, Sort Description ID of the user who was originally assigned this ProcessInstance. This is a polymorphic relationship field. Relationship Name OriginalActor Relationship Type Lookup Refers To Group, User | | ProcessInstanceId | Type reference Properties Filter, Group, Sort Description ID of the ProcessInstance. This is a relationship field. Relationship Name ProcessInstance Relationship Type Lookup Refers To ProcessInstance | | ProcessNodeId | Type reference Properties Filter, Group, Nillable, Sort Description ID of this step. This is a relationship field. Relationship Name ProcessNode Relationship Type Lookup Refers To ProcessNode | | RemindersSent | Type int Properties Filter, Group, Nillable, Sort Description Number of reminders that have been sent. Default is 0 (zero). | | StepStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the status of the ProcessInstanceStep. | | TargetObjectId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the object being approved. This is a polymorphic relationship field. Relationship Name TargetObject Relationship Type Lookup Refers To Account, Accreditation, ActivationTarget, Address, AlternativePaymentMethod, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskIndDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, AuthorizationForm, AuthorizationFormConsent, AuthorizationFormDataUse, AuthorizationFormText, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CodeSet, CodeSetBundle, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, ConsumptionRate, ConsumptionSchedule, Contact, ContactEncounter, ContactEncounterParticipant, ContactPointAddress, ContactPointConsent, ContactPointEmail, ContactPointPhone, ContactPointTypeConsent, Contract, CoverageBenefit, CoverageBenefitItem, CreditMemo, CreditMemoLine, DataStream, DataUseLegalBasis, DataUsePurpose, DelegatedAccount, DigitalSignature, DocumentChecklistItem, DuplicateRecordItem, DuplicateRecordSet, EmailMessage, EngagementChannelType, EnrollmentEligibilityCriteria, ExternalEventMapping, HealthCareDiagnosis, HealthCareProcedure, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, Identifier, IdentityDocument, Image, IndividualApplication, Invoice, InvoiceLine, Lead, Location, LocationTrustMeasure, MarketSegment, MarketSegmentActivation, MemberPlan, MessagingEndUser, MessagingSession, MktCalculatedInsight, Opportunity, Order, OrgMetricScanResult, OrgMetricScanSummary, OtherComponentTask, PartyConsent, PaymentAuthAdjustment, PersonEducation, PersonLanguage, PersonLifeEvent, PersonName, PlanBenefit, PlanBenefitItem, ProcessException, Product2, ProductFulfillmentLocation, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, PromptAction, PurchaserPlan, PurchaserPlanAssn, QuickTextUsage, ReceivedDocument, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderItemAdjustment, ReturnOrderItemTax, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, ServiceTerritoryWorkType, SharingRecordCollection, SharingRecordCollectionItem, SharingRecordCollectionMember, Shift, Shipment, ShipmentItem, SkillRequirement, SocialPost, Solution, StreamingChannel, UnitOfMeasure, UserProvisioningRequest, VideoCall, VideoCallParticipant, VideoCallRecording, Visit, VisitedParty, Visitor, VolunteerProject, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup, WorkTypeGroupMember | ## Usage This object helps you replicate the related list functionality of the Salesforce user interface for approval processes. Use ProcessInstanceHistory for a unified read-only view of the ProcessInstanceStep and ProcessInstanceWorkItem objects. You can’t query ProcessInstanceHistory. Instead, you can query ProcessInstanceHistory by including it in a nested query on the parent ProcessInstance object. For example, this SOQL query returns all the ProcessInstanceHistory records related to individual ProcessInstance records. The nested query references StepsAndWorkitems, which is the child relationshipName for ProcessInstanceHistory in the ProcessInstance object. SELECT Id, (SELECT Id, StepStatus, Comments FROM StepsAndWorkitems) FROM ProcessInstance This object respects field-level security on the parent object. #### See Also - [ProcessInstance](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstance.htm "Represents an instance of a single, end-to-end approval process. Use this and the node, step, and workitem process instance objects to create approval history reports.") - [ProcessInstanceStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancestep.htm "Represents one work item in an approval process (ProcessInstance).") - [ProcessInstanceWorkitem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstanceworkitem.htm "Represents a user’s pending approval request.") # ProcessInstanceNode Represents a step in an instance of an approval process. Compare to ProcessNode, which describes the step in a process definition. Use this object to retrieve approval history. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Exceptions apply to approval history data retrieved with this object and are available only via SOAP API. For each approval process instance that was pending when Summer '14 became available for your organization, some field values are never populated or are populated only after the rollout. Other fields are populated only after the approval process instance is next acted upon—such as when a user approves, rejects, or reassigns an approval request—after the Summer '14 rollout. ProcessInstanceNode fields are never populated for approval process instances that were completed before the Summer '14 rollout. For approval process instances that were pending during the Summer '14 rollout, all ProcessInstanceNode fields are populated only after the approval process instance is next acted upon after the Summer '14 rollout. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CompletedDate | Type dateTime Properties Filter, Nillable, Sort Description The completion date and time of this step in the approval process. The ElapsedTimeDay, ElapsedTimeHours, and ElapsedTimeMinutes field values are calculated using CompletedDate. | | ElapsedTimeInDays | Type double Properties Filter, Nillable, Sort Description The total time in days since this step was started. | | ElapsedTimeInHours | Type double Properties Filter, Nillable, Sort Description The total time in hours since this step was started. | | ElapsedTimeInMinutes | Type double Properties Filter, Nillable, Sort Description The total time in minutes since this step was started. | | LastActorId | Type reference Properties Filter, Group, Nillable, Sort Description The last actor that approved or rejected this step. This is a relationship field. Relationship Name LastActor Relationship Type Lookup Refers To User | | NodeStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of this approval instance, for example Started, Pending, or Approved. | | ProcessInstanceId | Type reference Properties Filter, Group, Sort Description The approval process this step is part of. This is a relationship field. Relationship Name ProcessInstance Relationship Type Lookup Refers To ProcessInstance | | ProcessNodeId | Type reference Properties Filter, Group, Sort Description The identifier for this step. This is a relationship field. Relationship Name ProcessNode Relationship Type Lookup Refers To ProcessNode | | ProcessNodeName | Type string Properties Filter, Group, Nillable, Sort Description The name of this step. The contents of this field can be publicly viewed. | # ProcessInstanceStep Represents one work item in an approval process (ProcessInstance). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Exceptions apply to approval history data retrieved with this object and are available only via SOAP API. For each approval process instance that was pending when Summer '14 became available for your organization, some field values are never populated or are populated only after the rollout. Other fields are populated only after the approval process instance is next acted upon—such as when a user approves, rejects, or reassigns an approval request—after the Summer '14 rollout. ProcessInstanceStep fields are never populated for approval process instances that were completed before the Summer '14 rollout. For approval process instances that were pending during the Summer '14 rollout, all ProcessInstanceStep fields are populated only after the approval process instance is next acted upon after the Summer '14 rollout. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ActorId | Type reference Properties Filter, Group, Sort Description ID of the user who’s assigned to this approval step. This is a polymorphic relationship field. Relationship Name Actor Relationship Type Lookup Refers To Group, User | | Comments | Type string Properties Filter, Nillable, Sort Description Limit: 4,000 bytes. The contents of this field can be publicly viewed. | | ElapsedTimeInDays | Type double Properties Filter, Nillable, Sort Description The total time in days since this step was started. | | ElapsedTimeInHours | Type double Properties Filter, Nillable, Sort Description The total time in hours since this step was started. | | ElapsedTimeInMinutes | Type double Properties Filter, Nillable, Sort Description The total time in minutes since this step was started. | | OriginalActorId | Type reference Properties Filter, Group, Sort Description ID of the user who was originally assigned to this approval step. This is a polymorphic relationship field. Relationship Name OriginalActor Relationship Type Lookup Refers To Group, User | | ProcessInstanceId | Type reference Properties Filter, Group, Sort Description ID of the ProcessInstance that this approval step belongs to. This is a relationship field. Relationship Name ProcessInstance Relationship Type Lookup Refers To ProcessInstance | | StepNodeId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the node currently assigned to this approval step. | | StepStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of this approval step. - Approved - Fault - Held - NoResponse - Pending - Reassigned - Rejected - Removed - Started If the approval step requires unanimous approval and one approver rejects the request, the value of this field for the other approvers changes to NoResponse. Likewise, if approval is based on the first response and an approver responds, the value of this field for the other approvers changes to NoResponse. | ## Usage Query or retrieve a new step in an approval process (ProcessInstance). ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [ProcessInstanceStepChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 58.0) Change events are available for the object. #### See Also - [ProcessInstance](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstance.htm "Represents an instance of a single, end-to-end approval process. Use this and the node, step, and workitem process instance objects to create approval history reports.") - [ProcessInstanceHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancehistory.htm "This read-only object shows all steps and pending approval requests associated with an approval process (ProcessInstance).") - [ProcessInstanceWorkitem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstanceworkitem.htm "Represents a user’s pending approval request.") # ProcessInstanceWorkitem Represents a user’s pending approval request. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Exceptions apply to approval history data retrieved with this object and are available only via SOAP API. For each approval process instance that was pending when Summer '14 became available for your organization, some field values are never populated or are populated only after the rollout. Other fields are populated only after the approval process instance is next acted upon—such as when a user approves, rejects, or reassigns an approval request—after the Summer '14 rollout. ProcessInstanceWorkitem fields are never populated for approval process instances that were completed before the Summer ’14 rollout. For approval process instances that were pending during the Summer ’14 rollout, all ProcessInstanceWorkitem fields are populated after the approval process instance is next acted upon after the Summer ’14 rollout, with three exceptions. The ElapsedTimeInDays, ElapsedTimeInHours, and ElapsedTimeInMinutes fields are never populated in ProcessInstanceWorkitem records for which equivalent ProcessInstanceStep records were created before the Summer ’14 rollout. For all other ProcessInstanceWorkitem records, these three fields are populated after the approval process instance is next acted upon after the Summer ’14 rollout. ProcessInstanceHistory combines fields from ProcessInstanceStep and ProcessInstanceWorkitem. As a result, incorrect elapsed times of 0 can appear in ProcessInstanceHistory records because the elapsed time fields were never populated in the related ProcessInstanceWorkitem record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Knowledge articles use ProcessInstanceWorkitem records to track the article history, so ProcessInstanceWorkitems records associated with Knowledge articles can’t be deleted. ## Supported Calls delete(), describeSObjects(), query(), retrieve(), update() ## Fields | Field | Details | | --- | --- | | ActorId | Type reference Properties Filter, Group, Sort, Update Description ID of the user responsible for approving an approval request. This field is a polymorphic relationship field. Relationship Name Actor Relationship Type Lookup Refers To Group, User | | ElapsedTimeInDays | Type double Properties Filter, Nillable, Sort Description The total time in days since this approval request was started. | | ElapsedTimeInHours | Type double Properties Filter, Nillable, Sort Description The total time in hours since this approval request was started. | | ElapsedTimeInMinutes | Type double Properties Filter, Nillable, Sort Description The total time in minutes since this approval request was started. | | OriginalActorId | Type reference Properties Filter, Group, Sort, Update Description ID of the user originally assigned this approval request. This field is a polymorphic relationship field. Relationship Name OriginalActor Relationship Type Lookup Refers To Group, User | | ProcessInstanceId | Type reference Properties Filter, Group, Sort, Update Description ID of the ProcessInstance associated with this approval request. This field is a relationship field. Relationship Name ProcessInstance Relationship Type Lookup Refers To ProcessInstance | ## Usage Use this object to manage a pending approval request for a user. #### See Also - [ProcessInstance](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstance.htm "Represents an instance of a single, end-to-end approval process. Use this and the node, step, and workitem process instance objects to create approval history reports.") - [ProcessInstanceHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancehistory.htm "This read-only object shows all steps and pending approval requests associated with an approval process (ProcessInstance).") - [ProcessInstanceStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancestep.htm "Represents one work item in an approval process (ProcessInstance).") # ProcessNode Describes a step in a process definition. Compare to ProcessInstanceNode, which describes a step in a running process. This object is available in API version 31.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Filter, Nillable, Sort Description A description of this node, no longer than 3,000 bytes. | | DeveloperName | Type string Properties Filter, Group, Sort Description The external name of the node that’s seen by users. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The unique node name. | | ProcessDefinitionId | Type reference Properties Filter, Group, Sort Description ID of the object affected by this approval instance. A relationship field. Relationship Name ProcessDefinition Relationship Type Lookup Refers To ProcessDefinition | ## Usage Use this object to get details about the process node or the process definition that it's associated with. # ProducerCommission Represents a producer's commission for an insurance policy. The commission can be calculated from the commissionable transactions or can be populated from an external system. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CommissionableAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The amount on which the commission is applied. This can be a transaction amount or a portion of the premium. | | CommissionAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The calculated commission amount for the insurance policy transaction. | | CommissionScheduleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the associated Commission Schedule, which is the commission calculation tied to the product or producer. This is a relationship field. Relationship Name CommissionSchedule Relationship Type Lookup Refers To CommissionSchedule | | InsurancePolicyAssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The insured item for which the commission was calculated. This is a relationship field. Relationship Name InsurancePolicyAsset Relationship Type Lookup Refers To InsurancePolicyAsset | | InsurancePolicyCoverageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the policy coverage for which the commission was calculated. This is a relationship field. Relationship Name InsurancePolicyCoverage Relationship Type Lookup Refers To InsurancePolicyCoverage | | InsurancePolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The insurance policy for which the commission was calculated. This is a relationship field. Relationship Name InsurancePolicy Relationship Type Lookup Refers To InsurancePolicy | | InsurancePolicyTransactionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The transaction for which the commission record was created. This is a relationship field. Relationship Name InsurancePolicyTransaction Relationship Type Lookup Refers To InsurancePolicyTransaction | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | MaxCommissionAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The maximum commission calculated for the product or producer for a commissionable event. Constrains the output from the commission schedule. | | MinCommissionAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The minimum commission calculated for the product or producer for a commissionable event. Constrains the output from the commission schedule. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the producer commission. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the record owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentProducerCommissionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The original commission record that was adjusted or modified. This is a relationship field. Relationship Name ParentProducerCommission Relationship Type Lookup Refers To ProducerCommission | | PaymentDatetime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the commission was paid. | | ProcessingProducerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The producer who performed the commissionable event. This is a relationship field. Relationship Name ProcessingProducer Relationship Type Lookup Refers To Producer | | ProducerId | Type reference Properties Create, Filter, Group, Sort, Update Description The producer, broker, brokerage, or other user who receives the commission. This is a polymorphic relationship field. Relationship Name Producer Relationship Type Lookup Refers To Account, Contact, Producer | | ProducerProductionCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The production code for the producer who performs the commissionable event. | | SourceSystem | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The system from which the producer commission record was sourced. | | SourceSystemIdentifier | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The ID of the producer commission record in the source system. This field is unique within your organization. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the status of the commission payment. Possible values are: - Disputed - Paid - Pending - Reversed | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of commission paid to a producer, account, or contact for a commissionable transaction. Possible values are: - Advance - Bonus - Chargeback - Commission - Contingent Commission | # Product2 Represents a product that your company sells. This object has several fields that are used only for quantity and revenue schedules (for example, annuities). Schedules are available only for orgs that have enabled the products and schedules features. If these features aren’t enabled, the schedule fields don’t appear, and you can’t query, create, or update the fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note As of API version 8.0, the Product object is no longer available. Requests that contain Product are refused, and responses don’t contain the Product object. Use the Products2 object instead. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The ConfigureDuringSale and IsSoldOnlyWithOtherProds fields are available in version 58.0 and later when Industry Automotive or Subscription Management is enabled. ## Fields | Field | Details | | --- | --- | | BillingPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related billing policy. This field is available when Subscription Management is enabled. This field is available in API version 55.0 and later. This field is a relationship field. Relationship Name BillingPolicy Relationship Type Lookup Refers To BillingPolicy | | CanUseQuantitySchedule | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the product can have a quantity schedule (true) or not (false). Label is **Quantity Scheduling Enabled**. | | CanUseRevenueSchedule | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the product can have a revenue schedule (true) or not (false). Label is **Revenue Scheduling Enabled**. | | ConnectionReceivedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your org. This field is available when Salesforce to Salesforce is enabled. | | ConnectionSentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that this record is shared with. This field is available Salesforce to Salesforce is enabled. In API version 16.0 and later, this value is null. Use PartnerNetworkRecordConnection object to forward records to connections. | | ConfigureDuringSale | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines whether a user can edit a configuration when creating a bundle order or quote. This field is available in API version 58.0 and later. This field is available when Industries Automotive or Subscription Management is enabled. Possible values are: - Allowed— Changes are allowed while adding line items to a bundle; for example, when adding products or editing quantity. - NotAllowed—Changes aren’t allowed. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the org. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A text description of this record. Label is **Product Description**. | | DisplayUrl | Type url Properties Create, Filter, Nillable, Sort, Update Description URL leading to a specific version of a record in the linked external data source. | | ExternalDataSourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the related external data source. | | ExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier of a record in the linked external data source. For example, ID #123. | | Family | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the product family associated with this record. Product families are configured as picklists in the user interface. To obtain a list of valid values, call describeSObjects() and process the result for the values associated with the Family field. Label is **Product Family**. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this record is active (true) or not (false). Inactive Product2 records are hidden in many areas in the user interface. You can change the IsActive flag on a Product2 object as often as necessary. Label is **Active**. | | IsArchived | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Describes whether the product is archived. The default value is false. | | IsAssetizable | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a product can be converted into an asset when a subscription order is placed. The default value is true. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsSerialized | Type boolean Properties Create, Filter, Group, Sort, Update Description Indicates if a product is a serialized product (true) or not (false). Label is **Serialized**. | | IsSoldOnlyWithOtherProds | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the product can be sold independently or only as part of a bundle. This field is available in API version 58.0 and later. This field is available when Industries Automotive or Subscription Management is enabled. The default value is false, which means that the product can be sold independently. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Default name of this record. Label is **Product Name**. | | NumberOfQuantityInstallments | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description If the product has a quantity schedule, the number of installments. | | NumberOfRevenueInstallments | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description If the product has a revenue schedule, the number of installments. | | ProductClass | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description This field is read-only. Its value is determined by the value of the Type field and whether the product is associated with a [ProductAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productattribute.htm "Represents the attributes that can be associated with a product. This object is available in API version 50.0 and later.") record. It describes whether a product is a bundle, set, or simple product, a variation parent, or a product variation. Possible values are: - Bundle—This product is a parent or component in a product bundle. - Set—This product is included in a product set. - Simple—This product has no variations - VariationParent—This product is a variation parent. It’s the base product for one or more product variations and, though it has its own stock-keeping unit (SKU), isn’t a sellable entity. Instead, it’s the parent of sellable entities—its variations. - Variation—This product is a variation of a parent product. Each variation has its own SKU. When the value of ProductClass = VariationParent, it never changes. The value of ProductClass changes between Simple and Variation when you attach or detach a [ProductAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productattribute.htm "Represents the attributes that can be associated with a product. This object is available in API version 50.0 and later.") record to the product. If you attach a [ProductAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productattribute.htm "Represents the attributes that can be associated with a product. This object is available in API version 50.0 and later.") record to a product, then the product’s ProductClass value changes to Variation. Conversely, when you detach all ProductAttribute records from a product, the ProductClass value changes to Simple. The default value is Simple. This field is available in API version 50.0 and later. It was introduced to support of B2B and B2C Commerce implementations. | | ProductCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Default product code for this record. Your org defines the product’s code-naming pattern. | | QuantityInstallmentPeriod | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If the product has a quantity schedule, the amount of time covered by the schedule. | | QuantityScheduleType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the quantity schedule, if the product has one. | | QuantityUnitOfMeasure | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Unit of the product; for example, kilograms, liters, or cases. This field comes with only one value, Each, so consider creating your own. The QuantityUnitOfMeasure field on ProductItem inherits this field’s values. | | RecalculateTotalPrice | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Changes behavior of OpportunityLineItem calculations when a line item has child schedule rows for the Quantity value. When enabled, if the rollup quantity changes, then the quantity rollup value is multiplied against the sales price to change the total price. | | RevenueInstallmentPeriod | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If the product has a revenue schedule, the time period covered by the schedule. | | RevenueScheduleType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the revenue schedule, if the product has one. | | StockCheckMethod | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The method for how a product's inventory is checked. Stock checks on parent products are common when bundles are prepackaged and individual child components can't be sold separately. Stock checks on child products are common when bundles aren't prepackaged and must be put together during fulfillment. If bundles aren’t prepackaged, child components can usually be sold separately. Possible values are: - Null—Check stock on the product SKU. - DoNotCheck —The stock shouldn't be check. - ParentProduct —If the product is a parent of a bundle, check stock on the parent product. - ChildProducts —If the product is a parent of a bundle, check stock on the child components. | | StockKeepingUnit | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The SKU for the product. Use in tandem with or instead of the ProductCode field. For example, you can track the manufacturer’s identifying code in the Product Code field and assign the product a SKU when you resell it. | | TaxPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related tax policy. This field is available when Subscription Management is enabled. This field is available in API version 55.0 and later. This field is a relationship field. Relationship Name TaxPolicy Relationship Type Lookup Refers To TaxPolicy | | TransferRecordMode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description If serialized, indicates when the serial number is recorded. This field is visible based on field-level security. The value affects the read-only value of the Product2TransferMode field on the ProductTransfer object. Possible values are: - SendAndReceive —The serial number is recorded when sending or receiving. - ReceiveOnly —The serial number is recorded when receiving only. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of product. This field's value affects the read-only value of the ProductClassfield on the Product2 object. The following mappings define how the Type selection updates the ProductClass. - Base—When Type = Base, then ProductClass = VariationParent. - Null—When Type = Null, then ProductClass = Simple for standalone products. - Null—When Type = Null, then ProductClass = Variation for variation products. - Bundle—When Type = Bundle, then ProductClass = Bundle. - Set—When Type = Set, then ProductClass = Set. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - Revenue Cloud doesn't support products with these specific combinations: Type = Base and ProductClass = VariationParent or Type = Null and ProductClass = Variation. - Values Null, Base, Bundle, and Set are available in environments where both Commerce and Revenue Cloud co-exist. - The Type field can only be updated from Null to Bundle for products with a Simple ProductClass This field is available when Revenue Cloud, B2B Commerce, B2C Commerce, or other clouds with PCM add-on is enabled. This field is available in API version 50.0 and later. | | UnitOfMeasureId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the unit of measure associated with the product. This field is a relationship field. This field is available when Revenue Cloud is enabled. This field is available in API version 63.0 and later. Relationship Name UnitOfMeasure Refers To UnitOfMeasure | ## Schedule Enabled Flags When enabling the schedules feature, you can decide whether to enable quantity schedules, revenue schedules, or both. In addition, you can use the API to control quantity and revenue scheduling at the product level via the CanUseQuantitySchedule and CanUseRevenueSchedule flags. A value of true for either flag indicates that the product and any OpportunityLineItems can have a schedule of that type. These flags can be set when creating or updating Product2 records. ## Default Schedule Fields The remaining schedule fields for this object define default schedules. Default schedule values are used to create an OpportunityLineItemSchedule when an OpportunityLineItem is created for the Product. The default schedule fields support the following valid values (all fields are also nillable). | Field | Valid Values | | --- | --- | | RevenueScheduleType | Divide, Repeat | | RevenueInstallmentPeriod | Daily, Weekly, Monthly, Quarterly, Yearly | | NumberOfRevenueInstallments | Integer from 1 to 150, inclusive. | | QuantityScheduleType | Divide, Repeat | | QuantityInstallmentPeriod | Daily, Weekly, Monthly, Quarterly, Yearly | | NumberOfQuantityInstallments | Integer from 1 to 150, inclusive | When you attempt to set the schedule fields when creating or updating, the API applies cross-field integrity checks. The integrity requirements are: - If the schedule type is nil, the installment period and number of installments must be nil. - If the schedule type is set to any value, then the installment period and number of installments must be non-nil. Any create or update that fails these integrity checks is rejected with an error. These default schedule fields, CanUseQuantitySchedule, and CanUseRevenueSchedule, are restricted picklist fields and are available only if the org has the schedules feature enabled. ## Usage Use this object to define the default product information for your org. This object is associated by reference with Pricebook2 objects via PricebookEntry objects. The same product can be represented in different price books as price book entries. In fact, the same product can be represented multiple times (as separate PricebookEntry records) in the same price book with different prices or currencies. A product can only have one price for a given currency within the same price book. To be used in custom price books, all standard prices must be added as price book entries to the standard price book. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Note: You can’t create lookup fields to Product2 object, which have **Required** check box set to true or the **Don't Allow Deletion**" radio button selected, as the platform would otherwise interpret this and throw an error that you cannot create a master-detail relationship to the object. You can query the products that have been configured for your org. For example, you can allow your client application to obtain valid product IDs for use when configuring PricebookEntry records via the API. Your client application can perform the following tasks on PricebookEntry objects: - Query - Create for the standard price book or custom price books. - Update - Delete - Change the IsActive field when creating or updating records This object is defined only for those orgs that have products enabled as a feature. If the org doesn’t have the products feature, this object doesn’t appear in the describeGlobal call, and you can't describe or query this object. If you try to delete a product via the API but there's an opportunity that uses that product, the delete fails. The workaround is to delete the product in the user interface, which gives you an option to archive the product. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note On opportunities and opportunity products, the workflow rules, validation rules, and Apex triggers fire when an update to a child opportunity product or schedule causes an update to the parent record. This means your custom application logic is enforced when there are updates to the parent record, ensuring higher data quality and compliance with your organization’s business policies. ## 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. [Product2ChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 44.0) Change events are available for the object. [Product2Feed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) (API version 18.0) Feed tracking is available for the object. [Product2History](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [Product2OwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) (API version 50.0) Sharing rules are available for the object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # Product2DataTranslation Represents the translated values of the data stored within a [Product2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_product2.htm "Represents a product that your company sells.") record’s fields. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules - Your organization must be using Enterprise, Performance, Unlimited, or Developer edition. - Translation Workbench and data translation must be enabled in your org. - To view this object, you must have the “View Setup and Configuration” permission ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The translated value for the Product2 description. | | IsOutOfDate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the translation is out-of-date (true) or current (false). A translation is out-of-date if the parent Product2 record is updated after the last translation was filed. | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language for these translated values. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The translated value for the Product2 record name. This field is required to translate the text in other fields. | | ParentId | Type reference Properties Create, Filter, Group, Sort, Update Description The record ID of the Product2 associated with the data that is being translated. | ## Usage Use this object to translate the data stored in a Product2 record into the different languages supported by Salesforce. If data translation is enabled for custom fields on the Product2 object, additional Product2DataTranslation fields exist for translating the data contained within those fields. You can’t use a custom external id field in an upsert call for a Product2DataTranslation object. # ProductAttribute Represents the attributes that can be associated with a product. This object is available in API version 50.0 and later. ## Supported Calls create, delete, describeLayout(), describeSObjects(), getDeleted, getUpdated, query(), retrieve(), undelete, update, upsert ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access products. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The default value is USD. Possible values are: - USD—U.S. Dollar | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the product attribute set. | | ProductId | Type reference Properties Create, Filter, Group, Sort Description The ID of the product that the attribute is associated with. This field is unique within your organization. | | Sequence | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The order that product attributes appear in. | | VariantParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the variation parent record associated with the product attribute. | ## 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. [ProductAttributeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. # ProductAttributeSet Represents a group of attributes that can be associated with a product. This object is available in API version 50.0 and later. ## Supported Calls create, delete, describeSObjects(), query(), retrieve(), update, upsert ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access products. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the product attribute set. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: - da—Danish - de—German - en\_US—English - esSpanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label of the product attribute set. | # ProductAttributeSetItem Represents a set of attributes that can be associated with a product. This object is available in API version 50.0 and later. ## Supported Calls create, delete, describeSObjects(), query(), retrieve(), update, upsert ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access products. ## Fields | Field | Details | | --- | --- | | Field | Type reference Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The field’s API name. | | FieldApiName | Type string Properties Filter, Sort Description A derived field whose values comes from CustomFieldDefinition object. | | IsGroupedBy | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if product variations are grouped by a specific attribute. This field is available in API version 64.0 and later. | | ProductAttributeSetId | Type reference Properties Create, Filter, Group, Sort Description The ID of the product attribute set. | | Sequence | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The order that product attributes appear in. | # ProductAttributeSetProduct Represents the product associated with a set of attributes. This object is available in API version 50.0 and later. ## Supported Calls create, delete, describeLayout(), describeSObjects(), getDeleted, getUpdated, query(), retrieve(), undelete, update, upsert ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access products. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The default value is USD. Possible values are: - USD—U.S. Dollar | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the product associated with the product attribute set. | | ProductAttributeSetId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the product attribute set. | | ProductId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the product associated with the product attribute set. | # ProductCatalog The container that holds a Product Category hierarchy. 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 You must have the Industries, Retail, or B2B Commerce license. ## Fields | Field | Details | | --- | --- | | CatalogCode | Type text Properties Create, Filter, Nillable, Sort, Update Description A unique ID associated with the catalog. Maximum size is 80 alphanumeric characters. | | CatalogType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The category of an entry in the catalog. Possible values are: - Sales - ServiceProcess—Service Process The default value is Sales. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: - EUR—Euro - USD—U.S. Dollar The default value is USD. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the category. | | EffectiveEndDate | Type dateTime Properties Filter, Nillable, Sort Description The date after which the catalog is unavailable to end users. | | EffectiveStartDate | Type dateTime Properties Filter, Nillable, Sort Description The date on which the catalog is available to end users. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the ProductCatlog record. | | NumberOfCategories | Type int Properties Filter, Group, Nillable, Sort Description Number of ProductCategory records assigned to this ProductCatalog record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The lifecycle state of the catalog. Possible values include: Draft, Active, Inactive | # ProductCategory Represents the category that products are organized in.This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access product media. ## Fields | Field | Details | | --- | --- | | CatalogId | Type reference Properties Create, Filter, Group, Sort Description The ID of the catalog. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The default value is USD. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the category. | | IsNavigational | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The default value is true. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the category. | | NumberOfProducts | Type int Properties Filter, Group, Nillable, Sort Description The number of products in a category. | | ParentCategoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the product’s parent category. Relationship Name ParentCategory Relationship Type Lookup Refers To ProductCategory | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Order that the category is displayed in. | ## 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. [ProductCategoryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. # ProductCategoryDataTranslation Represents the translated values for the data stored within a [ProductCategory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productcategory.htm "Represents the category that products are organized in.This object is available in API version 49.0 and later.") record’s fields. This object is available in API version 46.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules - Your organization must be using Enterprise, Performance, Unlimited, or Developer edition. - Translation Workbench and data translation must be enabled in your org. - To view this object, you must have the “View Setup and Configuration” permission ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The translated value for the Product Category description. | | IsOutOfDate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the translation is out-of-date (true) or current (false). A translation is out-of-date if the parent ProductCategory record is updated after the last translation was filed. | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language for these translated values. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The translated value for the Product Category name. | | ParentId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the category being translated. | ## Usage Use this object to translate the data stored in a Product Category record into the different languages supported by Salesforce. If data translation is enabled for custom fields on the ProductCategory object, additional ProductCategoryDataTranslation fields exist for translating the data contained within those fields. # ProductCategoryProduct Holds the relation between product and product category to assign products to a category. 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 You must have the Industries, Retail, or B2B Commerce license. ## Fields | Field | Details | | --- | --- | | Catalog | Type reference Properties Filter, Group, Sort Description The foreign key to the ProductCatalog ID of the Category. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: - EUR—Euro - USD—U.S. Dollar The default value is USD. | | EffectiveEndDate | Type dateTime Properties Filter, Nillable, Sort Description The date after which the catalog is unavailable to end users. | | EffectiveStartDate | Type dateTime Properties Filter, Nillable, Sort Description The date on which the catalog is available to end users. | | IsPrimaryCategory | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the ProductCategory is the primaryProductCategory for a given product in a ProductCatalog. The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the ProductCategoryProduct record. | | ProductCategory | Type reference Properties Create, Filter, Group, Sort Description Foreign key to the ProductCategory ID. | | Product | Type reference Properties Create, Filter, Group, Sort Description ID of the product. | | ProductToCategory | Type string Properties Filter, Group, Sort Description Concatenated Product ID and Category ID. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The lifecycle state of the catalog. Possible values include: Draft, Active, Inactive | ## 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. [ProductCategoryProductEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. # ProductComponentGroup Represents the logical grouping of associated products in a bundle and the products’ arrangement policy (group cardinality). This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available when Industries EPC or Subscription Management is enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description Describes the group items of a product bundle feature. For example, a group’s contents can be the associated products that accompany a main product in a bundle. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a related record or a list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user indirectly accessed this record (LastReferencedDate), but not viewed it. | | MaxBundleComponents | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of associated products allowed in a group. | | MinBundleComponents | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The minimum number of associated products allowed in a group. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the product component group. Maximum length is 255 characters (of any type). | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The unique identifier of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentProductId | Type reference Properties Create, Filter, Group, Sort Description The unique identifier associated with the main product record. This field is a relationship field. Relationship Name ParentProduct Relationship Type Lookup Refers To Product2 | | Sequence | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Determines the arrangement of the order products when configuring a bundle or set. | # ProductConsumed Represents an item from your inventory that was used to complete a work order or work order line item in field service. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To create products consumed, you need Read permission on product items. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To delete or undelete product consumed for non-serialized products, you need Edit, Create, and Read permission on product consumed. For product consumed records that lookup to serialized products, you need Modify All Data or Modify All Records permission on product consumed. ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description Notes and context about the product consumed. | | IsConsumed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that a product consumed has been processed if the Product2 it refers to has IsSerialized=true selected. The default is false. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the product consumed record is locked or not. The default value is false. | | IsProduct2Serialized | Type boolean Properties Create, Filter, Nillable, Sort, Update Description Indicates if a product is a serialized product. The default is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product consumed was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product consumed was last viewed. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the product consumed record can be edited or not. The default value is false. | | PricebookEntryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Price book associated with the product consumed. If the work order and the product item’s associated product are related to the same price book, the Price Book Entry auto-populates based on the product item. | | Product2Id | Type reference Properties Filter, Group, Nillable, Sort Description Product associated with the product consumed. | | ProductConsumedNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description (Read Only) Auto-generated number identifying the product consumed. | | ProductItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Product item associated with the product consumed. Creating a product consumed record subtracts the quantity consumed from the linked product item’s quantity. | | ProductName | Type string Properties Filter, Group, Nillable, Sort Description Name for the product consumed. | | QuantityConsumed | Type double Properties Create, Filter, Sort, Update Description The quantity of products consumed. | | QuantityUnitOfMeasure | Type picklist Properties Filter, Group, Nillable, Sort Description Units of the consumed item; for example, kilograms or liters. Quantity Unit of Measure picklist values are inherited from the Quantity Unit of Measure field on products. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description The total price paid for the product items. | | UnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The price per unit of the product consumed. | | WorkOrderId | Type reference Properties Create, Filter, Group, Sort Description Work order that the product was consumed for. | | WorkOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Work order line item that the product was consumed for. | ## Usage When a product is consumed during the completion of a work order, create a product consumed record to track its consumption. You can add products consumed to work orders or work order line items. Track product consumption at the line item level if you want to know which products were used for each line item’s tasks. The way you use products consumed depends on how closely you want to track the state of your inventory in Salesforce. If you want to track the entire lifecycle of items in your inventory, including their storage, transfer, and consumption, link your products consumed records to product items. This approach ensures that your inventory numbers auto-update to reflect the consumption of products from your inventory. If you want to track product consumption only, however, specify a Price Book Entry on each product consumed record and leave the Product Item field blank. ## 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. [ProductConsumedChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ProductConsumedFeed](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. [ProductConsumedHistory](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. # ProductConsumedState Represents the status of an item from your inventory that was used to complete a work order or work order line item in Field Service. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To create products consumed, you need Read permission on product items. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To delete products consumed, you need Edit, Create, and Read permission on product items. ## Fields | Field | Details | | --- | --- | | ConsumedState | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The new state of the serialized product after it’s consumed | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the product consumed record is locked or not. The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the product consumed record can be edited or not. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the product. | | ProductConsumedId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The Product Consumed that is used for consuming the serialized products Relationship Name Owner Relationship Type Lookup | | SerializedProductId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The serialized product being consumed. Relationship Name Owner Relationship Type Lookup | ## 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 ProductConsumedState. [Product Consumed State History](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. # ProductDetectedPriceChange Represents a detected change in price for a product associated with a partner account. This object is available in API version 63.0 and later. A ProductDetectedPriceChange record is automatically created when the system identifies a change in product pricing that can require price protection evaluation or further processing. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the partner account for which the price change was detected. This field is a relationship field. Relationship Name Account Refers To Account | | EffectiveDate | Type date Properties Create, Filter, Group, Sort, Update Description Date when the new price becomes effective for the product. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the record was last referenced by the current user. Useful for activity tracking. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and the timestamp the record was last referenced by a user or system process. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Unique name or identifier for the price change record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description User or group that owns this record. This is a polymorphic relationship field. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ProcessingStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the current processing stage of the price change. Possible values are: - Completed - Inactive - New - Processing—In Progress | | ProductId | Type reference Properties Create, Filter, Group, Sort, Update Description References the product for which the price change was detected. This field is a relationship field. Relationship Name Product Refers To Product2 | # ProductEntitlementTemplate Represents predefined terms of customer support (Entitlement) that users can add to products (Product2). ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only Salesforce admins, users with access to the Case, Entitlement, or Work Order objects, and users with the View Setup and Configuration permission can access this object. ## Fields | Field | Details | | --- | --- | | EntitlementTemplateId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the entitlement template. Must be a valid ID. | | Product2Id | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Product2 associated with the entitlement template. Must be a valid ID. | ## Usage Use to query and manage entitlement templates. #### See Also - [Entitlement](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entitlement.htm "Represents the customer support an account or contact is eligible to receive. This object is available in API version 18.0 and later. Entitlements may be based on an asset, product, or service contract.") # ProductFeaturedProduct Represents the user-defined collection of featured products that are meant to cross-sell or upsell with your product. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | FeatrProdtRelaType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines how the featured product is related to the product. Possible values are: - Complete the Look - Featured Products - New Arrivals - Top Seller | | FeaturedProductId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the featured product that is linked to the product. This field is a relationship field. Relationship Name FeaturedProduct Refers To Product2 | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the user-defined collection of featured products. | | ProductId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the product that your company sells. This field is a relationship field. Relationship Name Product Refers To Product2 | | Sequence | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Defines the order in which featured products are displayed. | ## 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. [ProductFeaturedProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # ProductItem Represents the stock of a particular product at a particular location in field service, such as all bolts stored in your main warehouse. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product item was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product item was last viewed. | | LocationId | Type reference Properties Create, Filter, Group, Sort Description Location associated with the product item. This usually indicates where the product item is stored. This is a relationship field. Relationship Name Location Relationship Type Lookup Refers To Location | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The product item’s owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Product2Id | Type reference Properties Create, Filter, Group, Sort Description Product associated with the product item, which represents the type of product in your inventory. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read Only) Auto-generated number identifying the product item. | | ProductName | Type string Properties Filter, Group, Nillable, Sort Description A name for the product item. Try to select a name that indicates what is being stored where; for example, Batteries in Warehouse A. | | QuantityOnHand | Type double Properties Create, Filter, Sort, Update Description The quantity at the location. If you want to add a serial number, this value must be 1. | | QuantityUnitOfMeasure | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Units of the product item; for example, kilograms or liters. Quantity Unit of Measure picklist values are inherited from the Quantity Unit of Measure field on products. | | SerialNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique number for identification purposes. If you want to enter a serial number, the Quantity on Hand must be 1. | ## Usage Each product item is associated with a product and a location in Salesforce. If a product is stored at multiple locations, the product will be tracked in a different product item for each location. ## 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. [ProductItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ProductItemFeed](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. [ProductItemHistory](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. [ProductItemOwnerSharingRule](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. [ProductItemShare](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. # ProductItemTransaction Represents an action taken on a product item in field service. Product item transactions are auto-generated records that help you track when a product item is replenished, consumed, or adjusted. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), undelete(), upsert() ## Special Access Rules - Field Service must be enabled. - Only users with Modify All Data or Modify All Records permissions can delete this object. ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description A description of the transaction. The description is blank when the transaction record is created, but can be updated. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | ProductItemId | Type reference Properties Create, Filter, Group, Sort Description The associated product item. This is a relationship field. Relationship Name ProductItem Relationship Type Lookup Refers To ProductItem | | ProductItemTransactionNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read Only) Auto-generated number identifying the product item transaction. | | Quantity | Type double Properties Create, Filter, Sort Description The quantity of the product item involved in the transaction. If inventory was consumed, the quantity is negative. | | RelatedRecordId | Type reference Properties Filter, Group, Nillable, Sort Description (Read Only) The product consumed or product transfer related to the action. If the action wasn’t related to consumption or transfer, the related record is blank. This is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To ProductTransfer, Visit | | TransactionType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The action that the transaction tracks. - Replenished: When a part is stocked at a location. A Replenished transaction is created when a product item is created. - Consumed: When parts are consumed to complete a work order. A Consumed transaction is created when a record is added to the Products Consumed related list on a work order or work order line item. - Adjusted: When there’s a discrepancy or a change in consumption. An Adjusted transaction is created when a product item’s Quantity on Hand is edited, a product consumed is updated or delete, or a product transfer is deleted. - Transferred: When parts are transferred between locations. | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [ProductItemTransactionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProductItemTransactionFeed](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. [ProductItemTransactionHistory](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. # ProductMedia Represents the rich media, including images and attachments, that can be added to products.This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access product media. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The default value is USD. Possible values are: - USD—U.S. Dollar | | ElectronicMediaGroupId | Type reference Properties Create, Filter, Group, Sort, Update Description Unique ID of the media group. This field is a relationship field. Relationship Name ElectronicMediaGroup Relationship Type Lookup Refers To ElectronicMediaGroup | | ElectronicMediaId | Type reference Properties Create, Filter, Group, Sort, Update Description Unique ID of the media record. This field is a polymorphic relationship field. Relationship Name ElectronicMedia Relationship Type Lookup Refers To ManagedContent, ManagedContentInfo | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the media. | | ProductId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the product that the media is associated with. This field is a relationship field. Relationship Name Product Relationship Type Lookup Refers To Product2 | | SortOrder | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The order that product media is displayed in. | ## Associated Objects [ProductMediaChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 57.0) Change events are available for the object. [ProductMediaHistory](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. [ProductMediaOwnerSharingRule](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. [ProductMediaShare](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. # ProductQuantityRule Represents the relationship between a quantity rule and a product. This object assigns quantity rules to a product. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The ProductQuantityRule object is available only if the B2B Commerce license or Automotive Cloud license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. This field is exposed in orgs that have multicurrency enabled. Default value is USD. Possible values are: - EUR—Euro - USD—U.S. Dollar | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the product quantity rule. | | ProductId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the product. This field is a relationship field. Relationship Name Product Relationship Type Lookup Refers To Product2 | | PurchaseQuantityRuleId | Type reference Properties Create, Filter, Group, Sort Description ID of the related purchase quantity rule. This field is a relationship field. Relationship Name PurchaseQuantityRule Relationship Type Lookup Refers To PurchaseQuantityRule | # ProductRelatedComponent Represents a product that is included in a product bundle, a set, or a product and an add-on. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules In version 58.0 and later, this object is available when B2B Commerce, B2C Commerce, Industries Automotive, Industries EPC, or Subscription Management is enabled. In version 57.0, this object is available when B2B Commerce, B2C Commerce, or Industries Automotive is enabled. ## Fields | | Details | | --- | --- | | ChildProductId | Type reference Properties Create, Filter, Group, Sort Description The unique identifier of the associated product. This field is a relationship field. In a bundle relationship, this item is the child product. Relationship Name ChildProduct Relationship Type Lookup Refers To Product2 | | ChildProductRole | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The position of the associated product in the relationship. Possible values are: - AddOnComponent—The child product is an add-on to another product. Available in API version 58.0 and later. - BundleComponent—The child product is a component in a bundle. - SetComponent—The child product is a component in a set. | | ChildSellingModelId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier of the associated product’s sales model. This field is a relationship field. Relationship Name ChildSellingModel Relationship Type Lookup Refers To ProductSellingModel | | DoesBundlePriceIncludeChild | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the bundle price includes the associated product’s price. | | IsComponentRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the associated product is required for configuring a bundle or set. The default value is false. | | IsDefaultComponent | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the associated product is part of the product bundle or set automatically, or can be added after the bundle’s or set’s creation. The default value is false. | | IsQuantityEditable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether you can edit the component’s quantity in the bundle or set after the bundle’s or set’s creation. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user accessed this record or list view (LastReferencedDate) without viewing it. | | MaxQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description The associated product’s allowed maximum quantity. | | MinQuantity | Type double Properties Create, Filter, Nillable, Sort, Update Description The associated product’s allowed minimum quantity. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the associated product. | | ParentProductId | Type reference Properties Create, Filter, Group, Sort Description The unique identifier of the main product around which the bundle or set is built. This field is a relationship field. Relationship Name ParentProduct Relationship Type Lookup Refers To Product2 | | ParentProductRole | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates the position of the main product in the relationship. Possible values are: - AddOn—The main product is the add-on parent. Available in API version 58.0 and later. - Bundle—The main product is the bundle parent. - Set— The main product is the set parent. | | ParentSellingModelId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The unique identifier of the main product’s sales model. This field is a relationship field. Relationship Name ParentSellingModel Relationship Type Lookup Refers To ProductSellingModel | | ProductComponentGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier of the group of a product bundle or set. This group contains the associated products that can be included in the main product’s bundle or set. This field is a relationship field. Relationship Name ProductComponentGroup Relationship Type Lookup Refers To ProductComponentGroup | | ProductRelationshipTypeId | Type reference Properties Create, Filter, Group, Sort, Update Description The unique identifier of the record that describes the relationship between the main and associated products. This field is a relationship field. Relationship Name ProductRelationshipType Relationship Type Lookup Refers To ProductRelationshipType | | Quantity | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The unit count of the associated product. | | QuantityScaleMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The scaling method is used to calculate the associated product’s quantity based on changes made to the main product’s quantity in a transaction. Possible values are: - Constant — The associated product’s quantity remains the same in relation to the main product’s quantity. For example, the main product has a quantity of one and the associated component has a quantity of one. If you increase the quantity of the main product to two, the associated component’s quantity remains at one. - Proportional — The associated product’s quantity increases or decreases based on the main product’s quantity. For example, the main component has a quantity of one and the associated product has a quantity of two. If you increase the quantity of the main product to two, the associated product’s quantity increases to four. The default value is Proportional. | | Sequence | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Determines the arrangement of the order products when configuring a bundle or set. | # ProductRelationshipType Defines the relationship between two sales transaction items. For example, defines a relationship between a bundle and a bundle component. This object is available in API version 57.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules In version 58.0 and later, this object is available when B2B Commerce, B2C Commerce, or Subscription Management is enabled. In version 57.0, this object is available when B2B Commerce or B2C Commerce is enabled. ## Fields | Field | Details | | --- | --- | | AssociatedProductRoleCat | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The position category that the associated product plays in the relationship. Possible values are: - AddOnComponent—The associated product is an add-on. - BundleComponent — The associated product is part of a bundle. - SetComponent — The associated product is part of a set. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | MainProductRoleCat | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The position category that the main product plays in the relationship. Possible values are: - AddOn—The parent of the add-on. - Bundle—The bundle parent. - Set—The set parent. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the relationship between two product items. | # ProductRequest Represents an order for a part or parts in field service. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. Authenticated external users can create and update ProductRequest objects. ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the product request. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | CaseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the product request. This is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. The label in the user interface is Currency ISO Code. | | Description | Type textarea Properties Create, Nillable, Update Description A text field for details not recorded in the provided fields. | | DestinationLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Where the product is delivered. This is a relationship field. Relationship Name DestinationLocation Relationship Type Lookup Refers To Location | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product request was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product request was last viewed. | | NeedByDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product must be delivered by. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the shipment. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ProductRequestNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-assigned number that identifies the shipment. | | ShipToAddress | Type address Properties Filter, Nillable Description The address that the product is to be delivered to. | | ShipToCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city that the product is to be delivered to. | | ShipToCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country that the product is to be delivered to. | | ShipToCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description A two letter uppercase country code conforming to the ISO 3166-1 alpha-2 standard. | | ShipToGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The accuracy of the geocode for the shipping address. | | ShipToLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude of the location where the product is to be delivered to. | | ShipToLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude of the location where the product is to be delivered to. | | ShipToPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the product is to be delivered to. | | ShipToState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the state where the product is to be delivered to. | | ShipToStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description A two letter uppercase state code conforming to the ISO 3166-1 alpha-2 standard. | | ShipToStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street address where the product is to be delivered to. | | ShipmentType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of shipment. The picklist includes the following values by default: - None - Rush - Overnight - Next Business Day - Pick Up | | SourceLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location the product is shipped from. This is a relationship field. Relationship Name SourceLocation Relationship Type Lookup Refers To Location | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status of the product transfer. | | WorkOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order that the product request is related to. This is a relationship field. Relationship Name WorkOrder Relationship Type Lookup Refers To WorkOrder | | WorkOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order line item that the product request is related to. This is a relationship field. Relationship Name WorkOrderLineItem Relationship Type Lookup Refers To WorkOrderLineItem | ## 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. [ProductRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ProductRequestFeed](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. [ProductRequestHistory](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. [ProductRequestOwnerSharingRule](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. [ProductRequestShare](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. # ProductRequestLineItem Represents a request for a part in field service. Product request line items are components of product requests. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. You can't use product request line item as a master in an master detail relationship (through a custom field) with a custom object with data. ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the product request line item. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | CareProgramEnrolleeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the care program enrollee associated with the product request line item. This field is available from API version 49.0 and later. This is a relationship field. Relationship Name CareProgramEnrollee Relationship Type Lookup Refers To CareProgramEnrollee | | CaseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the product request line item. This is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | Description | Type textarea Properties Create, Nillable, Update Description Details not recorded in the provided fields. | | DestinationLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Where the product is delivered. This is a relationship field. Relationship Name DestinationLocation Relationship Type Lookup Refers To Location | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | NeedByDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product must be delivered by. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The product request that the line item belongs to. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To ProductRequest | | Product2Id | Type reference Properties Create, Filter, Group, Sort, Update Description The product associated with the product request line item. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductRequestLineItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read Only) An auto-assigned number that identifies the product request line item. | | QuantityRequested | Type double Properties Create, Filter, Sort, Update Description The amount requested. | | QuantityUnitOfMeasure | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Units of the requested product; for example, grams, liters, or units. The picklist values can be customized. | | ShipToAddress | Type address Properties Filter, Nillable Description The physical address where the product is needed. | | ShipToCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address where the product is needed. | | ShipToCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address where the product is needed. | | ShipToGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address where the product is needed. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. This field is available in the API only. | | ShipToLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the product is needed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. This field is available in the API only. | | ShipToLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the product is needed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. This field is available in the API only. | | ShipToPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the product is needed. | | ShipToState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address where the product is needed. | | ShipToStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the address where the product is needed. | | ShipmentType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of shipment. The picklist includes the following values, which can be customized: - Rush - Overnight - Next Business Day - Pick Up | | SourceLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Where the product is at the time of the request. This is a relationship field. Relationship Name SourceLocation Relationship Type Lookup Refers To Location | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the shipment. The picklist includes the following values, which can be customized: - Draft - Submitted - Received | | WorkOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order for which the product is needed. This is a relationship field. Relationship Name WorkOrder Relationship Type Lookup Refers To WorkOrder | | WorkOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order line item for which the product is needed. This is a relationship field. Relationship Name WorkOrderLineItem Relationship Type Lookup Refers To WorkOrderLineItem | ## 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. [ProductRequestLineItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ProductRequestLineItemFeed](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. [ProductRequestLineItemHistory](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. # ProductRequired Represents a product that is needed to complete a work order or work order line item in field service. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product required was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product required was last viewed. | | ParentRecordId | Type reference Properties Create, Filter, Group, Sort Description The work order or work order line item that the product is required for. This is a polymorphic relationship field. Relationship Name ParentRecord Relationship Type Lookup Refers To Visit, WorkOrder, WorkOrderLineItem, WorkType | | ParentRecordType | Type string Properties Filter, Group, Nillable, Sort Description Indicates whether the parent record is a work order or a work order line item. | | Product2Id | Type reference Properties Create, Filter, Group, Sort, Update Description The required product. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductName | Type string Properties Filter, Group, Nillable, Sort Description The name of the product required. | | ProductRequiredNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read only) Auto-generated number identifying the product required. | | QuantityRequired | Type double Properties Create, Filter, Nillable, Sort, Update Description Quantity required of the product. | | QuantityUnitOfMeasure | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Units of the required product; for example, kilograms or liters. Quantity Unit of Measure picklist values are inherited from the Quantity Unit of Measure field on products. | ## Usage Required products can be added to work types, work orders, and work order line items to ensure that the assigned service resource arrives with the right equipment. Adding required products to work types saves you time and keeps your business processes consistent. Work orders and work order line items inherit their work type’s required products. For example, if all light bulb replacement jobs require a ladder and a light bulb, add the ladder and light bulb as required products to your Light Bulb Replacement work type. When it’s time to create a work order for a customer’s light bulb replacement, applying that work type to the work order adds the required products. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProductRequiredChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProductRequiredFeed](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. [ProductRequiredHistory](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. # ProductSellingModel Defines one method by which a product can be sold; for example, as a one-time sale, an evergreen subscription, or a term-defined subscription. If the product is sold on subscription, this object defines the subscription’s term. A product can have multiple product selling models. 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 This object is available with Revenue Cloud and Subscription Management. This object is available for Commerce when the Subscriptions (Beta) permission is enabled. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name given to the product selling model. | | PricingTerm | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the duration of the pricing term for a given selling model. Used with PricingTermUnit. For example, if this field’s value is 1 and the PricingTermUnit is Months, the subscription is priced monthly. If the selling model is one-time, this field must be null. Possible value is: - 1 | | PricingTermUnit | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of time used to define the pricing term. Used with PricingTerm to define the length of the pricing term. For example, if this field is Months and PricingTerm is 1, the subscription is priced monthly. If the selling model is one-time, this field must be null. Possible values are: - Annual—UI label is Years - Months | | SellingModelType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the product is sold as a one-time sale, an evergreen subscription, or a subscription with a defined term. Possible values are: - Evergreen—A subscription without an end date. An evergreen subscription continues until the customer affirmatively cancels it. - OneTime—A product that isn’t sold as a subscription. - TermDefined—A subscription with a defined end date. The subscription continues for a specified time period. When the term ends, the subscription ends. The default value is OneTime. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The status of the product selling model. Possible values are: - Active—An active product selling model can’t be deleted, and only the Name and Status fields can be modified. An active product selling model can’t be changed back to draft. - Draft—A draft product selling model can be modified and deleted. - Inactive—An inactive product selling model can’t be deleted, and only the Name and Status fields can be modified. An inactive product selling model can’t be changed back to draft. The default value is Draft. | # ProductSellingModelOption A junction object between Product Selling Model and Product2. 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 This object is available when Subscription Management or Commerce Subscriptions is enabled. Some fields require Industries EPC to be enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the product selling model option. | | DisplayName | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the product selling model option to display to customers. | | Increment | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of pricing term units that can be used to increase a subscription term. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indcates the default product selling model for a product. Setting a default is optional. A product can only have one default product selling model. The default value is false. This field requires Industries EPC. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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 but not viewed it. | | Maximum | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of pricing term units for a subscription term. | | Minimum | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The minimum number of pricing term units for a subscription term. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the product selling model. | | Product2Id | Type reference Properties Create, Filter, Group, Sort Description The ID of the Product2 record associated with this ProductSellingModelOption record. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductSellingModelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the ProductSellingModel record associated with this ProductSellingModelOption record. This is a relationship field. Relationship Name ProductSellingModel Relationship Type Lookup Refers To ProductSellingModel | | ProrationPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the ProrationPolicy record associated with this ProductSellingModelOption record. This is a relationship field. Relationship Name ProrationPolicy Relationship Type Lookup Refers To ProrationPolicy | # ProductServiceCampaign Represents a set of activities to be performed on a product service campaign asset, such as a product recall for safety issues or product defects. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description Description of the product service campaign. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which the product service campaign ends. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the asset was last modified. The UI label is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the asset was last viewed. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The product service campaign’s owner. By default, the product service campaign owner is the user who created the product service campaign record. The UI label is Product Service Campaign Owner. | | Priority | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The priority of the product service campaign. Possible values are: - Critical - High - Low - Medium | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Product2 associated with this campaign. The UI label is Product. | | ProductServiceCampaignName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the product service campaign. | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description The date on which the product service campaign starts. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The status of the product service campaign. The picklist includes the following values, which can be customized: - New—Product service campaign created, but there hasn’t yet been any activity. - In Progress—Product service campaign has begun. - On Hold—Work is paused. - Completed—Work is complete. - Cannot Complete—Work couldn’t be completed. - Closed—All work and associated activity is complete. - Canceled—Work is canceled, typically before any work began. | | StatusCategory | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each Status value falls into. The StatusCategory field has eight default values: seven values that are identical to the default Status values, and None for statuses without a status category. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Waiting for Response value, add it the On Hold category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) | | Type | Type picklist Properties Create, Filter, Group, Sort, Update Description The type of the product service campaign. The picklist includes the following values, which can be customized: - Modification—The asset requires an on-site alteration. - Recall—The asset must be returned to the manufacturer for modification or upgrade. - Service—The asset needs to be serviced. - Upgrade—The asset needs updating. | | WorkTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work type associated with the product service campaign. A customer uses this field as a guide when setting work type for work orders for the product service campaign. Duration, Duration Type, and required skills. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProductServiceCampaignFeed](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. [ProductServiceCampaignHistory](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. [ProductServiceCampaignOwnerSharingRule](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. [ProductServiceCampaignShare](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. # ProductServiceCampaignItem Represents a product service campaign's asset. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset associated with the product service campaign. Must be present if Product2Id is not present. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the asset was last modified. Its UI label is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the asset was last viewed. | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Product2 associated with this campaign. The UI label is Product. Must be present if AssetID is not present. | | ProductServiceCampaignId | Type reference Properties Create, Filter, Group, Sort Description Required. The item’s parent product service campaign record. | | ProductServiceCampaignItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The ID of the product service campaign item. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The status of the product service campaign item. The picklist includes the following values, which can be customized: - New—Product service campaign item created, but there hasn’t yet been any activity. - In Progress—Product service campaign item has begun. - On Hold—Product service campaign item is paused. - Completed—Product service campaign item is complete. - Cannot Complete—Product service campaign item couldn’t be completed. - Closed—All product service campaign item and associated activity is complete. - Canceled—Product service campaign item is canceled, typically before any work began. | | StatusCategory | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each Status value falls into. The StatusCategory field has eight default values: seven values that are identical to the default Status values, and None for statuses without a status category. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Waiting for Response value, add it to the On Hold category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProductServiceCampaignItemFeed](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. [ProductServiceCampaignItemHistory](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. [ProductServiceCampaignItemOwnerSharingRule](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. [ProductServiceCampaignItemShare](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. # ProductServiceCampaignItemStatus Represents a status for a product service campaign item in field service. This object is available in API version 51.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description The API name of the status value. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the status value is the default status on product service campaign items when true. Only one status value can be the default. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The label for the picklist value in the UI. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description The value’s position in the dropdown list in the UI. | | StatusCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status category that the value corresponds to. The Status Category field has seven values that are identical to the default Status values. | ## Usage The Status field on product service campaign items comes with the following values: - New—Product service campaign item created, but there hasn’t been any activity. - In Progress—Work has begun. - On Hold—Work is paused. - Completed—Work is complete. - Cannot Complete—Work couldn’t be completed. - Closed—All work and associated activity is complete. - Canceled—Work is canceled, typically before any work began. The ProductServiceCampaignItemStatus object corresponds to the Status field. Adding a value to the Status field—for example, Canceled By Supplier—creates a product service campaign item status record, and vice versa. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Product service campaign items also come with a Status Category field whose values are identical to the default status values. If you create custom status values, you must indicate which category it belongs to. For example, if you create a Customer Absent value, add it to the Cannot Complete category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) # ProductServiceCampaignStatus Represents a status for a product service campaign in field service. This object is available in API version 51.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description The API name of the status value. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the status value is the default status on product service campaigns when true. Only one status value can be the default. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The label for the picklist value in the UI. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description The value’s position in the dropdown list in the UI. | | StatusCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status category that the value corresponds to. The Status Category field has seven values that are identical to the default Status values. | ## Usage The Status field on product service campaigns comes with the following values: - New—Product service campaign created, but there hasn’t been any activity. - In Progress—Work has begun. - On Hold—Work is paused. - Completed—Work is complete. - Cannot Complete—Work couldn’t be completed. - Closed—All work and associated activity is complete. - Canceled—Work is canceled, typically before any work began. The ProductServiceCampaignStatus object corresponds to the Status field. Adding a value to the Status field—for example, Canceled By Supplier—creates a product service campaign status record, and vice versa. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Product service campaigns also come with a Status Category field whose values are identical to the default status values. If you create custom status values, you must indicate which category it belongs to. For example, if you create a Customer Absent value, add it to the Cannot Complete category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) # ProductTransfer Represents the transfer of inventory between locations in field service. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description Details not recorded in the provided fields. | | DestinationLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The place the product is to be delivered. This is a relationship field. Relationship Name DestinationLocation Relationship Type Lookup Refers To Location | | ExpectedPickupDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product is expected to be picked up. | | IsReceived | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Checkbox identifying that the product was received. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product request was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product request was last viewed. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Owner of the product transfer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the product associated with the product transfer. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | Product2TransferRecordMode | Type reference Properties Filter, Group, Nillable, Sort Description If serialized, indicates when the serial number is recorded. It is visible on the product transfer as a read-only field depending on the field-level security. Possible values are: - SendAndReceive —The serial number is recorded when sending or receiving. - ReceiveOnly —The serial number is recorded when receiving only. Relationship Name Product2.TransferRecordMode Relationship Type Lookup Refers To Product2.TransferRecordMode | | ProductRequestId | Type reference Properties Filter, Group, Nillable, Sort Description Lookup field for the product request associated with the product transfer. This is a relationship field. Relationship Name ProductRequest Relationship Type Lookup Refers To ProductRequest | | ProductRequestLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the product request line item associated with the product transfer. This is a relationship field. Relationship Name ProductRequestLineItem Relationship Type Lookup Refers To ProductRequestLineItem | | ProductTransferNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-assigned number that identifies the product transfer. | | QuantityReceived | Type double Properties Create, Filter, Nillable, Sort, Update Description Amount of product received at the destination location. | | QuantitySent | Type double Properties Create, Filter, Sort, Update Description Amount of product sent from the source location. | | QuantityUnitOfMeasure | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The units of the product, for example grams, liters, or units. | | ReceivedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the contact who received the product at the destination location. This is a polymorphic relationship field. Relationship Name ReceivedBy Relationship Type Lookup Refers To Group, User | | ReturnOrderId | Type reference Properties Filter, Group, Nillable, Sort Description The return order associated with the product transfer. This is a relationship field. Relationship Name ReturnOrder Relationship Type Lookup Refers To ReturnOrder | | ReturnOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The return order line item associated with the product transfer. This is a relationship field. Relationship Name ReturnOrderLineItem Relationship Type Lookup Refers To ReturnOrderLineItem | | ShipmentExpectedDeliveryDate | Type dateTime Properties Filter, Nillable, Sort Description Lookup field for the shipment related to the product transfer. | | ShipmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the shipment related to the product transfer. This is a relationship field. Relationship Name Shipment Relationship Type Lookup Refers To Shipment | | ShipmentStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description Lookup field for the shipment related to the product transfer. | | ShipmentTrackingNumber | Type string Properties Filter, Group, Nillable, Sort Description Lookup field for the shipment related to the product transfer. | | ShipmentTrackingUrl | Type url Properties Filter, Group, Nillable, Sort Description Lookup field for the shipment related to the product transfer. | | SourceLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the source location related to the product transfer. This is a relationship field. Relationship Name SourceLocation Relationship Type Lookup Refers To Location | | SourceProductItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the product item related to the product transfer. Relationship Name SourceProductItem Relationship Type Lookup Refers To ProductItem | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status of the product transfer. | ## 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. [ProductTransferChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ProductTransferFeed](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. [ProductTransferHistory](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. [ProductTransferOwnerSharingRule](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. [ProductTransferShare](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. # ProductWarrantyTerm Defines the relationship between a product or product family and warranty term. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CoveredProductFamily | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The product family that the warranty term applies to. | | CoveredProductId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the product that the warranty term applies to. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product warranty term was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the product warranty term was last viewed. | | ProductWarrantyTermNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The identifier for this product warranty term. | | WarrantyTermId | Type reference Properties Create, Filter, Group, Sort Description The ID of the warranty term. | ## 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. [ProductWarrantyTermChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # Profile Represents a profile, which defines a set of permissions to perform different operations. Operations can include creating a custom profile or querying, adding, updating, or deleting information. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, Customer Portal and Partner Portal users _can’t_ access this object. To view the following settings, assignments, and permissions for standard and custom objects in a specified profile, the View Setup and Configuration permission is required. - Client settings - Field permissions - Layout assignments - Object permissions - Permission dependencies - Permission set tab settings - Permission set group components - Record types Starting in Winter ’21, only users with correct permissions can view profile names other than their own if the Profile Filtering setting is enabled. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Profile names are also exposed when users with permissions to perform the following tasks take these actions: - Create a tab or record type with a wizard step that includes the assignment of tabs and record types to profiles. - Configure a login flow where viewing profile lists is required to make flow associations. - Set up delegated admins where looking up profiles is needed to identify assignable profiles. - Administer an org as a delegated customer admin. - Administer an org as a delegated admin to view and assign profiles of the delegated group. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the profile. | | IsSsoEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description If true, users assigned to this profile can delegate username and password authentication to a corporate database instead of the user database. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this profile. Available in API version 29.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this profile. Available in API version 29.0 and later. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the profile. | | PermissionsPermissionName | Type boolean Properties Create, Filter, Update Description One field for each permission. If true, users assigned to this profile have the named permission. The number of fields varies depending on the permissions for the org and license type. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip To get a list of available permissions in SOAP API, use describeSObjects(). | | UserLicenseId | Type reference Properties Create, Filter, Group, Sort Description ID of the UserLicense associated with this profile. This is a relationship field. Relationship Name UserLicense Relationship Type Lookup Refers To UserLicense | | UserType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The category of user license. Each UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. In API version 10.0 and later, valid values include: - Standard: user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses. Label is **Standard**. - PowerPartner: User whose access is limited because they’re a partner and typically access the application through a partner portal or Experience Cloud site. Label is **Partner**. - CspLitePortal: user whose access is limited because they’re an org's customer and access the application through a Customer Portal or Experience Cloud site. Label is **High Volume Portal**. - CustomerSuccess: user whose access is limited because they’re an org's customer and access the application through a Customer Portal. Label is **Customer Portal User**. - PowerCustomerSuccess: user whose access is limited because they’re an org's customer and access the application through a Customer Portal. Label is **Customer Portal Manager**. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the Customer Portal role hierarchy. - CsnOnly: user whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. Label is **Chatter Free**. - Guest: user whose access is limited because they’re an unauthenticated user without login credentials. Label is **Guest**. UserType replaces LicenseType, which is unavailable as of API version 10.0. In API versions 8.0 and 9.0 LicenseType is still available with the following valid values: - AUL: Lightning Platform user license. Label is **Apex Platform**. - AUL1: Lightning Platform user license with only one user. Label is **Apex Platform One**. - Salesforce: Salesforce user license. Label is **Salesforce**. - PackageManager: user who can create and work with managed packages for AppExchange. Label is **Package Manager**. - PRM: user whose access is limited because they’re a partner and typically accesses the application through a partner portal. Label is **Partner**. - CustomerUser: user whose access is limited because they’re an org's customer and accesses the application through a Customer Portal. Label is **Customer Portal User**. - CustomerManager: user whose access is limited because they’re an org's customer and accesses the application through a Customer Portal. Label is **Customer Portal Manager**. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the Customer Portal role hierarchy. In API version 53.0 and later, you can’t set the value of UserType using Apex. | ## Usage Use the Profile object to create custom profiles that start without any permissions enabled except for required permissions for the profile’s user license. While you can use the Profile Metadata type to deploy profiles, we recommend that you use the Profile SOAP API object because it allows you to create empty profiles. You can also query the set of currently configured user profiles in your org. Your client application can use Profile objects to obtain valid profile IDs for use when querying or modifying users through the API. In the user interface, profiles can be used to assign user licenses from specific pools (Lightning Platform user license or Salesforce user license, for example). When users are reassigned to profiles with different license types, the number of available licenses in the old license type pool increases, one per user assignment updated. Also, the number of available licenses decreases by the same amount in the new license type pool. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") - [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.") # ProfileSkill Represents a profile skill, which describes a user’s professional knowledge. This is a global record for the organization, and users are associated through the ProfileSkillUser object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For information about Live Agent skills, see the [Skill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_skill.htm "Represents a category or group of Chat users or service resources in Field Service or Workforce Engagement. This object is available in API version 24.0 and later.") topic. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description Description of the profile skill. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when the current user last viewed a record related to this profile skill. Available in API version 29.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when the current user last viewed this profile skill. Available in API version 29.0 and later. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the profile skill. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the profile skill. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | UserCount | Type int Properties Filter, Group, Nillable, Sort Description The number of users with the profile skill. | ## Usage Use the ProfileSkill object to look up the attributes of a skill that can be assigned to a user. This is a global object and is not owned by any specific user. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProfileSkillFeed](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.") (API version 34.0) Feed tracking is available for the object. [ProfileSkillHistory](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. [ProfileSkillOwnerSharingRule](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. [ProfileSkillShare](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. # ProfileSkillEndorsement Represents a detail relationship of ProfileSkillUser. An endorsement of a profile skill shows approval and support of another user’s publicly declared skill. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the profile skill being endorsed. | | ProfileSkillUserId | Type reference Properties Create, Filter, Group, Sort Description The ID of the ProfileSkillUser record that is being endorsed. This is a relationship field. Relationship Name ProfileSkillUser Relationship Type Lookup Refers To ProfileSkillUser | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user ID of the person giving the endorsement. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Usage Use the ProfileSkillEndorsement object to query about a single endorsement given to a user about a specific skill. Users can’t endorse themselves, they can only be endorsed by others unless they are administrators with the “Modify All Data” permission. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProfileSkillEndorsementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [ProfileSkillEndorsementFeed](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.") (API version 34.0) Feed tracking is available for the object. [ProfileSkillEndorsementHistory](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. # ProfileSkillShare Represents a sharing entry on a ProfileSkill. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field Name | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the ProfileSkill. The possible values are: - Read - Edit - All (This value is not valid for create() or update() calls.) This value must be set to an access level that is higher than the organization’s default access level for ProfileSkill objects. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent object, if any. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To ProfileSkill | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Values may include: - Manual—The User or Group has access because a user with “All” access manually shared the ProfileSkill with them. - Owner—The User is the owner of the ProfileSkill or is in a role above the ProfileSkill owner in the role hierarchy. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the ProfileSkill. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object is read only. It is visible because of constraints to the ProfileSkill object, but it is ignored and does not control which users and groups can view and edit ProfileSkill records owned by other users. # ProfileSkillUser Represents a detail relationship of User. The object connects profile skills with users. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | EndorsementCount | Type int Properties Filter, Group, Nillable, Sort Description The number of endorsements. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the skill user. | | ProfileSkillId | Type reference Properties Create, Filter, Group, Sort Description The ID of the ProfileSkill. This is a relationship field. Relationship Name ProfileSkill Relationship Type Lookup Refers To ProfileSkill | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the user. This field can’t be changed once it is created. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Usage Use this object to assign specific skills to specific users. ProfileSkillUser appears on the Overview tab on the Chatter profile page. Users can only create a skill mapping for themselves, they can’t create skill mappings for others unless they are administrators with the “Modify All Data” permission. Additionally, users can only edit this object if they are the context user and are not editing the UserId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProfileSkillUserFeed](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.") (API version 34.0) Feed tracking is available for the object. [ProfileSkillUserHistory](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. # ProgramProduct Represents a junction between Program and Product2. This will hold Product2 values related to a Program. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only with the EAndU Cloud Program Access permission set. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the ProgramProduct object. | | ProductId | Type reference Properties Create, Filter, Group, Sort, Update Description The Product2 object associated with the Program. This field is a relationship field. Relationship Name Product Relationship Type Lookup Refers To Product2 | | ProgramId | Type reference Properties Create, Filter, Group, Sort, Update Description The Program parent object associated with the record. This field is a relationship field. Relationship Name Program Relationship Type Lookup Refers To Program | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the status of the ProgramProduct object. Possible values are: - Active - Inactive - Pending For Approval | ## 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. [ProgramProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [ProgramProductFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ProgramProductHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ProgramProductOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ProgramProductShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ProgramRebateType Represents a rebate structure associated with a Rebate Program. This object is available in API version 63.0 and later. A ProgramRebateType record is created to define how benefits are calculated—such as accruals, payouts, or both—based on specified measure fields and logic. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccrualRate | Type double Properties Create, Filter, Nillable, Sort, Update Description The rate of accrual based on the value selected in the Measure Type field. For example, when the measure type is percent and you enter 10, the accrual rate is 10%. | | AggregateObjectName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The object that stores the aggregation results. | | BenefitQualifierField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The field on the aggregation object used to define thresholds for qualifying benefits (minimum or maximum). | | CalcObjectId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Links to a calculation definition from the Data Processing Engine. This field is a relationship field. Relationship Name CalcObject Refers To BatchCalcJobDefinition | | CalculationBasis | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the method used to calculate the rebate amount. Possible values are: - Accrual - Payout - PayoutAndAccrual—Payout and Accrual The default value is Payout. | | CalculationMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Defines how tiered rebate benefits are calculated. Possible values are: - Retrospective - Stepped The default value is Retrospective. | | CalculationType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of rebate calculation logic to use. Possible values are: - AggregateBased—Aggregate Based - Custom - GrowthBased—Growth Based - PerTransaction—Per Transaction | | ExecutionProcedureId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Links to business rules that define custom execution logic. This field is a relationship field. Relationship Name ExecutionProcedure Refers To ExpressionSet | | FilterAction | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Logical operator to apply between filter conditions. Possible values are: - AllConditionsMet—All Conditions Are Met (AND) - AnyConditionMet—Any Condition Is Met (OR) - CustomLogic—Custom Condition Logic - NoConditionsMet—No Conditions Are Met | | FilterCriteria | Type textarea Properties Nillable Description Holds the filter conditions in textual format. Used to define eligibility criteria for rebate qualification. | | FilterLogic | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Logical formula used to combine filter conditions, typically using field references and logical operators. | | IsIntegratable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description When selected, allows this rebate type to be applied on transactional records such as orders or opportunities. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and the timestamp when the record was last referenced by the user. Useful for user activity tracking. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and the timestamp when the record was last opened or viewed. Tracks user interaction history. | | MeasureField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The aggregation object field used with measure type and benefit value to calculate the rebate amount. This is required for the Amount per Unit and Percentage of Revenue measure types. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Unique name that identifies the rebate type configuration. Used as a reference label across related components. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Identifies the user or group that owns this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ProductFilterType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether the rebate applies to included or excluded products. Possible values are: - ExcludeProducts—Exclude Products - IncludeProducts—Include Products | | RebateMeasureType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the method to measure benefit payout. Possible values are: - AmountperUnit—Amount per Unit - Custom - FixedAmount—Fixed Amount - PercentageOfRevenue—Percentage of Revenue | | RebateProgramId | Type reference Properties Create, Filter, Group, Sort, Update Description Links this rebate type to its parent rebate program. This field is a relationship field. Relationship Name RebateProgram Relationship Type Master-detail Refers To RebateProgram (the master object) | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies whether the rebate type is currently active. Possible values are: - Active - Inactive The default value is Inactive. | | UnitOfMeasureId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Identifies the unit of measure associated with the rebate type. This field is a relationship field. Relationship Name UnitOfMeasure Refers To UnitOfMeasure | | ValidityDuration | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Duration for which the inventory is eligible for price protection. | | ValidityDurationType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Unit of time used to measure ValidityDuration. Possible values are: - Days - Months - Years The default value is Years. | # Promotion Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Some of the fields on the Promotion object are available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AreQualItemsExclFromDiscounts | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Exclude qualifying items from discount. You can use this field to create buy-one-get-one promotions. The default value is false. This field is available in API version 56.0 and later. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the promotion. | | DiscountOrder | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether to apply discounts first to the least expensive products or to the most expensive products. Possible values are: - LeastExpensive - MostExpensive The default value is MostExpensive. This field is available in API version 56.0 and later. | | DiscountRestriction | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether to restrict the products that can be discounted based on the least expensive qualifying product. Possible values are: - LeastExpensive - None The default value is None. This field is available in API version 56.0 and later. | | DisplayName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Display name of the promotion. | | EndDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when the promotion ends. | | ExclusivityType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines whether a promotion can be combined with other promotions. Possible values are: - No - Can be combined with other promotions. - Class - Can’t be combined with a promotion of the same class (product, order, or shipment), but allows for promotions of separate classes to be combined. For example, an order discount on top of a product discount. - Global - Only promotion that can be applied to the order, regardless of class. The default value is Class. This field is available in API version 58.0 and later. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the promotion is active (true) or inactive (false). The default value is false. | | IsApproachingDiscountApplicable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the promotion shows an approaching discount message. Set an approaching discount threshold value on the PromotionQualifier object. This field is available in API version 64.0 and later. The default value is false. | | IsAutomatic | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the promotion is automatic or manual. If the promotion is automatic, it automatically applies to eligible carts with no buyer action required. if the promotion is manual, the buyer applies a coupon to redeem the promotion. The default value is false. | | IsCommercePromotion | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the promotion is a B2B Commerce promotion (true) or not (false). The default value is false. | | IsTiered | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the promotion uses promotion tiers (true) or not (false). This value can’t be changed. The default value is false. A tiered promotion can have up to 10 associated tiers. This field is available in API version 57.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced and not directly accessed. | | MaximumUsageCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Maximum number of times the promotion can be applied to a cart. If left blank, the default value is 1. This field is available in API version 56.0 and later. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the promotion. | | Objective | Type textarea Properties Create, Filter, Nillable, Sort, Update Description More information, if any, about the purpose of the promotion. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who created the promotion. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PriorityNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Priority for the promotion. The priority determines which promotions apply first. The lower the number, the higher the priority. | | QualifierCriteria | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If a promotion has multiple qualifiers, this field determines whether all qualifiers must be met or whether any must be met for the promotion to apply. Possible values are: - All - Any The default value is 'All'. This field is available in API version 53.0 and later. | | StartDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when the promotion begins. | | TargetCriteria | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If a promotion has multiple targets, indicates whether a cart must meet the criteria for any target or the criteria for all targets. Possible values are: - All - Any This field is available in API version 56.0 and later. | | TermsAndConditions | Type textarea Properties Create, Nillable, Update Description Terms and conditions the buyer accepts before applying the promotion. This field is available in API version 53.0 and later. | ## 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. [PromotionFeed](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. [PromotionHistory](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. [PromotionShare](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. #### See Also - [Promotion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotion.htm "Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later.") - [PromotionMarketSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionmarketsegment.htm "Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later.") - [PromotionQualifier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionqualifier.htm "Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later.") - [PromotionSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegment.htm "Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later.") - [PromotionSegmentBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentbuyergroup.htm "Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionSegmentSalesStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentsalesstore.htm "Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontarget.htm "Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later.") - [PromotionTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontier.htm "Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later.") # PromotionLineItemRule Lists compound conditions about a promotion. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssociatedReferenceId | Type Reference Properties Create, Filter, Group, Sort Description ID of the associated reference. Relationship Name AssociatedReference Relationship Type Lookup Refers To PromotionQualifier, PromotionTarget | | AssociatedType | Type Picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Specifies the type of object the rule is associated with. Possible values are: - PromotionQualifier - PromotionTarget | | Name | Type String Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the promotion rule. | | OperatorType | Type Picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Operator type for promotion line item rule. Possible values are: - EQUAL\_TO - GREATER\_THAN - GREATER\_THAN\_OR\_EQUAL\_TO - LESS\_THAN - LESS\_THAN\_OR\_EQUAL\_TO - NOT\_EQUAL\_TO The default value is EQUAL\_TO. | | OwnerId | Type Reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Type | Type Picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the type on which the rule is being applied. Possible values are: - Attribute - Price - Product - ProductCategory | | TypeReferenceId | Type Reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the type. Relationship Name TypeReference Relationship Type Lookup Refers To Product2, ProductCategory | | TypeValue | Type String Properties Create, Filter, Group, Nillable, Sort, Update Description Value of the type selected. | # PromotionMarketSegment Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The PromotionMarketSegment object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the promotion segment. | | PromotionId | Type reference Properties Create, Filter, Group, Sort Description The ID of the promotion that you want to associate with your promotion segment. This is a relationship field. Relationship Name Promotion Relationship Type Lookup Refers To Promotion | | PromotionSegmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the promotion segment that you want to associate with. This is a relationship field. Relationship Name PromotionSegment Relationship Type Lookup Refers To PromotionSegment | #### See Also - [Promotion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotion.htm "Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later.") - [PromotionMarketSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionmarketsegment.htm "Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later.") - [PromotionQualifier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionqualifier.htm "Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later.") - [PromotionSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegment.htm "Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later.") - [PromotionSegmentBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentbuyergroup.htm "Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionSegmentSalesStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentsalesstore.htm "Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontarget.htm "Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later.") - [PromotionTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontier.htm "Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later.") # PromotionQualifier Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The PromotionQualifier object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields
Field Details
ApproachingDiscountThreshold
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount that a customer has to reach before seeing an approaching discount message.
For example, if a promotion qualifier minimum is set at $150 and this field is set at $50, then a customer receives a banner notification that they're approaching the discount when they have at least $50 in their cart. This field is available in API version 64.0 and later.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
ExternalQualifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A qualifying product or product category stored outside of Salesforce. This field is available in API version 56.0 and later.
Note

Note

This field is available through the API only.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
MinimumAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum dollar amount that a buyer must purchase to qualify for the promotion.
MinimumQuantity
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum quantity that a buyer must purchase to qualify for the promotion.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Name of the promotion qualifier.
PromotionId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the promotion that you want to associate with your promotion qualifier.
This is a relationship field.
Relationship Name
Promotion
Relationship Type
Lookup
Refers To
Promotion
PromotionTierId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the promotion tier associated with the qualifier. Only used with tiered promotions.
This is a relationship field.
This field is available in API version 57.0 and later.
Relationship Name
PromotionTier
Relationship Type
Lookup
Refers To
PromotionTier
QualifierId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the qualifier.
This is a polymorphic relationship field.
Relationship Name
Qualifier
Relationship Type
Lookup
Refers To
Product2, ProductCategory
QualifierOperator
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Possible values are:
  • EQUAL_TO
  • NONE
  • NOT_EQUAL_TO
QualifierProductCategoryName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product category referenced in the qualifier. This field is available in API version 55.0 and later.
QualifierProductName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product referenced in the qualifier. This field is available in API version 55.0 and later.
QualifierProductSku
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The stock keeping unit of the product referenced in the qualifier. This field is available in API version 55.0 and later.
QualifierRuleCriteriaType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of qualifier rule criteria.
Possible values are:
  • All
  • Any
QualifierType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of qualifier that you want to add to the promotion. Product applies the qualifier to a single product, ProductCategory to a predetermined group of products, and TransactionTotal to the entire order.
Possible values are:
  • Product
  • ProductCategory
  • TransactionTotal
## 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. [PromotionQualifierFeed](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. [PromotionQualifierHistory](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. #### See Also - [Promotion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotion.htm "Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later.") - [PromotionMarketSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionmarketsegment.htm "Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later.") - [PromotionQualifier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionqualifier.htm "Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later.") - [PromotionSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegment.htm "Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later.") - [PromotionSegmentBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentbuyergroup.htm "Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionSegmentSalesStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentsalesstore.htm "Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontarget.htm "Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later.") - [PromotionTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontier.htm "Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later.") # PromotionSegment Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The PromotionSegment object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the promotion segment. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who created this promotion segment. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## 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. [PromotionSegmentFeed](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. [PromotionSegmentHistory](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. #### See Also - [Promotion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotion.htm "Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later.") - [PromotionMarketSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionmarketsegment.htm "Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later.") - [PromotionQualifier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionqualifier.htm "Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later.") - [PromotionSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegment.htm "Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later.") - [PromotionSegmentBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentbuyergroup.htm "Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionSegmentSalesStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentsalesstore.htm "Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontarget.htm "Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later.") - [PromotionTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontier.htm "Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later.") # PromotionSegmentBuyerGroup Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The PromotionSegmentBuyerGroup object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | BuyerGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Buyer Group that you want to include in your market segment. This is a relationship field. Relationship Name BuyerGroup Relationship Type Lookup Refers To BuyerGroup | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. This field is available in API version 53.0 and later. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. This field is available in API version 53.0 and later. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the promotion segment. | | PromotionSegmentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the promotion segment you want to associate with your buyer group. This is a relationship field. Relationship Name PromotionSegment Relationship Type Lookup Refers To PromotionSegment | ## 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. [PromotionSegmentBuyerGroupFeed](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. [PromotionSegmentBuyerGroupHistory](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. #### See Also - [Promotion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotion.htm "Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later.") - [PromotionMarketSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionmarketsegment.htm "Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later.") - [PromotionQualifier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionqualifier.htm "Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later.") - [PromotionSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegment.htm "Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later.") - [PromotionSegmentBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentbuyergroup.htm "Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionSegmentSalesStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentsalesstore.htm "Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontarget.htm "Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later.") - [PromotionTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontier.htm "Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later.") # PromotionSegmentSalesStore Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The PromotionSegmentSalesStore object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the promotion segment. | | PromotionSegmentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the promotion segment you want to associate with your store. This is a relationship field. Relationship Name PromotionSegment Relationship Type Lookup Refers To PromotionSegment | | SalesStoreId | Type reference Properties Create, Filter, Group, Sort Description The ID of the store you want to include in your promotion segment. This is a relationship field. Relationship Name SalesStore Relationship Type Lookup Refers To WebStore | ## 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. [PromotionSegmentSalesStoreFeed](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. [PromotionSegmentSalesStoreHistory](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. #### See Also - [Promotion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotion.htm "Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later.") - [PromotionMarketSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionmarketsegment.htm "Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later.") - [PromotionQualifier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionqualifier.htm "Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later.") - [PromotionSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegment.htm "Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later.") - [PromotionSegmentBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentbuyergroup.htm "Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionSegmentSalesStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentsalesstore.htm "Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontarget.htm "Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later.") - [PromotionTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontier.htm "Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later.") # PromotionTarget Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The PromotionTarget object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields
Field Details
AdjustmentAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The promotion discount is expressed as an amount, not as a percentage.
AdjustmentPercent
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
The percentage discount of the promotion. Valid values include numbers from 1 through 100.
AdjustmentType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of adjustment discount applied to the product or group of products.
Possible values are:
  • FixedAmountOffLineItemTotal—Fixed amount off the total of all line items.
  • FixedAmountOffTransaction—Fixed amount off the entire transaction. This value is available in API version 56.0 and later.
  • FixedAmountOffUnitPrice—Fixed amount off the unit price.
  • FixedPrice—Fixed price for a product. This value is available in API version 56.0 and later.
  • TotalFixedPrice—Fixed price for a set number of products. Requires a quantity limit. This value is available in API version 56.0 and later.
  • FixedAmountOffUnitPrice—Fixed amount off the unit price.
  • PercentageDiscount—Percentage discount.
  • BonusProduct—Gift product at no additional cost after qualifying purchases. This value is available in API version 64.0 and later.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
ExternalTarget
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A target product or product category stored outside of Salesforce. This field is available in API version 56.0 and later.
Note

Note

This field is available through the API only.
IsMinItemCountRequired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
If true, the max value in the RestrictionQuantity field must be met before the promotion is applied. The default value is false. This field is available in API version 56.0 and later.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the promotion target.
PromotionId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the promotion that you want to reference.
This is a relationship field.
Relationship Name
Promotion
Relationship Type
Lookup
Refers To
Promotion
PromotionTierId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the promotion tier associated with the target. Only used with tiered promotions.
This is a relationship field.
This field is available in API version 57.0 and later.
Relationship Name
PromotionTier
Relationship Type
Lookup
Refers To
PromotionTier
RestrictionQuantity
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Maximum number of times the discount can be applied to the target. This field is available in API version 56.0 and later.
TargetId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the product or product category that you want to target.
This is a polymorphic relationship field.
Relationship Name
Target
Relationship Type
Lookup
Refers To
Product2, ProductCategory
TargetOperator
Type
enum
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
For product and category targets, specify if the qualifying product or item in the qualifying category must be in the cart to determine if the cart satisfies the promotions criteria. For example, a quantity or amount across one or more items. This field is available in API version 59.0 and later.
Possible values are:
  • EQUAL_TO—Specifies that the qualifying product or item in the qualifying category must be in the cart.
  • NOT_EQUAL_TO—Specifies that the qualifying product or item in the qualifying category isn’t required to be in the cart.
  • NONE—Specifies that none of the other possible values apply. If the target type is for an order, you must use none.
TargetProductCategoryName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product category referenced in the target. This field is available in API version 55.0 and later.
TargetProductName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product referenced in the target. This field is available in API version 55.0 and later.
TargetProductSku
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The stock keeping unit of the product referenced in the target. This field is available in API version 55.0 and later.
TargetRuleCriteriaType
Type
enum
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Controls what promotion rules must be met for the promotion to be valid. This field is available in API version 59.0 and later.
Possible values are:
  • ALL—Specifies that all of the promotion rules must be met.
  • ANY—Specifies that any of the promotion rules can be met.
TargetType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The target of the promotion.
Possible values are:
  • Product—Applies the promotion to a single product.
  • ProductCategory—Applies the promotion to a group of products.
  • Shipping—Applies the promotion to all shipping methods on the order.
  • StandardShippingRate—Applies the promotion to a single shipping method on the order.
  • Transaction—Applies the promotion to the entire order.
#### See Also - [Promotion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotion.htm "Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later.") - [PromotionMarketSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionmarketsegment.htm "Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later.") - [PromotionQualifier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionqualifier.htm "Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later.") - [PromotionSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegment.htm "Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later.") - [PromotionSegmentBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentbuyergroup.htm "Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionSegmentSalesStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentsalesstore.htm "Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontarget.htm "Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later.") - [PromotionTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontier.htm "Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later.") # PromotionTier Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, it can mean that the user accessed this record or list view (LastReferencedDate) but didn’t view it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the promotion tier. | | PromotionId | Type reference Properties Create, Filter, Group, Sort Description ID of the promotion associated with the promotion tier. This field is a relationship field. Relationship Name Promotion Relationship Type Lookup Refers To Promotion | | Rank | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Priority of the tier among the associated promotion’s tiers. Tiers are evaluated in order from lowest to highest rank. Each tier in a promotion must have a unique rank. | ## Usage Use promotion tiers with promotion qualifiers and promotion targets to create tiered promotions. Instead of associating one promotion qualifier and one promotion target with each promotion, associate one promotion qualifier and one promotion target with each promotion tier. ## 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. [PromotionTierFeed](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. [PromotionTierHistory](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. #### See Also - [Promotion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotion.htm "Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later.") - [PromotionMarketSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionmarketsegment.htm "Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later.") - [PromotionQualifier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionqualifier.htm "Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later.") - [PromotionSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegment.htm "Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later.") - [PromotionSegmentBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentbuyergroup.htm "Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionSegmentSalesStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentsalesstore.htm "Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later.") - [PromotionTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontarget.htm "Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later.") - [PromotionTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontier.htm "Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later.") # Prompt Represents record details about an in-app guidance prompt or walkthrough. Available in API version 46.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, multiple permissions are required. See [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. ## Prompts and Walkthroughs in Managed Packages For considerations about including in-app guidance in a managed package, see [Guidelines for In-App Guidance in Managed Packages](https://help.salesforce.com/articleView?id=customhelp_iag_packages.htm&language=en_US) in Salesforce Help. For more information about creating managed packages, see [Create a First-Generation Managed Package](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/creating_packages.htm). Unmanaged packages must contain a namespace prefix. For more information, see [Register a Namespace for a First-Generation Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/register_namespace_prefix.htm) and [What happens to my namespace prefix when I install a package?](https://help.salesforce.com/articleView?id=faq_distribution_installing_what_happens_to_my.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the language used in the org where the in-app guidance was created. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label. Maximum of 80 characters. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren't Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | # PromptAction Represents how the user interacted with the in-app guidance prompt or walkthrough. Available in API version 46.0 and later. Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, multiple permissions are required. See [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. ## Fields | Field | Details | | --- | --- | | LastDisplayDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the in-app guidance was last displayed to the user. | | LastResult | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the last user interaction. Valid values are: - CustomAction - Dismiss - Error - Finish—(walkthroughs only) - NoAction - NotSeen - Snooze | | LastResultDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the in-app guidance was last interacted with. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the in-app guidance. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PromptVersionId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the PromptVersion object. This is a relationship field. Relationship Name PromptVersion Relationship Type Lookup Refers To PromptVersion | | SnoozeUntil | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The timestamp for when the user’s snooze request expires. The user won’t see the prompt again until they navigate to the page after the snooze time expires. | | StepCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the total number of steps in the walkthrough. Available in API version 49.0 and later. | | StepNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the number of the last step the user viewed or interacted with in a walkthrough. Maximum value is 10. Available in API version 49.0 and later. | | TimesActionTaken | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user took action on the in-app guidance. | | TimesDismissed | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user dismissed the in-app guidance. | | TimesDisplayed | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the in-app guidance was displayed to the user. | | TimesSnoozed | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of times the user snoozes the prompt. | | UserId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the user. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Associated Objects This object has the following associated objects. They are available in API version 46.0 and later. [PromptActionOwnerSharingRule](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. [PromptActionShare](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. # PromptActionOwnerSharingRule Represents a rule which determines PromptAction sharing access for the owners. Available in API version 46.0 and later. Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, multiple permissions are required. See [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the access level of users for in-app guidance. Valid values are Read and Edit. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the in-app guidance. Maximum of 255 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the group whose PromptAction are shared. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the in-app guidance. | | UserOrGroupID | Type reference Properties Create, Filter, Group, Sort Description ID of the user or group with whom PromptAction access is shared. | # PromptActionShare Represents a sharing entry on a prompt action record. Available in API version 46.0 and later. Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, multiple permissions are required. See [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the access level of users for in-app guidance. Valid values are Read, Edit, and All. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent. | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Rule—The User or Group has access via a sharing rule. - GuestRule—The User or Group has access via a guest user sharing rule. - Manual—The User or Group has access because a User with “All” access manually shared the prompt action with them. - Owner—The User is the owner of the prompt action. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID of the User or Group. | # PromptError Represents the error or warning associated with the PromptAction. Available in API version 52.0 and later. Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, multiple permissions are required. See [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. ## Fields | Field | Details | | --- | --- | | IsError | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the in-app guidance had an error true or a warning false. The default is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the PromptError record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User or Group. | | PromptActionId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the PromptAction that the PromptError is related to. | | StepNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the step number that the user encountered an error or warning in a walkthrough. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the type of error or warning. Possible values are: - NoAccessToApp—A step on this walkthrough is on an app that some of your users don’t have access to. - NoAccessToPage—A step on the walkthrough is on a page that some of your users don’t have access to. - ReferenceElementNotFound—The target element has moved or is no longer on your page. Targeted prompts attached to unavailable elements convert to floating prompts. Check your access to the element, or enter targeting mode and reassign the targeted prompt. - Unavailable—Users tried to open this walkthrough using its URL, but it's inactive or the users aren’t licensed to see it. To make it accessible to users, check its settings or activate it. | ## Associated Objects This object has the following associated objects. They are available in API version 52.0 and later. [PromptErrorOwnerSharingRule](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. [PromptErrorShare](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. # PromptLocalization Represents the translated value of a label for record details about in-app guidance when the Translation Workbench is enabled for your org. Available in API version 48.0 and later. Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, multiple permissions are required. See [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. ## Prompts and Walkthroughs in Managed Packages For considerations about including in-app guidance in a managed package, see [Guidelines for In-App Guidance in Managed Packages](https://help.salesforce.com/articleView?id=customhelp_iag_packages.htm&language=en_US) in Salesforce Help. For more information about creating managed packages, see [Create a First-Generation Managed Package](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/creating_packages.htm). Unmanaged packages must contain a namespace prefix. For more information, see [Register a Namespace for a First-Generation Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/register_namespace_prefix.htm) and [What happens to my namespace prefix when I install a package?](https://help.salesforce.com/articleView?id=faq_distribution_installing_what_happens_to_my.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Indicates the language used in the org where the in-app guidance was created. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren't Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the in-app guidance. | | Value | Type textarea Properties Create, Filter, Sort, Update Description The actual translated record details for the in-app guidance. | # PromptVersion Represents an in-app guidance prompt or walkthrough. Available in API version 46.0 and later. Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, see [Considerations for Creating In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_prompt_consider.htm&type=5&language=en_US "HTML (New Window)") and [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help for permissions. ## Prompts and Walkthroughs in Managed Packages For considerations about including in-app guidance in a managed package, see [Guidelines for In-App Guidance in Managed Packages](https://help.salesforce.com/articleView?id=customhelp_iag_packages.htm&language=en_US) in Salesforce Help. For more information about creating managed packages, see [Create a First-Generation Managed Package](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/creating_packages.htm). Unmanaged packages must contain a namespace prefix. For more information, see [Register a Namespace for a First-Generation Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/register_namespace_prefix.htm) and [What happens to my namespace prefix when I install a package?](https://help.salesforce.com/articleView?id=faq_distribution_installing_what_happens_to_my.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | ActionButtonLabel | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Label for the action button or link. Maximum of 25 characters. For a walkthrough, specify this value on the last step. | | ActionButtonLink | Type url Properties Create, Filter, Nillable, Sort, Update Description URL for the action button or link. Maximum of 1,000 characters. You can’t use the GROUP BY option in a SOQL query for this field. For a walkthrough, specify this value on the last step. | | Body | Type textarea Properties Create, Update Description Body content. In API version 60.0 and later, enter up to 4,000 characters for all prompt types. In earlier API versions, enter up to 240 characters for floating prompts and targeted prompts. Enter up to 4,000 characters for docked prompts. For docked prompts, the maximum characters include HTML markup, not just readable text. | | DelayDays | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of days between occurrences. For a walkthrough, specify this value on the first step. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description. Maximum of 255 characters. | | DismissButtonLabel | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Label for the dismiss button of a floating or targeted prompt. Maximum of 15 characters. | | DisplayPosition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The position of a floating prompt on the page. Valid values are: - TopLeft - TopCenter - TopRight - MiddleLeft - MiddleCenter - MiddleRight - BottomLeft - BottomCenter - BottomRight | | DisplayType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of prompt. Valid values are: - DockedComposer—A docked prompt - FloatingPanel—A floating prompt - Targeted—A targeted prompt. Available in API version 52.0 and later. | | ElementRelativePosition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The location of a targeted prompt relative to the element. This field is available in API version 52.0 and later. Valid values are: - BottomCenter - BottomLeft - BottomRight - LeftBottom - LeftCenter - LeftTop - RightBottom - RightCenter - RightTop - TopCenter - TopLeft - TopRight | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date to stop showing the in-app guidance. For a walkthrough, specify this value on the first step. | | Experience | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description This field corresponds to the **Environment** picklist in In-App Guidance Builder. Available in version 60.0 and later. Possible values are: - Lightning—Default. The in-app guidance is used in a Lightning Experience app or page. - Site—The in-app guidance is used in a supported Experience Cloud site page. | | ExperienceContextId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required if the value of Experience is Site. The ID of the Experience Cloud site context associated with the in-app guidance prompt. Available in version 60.0 and later. This field is a polymorphic relationship field. Relationship Name ExperienceContext Relationship Type Lookup Refers To Site | | Header | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Label for the header of a docked prompt. This value is the label contained in the window’s browser bar. Maximum of 36 characters. | | ImageAltText | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the alt text of an image. Required if ImageLocation or ImageID is specified. | | ImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the ContentAsset that holds the image. Required if ImageLocation or ImageAltText is specified. This is a relationship field. Relationship Name Image Relationship Type Lookup Refers To ContentAsset | | ImageLocation | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the location of the image in relation to the body text. Required if ImageID or ImageAltText is specified. Valid values are: - Top - Bottom - Right, which is for floating or targeted prompts only - Left, which is for floating or targeted prompts only | | IndexWithIsPublished | Type string Properties Filter, idLookup, Nillable, Sort Description Used by Salesforce for efficient querying. | | IndexWithoutIsPublished | Type string Properties Filter, idLookup, Nillable, Sort Description Used by Salesforce for efficient querying. | | IsPublished | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the in-app guidance is active (true) or not (false). | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label. Maximum of 80 characters. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the in-app guidance. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Prompt | | PublishedByUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who activated the in-app guidance. If the in-app guidance is part of a package, this value is the user who installed the package. This is a relationship field. Relationship Name PublishedByUser Relationship Type Lookup Refers To User | | PublishedDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the date the in-app guidance was activated. If installed from a package, this value is the date when the package was installed. For walkthroughs, this field can only be specified on the first step. | | ReferenceElementContext | Type textarea Properties Create, Nillable, Update Description Used by Salesforce to identify the element that the targeted prompt is associated with. Available in API version 52.0 and later. | | ShouldDisplayActionButton | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether an action button or link is included (true) or not (false). | | ShouldIgnoreGlobalDelay | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the in-app guidance ignores the global time delay and instead shows on page load (true) or not (false). This field is available in API version 48.0 and later. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the date to start showing the in-app guidance. For a walkthrough, specify this value on the first step. In API version 48.0 and earlier, this field is required. | | StepNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Required for walkthroughs only. Indicates the number of the last step the user viewed or interacted with in a walkthrough. Include up to 10 steps. Numbers must be consecutive without repeated or skipped numbers. Available in API version 49.0 and later. | | TargetAppDeveloperName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The app’s developer name where the in-app guidance appears. Deprecated in API version 51.0 and later. | | TargetAppNamespacePrefix | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The app’s namespace prefix where the in-app guidance appears. This value must match the target app’s NamespacePrefix in the org that the package is being installed into. Maximum of 15 characters. Deprecated in API version 51.0 and later. | | TargetPageKey1 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. Used by Salesforce to identity the prompt’s page location along with targetPageKey2, targetPageKey3, targetPageKey4, and targetPageType. | | TargetPageKey1Ref | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Used by Salesforce to identify the prompt’s page location along with TargetPageKey2, TargetPageKey3, TargetPageKey4, and TargetPageType. | | TargetPageKey2 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used by Salesforce to identify the prompt’s page location along with TargetPageKey1, TargetPageKey3, TargetPageKey4, and TargetPageType. | | TargetPageKey3 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used by Salesforce to identify the prompt’s page location along with TargetPageKey1, TargetPageKey2, TargetPageKey4, and TargetPageType. | | TargetPageKey4 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used by Salesforce to identify the page location along with TargetPageKey1, TargetPageKey2, TargetPageKey3, and TargetPageType. This field is available in API version 53.0 and later. | | TargetPageType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The type of page where the in-app guidance appears. | | TargetRecordType | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Used by Salesforce to determine if in-app guidance is specific to a record type. This field is available in API version 53.0 and later. Relationship Name TargetRecordType Relationship Type Lookup Refers To RecordType | | ThemeColor | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates which custom theme color is applied to the in-app guidance. Required if ThemeSaturation is specified. For a walkthrough, specify this value on the first step. Valid values are: - Theme1—derived from the current brand color - Theme2—derived from the current page background color - Theme3—derived from the current global header color - Theme4—derived from the current app theme color | | ThemeSaturation | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates which color value, or saturation, is applied to the in-app guidance that has a custom theme color. Required if ThemeColor is specified. For a walkthrough, specify this value on the first step. Valid values are: - Dark - Light | | TimesToDisplay | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Required if recurrences are scheduled. The maximum number of times to show the in-app guidance. Salesforce detects whether the user interacts with the in-app guidance, then determines whether to show the in-app guidance again or cancel scheduled recurrences. Maximum value of 30. For a walkthrough, specify this value on the first step. | | Title | Type string Properties Create, Filter, Group, Sort, Update Description Required. The label for the title. Maximum of 36 characters. | | UserAccess | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates which permissions can see the in-app guidance. Valid values are: - Everyone, which indicates that there’s no permission restrictions - SpecificPermissions, which indicates that only users with all the specific user permissions specified can see the in-app guidance In API version 48.0 and earlier, this field is required. | | UserProfileAccess | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates which profiles can see the in-app guidance. This field is available in API version 48.0 and later. Valid values are: - Everyone, which indicates that there are no profile restrictions - SpecificProfiles, which indicates that users with any of the specified user profiles can see the in-app guidance | | VersionNumber | Type int Properties Create, Filter, Group, Sort, Update Description Required. The number remains 1 since multiple versions aren’t saved in the org. | | VideoLink | Type url Properties Create, Filter, Nillable, Sort, Update Description The embed URL for a video in a docked prompt. Maximum of 1,000 characters. You can specify this field or the image field, but not both. This field is available in API version 48.0 and later. See [Considerations for Creating In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_prompt_consider.htm&type=5&language=en_US "HTML (New Window)"). | # PromptVersionLocalization Represents the translated value of a label for-app guidance when the Translation Workbench is enabled for your org. Available in API version 48.0 and later. Use prompts and walkthroughs to display announcements, training, or news to users within the app. Choose to add an action button or link that links to a URL of your choice. Track views, action button clicks, and walkthrough completions. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, multiple permissions are required. See [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. ## Prompts and Walkthroughs in Managed Packages For considerations about including in-app guidance in a managed package, see [Guidelines for In-App Guidance in Managed Packages](https://help.salesforce.com/articleView?id=customhelp_iag_packages.htm&language=en_US) in Salesforce Help. For more information about creating managed packages, see [Create a First-Generation Managed Package](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/creating_packages.htm). Unmanaged packages must contain a namespace prefix. For more information, see [Register a Namespace for a First-Generation Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/register_namespace_prefix.htm) and [What happens to my namespace prefix when I install a package?](https://help.salesforce.com/articleView?id=faq_distribution_installing_what_happens_to_my.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Indicates the language used in the org where the in-app guidance was created. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren't Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the in-app guidance. | | Value | Type textarea Properties Create, Filter, Sort, Update Description The actual translated label of the in-app guidance. | # ProrationPolicy Defines how the price of a subscription is divided into time periods and how the price is calculated for each time period. This object is available in API version 55.0 and later. The proration policy defines whether partial periods are allowed and how remainder amounts are handled. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Special Access Rules This object is available when Subscription Management is enabled. ## Fields | Field | Details | | --- | --- | | ArePartialPeriodsAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether a subscription can be canceled partway through a period. Set the value to True if a subscription can be canceled partway through a period. Otherwise, set the value to false. For example, if the proration period is monthly and this field is true, then customers can cancel a subscription partway through the month. If the proration period is monthly and this field is false, then the subscription is canceled at the end of the current month. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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 viewLastReferencedDate but not viewed it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort Description The name of the proration policy. | | ProrationPolicyType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of proration policy. Possible values are: - StandardTimePeriods—Indicates that the proration policy divides the subscription into similar time periods, and prorates the subscription using the time periods. For example, a monthly subscription that's subscribed to for 12 months for a total amount of $120 is prorated as $10 per month. | | RemainderStrategy | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Indicates how the leftover amount from the price calculation is allocated. For example, if the total amount is $100 and the subscription has 12 periods, the price per period is $8.33, with $0.04 remaining. To indicate that the $0.04 is included in the first period, use the value AddToFirst. To indicate that the $0.04 is included in the final period, use the value AddToLast. Possible values are: - AddToFirst—Add the remaining amount to the first period. - AddToLast—Add the remaining amount to the last period. | # Prospect Represents a prospect. A prospect is an individual who has shared contact information, but isn't yet qualified. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Address | Type address Properties Filter, Nillable Description Street address of the prospect. Up to 255 characters are allowed. | | AnnualRevenue | Type currency Properties Create, Filter, Nillable, Sort, Update Description The prospect company's yearly revenue. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City that's included in the prospect’s address. | | Company | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The prospect's company. | | ConvertedAccountId | Type reference Properties Filter, Group, Nillable, Sort Description Object reference ID that points to the account into which the prospect converted. This is a relationship field. Relationship Name ConvertedAccount Refers To Account | | ConvertedContactId | Type reference Properties Filter, Group, Nillable, Sort Description Object reference ID that points to the contact into which the prospect converted. This is a relationship field. Relationship Name ConvertedContact Refers To Contact | | ConvertedDate | Type date Properties Filter, Group, Nillable, Sort Description Date on which this prospect was converted. | | ConvertedLeadId | Type reference Properties Filter, Group, Nillable, Sort Description Object reference ID that points to the lead into which the prospect has been converted. This is a relationship field. This field is a relationship field. Relationship Name ConvertedLead Refers To Lead | | ConvertedOpportunityId | Type reference Properties Filter, Group, Nillable, Sort Description Object reference ID that points to the opportunity into which the prospect has been converted. This is a relationship field. Relationship Name ConvertedOpportunity Refers To Opportunity | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Prospect's country. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Description | Type textarea Properties Create, Nillable, Update Description The prospect’s description. | | Email | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The prospect's email address. | | FirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The prospect’s first name. Up to 40 characters allowed. | | GenderIdentity | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The prospect’s self-identified experience of their gender, which does or doesn’t correspond to the prospect’s designated sex at birth. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address. For details on geolocation compound fields, see [Geolocation Compound Field](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_geolocation.htm "Geolocation fields are accessible in the SOAP and REST APIs as a Location—a structured compound data type—or as individual latitude and longitude elements."). | | Industry | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Primary business of the prospect’s company | | IsConverted | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the prospect has been converted (true) or not (false). Label is **Converted**. | | LastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The Last name of the prospect. Up to 80 characters are allowed. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | LeadSource | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The origin or source of the lead. | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | Name | Type string Properties Filter, Group, Nillable, Sort Description Concatenation of FirstName, MiddleName, LastName, and Suffix up to 203 characters, including whitespaces. | | NumberOfEmployees | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of employees at the prospect's company. Label is **Employees**. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The prospect's phone number. | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal code that's included in the prospect's address. Label is **Zip/Postal Code**. | | ProspectRecordName | Type string Properties Filter, Group, idLookup, Sort Description The name of the prospect record used for managing prospects. | | ProspectStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the prospect. Possible values are: - Contacted - New - Nurturing - Qualified - Unqualified The default value is New. | | Salutation | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The prospect's preferred title. Possible values are: - Dr. - Mr. - Mrs. - Ms. - Mx. - Prof. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State that's included in the prospect's address. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street number or name that's included in the prospect's address. | | Title | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The prospect's business title, such as CFO or CEO. The maximum size is 128 characters. When converting a prospect to a person account, the conversion fails if the prospect Title field contains more than 80 characters. | # ProspectingAgentDataSource Represents a Prospecting Agent data source. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | Priority | Type int Properties Create, Filter, Group, Sort, Update Description The priority value for the source. A lower number indicates a higher priority. | | ProspectingAgentSpecId | Type reference Properties Create, Filter, Group, Sort Description A reference to the parent ProspectingAgentSpecification. Relationship Name ProspectingAgentSpec Relationship Type Master-detail Refers To ProspectingAgentSpec (the master object) | | SourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID associated with the Salesforce report this agent is using to generate prospects. If the agent is not using a Salesforce report, this value is null. Relationship Name Source Refers To Report | | SourceType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The category of the source the agent is referencing. Possible values are: - Report - ZoomInfo | # ProspectingAgentExternalCompanyResearch Represents research done by a prospecting agent on an external company. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | ExternalIdentifier | Type string Properties Filter, Group, Sort Description The external ID associated with the lead or contact the AI agent researched. | | IsQualified | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The default value is false. | | OwnerId | Type reference Properties Filter, Group, Sort Description This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Rationale | Type textarea Properties Nillable Description The explanation of why the account was qualified or not. The rationale provides extra context to guide human users in their decision making. | | ResearchRunKey | Type string Properties Filter, Group, Nillable, Sort Description The date and time the research was complete. | | Source | Type string Properties Filter, Group, Nillable, Sort Description The source of the external company. | # ProspectingAgentExternalPersonResearch Represents research done by a prospecting agent on an external person. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | ExternalIdentifier | Type string Properties Filter, Group, Sort Description The external ID associated with the lead or contact the AI agent researched. | | IsQualified | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The default value is false. | | OwnerId | Type reference Properties Filter, Group, Sort Description This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Rationale | Type textarea Properties Nillable Description The explanation of why the account was qualified or not. The rationale provides extra context to guide human users in their decision making. | | ResearchRunKey | Type string Properties Filter, Group, Nillable, Sort Description The date and time the research was complete. | | Source | Type string Properties Filter, Group, Nillable, Sort Description The source of the external person. | # ProspectingAgentRcmdTarget Represents prospecting information suggested by generative AI. This object is available in API version 66.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | ExpirationDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date the recommendation expires, after which the recommendation is automatically deleted. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. The ID associated with the owner of the AI-generated recommendation. The owner can be an individual user or a list. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Rationale | Type textarea Properties Create, Nillable Description The explanation of why the agent recommended the target contact or lead. The rationale provides context to guide users in their decision making. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the AI-generated recommendation. Possible values are: - Accepted - New – Default - Rejected | | TargetId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Required. The ID associated with the contact or lead recommended by the AI agent. This field is a polymorphic relationship field. Relationship Name Target Refers To Contact, Lead | # ProspectingAgentSpec Represents a Prospecting Agent specification. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | AgentDeveloperName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The developer name associated with the agent. | | BotDefinitionId | Type reference Properties Filter, Group, Nillable, Sort Description This field is a relationship field. Relationship Name BotDefinition Refers To BotDefinition | | CurrentRunErrorCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Possible values are: - AgentConfigInvalid - AgentInactive - AgentTimeout - GeneralException - InvalidInputs - ReportSelectionInvalid - UnknownError - ZoomInfoAuthFailure - ZoomInfoLookupFailed - ZoomInfoQuotaExhausted - ZoomInfoRateLimited | | CurrentRunStartDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time the current run started. | | CurrentRunStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Possible values are: - Completed - Failed - Interrupted - NotAvailable - Pending - Queued - Running - Skipped | | OwnerId | Type reference Properties Create, Defaulted on Create, Filter, Group, Sort, Update Description This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | # ProspectingAgentSpecParm Stores runtime configuration parameters for a ProspectingAgentSpec. Each row represents one parameter keyed by type namespace and parameter name. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | ProspectingAgentSpecId | Type reference Properties Create, Filter, Group, Sort Description A reference to the parent ProspectingAgentSpec. Relationship Name ProspectingAgentSpec Relationship Type Master-detail Refers To ProspectingAgentSpec (the master object) | | ProspectingAgentDataSourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the parent ProspectingAgentDataSource. The parent field can determine available categories for the config parameter. When the value is null, the config applies to all sources. Relationship Name ProspectingAgentDataSource Refers To ProspectingAgentDataSource | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The category for this config parameter. Possible values are: - Automation - Governance - Ownership - Prompt | | ParameterName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name for this config parameter. | | Value | Type textarea Properties Create, Nillable, Update Description The config value. Can be in JSON or text format. | | DataType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Possible values are: - Boolean - Datetime - Dict - List - Number - String | # ProspectingAgentUserSpec Represents a Prospecting Agent user specification. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available if Agentforce Prospecting is enabled in your org and your org has an Agentforce for Sales or an Agentforce for an Industry add-on license. To access this object, you need the Sales Agentic Prospecting Manager user permission. ## Fields | Field | Details | | --- | --- | | ProspectingAgentDataSourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the parent ProspectingAgentDataSource. (Null means user specification is at the agent definition level.) Relationship Name ProspectingAgentDataSource Refers To ProspectingAgentDataSource | | ProspectingAgentSpecId | Type reference Properties Create, Filter, Group, Sort Description A reference to the parent ProspectingAgentSpecification. Relationship Name ProspectingAgentSpec Relationship Type Master-detail Refers To ProspectingAgentSpec (the master object) | | UserId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID associated with the parent user. Relationship Name User Refers To User | | UserType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of user. Possible values are: - LibraryUser - Library User - LicensedRep - Licensed Rep | # PublicComplaint Represents the complaints submitted by public users. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Fields added in API version 58.0 are available if the add-on license for Financial Services Cloud is enabled. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Account associated with this complaint. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | BusinessAddress | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The address of the business. | | BusinessName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the business. | | CauseSubtype | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The subtype of complaint cause. This field is available in API version 58.0 and later. Possible values are: - Misleading advertisement or documentation | | CauseType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of complaint cause. This field is available in API version 58.0 and later. Possible values are: - Product Communication | | Comments | Type textarea Properties Create, Nillable, Update Description Additional details about the complaint. This field is available in API version 51.0 and later. | | CompensationAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Any amount of money offered to resolve the complaint. This field is available in API version 58.0 and later. | | ComplaintCaseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related Case. This field is available in API version 58.0 and later. This field is a relationship field. Relationship Name ComplaintCase Relationship Type Lookup Refers To Case | | ComplaintCaseStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description The status of the related Case. This field is available in API version 58.0 and later. Possible values are: - Closed - Escalated - In Progress - Merged - New - On Hold - Response Received - Waiting for Customer - Working The default value is New. | | ComplaintSubType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The subtype of complaint. All values except Fire Safety are available in API version 58.0 and later. Possible values are: - Account Opening/Closure - Amount Not Dispensed - Attempts to Collect Debt not Owed - Auto Debit Mandate - Communication Tactics - Credit Limit Changed - Credit Report / Credit Score - Delays / Timescales - Disputes over sums/charges - Errors / not following instructions - Fire Safety - Fraud Handling - Inaccessible ATMs - Inaccessible Branch Entrances - Inaccessible Mobile banking features - Inaccessible Website - Misleading Advertising - Mobile Banking - Features or Functionality - No Written Notification About Debt - Online Banking - Features or Functionality - Other General Admin/Customer Service - Others - Problem when Making Payments - Product Disclosure Information - Product Performance/Features - Unauthorised Transaction(s) - Unclear Arrangement - Unclear Guidance - Unsuitable Advice | | ComplaintSummary | Type textarea Properties Create, Nillable, Update Description The summary of customer complaints and related cases. This field is available in API version 62.0 and later. | | ComplaintType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of complaint. All values except Safety are available in API version 58.0 and later. Possible values are: - Accessibility Issues - Advising, Selling and Arranging - Digital or Technology - Financial Hardship or Collections - General Admin/ Customer Service - Information, sums/ charges or Product Performance - Lending / Credit - Marketing or Corporate Communications - Others - Safety - Transaction Related | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the complaint. | | Email | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email of the complainant. | | EscalationCause | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The reason the complaint was escalated. This field is available in API version 58.0 and later. Possible values are: - Alleged ADA Violation - Alleged Discrimination - Alleged MLA Violation - Alleged SCRA Violation - Alleged UDAAP Violation - Consumer Protection Agency Involvement - Lawsuit Filed - Media Involvement - None - Received by Executive Leadership The default is None. | | FirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The given name of the complainant. | | IncidentDate | Type date Properties Create, Filter, Group, Sort, Update Description The date of the incident. The default is the date this record was created, but this field is editable. | | IsComplainantAuthorized | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the person who filed the complaint is an authorized representative of the Account. This field is available in API version 58.0 and later. The default value is false. | | IsReporterConfidential | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The reporter's request for confidentiality. The default value is false. | | LastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The family name of the complainant. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, possibly the user only accessed this record or list view (LastReferencedDate) but didn't view it. | | MobileNumber | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The mobile number of the complainant. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the complaint. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the complaint owner. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The priority of the complaint. Possible values are: - Critical - High - Low - Medium The default value is Medium. | | ProductType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The product that the complaint is about. This field is available in API version 58.0 and later. Possible values are: - ATM / debit card - Credit Card or Prepaid Card - Insurance - Investments - Merchant Services - Mobile / electronic banking - Money transfers, virtual currency, and money services - Mortgage / Home Finance - Other - Personal Loan / other loans - Vehicle loan or lease | | ReceivedDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the complaint was received. This field is available in API version 58.0 and later. | | ReferenceRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset, vehicle, or financial account that’s associated with the public complaint. This field is available in API version 64.0 and later with Automotive Cloud. This field is a relationship field. Relationship Name ReferenceRecord Relationship Type Lookup Refers To Financial Account, Asset, Vehicle, Product2 | | ReporterAddress | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The address of the reporter for further communication. | | ReporterCategory | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Role of the reporter in the organization. Possible values are: - Childcare Providers - Healthcare worker - Law Enforcement - Medical Examiners - Mental Health Professionals - Other - School Personnel - Social Worker The default value is School Personnel. | | ReporterOrganization | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The organization the reporter is part of. | | ShouldInclInRegulatoryRpt | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether this complaint must be included in a regulatory report. This field is available in API version 58.0 and later. The default value is false. | | SourceType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The source of the complaint. This field is available in API version 58.0 and later. Possible values are: - Branch - Consumer Protection Agency - Contact Centre - Mobile App - Regulatory Agency - Social Media - Web Chat | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the complaint. Possible values are: - In Review - Resolved - Submitted The default value is Submitted. | | Subject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Subject of the complaint. This field is available in API version 51.0 and later. | ## 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. [PublicComplaintFeed](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. [PublicComplaintHistory](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. [PublicComplaintOwnerSharingRule](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. [PublicComplaintShare](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. # PurchaseQuantityRule Represents a rule that restricts the quantity of a product that can be purchased. The rule can be an increment, minimum, or maximum rule. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The PurchaseQuantityRule object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Possible values are: - EUR—Euro - USD—U.S. Dollar | | Increment | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Quantity of product that can be added with each increase. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Maximum | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Maximum quantity that can be purchased. | | Minimum | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Minimum quantity that can be purchased. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the purchase quantity rule. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the creator of this object. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | # PushTopic Represents a query that is the basis for notifying Streaming API clients of changes to records in an org. This object is available in API version 21.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules - This object is available only if Streaming API is enabled for your org. - Users with the Create permission can create this record. - To receive notifications, users must have read access on both the object in the PushTopic query and the PushTopic itself. ## Fields | Field | Details | | --- | --- | | ApiVersion | Type double Properties Create, Filter, Sort, Update Description Required. API version to use for executing the query specified in Query. It must be an API version greater than 20.0. If your query applies to a custom object from a package, this value must match the package's ApiVersion. Example value: 68.0 | | Description | Type string Properties Create, Filter, Nillable, Sort, Update Description Description of the PushTopic. Limit: 400 characters | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the record currently counts towards the organization's allocation. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Required. Descriptive name of the PushTopic, such as MyNewCases or TeamUpdatedContacts. Limit: 25 characters. This value identifies the channel and must be unique. | | NotifyForFields | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies which fields are evaluated to generate a notification. Possible values are: - All - Referenced (default) - Select - Where | | NotifyForOperationCreate | Type boolean Properties Create, Filter, Update Description true if a create operation should generate a notification, otherwise, false. Defaults to true. This field is available in API version 29.0 and later. | | NotifyForOperationDelete | Type boolean Properties Create, Filter, Update Description true if a delete operation should generate a notification, otherwise, false. Defaults to true. Clients must connect using the cometd/29.0 (or later) Streaming API endpoint to receive delete and undelete event notifications. This field is available in API version 29.0 and later. | | NotifyForOperationUndelete | Type boolean Properties Create, Filter, Update Description true if an undelete operation should generate a notification, otherwise, false. Defaults to true. Clients must connect using the cometd/29.0 (or later) Streaming API endpoint to receive delete and undelete event notifications. This field is available in API version 29.0 and later. | | NotifyForOperationUpdate | Type boolean Properties Create, Filter, Update Description true if an update operation should generate a notification, otherwise, false. Defaults to true. This field is available in API version 29.0 and later. | | NotifyForOperations | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Specifies which record events may generate a notification. In API version 29.0 and later, this field is read-only, and doesn’t contain information about delete and undelete events. Use NotifyForOperationCreate, NotifyForOperationDelete, NotifyForOperationUndelete and NotifyForOperationUpdate to specify which record events should generate a notification. Possible values are: - All (default) - Create - Extended - Update A value of Extended means that neither create or update operations are set to generate events. | | Query | Type string Properties Create, Filter, Sort, Update Description Required. The SOQL query statement that determines which record changes trigger events to be sent to the channel. Limit: 1,300 characters | ## Usage The PushTopic defines when notifications are generated in the channel. Determine which fields to configure by checking out these links in the Streaming API Developer Guide. - [PushTopic Queries](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_streaming.meta/api_streaming/pushtopic_queries.htm "HTML (New Window)") - [Events](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_streaming.meta/api_streaming/events.htm "HTML (New Window)") - [Notifications](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_streaming.meta/api_streaming/notifications.htm "HTML (New Window)") #### See Also - [_Streaming API Developer Guide_](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_streaming.meta/api_streaming/intro_stream.htm " Streaming API Developer Guide - HTML (New Window)") # PushUpgradeCustomization Customized push upgrades allow a package subscriber to block push upgrades to their org. Package developers control which subscribers can opt into customized push upgrades. Each push upgrade customization maps to a specific package and to a specific subscriber org. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CustomUpgradeType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of push upgrade customization. Possible values are: - BlockedBySubscriber—Blocked By Subscriber - None The default value is None. | | ExpirationDays | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The number of days that a subscriber is allowed to block push upgrades. Enter \-1 to set customized push upgrades to never expire. The default value is null. | | HasRestrictionEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the subscriber org has blocked push upgrades. The default value is false. | | IsCustomUpgradeAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the package developer has allowed a subscriber to opt into customized push upgrades. The default value is false. | | IsRestrictionOverridden | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether customized push upgrades have been overridden by Salesforce Customer Support for the subscriber org. The default value is false. | | PushUpgradeBlockInitiatedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date that IsCustomUpgradeAllowed was set to true. | # PymtSchdDistributionMethod Indicates how the total payment is divided into partial payments. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_pymtschddistributionmethod.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description User-entered description of the payment schedule distribution method. | | DistributionCount | Type int Properties Create, Filter, Group, Sort, Update Description The number of payment schedule items for the payment schedule. The payment schedule items are used to distribute the payment schedule’s total payment into partial payments. Possible values are: - 1—Full distribution. Currently, each payment schedule must have exactly one payment schedule item. | | DistributionMethodType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Distribution method time interval. Possible values are: - FullDistribution—The full amount on the payment schedule is distributed to a single payment schedule item. - LumpSum—The specified payment amount on the payment schedule is distributed to a single payment schedule item. Available in API version 65.0 and later with Financial Services and Automotive Cloud. - Monthly—The specified payment amount on the payment schedule is distributed evenly across multiple monthly payments. Available in API version 65.0 and later with Financial Services and Automotive Cloud. - Quarterly—The specified payment amount on the payment schedule is distributed evenly across multiple quarterly payments. Available in API version 65.0 and later with Financial Services and Automotive Cloud. - Weekly—The specified payment amount on the payment schedule is distributed evenly across multiple weekly payments. Available in API version 65.0 and later with Financial Services and Automotive Cloud. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description User-entered name for the payment schedule distribution method. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | # Question Represents a question in a zone that users can view and reply to. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is only available if the Answers permission and AnswersEnabled preference or PortalFeed permission and PortalFeedEnabled preference are enabled in your org. ## Fields | Field | Details | | --- | --- | | BestReplyId | Type reference Properties Filter, Group, Nillable, Sort, Update Description The ID of the reply that has been identified as the best answer to the question. Use the user interface to identify the best answer for a question. | | BestReplySelectedById | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who selected the best answer to the question. This field is available in API version 24.0 and later. In API version 24.0 through version 29.0, you must update this field using the UI. In API version 30.0 and later, you can update this field using the API. | | Body | Type textarea Properties Create, Nillable, Update Description Description of the question. | | CommunityId | Type reference Properties Create, Filter, Group, Sort Description The zone ID associated with the question. After you create a question, you can’t change the zone ID associated with that question. | | CreatorFullPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | CreatorName | Type string Properties Filter, Group, Nillable, Sort Description Name of the user who posted the question or reply. Only the first name of internal users (agents) appears to portal users in the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | CreatorSmallPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | HasSingleFieldForContent | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the content of a Chatter Answers question is: - Included in only one field: Title if the content is unformatted and less than 255 characters; or Body if the content is formatted or more than 255 characters (true) - Included in two fields: Title and Body (false) This field also determines if content displays in one or two fields in Chatter Answers question feeds. This field is available in API version 25.0 and later. | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record. | | LastReplyDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time the last reply (child Reply object) was posted. | | LastReplyId | Type reference Properties Filter, Group, Nillable, Sort Description Read only. The ID of the last reply (child Reply object) posted to the question. | | LastViewedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | MostReportAbusesOnReply | Type int Properties Filter, Group, Nillable, Sort Description The most number of user-reported abuses on a Reply associated with the question. This field is available in API version 24.0 and later. | | NumReplies | Type int Properties Filter, Group, Nillable, Sort Description The number of replies (child Reply object) that users have submitted for the question. | | NumReportAbuses | Type int Properties Filter, Group, Nillable, Sort Description Represents the number of user-reported abuses on the question. This field is available in API version 24.0 and later. | | NumSubscriptions | Type int Properties Filter, Group, Nillable, Sort Description Represents the number of users following the question. This field is available in API version 24.0 and later. | | Origin | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The source of the question, such as Chatter Answers. This field is available in API version 24.0 and later. | | Title | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The descriptive title of the question. | | UpVotes | Type int Properties Filter, Group, Nillable, Sort Description The total number of up votes for the question. | | VoteScore | Type double Properties Filter, Nillable, Sort Description The internal score of the question, used to sort questions and articles on the Popular tab in the application user interface. The internal algorithm that determines the score gives older votes less weight than newer votes, simulating exponential decay. The score itself doesn’t display in the application user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Unlike other fields of type double, you can't use a SOQL aggregate function with this field. | ## Usage Use this object to track questions in a zone. # QuestionDataCategorySelection A data category selection represents a data category that classifies a question. This object can be used to associate a question with a data category from a data category group or to query the categorization for a question. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To create, read or update data category selection, you must have create, read or update permission on the categorized question. Users who can update question can also delete its category selection. Users who can create questions can only select categories visible to their role. ## Fields | Field Name | Details | | --- | --- | | DataCategoryGroupName | Type DataCategoryGroupReference Properties Create Description Unique name of the data category group which has a category associated with the question. | | DataCategoryName | Type DataCategoryGroupReference Properties Create Description Unique name of the data category associated with the question. | | ParentId | Type reference Properties Create, Filter Description ID of the question associated with the data category selection. | ## Usage Every question can be categorized in a data category. You can use the QuestionDataCategorySelection object to query and manage question categorization. Client applications can create categorization for a question. They can also delete, query, and retrieve question categorization. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning Even though the API lets you select more than one category for QuestionDataCategorySelection, the Answers tab only supports one data category selection for questions. Selecting multiple categories through QuestionDataCategorySelection may result in unexpected behavior in the Answers tab, such as losing your multiple selections. You should only select one data category when using QuestionDataCategorySelection. ## Sample Code—Java In the following example, the selectCategory method adds a category to a question data category selection. The retrieveCategorySelections method returns all the categories from a question data category selection. public void selectCategory(ID parentId, String categoryGroupName, String categoryName) { try { QuestionDataCategorySelection categorySelection = new QuestionDataCategorySelection(); categorySelection.setParentId(parentId); categorySelection.setDataCategoryGroupName(categoryGroupName); categorySelection.setDataCategoryName(categoryName); binding.create(new SObject\[\]{categorySelection}); } catch (RemoteException e) { System.out.println("An unexpected error has occurred." + e.getMessage()); } } public String\[\] retrieveCategorySelections(String parentId) { QueryResult qr = null; try { qr = binding.query("SELECT DataCategoryName FROM QuestionDataCategorySelection WHERE Id = '" + parentId + "'"); } catch (RemoteException e) { System.out.println("An unexpected error has occurred." + e.getMessage()); } String\[\] categoryNames = new String\[qr.getRecords().length\]; for (int index = 0; index < qr.getRecords().length; index++) { categoryNames\[index\] = ((QuestionDataCategorySelection)qr.getRecords()\[index\]).getDataCategoryName(); } return categoryNames; } Salesforce Knowledge uses a similar object for article data category selection. See [Article Type \_\_DataCategorySelection \_\_DataCategorySelection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_articletype__datacategoryselection.htm#sforce_api_objects_articletype__datacategoryselection "A data category selection represents a data category that classifies an article. This object is available in API version 19.0 and later.") for SOQL examples using this object. #### See Also - [Article Type\_\_DataCategorySelection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_articletype__datacategoryselection.htm "A data category selection represents a data category that classifies an article. This object is available in API version 19.0 and later.") # QuestionReportAbuse Represents a user-reported abuse on a Question in a Chatter Answers zone. This object is available in API version 24.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the Question from which the user reported abuse. | | QuestionId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Question from which the user reported abuse. | | Reason | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The reason the user reported abuse on the Question, such as Spam, Hateful, or Inappropriate. | ## Usage Use this object to track user-reported abuse on questions created in a Chatter Answers zone. # QuestionSubscription Represents a subscription for a user following a Question. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CommunityId | Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the zone associated with the Question the user is following. This field can’t be updated. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The name of the question subscription. | | QuestionCreatedDate | Type dateTime Properties Filter, Nillable, Sort Description Required. Creation date of the Question which the user is following. This field can’t be updated. | | QuestionId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the Question which the user is following. This field can’t be updated. | | SubscriberId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the User who is following the Question. This field can’t be updated. | ## Usage Things to consider when following a Question: - A user can only follow questions that they have permission to view. - Administrators and users with the “Modify All Data” permission can configure other users to follow questions that the other user has read access to. - Administrators and users with the “Modify All Data” permission can configure users to stop following questions. Queries on QuestionSubscription: - Users with the “Read” permission on Question can see which questions other users are following. - A query must include a LIMIT clause and the limit can’t exceed 1,000. - A query using a WHERE clause can only filter by fields on Question. # Queued Execution Event Type Queued Execution events contain details about queued executions—for example, batch Apex. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CPU\_TIME | Type Number Description The CPU time in milliseconds that it took to complete the batch apex request. This field indicates the amount of activity taking place in the app server layer, allowing you to identify pieces of Apex or Visualforce code that need refactoring. | | DB\_TOTAL\_TIME | Type Number Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB\_CPU\_TIME. Compare this field to CPU\_TIME to determine whether performance issues are occurring in the database layer or in your own code. | | ENTRY\_POINT | Type String Description The name of the Apex class that serves as the execution point for the batch job. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field contains data only for [Batch Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_batch.htm "HTML (New Window)"). It is unpopulated for Future and Queueable processes. Example TaskPhoneExtensionBatchUpdate | | EVENT\_TYPE | Type String Description The type of event. The value is always QueuedExecution. | | JOB\_ID | Type String Description The ID of the batch Apex job. Example 7073000000lDquo | | LOGIN\_KEY | Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. For example: 00D000000000123. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | REQUEST\_STATUS | Type String Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RUN\_TIME | Type Number Description The amount of time that the request took in milliseconds. | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | URI | Type String Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | URI\_ID\_DERIVED | Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. | | USER\_ID | Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. For example: 00590000000I1SNIA0. | | USER\_TYPE | Type String Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # QueuedExecutionEventLog Queued Execution events contain details about queued executions—for example, batch Apex. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB\_CPU\_TIME. Compare this field to CPU\_TIME to determine whether performance issues are occurring in the database layer or in your own code. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | RequestStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # QueueRoutingConfig Represents the settings that determine how work items are routed to agents. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), query(), retrieve(), update() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | CapacityPercentage | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of an agent’s capacity for work items that’s consumed by a specific type of work item from this service channel. Voice calls must have a capacity percentage of 100. If an agent receives a voice call, the agent won’t receive new work items until the call ends, because at that point the agent’s capacity will have reached 100%. This field is available in API version 33.0 and later. | | CapacityWeight | Type double Properties Create, Filter, Nillable, Sort, Update Description The amount of an agent’s capacity for work items that’s consumed by a work item from this service channel. For example, if an agent has a capacity of 6, and cases are assigned a capacity weight of 2, an agent can be assigned up to 3 cases before the agent is at capacity and can’t receive new work items. Voice calls must use the entire capacity weight. This field is available in API version 33.0 and later. | | DeveloperName | Type string Properties 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | DropAdditionalSkillsTimeout | Type int Properties Create, Filter, Group Nillable, Sort, Update Description The number of seconds to wait before a skill marked as **Additional Skill** is dropped from Omni-Channel routing. The case is then routed to the best-matched agent even if they don’t have all the skills. | | IsAttributeBased | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this routing is attribute-based. Available in API version 45.0 and later. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the presence status. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label of the presence status. | | OverflowAssigneeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user or queue that’s set as the Overflow Assignee. | | | | | PausedCapacityPercentage | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of an agent’s capacity for work items that’s consumed by a paused work item from this service channel. The paused capacity feature is available with status-based capacity and Enhanced Omni-Channel only. | | PausedCapacityWeight | Type double Properties Create, Filter, Nillable, Sort, Update Description The amount of an agent’s capacity for work items that’s consumed by a paused work item from this service channel. The paused capacity feature is available with status-based capacity and Enhanced Omni-Channel only. | | PushTimeout | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of seconds set for push timeout. **0** is returned when push timeout isn’t enabled. Available in API version 36.0 and later. | | RoutingModel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The routing type that determines how work items are routed (pushed) to agents. Possible values are Least Active and Most Available. | | RoutingPriority | Type int Properties Create, Filter, Group, Sort, Update Description The priority in which work items from the service channels that are related to this routing configuration are routed to agents. Work items from routing configurations that have lower priority values (for example, 0) are routed to agents first. | | ServiceChannelId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service channel that’s associated with this configuration. This field is available in API version 32.0 and earlier. | # QueueSobject Represents the mapping between a queue Group and the types associated with the queue, including custom objects. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. A queue is a Group whose Type is Queue. To create a Group, you must have the Manage Users permission. ## Fields | Field | Details | | --- | --- | | QueueId | Type reference Properties Create, Filter, Group, Sort Description The ID of a queue. This field is a relationship field. Relationship Name Queue Relationship Type Lookup Refers To Group | | SobjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description A list of object types that can be associated with the queue specified by the QueueId. | ## Usage Use this object to associate a queue with the sObject that can be associated with the queue, including custom objects. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning You can't update or insert more than 18 queues at once when using the Bulk API. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # QuickText This object stores a snippet of text that allows users to send a quick response to a customer. Use quick text to create greetings, answers to common questions, short notes, and more. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Category | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description A customizable picklist that can be used to group multiple related quick text records together | | Channel | Type multipicklist Properties Create, Defaulted on create, Filter, Nillable, Update Description A multi-select picklist that can be used to specify where specific quick text messages are available, such as in Chat or in the Email publisher in Case Feed. | | FolderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Returns the ID of the folder that contains the quick text. Available in API version 44.0 and later. This is a relationship field. Relationship Name Folder Relationship Type Lookup Refers To Folder | | FolderName | Type string Properties Filter, Nillable, Sort Description Name of the folder that contains the quick text. Available in API version 44.0 and later. | | IsInsertable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the quick text is available in the channels selected in the Channel field. If false, the quick text is not available. The label in the UI is **Include in selected channels**. By default: - This field is set to true on quick text records created from the Quick Text page or via the API. - This field is set to false on quick text records created during the Einstein Reply Recommendations reply publishing process. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Message | Type textarea Properties Create, Filter (unavailable in API version 25.0 and later), Sort (unavailable in API version 25.0 and later), Update Description The content of the quick text record | | Name | Type string Properties Create, Filter (unavailable in API version 25.0 and later), Group, idLookup, Sort (unavailable in API version 25.0 and later), Update Description A descriptive label for the quick text record | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the [User](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_user.htm "Represents a user in your organization.") or Queue that owns the quick text record This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | SourceType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description (Used with Einstein Reply Recommendations.) Indicates how the text was composed. This field is not available in the UI. Possible values are: - EINSTEIN\_GENERATED—Text was generated by Einstein Reply Recommendations - USER\_EDITED—Text was generated by Einstein Reply Recommendations, and then edited by a user - USER\_GENERATED—User wrote the text | ## Usage Use this object to create and manage the quick text messages available to users. You can categorize multiple quick text records into groups using the Category field. The Category field can also be a parent to multiple custom-dependent Picklist fields to create a hierarchical structure of categories. QuickText is also used in Einstein Reply Recommendations, a feature that recommends stock replies for support agents to use in chats in the Lightning Service Console. During setup, Einstein Reply Recommendations scans past chats to generate a list of commonly used replies. Each generated reply is a ReplyText record. The admin then publishes, or converts, the replies to quick text, creating a corresponding QuickText record for each reply. Therefore, certain QuickText fields are used only on quick text records that originated as a ReplyText record. ## 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. [QuickTextChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [QuickTextHistory](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. [QuickTextOwnerSharingRule](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. [QuickTextShare](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. # QuickTextUsage Represents the usage of quick text on a record, including which quick text was used, who used it, and how they used it. Quick text is a snippet of text that allows users to send a quick response to a customer. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is always read-only. ## Fields | Field | Details | | --- | --- | | AppContext | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Context in which the quick text was used. Possible values are: - Aloha—Salesforce Classic - Lightning—Lightning Experience - Unknown | | Channel | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The channel in which the quick text was used. Possible values are: - Email - Event - Generic - Internal - Knowledge - Live Agent - Messaging - Phone - Portal - Social - Task | | FolderId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the folder containing the quick text at the time it was used. This is a relationship field. Relationship Name Folder Relationship Type Lookup Refers To Folder | | LaunchSource | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description How the user started the quick text. Possible values are: - Floater - Keyboard shortcut - Macro - Toolbar | | LoggedTime | Type dateTime Properties Filter, Nillable, Sort Description The time when the quick text was used. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Name of the quick text. | | OwnerId | Type reference Properties Filter, Group, Sort Description ID of the group or user that owns the quick text. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | QuickTextID | Type reference Properties Filter, Group, Sort Description ID of the quick text. This is a relationship field. Relationship Name QuickText Relationship Type Lookup Refers To QuickText | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user that used the quick text. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [QuickTextUsageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [QuickTextUsageOwnerSharingRule](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. [QuickTextUsageShare](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. # Quote Represents a quote, which is a record showing proposed prices for products and services. Available in API version 18.0 and later. Quotes can be created from and synced with opportunities, and emailed as PDFs to customers ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the account that’s associated with the quote. | | AdditionalAddress | Type address Properties Filter, Nillable Description Compound form of the additional address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | AdditionalCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the quote's additional address. Up to 40 characters allowed. | | AdditionalCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the quote's additional address. Up to 80 characters allowed. | | AdditionalCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO country code for the quote’s additional address. | | AdditionalLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with AdditionalLongitude to specify the precise geolocation of an additional address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | AdditionalLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with AdditionalLatitude to specify the precise geolocation of an additional address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | AdditionalName | Type string Properties Filter, Group, Nillable, Sort Description Name associated with the quote's additional address. Limited: 255 characters. | | AdditionalPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal Code for the quote's additional address. | | AdditionalState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the quote's additional address. Up to 80 characters allowed. | | AdditionalStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO state code for the quote’s additional address. | | AdditionalStreet | Type textarea Properties Create, Filter, Nillable, Group, Sort, Update Description Street name for the quote's additional address. | | BillToContactId | Type reference Properties Create, Filter, Nillable, Group, Sort, Update Description ID of the contact that the order is billed to. This field is available in API version 56.0 and later. This field is available with Subscription Management. | | BillingAddress | Type address Properties Filter, Nillable Description Compound form of the billing address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the quote's billing address. Up to 40 characters allowed. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the quote's billing address. Up to 80 characters allowed. | | BillingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO country code for the quote’s billing address. | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | BillingName | Type string Properties Filter, Group, Nillable, Sort Description Entity that the quote is billed to. | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal Code for the quote's billing address. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the quote's billing address. Up to 80 characters allowed. | | BillingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO state code for the quote’s billing address. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street name for the quote's billing address. | | CalculationStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Price calculations are performed by Salesforce. Tax calculations are performed by a third-party tax provider integration with Salesforce. Both of these calculations are asynchronous, and you can use this field to see the status of the asynchronous processes. This field is available with Subscription Management or Revenue Cloud. Possible values are: - CompletedWithPricing—Indicates that pricing is complete and tax will now be calculated. - CompletedWithTax—Indicates that pricing and tax calculation are complete. - CompletedWithoutPricing—Indicates that pricing and tax calculation were skipped. - ConfigurationFailed—Indicates that configuration failed. Available in API version 62.0 - ConfigurationInProgress—Indicates that the configuration is in progress. Available in API version 62.0 - GroupRampConfigurationFailed—Indicates that the checks for group ramps have failed. Available in API version 65.0 and later. - NotStarted - PriceCalculationFailed—Indicates that pricing failed. Available in API version 58.0 and later. - PriceCalculationInProgress—Available in API version 58.0 and later. - PriceCalculationQueued—The request is sent to the asynchronous price calculation process, but the process hasn’t started. Available in API version 58.0 and later. - QuoteRequestFailed—Indicates that the requested quote changes weren’t saved. Available in API version 62.0 - QuoteRequestPartiallySaved—Indicates that the requested quote changes were partially saved. Available in API version 62.0 - ReconciliationFailed—Indicates that the arrangement of quote data failed. Available in API version 62.0 - ReconciliationInProgress—Indicates that the arrangement of data is in progress. For a sales rep, this value appears as Saving on the quote page. Available in API version 62.0 - SaveFailedOrIncomplete—Some or all of the records couldn’t be saved. For example, some of the quote line item records weren’t saved. Available in API version 58.0 and later. - Saving - TaxCalculationFailed - TaxCalculationInProcess - TaxCalculationSuccess—Available in API versions 56.0 and 57.0 - TaxCalculationWaiting The default value is NotStarted. | | CanCreateQuoteLineItems | Type boolean Properties Create, Defaulted on create, Group Description This field isn’t used. | | ContactId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the contact that’s associated with the quote. | | ContractId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the contract that’s associated with the quote. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Restricted picklist Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. If the organization has multicurrency and a Pricebook2Id specified on the quote, then the currency value of this field must match the currency of the PricebookEntry objects that are associated with any quote line items it has. This value is copied from the related Opportunity and can't be changed. | | Description | Type textarea Properties Nillable Description Text description of the quote. Limit: 32,000 characters. | | Discount | Type percent Properties Filter, Nillable, Sort Description The difference between the QuoteLineItem record’s subtotal and its discounted total, divided by the QuoteLineItem’s subtotal. Expressed as a percentage. | | Email | Type email Properties Filter, Group, Nillable, Sort Description The email address of the contact who’s associated with the quote. | | ExpirationDate | Type date Properties Create, Filter, Nillable, Update Description The date when this quote is no longer valid. | | Fax | Type phone Properties Create, Filter, Nillable, Update Description The fax number for the contact who’s associated with the quote. | | GrandTotal | Type currency Properties Filter, Nillable Description The total price of the quote plus shipping and taxes. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The GrandTotal is a system-calculated summary field and is not directly referenceable or usable in custom formula fields on the Quote object. Attempts to do so result in an error message. For example, "Error: Field GrandTotal does not exist. Check spelling." To perform calculations based on the total value of a quote, consider using a **Roll-Up Summary** field from related Quote Line Items or performing calculations directly on the [QuoteLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelineitem.htm "Represents a quote line item, which is a member of the list of Product2 products associated with a quote, along with other information about those line items on that quote. Available in API version 18.0 and later.") object. | | IsSyncing | Type boolean Properties Defaulted on create, Filter Description Indicates whether the quote is syncing with an opportunity. | | InsuranceQuoteType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of insurance quote. Possible values are: - New Business - Renewal - Endorsement - Reinstatement - New Group Business - Group Endorsement - Group Renewal | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | LastViewedDate | Type date Properties Filter, Nillable, Sort, Update Description The 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 but not viewed it directly. | | LineItemCount | Type int Properties Filter, Nillable Description The number of line items on the quote. | | Name | Type string Properties Create, Filter, idLookup, Update Description Required. Name for the quote. Limit: 225 characters. | | OpportunityId | Type reference Properties Create, Filter Description ID for the opportunity associated with the quote. | | Phone | Type phone Properties Create, Filter, Nillable, Update Description The phone number of the contact who’s associated with the quote. | | Pricebook2Id | Type reference Properties Create, Filter, Nillable, Update Description ID of the price book associated with the quote. | | QuoteAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the account associated with the quote. This field is available in API version 58.0 and later only when the **Create Quotes Without a Related Opportunity** setting on the Quotes Settings page is enabled. This field is a relationship field. Relationship Name QuoteAccount Refers To Account | | QuoteNumber | Type string Properties Defaulted on create, Filter Description A system-generated number that identifies the quote. | | QuoteToAddress | Type address Properties Filter, Nillable Description Compound form of the quote to address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | QuoteToCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the address to send the quote to for approval, such as a third party-agency representing a buyer. Up to 40 characters allowed. | | QuoteToCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the address to send the quote to for approval. Up to 80 characters allowed. | | QuoteToLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with QuoteToLongitude to specify the precise geolocation of a quote to address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | QuoteToLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with QuoteToLatitude to specify the precise geolocation of a quote to address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | QuoteToName | Type string Properties Create, Filter, Nillable, Update Description The name of the entity (such as a person or business) that the quote is sent to for approval. Limit: 255 characters. | | QuoteToPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal code for the address to send the quote to for approval. | | QuoteToState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the address to send the quote to for approval. Up to 80 characters allowed. | | QuoteToStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street name for the address to send the quote to for approval. | | RecordSource | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the source application context for the record. This field is available with Digital Insurance in API version 66.0 and later. Possible values are: - DigitalInsurance - Null | | RecordTypeID | Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to the object. | | RelatedWorkId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Relationship field that’s visible only if Field Service and Quotes are enabled in the Salesforce org. This field refers to the work order that the quote is created from. When a mobile worker creates a quote using the New Quote action in the Field Service mobile app, this field is automatically populated. This field is used in the related list that shows all of the quotes related to the work order. | | ShippingAddress | Type address Properties Filter, Nillable Description Compound form of the shipping address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | ShippingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the quote's shipping address. Up to 40 characters allowed. | | ShippingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the quote's shipping address. Up to 80 characters allowed. | | ShippingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO country code for the quote’s shipping address. | | ShippingHandling | Type currency Properties Create, Filter, Nillable, Update Description The total shipping and handling costs for the quote. | | ShippingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | ShippingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | ShippingName | Type string Properties Create, Filter, Nillable, Update Description The name of the entity (such as a person or business) that the quote is sent to for approval. | | ShippingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal code for the quote's shipping address. | | ShippingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the quote's shipping address. Up to 80 characters allowed. | | ShippingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO state code for the quote’s shipping address. | | ShippingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street name for the quote's shipping address. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Nillable, Update Description The status of the quote. The standard options are: - —None— - Draft - Needs Review - In Review - Approved - Rejected - Presented - Accepted - Denied | | Subtotal | Type currency Properties Filter, Nillable Description The sum of sales price multiplied by quantity for line items, not including the discount. | | Tax | Type currency Properties Create, Filter, Nillable, Update Description The total taxes for the quote. | | TotalPrice | Type currency Properties Filter, Nillable Description The total of the quote line items after discounts and before taxes and shipping. | | TotalPriceWithTax | Type currency Properties Filter, Nillable, Sort Description The sum of TotalPrice and TotalTaxAmount. This field is available in API version 55.0 and later. This field is available if Subscription Management is enabled in your org. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description The total amount of all taxes. This field is available in API version 55.0 and later. This field is available if Subscription Management is enabled in your org. This field is a calculated field. | ## Usage Use Quote to manage proposed product prices for customers. To update a Quote, your client application needs “Edit” permission. - Client applications can create, update, delete, and query Attachment records associated with a quote via the API. - You can sync a quote and its parent Opportunity. ## 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. [QuoteChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [QuoteFeed](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.") (API version 39.0) Feed tracking is available for the object. [QuoteHistory](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.") (API version 57.0) History is available for tracked fields of the object. [QuoteOwnerSharingRule](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.") (API version 41.0) Sharing rules are available for the object. [QuoteShare](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.") (API version 41.0) Sharing is available for the object. #### See Also - [QuoteLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelineitem.htm "Represents a quote line item, which is a member of the list of Product2 products associated with a quote, along with other information about those line items on that quote. Available in API version 18.0 and later.") - [QuoteDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotedocument.htm "Represents a quote in document format. Available in API version 18.0 and later.") - [Opportunity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm "Represents an opportunity, which is a sale or pending deal.") # QuoteAction Indicates the type of sales transaction that’s being quoted; for example, a renewal sale. This object is available in API version 59.0 and later. If a quote doesn't have a quote action, Salesforce treats it as a quote of the Add type. When such a quote is used to create an order, Salesforce automatically creates an order action of the Add type. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available in orgs with Revenue Cloud. It’s also available in Industries Automotive and Industries Field Service. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description ISO code of the currency. Use only one of the valid alphabetic, three-letter currency ISO codes defined by the ISO 4217 standard, such as USD, GBP, or JPY. Must be unique within your organization. Label is **Currency ISO Code**. The default value is USD. See [Supported Currencies (ICU)](https://help.salesforce.com/s/articleView?id=xcloud.admin_supported_currencies.htm&type=5&language=en_US "HTML (New Window)") for a list of currency codes Salesforce supports. This field is available in Revenue Cloud in API version 66.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user accessed this record or list view indirectly, but didn’t view it. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name given to the quote action. | | QuoteId | Type reference Properties Create, Filter, Group, Sort Description The quote related to this quote action. This field is a relationship field. Relationship Name Quote Relationship Type Lookup Refers To Quote | | SourceAssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset changed by this sales transaction. For example, if the quote action is a quantity amendment, this field contains the ID of the asset that’s amended. This field is a relationship field. Relationship Name SourceAsset Relationship Type Lookup Refers To Asset | | Subtype | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The subtype of the action on the quote line item. Valid values are: - DowngradeFrom—Available in API version 66.0 and later. - DowngradeTo—Available in API version 66.0 and later. - FieldAmendment - Rollback - StartDateAdjustment - SwapIn—Available in API version 66.0 and later. - SwapOut—Available in API version 66.0 and later. - TransferFrom - TransferTo - UpgradeFrom—Available in API version 66.0 and later. - UpgradeTo—Available in API version 66.0 and later. This field is available with Revenue Cloud in API version 64.0 and later. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of sales transaction that the related quote is for. Valid values are: - Add - Amend - Association—Available in API version 66.0 and later. - Cancel - No Change - Renew - Transfer—Available with Revenue Cloud in API version 65.0 and later. | # QuoteAdjustmentGroup Group containing a set of adjustments applied to a quote. This object is available in API version 58.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available with Subscription Management. ## Fields | Field | Details | | --- | --- | | AdjustmentSource | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates the origin of the price adjustment. Possible values are: - Discretionary—The adjustment is entered manually; for example, by a sales rep. - Promotion—The adjustment is part of a promotion; for example, a holiday sale discount. - Rule—The adjustment is due to a price rule. - System—The adjustment originates from the system, for example, a volume discount. | | AdjustmentType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates the type of mathematical adjustment to be applied to the quote. Possible values are: - AdjustmentAmount—The adjustment is a numerical amount, for example, a cash discount of 20. - AdjustmentPercentage—The adjustment is a percentage amount, for example, a 10% discount. - OverrideAmount—The adjustment is a manual price override. Available in API version 59.0 and later. | | AdjustmentValue | Type double Properties Filter, Sort Description The specified AdjustmentType amount that is applied to the quote. For example, when AdjustmentType is AdjustmentAmount, AdjustmentValue is the cash amount of the price adjustment. When AdjustmentType value is AdjustmentPercentage, AdjustmentValue is the percent value of the price adjustment. When AdjustmentType is OverrideAmount, AdjustmentValue overrides the total amount of the quote. | | Description | Type textarea Properties Nillable Description User-entered information about the quote adjustment group. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The user-defined name of the quote adjustment group. | | Priority | Type int Properties Filter, Group, Nillable, Sort Description A numeric value that represents the order of precedence of the quote adjustment group. It can also represent the order of precedence when applying the AdjustmentType values. For example, a quote can have two adjustments: a $100 discount and a 10% discount. This field indicates which adjustment to apply first. | | QuoteId | Type reference Properties Filter, Group, Sort Description The ID of the quote related to the adjustments in this group. This field is a relationship field. Relationship Name Quote Relationship Type Lookup Refers To Quote | | TotalAmount | Type currency Properties Filter, Sort Description The total of all quote adjustments in this quote adjustment group, excluding tax. | ## 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. [QuoteAdjustmentGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [QuoteAdjustmentGroupFeed](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. [QuoteAdjustmentGroupHistory](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. [QuoteAdjustmentGroupOwnerSharingRule](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. [QuoteAdjustmentGroupShare](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. # QuoteDocument Represents a quote in document format. Available in API version 18.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ContentVersionDocumentId | Type reference Properties Create, Filter, Group, Sort Description ID for the document’s version. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Restricted picklist Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. If the organization has multicurrency and a Pricebook2Id specified on the quote, then the currency value of this field must match the currency of the PricebookEntry objects that are associated with any quote line items it has. | | Discount | Type percent Properties Filter, Nillable, Sort Description The discount for the quote used in the document. | | Document | Type base64 Properties Create, Nillable Description The binary data of the document stored in the QuoteDocument object. | | DocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort Description The ID of the template used to generate the document. | | GrandTotal | Type currency Properties Filter, Nillable, Sort Description Grand total for the quote used in the document. | | Name | Type string Properties Filter, idLookup, Sort Description Name of the quote document. | | QuoteId | Type reference Properties Create, Filter, GroupSort Description ID for the quote used for the document. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the document. Possible values are: - Completed - Failed - Generating - In Progress - None - Queued The default value is None. | ## Usage Use the QuoteDocument object to store a document that can be used to present the quote information to the customer. #### See Also - [Quote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quote.htm "Represents a quote, which is a record showing proposed prices for products and services. Available in API version 18.0 and later.") - [QuoteLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelineitem.htm "Represents a quote line item, which is a member of the list of Product2 products associated with a quote, along with other information about those line items on that quote. Available in API version 18.0 and later.") # QuoteItemTaxItem The tax that is applied to a quote line item. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available if Subscription Management is enabled in your org. This object is also available in Enterprise, Unlimited, and Developer Editions of Revenue Cloud. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort, Update Description The tax amount for the quote line item. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the org. Possible values are: - BHD—Bahraini Dinar - EUR—Euro - JPY—Japanese Yen - USD—U.S. Dollar The default value is 'USD'. | | Description | Type textarea Properties Create, Nillable, Update Description User-defined description of the tax. For example, state sales tax or value-added tax (VAT). | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the tax. | | ProductSurchargeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product surcharge associated with the quote item tax item. This field is a relationship field. This field is available with Digital Insurance. Relationship Name ProductSurcharge Refers To ProductSurcharge | | ProratedSurchargeAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The prorated portion of the tax amount based on the quote line item's effective dates. This field is available with Digital Insurance. | | QuoteLineItemId | Type reference Properties Create, Filter, Group, Sort Description ID of the related quote line item. This is a relationship field. Relationship Name QuoteLineItem Relationship Type Lookup Refers To QuoteLineItem | | Rate | Type percent Properties Create, Filter, Nillable, Sort, Update Description If the tax is a percentage tax, then this field contains the percent value. If the tax is a fixed amount, then this field is null. | | TaxEffectiveDate | Type date Properties Create, Filter, Group, Sort, Update Description The date used to calculate the tax rate. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Whether the tax is estimated or calculated by the tax provider. Possible values are: - Actual - Estimated | # QuoteLineGroup Stores the group information for line items in a quote. It also stores the aggregated line field information (subtotal). It contains a parent-child relationship to quote. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the group. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for future use. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the group. | | QuoteId | Type reference Properties Create, Filter, Group, Sort Description The quote associated with the group. This field is a relationship field. Relationship Name Quote Relationship Type Master-detail Refers To Quote (the master object) | | SegmentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The time period for the segment. Possible values are: - Custom - FreeTrial—Free Trial - Prorated - Yearly The default value is Yearly. | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number indicating the sort order selected by the user. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for future use. | | SummarySubtotal | Type currency Properties Create, Filter, Nillable, Sort, Update Description The total amount of all the line items in the group. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the group. Possible values are: - CPQQuoteGroup—CPQ Line Grouping The default value is CPQQuoteGroup. | | UnitPriceUplift | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage increase of the quote line group's unit price. | # QuoteLineItem Represents a quote line item, which is a member of the list of Product2 products associated with a quote, along with other information about those line items on that quote. Available in API version 18.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The user must have “Edit” permissions on quote records to create or update quote line items on a quote. The user must have “Edit” permissions on quote records to delete a quote line item. Some of the fields are available when you turn on Subscription Management. ## Fields | Field | Details | | --- | --- | | BatchIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Identifier for a product bundle in a transaction processing batch. This value makes sure that quote lines from the same bundles process together. | | BillingFrequency | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time period that indicates how often the quote line item is billed. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. Possible values are: - Annual - Monthly | | BillingReference | Type string Properties Create, Filter, Group, Nillable, Sort Description Reference to the original quote for which this quote line item is created. This field is available in API version 61.0 and later. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for organizations enabled for multiple currencies. Contains the ISO code for any currency allowed by the organization. If the organization has multicurrency and a Pricebook2 specified on the quote (the Pricebook2Id field isn’t blank), then the currency value of this field must match the currency of the PricebookEntry objects for any associated quote line items. This value comes from the related quote and can't be changed. | | CustomProductName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Custom product name for the quote line item. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the line item. Limit: 225 characters. | | Discount | Type percent Properties Create, Filter, Nillable, Sort, Update Description The optional discount percentage, specified by the sales representative at the line level. Editable number from 0 to 100. | | DiscountAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The fixed amount discount to apply to the quote line item. Available in API version 59.0 and later. | | DoesAutomaticallyRenew | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the quote line item is set to automatically renew (True) or not (False). The default value is false. | | Division | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled. | | EffectiveGrantDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which the resources associated with the quote line item are granted. | | EndDate | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description If the quote line item is sold on subscription, this field indicates the date on which the subscription ends. This field is available in API version 55.0 and later. This field is available if Subscription Management is enabled in your org. You can indicate a subscription’s length by using either StartDate and EndDate, or by using StartDate and SubscriptionTerm. If you provide a value for both EndDate and SubscriptionTerm, EndDate is used to determine the subscription’s length. | | EndDateTime | Type dateTime Properties Filter, Nillable, Sort Description The end date and time of the quote line item, which is derived from the End Date and End Time fields in the time zone specified in the Start and End Time Zone field. If the time zone isn't specified, the default is Coordinated Universal Time (UTC). This field is available in Revenue Cloud in API version 65.0 and later. | | EndQuantity | Type double Properties Filter, Nillable, Sort Description If the quote line item is sold on a subscription, this field indicates the end quantity when the subscription ends. This field is available in API version 60.0 and later. This field is available with Subscription Management. | | EndTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The end time of the quote line item. This field is available in Revenue Cloud in API version 65.0 and later. | | HasQuantitySchedule | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the opportunity line item that the quote line item is synced with has a quantity schedule. | | HasRevenueSchedule | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the opportunity line item that the quote line item is synced with has a revenue schedule. If this object has a revenue schedule, the GrandTotal and TotalPrice fields can't be updated. In addition, the Quantity field can't be updated if this object has a quantity schedule. The system ignores any attempt to update this field. The update isn't rejected but the updated value is ignored. | | HasSchedule | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the line item uses schedules. | | IsPrimarySegment | Type boolean Properties Filter, Group, Sort Description Indicates whether the segment for the quote line item is a primary segment (true) or not (false). The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user only accessed this record or list view (LastReferencedDate) but not viewed it. | | LegalEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the legal entity record associated with the quote line item. This field is a relationship field. Relationship Name LegalEntity Refers To LegalEntity | | LineNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Read-only. An automatically generated number identifying the quote line item. In the form of QL-XXXXX. | | ListPrice | Type currency Properties Filter, Nillable, Sort Description Read-only. Corresponds to the UnitPrice on the PricebookEntry that is associated with this line item, which can be in the standard price book or a custom price book. A client app can use this information to show whether the unit price (or sales price) of the line item differs from the price book entry list price. | | ListPriceTotal | Type currency Properties Filter, Nillable, Sort Description The ListPrice times the Quantity. This field is a calculated field. | | Margin | Type percent Properties Create, Filter, Nillable, Sort, Update Description The optional margin percentage, specified by the sales representative at the line item level. This field is available in Revenue Cloud in API version 65.0 and later. | | MarginAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The optional margin amount, specified by the sales representative at the line item level. This field is available in Revenue Cloud in API version 65.0 and later. | | NetTotalPrice | Type currency Properties Filter, Nillable, Sort Description The price after all adjustments, inclusive of quantity, prorated for the duration of the subscription. This field is a calculated field equal to TotalAdjustmentAmount plus TotalLineAmount. This field is available in API version 56.0 and later. This field is available with Subscription Management. | | NetUnitPrice | Type currency Properties Filter, Nillable, Sort Description The unit price after all price adjustments are applied. | | OpportunityLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the related opportunity line item. This field is populated by the API during creation of the quote line item. Not editable. Available in API version 40.0 and later. | | ParentQuoteLineItemId | Type reference Properties Filter, Group, Nillable, Sort Description The unique identifier of the related line item in the parent quote. This field is populated by the API during creation of the quote line item. This field is available in version 58.0 and later. This field is available when Subscription Management is enabled. This field is a relationship field. Relationship Name ParentQuoteLineItem Relationship Type Lookup Refers To QuoteLineItem | | PartnerDiscountPercent | Type percent Properties Create, Filter, Nillable, Sort, Update Description The partner’s discount percent applied to the quote lines. Available in API version 59.0 and later. | | PartnerUnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description The unit price after applying the discount given to the partner for the quote line item. Available in API version 59.0 and later. | | PeriodBoundary | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The period boundary helps determine the start and end date of the billing periods. This field is available in API version 55.0 and later. This field is available with Subscription Management and Revenue Cloud. Possible values are: - AlignToCalendar—the period starts on the first day of the term unit; for example, the first day of the month. - Anniversary—The start date determines the boundary. For example, if a monthly subscription starts on September 13, the subscription starts on the 13th day of each month. - DayOfPeriod—the period starts on the day indicated by PeriodBoundaryDay. - LastDayOfPeriod—the period starts on the last day of the pricing term unit. Keep these considerations in mind for amendment, renewal, and cancellations of assets in Revenue Cloud. - The value of the PeriodBoundary field is copied from the AssetActionSource (initial sale), by default. - For termed selling models where the PeriodBoundary value is Anniversary, the value of the PeriodBoundary field is automatically converted to DayOfPeriod. - Start date adjustment operation on an asset preserves the original value without conversion. | | PeriodBoundaryDay | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Required when PeriodBoundary is DayOfPeriod. Indicates day of the week or month that marks the period boundary. Must be an integer from 1 through 31. This field is available in API version 55.0 and later. This field is available with Subscription Management and Revenue Cloud. Keep these considerations in mind for amendment, renewal, and cancellations of assets in Revenue Cloud. - The value of the PeriodBoundary field is copied from the AssetActionSource (initial sale), by default. - When PeriodBoundary field value is converted from Anniversary to DayOfPeriod for termed selling models, the value of the PeriodBoundaryDay field is automatically populated with the day value from AssetActionSource.StartDate. - Start date adjustment operation on an asset preserves the original value without conversion. | | PeriodBoundaryStartMonth | Type picklist Properties Create, Filter, Group, Restricted picklist, Nillable, Sort, Update Description The field is populated based on input in the StartDate, PeriodBoundary, and PeriodBoundaryDay when BillingFrequency is Annual and PricingTermUnit is Annual or by manual user entry. Possible values are: - 1-January - 2-February - 3-March - 4-April - 5-May - 6-June - 7-July - 8-August - 9-September - 10-October - 11-November - 12-December Keep these considerations in mind for amendment, renewal, and cancellations of assets in Revenue Cloud. - The value of the PeriodBoundary field is copied from the AssetActionSource (initial sale), by default. - For termed selling models where PeriodBoundary field value is Anniversary and PricingTermUnit field value is ANNUAL, SEMI\_ANNUAL, or QUARTERLY, the value of the PeriodBoundaryStartMonth field is automatically recalculated by using AssetActionSource.StartDate.month. - Start date adjustment operation on an asset preserves the original value without conversion. | | PricebookEntryId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated PricebookEntry. Exists only for orgs with Products enabled. In API 38.0 and earlier, if Product2Id is populated with PricebookEntryId data, you receive an error message. In API 39.0 and later, Product2Id is nulled, and PricebookEntryId is populated with the PricebookEntryId data. | | PriceRevisionPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The price uplift policy associated with this quote line item. This field is a relationship field. Relationship Name PriceRevisionPolicy Refers To PriceRevisionPolicy Label is **Price Revision Policy**. This field is available in Revenue Cloud in API version 65.0 and later. | | PricingContractId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The contract used for pricing that's associated with the quote line item. This field is a relationship field. Relationship Name PricingContract Refers To Contract | | PriceWaterfallIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The price waterfall identifier generated by Salesforce Pricing that's associated with the pricing of the detail record. Available in API version 60.0 and later. | | PricingTerm | Type int Properties Filter, Group, Nillable, Sort Description The number of terms in the subscription. For example, if a monthly subscription is priced yearly, this field is 12. This field is available in API version 55.0 and later. This field is available with Subscription Management. | | PricingTermCount | Type double Properties Filter, Nillable, Sort Description A calculated field indicating the number of pricing terms in the subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management. | | PricingTermUnit | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The unit of time for the pricing term. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: - Annual—Available in API version 58.0 and later. UI label is Years. - Months. | | Product2Id | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Product2 associated with this QuoteLineItem. In API 38.0 and earlier, if Product2Id is populated with PricebookEntryId data, you receive an error message. In API 39.0 and later, Product2Id is nulled, and PricebookEntryId is populated with the PricebookEntryId data. | | ProductInstanceIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the product instance that’s added to a quote. Each quote line item created for the same product instance has the same product instance identifier value. | | ProductSellingModelId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related product selling model. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name ProductSellingModel Relationship Type Lookup Refers To ProductSellingModel | | ProrationPolicyId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related proration policy. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name ProrationPolicy Relationship Type Lookup Refers To ProrationPolicy | | Quantity | Type double Properties Create, Filter, Sort, Update Description Required. The number of units for the line item. | | QuantityUnitOfMeasureId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The unit of measure for the quantity, start quantity, and end quantity. This field is a relationship field. Relationship Name QuantityUnitOfMeasure Refers To UnitOfMeasure | | QuoteActionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related quote action. This field is available in API version 58.0 and later. This field is available with Subscription Management and Revenue Lifecycle Management. This field is a relationship field. Relationship Name QuoteAction Relationship Type Lookup Refers To QuoteAction | | QuoteId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated quote. | | QuoteLineGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the quote line group for the quote line item. This field is a relationship field. Relationship Name QuoteLineGroup Refers To QuoteLineGroup | | QuoteLineItemRecipientId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the recipient for the quote line item. This field is a relationship field. Relationship Name QuoteLineItemRecipient Refers To QuoteLineItemRecipient | | RampIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ramp ID used to group quote line item segments. | | RelatedQuoteLineItemId | Type reference Properties Filter, Group, Nillable, Sort Description The quote line item ID related to the order item created. This field is a relationship field. Relationship Name RelatedQuoteLineItem Refers To OrderItem This field is available in Revenue Cloud in API version 65.0 and later. | | SegmentIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the segment. | | SegmentName | Type string Properties Filter, Group, Nillable, Sort Description The name of the quote line item segment. | | SegmentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The time period for the segment. Possible values are: - Custom - FreeTrial—Free Trial - Prorated - Yearly The default value is Yearly. | | SellingModelType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the quote line item is sold as a one-time purchase, an evergreen subscription, or as a termed subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: - Evergreen - OneTime - TermDefined The default value is OneTime. | | ServiceDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the product revenue is recognized and the product quantity is shipped. | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The value of where the line item is in the sorted order such as 1, 2, 3. The SortOrder value determines the order in which a quote line item appears in the Quote Line Items related list and the Quote PDF. Client apps can use this value to match the sort order in Salesforce. This field is only available in API versions 21.0 and greater. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description If the quote line item is sold on subscription, this field indicates the date on which the subscription starts. This field is available in API version 55.0 and later. This field is available with Subscription Management. | | StartDateTime | Type dateTime Properties Filter, Nillable, Sort Description The start date and time of the quote line item, which is derived from the Start Date and Start Time fields in the time zone specified in the Start and End Time Zone field. If the time zone isn't specified, the default is Coordinated Universal Time (UTC). This field is available in Revenue Cloud in API version 65.0 and later. | | StartEndTimeZone | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time zone for the quote line item's start and end dates, times, and datetimes. This field is available in Revenue Cloud in API version 65.0 and later. | | StartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The start time of the quote line item. This field is available in Revenue Cloud in API version 65.0 and later. | | StartQuantity | Type double Properties Create, Filter, Nillable, Sort Description If the quote line item is sold on a subscription, this field indicates the item quantity when the subscription starts. This field is available in API version 60.0 and later. This field is available with Subscription Management. | | StartingPriceTotal | Type currency Properties Filter, Nillable, Sort Description The starting unit price times the quantity. | | StartingUnitPriceSource | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the starting unit price was entered manually or calculated. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: - Manual - System - Inherited | | Status | Type dynamic picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents the status of the quote line item. This field is available in API version 60.0 and later. The QuoteLineItemStatus permission is required to access this field. Possible values are: - In Progress - Pending - Approved - Rejected Default value is In Progress. | | SubscriptionTerm | Type int Properties Filter, Group, Nillable, Restricted picklist, Sort Description The number of terms in the subscription. You can indicate a subscription’s length by using either StartDate and EndDate, or by using StartDate and SubscriptionTerm. If you provide a value for both EndDate and SubscriptionTerm, EndDate is used and SubscriptionTerm is ignored. | | SubscriptionTermUnit | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The unit of time used to define the subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: - Annual—UI label is Years - Months | | Subtotal | Type currency Properties Filter, Nillable, Sort Description The line item's Quantity multiplied by the UnitPrice. In Revenue Cloud, Subtotal is set to TotalLineAmount when TotalLineAmount has a value. | | TotalAdjustment | Type percent Properties Filter, Nillable, Sort Description The total discount percentage applied at the line item level. This percentage is calculated by using the formula: (Total Line Amount - Net Total Price) / Total Line Amount. This field is available in Revenue Cloud in API version 65.0 and later. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description The sum of the adjustments applied to the quote line item, inclusive of quantity, prorated for the duration of the subscription. This field is available in API version 56.0 and later. This field is available with Subscription Management. | | TotalCost | Type currency Properties Filter, Nillable, Sort Description The total cost of all products sold in the quote, calculated by multiplying the quantity by the unit cost. This field is available in Revenue Cloud in API version 65.0 and later. | | TotalLineAmount | Type currency Properties Filter, Nillable, Sort Description The total price of the quote line item, before price adjustments, inclusive of quantity, prorated for the duration of the subscription. This price is a calculated field equal to ListPrice times Quantity times PricingTermCount. This field is available in API version 56.0 and later. This field is available with Subscription Management. | | TotalMargin | Type percent Properties Filter, Nillable, Sort Description The effective margin percentage at the line item level. This percentage is calculated by using the formula: (Net Total Price - Total Cost) / Net Total Price. This field is available in Revenue Cloud in API version 65.0 and later. | | TotalMarginAmount | Type currency Properties Filter, Nillable, Sort Description The effective margin amount at the line item level. This amount is calculated by subtracting total cost from net total price. This field is available in Revenue Cloud in API version 65.0 and later. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description Read-only. Calculated by applying the Discount to the Subtotal. This field is nillable, but you can't set both TotalPrice and to null in the same update. To insert the for a quote line item via the API (given only a unit price and the quantity), calculate this field as the unit price multiplied by the quantity. This field is read only if the quote line item has a revenue schedule. | | UnitCost | Type currency Properties Create, Filter, Nillable, Sort, Update Description The unit cost of a product sold as part of the quote. This field is available in Revenue Cloud in API version 65.0 and later. | | UnitPrice | Type currency Properties Create, Filter, Sort, Update Description Required. The price per unit for the quote line item. | | UnitPriceUplift | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage increase of the quote line item's unit price. | | ValidationResult | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether the quote line item was configured and priced by Revenue Lifecycle Management. A quote can be activated only after all its quote line items are configured and priced by Revenue Lifecycle Management. Valid values are: - Warning—Indicates that the quote line item wasn’t configured and priced by Revenue Lifecycle Management. Available in API version 60.0 and later. | | Visibility | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies how Salesforce shows a quote line item in the Transaction Line Editor and a quote document. Possible values are: - Always—Quote line items are always displayed in the Transaction Line Editor. - Never—Quote line items aren't displayed in the Transaction Line Editor or in the quote document. - Quote Document Only—Quote line items are displayed only in the quote document, but not in the Transaction Line Editor. - Transaction Line Editor Only—Quote line items are displayed only in the Transaction Line Editor, but not in the quote document. The default value is Always. | ## Usage A quote record can have QuoteLineItem records only if the quote has a Pricebook2. A QuoteLineItem must correspond to a Product2 that is listed in the quote's Pricebook2. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If the multicurrency option is enabled, the CurrencyIsoCode field is present. It can't be modified, it’s always set to the value of the CurrencyIsoCode of the parent quote. Effects on Quotes Quotes with related QuoteLineItem objects are affected in the following ways: - Creating a QuoteLineItem increments the quote value by the TotalPrice of the QuoteLineItem. - When you create or update a QuoteLineItem, the API verifies that the line item corresponds to a PricebookEntry in the Pricebook2 associated with the quote. ## 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. [QuoteLineItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [QuoteLineItemHistory](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.") (API version 57.0) History is available for tracked fields of the object. #### See Also - [Quote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quote.htm "Represents a quote, which is a record showing proposed prices for products and services. Available in API version 18.0 and later.") - [QuoteDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotedocument.htm "Represents a quote in document format. Available in API version 18.0 and later.") - [Opportunity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm "Represents an opportunity, which is a sale or pending deal.") # QuoteLineItemRecipient Represents a site, employee, or other entity for which services are being quoted. This could include details such as the recipient's name, contact information, associated site or location, and any specific requirements or preferences for the quoted services. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BroadbandConnectionType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the broadband connection that's available at the address. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | MaxDownloadSpeed | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum download speed available at the address. | | MaxUploadSpeed | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum upload speed available at the address. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the customer's site or location. | | QuoteId | Type reference Properties Create, Filter, Group, Sort Description The quote associated with the recipient. This field is a relationship field. Relationship Name Quote Relationship Type Master-detail Refers To Quote (the master object) | | RecipientType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of recipient of the service. Possible values are: - Location - Subscriber The default value is Location. | | ServiceAddrValidationDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the address was validated. | | Service Account | Type entityid Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to the Account Entity where the product is used, serviced, or installed. | | ServiceAddrValidationMsg | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The message sent after the validation of the address. | | ServiceAddrValidationResult | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the status of the address validation. Possible values are: - Fail - Partial Success - Success The default value is Success. | | ServiceAddress | Type address Properties Filter Description The address where the recipient receives the service. | | ServiceCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where the recipient receives the service. | | ServiceCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the recipient receives the service. | | ServiceGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the accuracy level of the geocoded address coordinates. Possible values are: - Address - Block - City - County - ExtendedZip—Extended Zip - NearAddress—Near Address - Neighborhood - State - Street - Unknown - Zip | | ServiceLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude of the location where the recipient receives the service. | | ServiceLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude of the location where the recipient receives the service. | | ServicePostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address. | | ServiceState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the recipient receives the service. | | ServiceStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street where the recipient receives the service. | | ServiceabilityCheckDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the serviceability check was done. | | ServiceabilityData | Type textarea Properties Create, Nillable, Update Description The information about serviciability, such as broadband connection, download, and upload speeds available at the address. | | SiteName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the customer's site or location. | ## 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. [QuoteLineItemRecipientHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. # QuoteLinePriceAdjustment Indicates the calculated price adjustment that is applied to the quote line, for example, a calculated volume discount or the prorated value of a manual discount. Use the quote line price adjustment to inform potential customers about the type, value, and total amount of their discounts. This object is available in API version 56.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available with Subscription Management. ## Fields | Field | Details | | --- | --- | | AdjustmentAmountScope | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Used with AdjustmentValue to determine the amount of the adjustment. Possible values are: - Total—The adjustment applies to the line item's total and isn’t multiplied by the quantity. The adjustment amount is prorated for the duration of the subscription. - Unit—The adjustment is multiplied by the line item’s quantity, prorated for the duration of the subscription. - UnproratedTotal—The adjustment applies to the line item's total and isn’t multiplied by the quantity. The adjustment amount isn’t prorated for the duration of the subscription. | | AdjustmentSource | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The source of the adjustment. Possible values are: - Discretionary—The adjustment is entered manually; for example, by a sales rep. - Promotion—Reserved for future use. - Rule—The adjustment results from a system rule, such as a price rule or product rule. - System—The adjustment is determined by the pricing configuration for the product; for example, as part of a discount schedule. | | AdjustmentType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of adjustment to apply to a quote line. Possible values are: - AdjustmentAmount—The adjustment is a numerical amount, for example, a cash discount of 20. - AdjustmentPercentage—The adjustment is a percentage amount, for example, a 10% discount. - OverrideAmount—The adjustment is a manual price override. Available in API version 59.0 and later. | | AdjustmentValue | Type double Properties Filter, Sort Description The value of the adjustment. Used together with AdjustmentAmountScope to determine the amount of the adjustment. | | AppliedPromotionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time on which the promotion was applied to the asset. | | CouponCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the coupon code that was applied. | | Description | Type textarea Properties Nillable Description The system-entered description of the quote line price adjustment. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The system-entered name of the quote line price adjustment. | | PriceAdjustmentCauseId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the record that caused the adjustment. Null if AdjustmentSource is Discretionary, indicating a manual adjustment. For example, if the price adjustment is due to a price adjustment tier, this field contains the ID of the PriceAdjustmentTier record. This field is a polymorphic relationship field. Relationship Name PriceAdjustmentCause Relationship Type Lookup Refers To PriceAdjustmentTier | | Priority | Type int Properties Filter, Group, Nillable, Sort Description Reserved for future use. | | ProratedAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description The prorated portion of the fee amount based on the quote line item's effective dates. This field is available with Digital Insurance in API version 67.0 and later. | | QuoteAdjustmentGroupId | reference int Properties Filter, Group, Nillable, Sort Description The ID of the quote adjustment group, which totals all price adjustments for the quote. This field is a relationship field. Relationship Name QuoteAdjustmentGroup Relationship Type Lookup Refers To QuoteAdjustmentGroup | | QuoteLineItemId | Type reference Properties Filter, Group, Sort Description The ID of the quote line item that this price adjustment applies to. This field is a relationship field. Relationship Name QuoteLineItem Relationship Type Lookup Refers To QuoteLineItem | | TotalAmount | Type currency Properties Filter, Sort Description The total amount of the adjustment that applies to the quote line item, inclusive of quantity, prorated for the duration of the subscription. | # QuoteLineRelationship Describes the relationship between quote line items, such as items in a bundle. When you create a QuoteLineRelationship object, it’s immutable: it can’t be edited or removed. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available if Subscription Management or Revenue Cloud is enabled. ## Fields | Field | Details | | --- | --- | | AssociatedQuantScaleMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description How to scale the quantity of the associated quote line, relative to the main quote line. If this field has a non-null value, you can't edit the associated quote line's quantity. Possible values are: - Constant— The associated quote’s line quantity remains the same in relation to the main quote line’s quantity. For example, the main quote line has a quantity of one and the associated quote line has a quantity of one. If you increase the quantity of the main quote line to two, the associated quote line’s quantity remains at one. - Proportional— The associated order’s item quantity increases or decreases based on the main quote line’s quantity. For example, the main quote line has a quantity of one and the associated quote line has a quantity of two. If you increase the quantity of the main quote line to two, the associated quote line’s quantity increases to four. The default value is Proportional. | | AssociatedQuoteLineId | Type reference Properties Create, Filter, Group, Sort Description The unique identifier of the associated quote line item. This field is a relationship field. In a bundle relationship, this quote line is the bundle component. Relationship Name AssociatedQuoteLine Relationship Type Lookup Refers To QuoteLineItem | | AssociatedQuoteLinePricing | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates how the associated quote line item is priced relative to the main quote line item. Possible values are: - IncludedInBundlePrice— The associated quote line’s cost is $0 because it’s included in the bundle’s price. - NotIncludedInBundlePrice— The associated quote line has a cost because it’s not included in the bundle’s price. | | AssociatedQuoteLineRole | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Describes the position of the associated quote line item in the relationship. Possible values are: - BundleComponent— The associated quote line item is part of a bundle. - SetComponent— The associated quote line item is part of a set. - ClassificationComponent— The associated quote line item is a product classification component. | | IsPriceInclusive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether child products are included in the root bundle price. If set to true, the price of each child product is zero. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | MainQuoteLineId | Type reference Properties Create, Filter, Group, Sort Description The unique identifier of the main quote line item. This field is a relationship field. In a bundle relationship, this quote line is the bundle parent. Relationship Name MainQuoteLine Relationship Type Lookup Refers To QuoteLineItem | | MainQuoteLineRole | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates the position of the main quote line item in the relationship. Possible values are: - Bundle—The main quote line item is the bundle parent. - Set—The main quote line item is the set parent. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the quote line relationship. | | ProductRelatedComponentId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the product related component. This field is a relationship field. Relationship Name ProductRelatedComponent Refers To ProductRelatedComponent | | ProductRelationshipTypeId | Type reference Properties Create, Filter, Group, Sort Description The unique identifier of record that describes the relationship between the main and associated quote lines. This field is a relationship field. Relationship Name ProductRelationshipType Relationship Type Lookup Refers To ProductRelationshipType | | QuoteId | Type reference Properties Filter, Group, Nillable, Sort Description The unique identifier of the quote to which the main and associated quote lines belong. This field is a relationship field. Relationship Name Quote Relationship Type Lookup Refers To Quote | | RootQuoteLineId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The root quote line for the quote line relationship. In a bundle relationship, the root quote line is the root bundle. This field is a relationship field. Relationship Name RootQuoteLine Refers To QuoteLineItem | ## Associated Objects This object has the following associated objects. [QuoteLineRelationshipFeed](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. [QuoteLineRelationshipHistory](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. # QuoteLineWorkSource Represents an association between a quote and work sources, such as assets, quote line items, order products, or work type groups. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset associated with the quote work source. This field is a relationship field. Relationship Name Asset Refers To Asset | | OrderItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order product associated with the quote work source. This field is a relationship field. Relationship Name OrderItem Refers To OrderItem | | QuoteId | Type reference Properties Create, Filter, Group, Sort Description The quote associated with the quote work source. This field is a relationship field. Relationship Name Quote Relationship Type Master-detail Refers To Quote (the master object) | | QuoteLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The quote associated with the quote work source. This field is a relationship field. Relationship Name QuoteLineItem Refers To QuoteLineItem | | WorkTypeGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The quote associated with the work source This field is a relationship field. Relationship Name WorkTypeGroup Refers To WorkTypeGroup | # QuoteRecipientGroup Represents a recipient group for which offers or products with the same configuration are being added. This also includes reusing these groups to add or remove recipients. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActualMemberCount | Type int Properties Filter, Group, Nillable, Sort Description The actual number of members in the quote recipient group. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the quote recipient group. | | ExpectedMemberCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The expected number of members in the quote recipient group. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the quote recipient group. | | QuoteId | Type reference Properties Create, Filter, Group, Sort Description The ID of a quote recipient group. This field is a relationship field. Relationship Name Quote Relationship Type Master-detail Refers To Quote (the master object) | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the quote recipient group is active. Possible values are: - Active - Inactive The default value is Active. | # QuoteRecipientGroupMember Represents a junction between a quote line item recipient and a quote recipient group. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the quote recipient group member. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of a quote recipient group member. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | QuoteLineItemRecipientId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The quote line item recipient associated with the quote recipient group. This field is a relationship field. Relationship Name QuoteLineItemRecipient Refers To QuoteLineItemRecipient | | QuoteRecipientGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The quote line item recipient group associated with the quote recipient group. This field is a relationship field. Relationship Name QuoteRecipientGroup Refers To QuoteRecipientGroup | # RecentFieldChange Use this virtual object to see how an opportunity has changed in the past seven days. Learn the previous value of a field, who made the change, and when the change was made. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To use RecentFieldChange, set up historical trend reporting for opportunities in your org. You must also have the Pipeline Inspection user permission and the Pipeline Inspection setting enabled. ## Fields | Field | Details | | --- | --- | | ChangeDate | Type dateTime Properties Description The date and time that the specified field was changed. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The ISO code for the currency value. Must be one of the valid alphabetic, three-letter currency ISO codes defined by the ISO 4217 standard, such as USD, GBP, or JPY. The default value is 'USD'. | | FieldName | Type string Properties Filter, Group Description The name of the opportunity field that you want the previous value of. Possible values are: - Amount - CloseDate - StageName - ForecastCategory - NextStep | | ParentId | Type reference Properties Filter, Group Description The ID of the opportunity that you want the change history for. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Opportunity | | PreviousCurrencyValue | Type currency Properties Nillable Description The previous value of a currency field on an opportunity. | | PreviousDateOnlyValue | Type date Properties Group, Nillable Description The previous value of a date field on an opportunity. | | PreviousTextValue | Type string Properties Group, Nillable Description The previous value of a text field on an opportunity. | | ValueChangedById | Type reference Properties Group Description The ID of the user who changed the specified field's value during the specified time period. This is a relationship field. Relationship Name ValueChangedBy Relationship Type Lookup Refers To User | ## Usage One recentFieldChange record is returned for each field that was changed in the past seven days. The supported fields are Amount, Close Date, Forecast Category, Next Step, and Stage Name. Only the most recent previous value is returned. ## Example To see the most recent previous amount for an opportunity, use the following query. Replace 006R0000XXXXXXXXXX with the ID of the opportunity. select PreviousTextValue from RecentFieldChange where ParentId = '006R0000003JkHBIA0' and FieldName = 'StageName' If the sales rep didn't change the opportunity stage name in the past seven days, no values are returned. If the sales rep changed the opportunity amount several times in the past seven days, only the most recent previous value is returned. ## Example To see the most recent previous amount, close date, forecast category, next step, and stage name for an opportunity, use the following query. Replace 006R0000XXXXXXXXXX with the ID of the opportunity. select PreviousTextValue, PreviousCurrencyValue, PreviousDateOnlyValue from RecentFieldChange where ParentId = '006R0000XXXXXXXXXX' and FieldName IN ('StageName', 'Amount', 'CloseDate') If the opportunity amount, close date, forecast category, next step, and stage name didn’t change in the past seven days, no values are returned. # RecentlyViewed Represents records or list views that the current user has recently viewed or referenced (by viewing a related record). List views are available in API version 29.0 and later. ## Supported Calls describeSObjects(), query(), update() ## Special Usage Rules The RecentlyViewed object doesn’t support the Event, Task, Report, KnowledgeArticle, and Article objects. The RecentlyViewed object supports only certain objects, and supports list views only for those supported objects. Supported objects have the fields LastReferencedDate and LastViewedDate. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note RecentlyViewed records for users who are members of several communities can’t be retrieved automatically into a map via Apex. This is because records of a user with different networks can result in duplicate IDs that maps don’t support. ## Fields | Field | Details | | --- | --- | | Alias | Type string Properties Filter, Group, Nillable, Sort Description The alias on the record. | | Email | Type email Properties Filter, Group, Nillable, Sort Description The email address on the record. | | FirstName | Type string Properties Filter, Group, Nillable, Sort Description The first name on the record. If the recently viewed record is a user, the value is the user’s first name. | | Id | Type ID Properties Defaulted on create, Filter, Group, Sort Description The ID of the recently viewed record or list view. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the recently viewed record is an active user (true) or not (false). This field contains a value only if the recently viewed record is a user. | | LastName | Type string Properties Filter, Group, Nillable, Sort Description The last name on the record. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last interacted with this record, directly or indirectly. - Viewing or opening a record. - Selecting a record in a lookup search or related list search. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Name | Type string Properties Filter, Group, Nillable, Sort Description The name on the recently viewed record or list view. If the recently viewed record is a user, contact, or lead, the value is a concatenation of the firstname and lastname field values. | | NetworkId | Type reference Properties Filter,Group, Nillable, Sort Description ID of the Experience Cloud site that this group is part of. This field is available only if digital experiences is enabled in your org. You can add a NetworkId only when creating a group. You can’t change or add a NetworkId for an existing group. This field is available in API version 27.0 and later. | | Phone | Type phone Properties Filter, Group, Nillable, Sort Description The phone number on the record. | | ProfileId | Type reference Properties Filter, Group, Nillable, Sort Description If the recently viewed record is a user, this value is the user’s profile ID. This field is a relationship field. Relationship Name Profile Relationship Type Lookup Refers To Profile | | Title | Type string Properties Filter, Group, Nillable, Sort Description If the recently viewed record is a user, this value is the title of the user; for example CFO or CEO. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The object type for this recently viewed record or list view. Valid values include any standard or custom objects that RecentlyViewed supports. | | UserRoleId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user role associated with this object. This field is a relationship field. Relationship Name UserRole Relationship Type Lookup Refers To UserRole | ## Usage This object provides a heterogeneous list of different object types. The list consists of recently viewed records, records that were recently referenced (a related record was viewed), or recently viewed list views. A record is considered viewed when the user sees the record details, but not when the user sees the record in a list with other records. Use this object to programmatically construct a list of recently viewed items specific to the current user. For example, use this object on a custom user interface or for search auto-complete options. You can also retrieve a filtered list of records by object type (Type). The RecentlyViewed data is periodically truncated down to 200 records and 200 list views. RecentlyViewed data is retained for 90 days, after which it’s removed on a periodic basis. Use this query in your code to retrieve a list of all the records and list views that were recently viewed. The results are ordered from most to least recent. SELECT Id, Name FROM RecentlyViewed WHERE LastViewedDate !=null ORDER BY LastViewedDate DESC Use this query to retrieve data that was either viewed or referenced, but only for a limited set of objects. SELECT Id, Name FROM RecentlyViewed WHERE Type IN ('Account', 'Contact', 'Plan\_\_c') ORDER BY LastViewedDate DESC This query retrieves a list of all recently viewed contacts with contact-specific fields, such as the contact’s account name, and the custom website field. Records are ordered from most to least recent. SELECT Account.Name, Title, Email, Phone, Website\_\_c FROM Contact WHERE LastViewedDate != NULL ORDER BY LastViewedDate DESC # Recommendation Represents the recommendations surfaced as offers and actions for Einstein Next Best Action. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules You must have the Modify All Data or Manage Next Best Action Recommendations user permission to create and edit recommendations. ## Fields | Field | Details | | --- | --- | | AcceptanceLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label that appears as the accept option on the surfaced recommendation. Maximum size is 80 characters. | | ActionReference | Type string Properties Create, Filter, Group, Sort, Update Description Flow referenced for this recommendation. Label is **Action**. | | Description | Type string Properties Create, Filter, Group, Sort, Update Description Text description of the recommendation. Maximum size is 255 characters. | | ExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Stores an identifier for the recommendation source, such as product, so Einstein can group all responses for a given recommendation. | | ImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Image referenced by this recommendation. Label is **Image**. This is a relationship field. Relationship Name Image Relationship Type Lookup Refers To ContentAsset | | IsActionActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the flow referenced in the Action field is active (true) or not (false). Read only. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the recommendation was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the recommendation was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the recommendation. Maximum size is 80 characters. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Experience Cloud site associated with the recommendation (if applicable). | | RecommendationKey | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Track responses to a recommendation when it doesn’t have an ID. Maximum size is 255 characters. | | RejectionLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label that appears as the reject option on the surfaced recommendation. Maximum size is 80 characters. | ## 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. [RecommendationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. # RecommendationResponse Represents the user responses to a presented offer or recommendation for Einstein Next Best Action. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated() query(), retrieve(), ## Special Access Rules You must have one of these user permissions to read, delete, or update recommendation responses: - Modify All Data - Manage Next Best Action Recommendations - Manage Next Best Action Strategies ## Fields | Field | Details | | --- | --- | | ActionReference | Type string Properties Create, Filter, Group, Nillable, Sort Description The full name of an action flow at the time of the response. The full name includes the action’s namespace. | | ContextRecord | Type string Properties Create, Filter, Group, Nillable, Sort Description The ID of context record that contains the Einstein Next Best Action component. For example, if the Einstein Next Best Action component is on a case record the ContextRecord is the ID of the case record. | | ContextRecordName | Type string Properties Filter, Group, Nillable, Sort Description The name of the context record. | | ContextRecordType | Type string Properties Filter, Group, Nillable, Sort Description The name of the object that’s associated with the value stored in the ContextRecord field. For example, Account, Case, or Contact. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Experience Cloud site associated with the recommendation (if applicable). This is a relationship field. Relationship Name Network Relationship Type Lookup Refers To Network | | OnBehalfOf | Type string Properties Create, Filter, Group, idLookup, Sort Description The user ID or record that is indirectly reacting to the recommendation. | | OnBehalfOfName | Type string Properties Filter, Group, Sort Description Name of the value stored for OnBehalfOf at time of response. | | OnBehalfOfType | Type string Properties Filter, Group, Nillable, Sort Description The name of the object that’s associated with the value stored in the OnBehalfOf field. For example, Account, Case, or Contact. | | RecommendationKey | Type string Properties Create, Filter, Group, Sort Description RecommendationId if available, otherwise a generated string that represents the recommendation name. | | RecommendationName | Type string Properties Create, Filter, Group, Nillable, Sort Description Name of the recommendation returned from the recommendation strategy. | | RecommendationType | Type string Properties Create, Filter, Group, Sort Description Object type of the recommendation. It can be Recommendation or any object type mapped to the Recommendation object. For example, if you map Product to Recommendation, the RecommendationType is Product. | | Response | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The user’s response to the recommendation. Possible values are: - Accepted - Rejected | | StrategyReference | Type string Properties Create, Filter, Group, Sort Description The full name of a recommendation strategy flow at the time of the response. The response is formatted as namespace underscore prefix double underscore flowname, such as namespace\_prefix\_\_flowname. | | StrategyVersion | Type string Properties Filter, Group, Sort Description The recommendation strategy version that’s active at the time of the response. | ## Usage The RecommendationResponse object can’t be customized with additional fields. # RecordAction Represents a relationship between a record and an action, such as a flow. Create a RecordAction for every action that you want to associate with a particular record. Available in API version 42.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Access to the RecordAction object is determined by a user’s access to the associated parent record. ## Supported Calls create(), delete(), , describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | ActionDefinition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required in Lightning Flow for Service implementations that use version 44.0 or later of the API. The API name of the action to associate with the record; for example, the API name of a flow. Use this field rather than FlowDefinition. To distinguish a quick action from a flow with the same API name, we prepend "QuickAction" to the API name of every quick action. | | ActionType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required in Lightning Flow for Service implementations that use version 46.0 or later of the API. The type of action. Possible values are: - Flow (default) - QuickAction For versions of the API prior to version 46.0, this field is set to Flow. | | FlowDefinition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Optional in Lightning Flow for Service implementations using version 42.0 or 43.0 of the API. An upgrade to Winter '19 or later, which uses API version 44.0 or later, copies FlowDefinition to ActionDefinition. For versions 42.0 and 43.0, this field is the API name of the flow that’s associated with the record. | | FlowInterviewId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. The flow interview ID of the paused or completed flow. This field can’t be set in Process Builder. This is a relationship field. Relationship Name FlowInterview Relationship Type Lookup Refers To FlowInterview | | IsMandatory | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Optional. Specifies whether the action is mandatory. The default value is false. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note At runtime, we show a reminder when the user closes a mandatory flow without completing it. We don't show the reminder for quick actions. | | IsUiRemoveHidden | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Optional. Specifies whether the ability to remove the action is hidden in the UI. The default value is false. If true, the UI hides the ability to remove the action. However, actions can still be deleted using the API. | | Order | Type int Properties Create, Filter, Group, Sort, Update Description Required. The order of the action among all actions associated with this record. | | ParticipantRoleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The participant role that's associated with the record action. This field is a polymorphic relationship field and is available in API version 58.0 and later. Relationship Name ParticipantRole Relationship Type Lookup Refers To ParticipantRole | | Pinned | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Specifies whether the action is pinned to the top or bottom of the component. If an action is pinned, users see the Remove option in the UI unless IsUiRemoveHidden is set to true. Possible values are: - None (default) - Top - Bottom | | RecordId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. Record associated with the action. In version 46.0 and above, we support most object types. To learn about supported objects, see the [Lightning Flow for Service Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_guided_engagement.meta/salesforce_guided_engagement/guided_engagement_support.htm "HTML (New Window)"). This is a relationship field. Relationship Name Record Relationship Type Lookup Refers To Account, Address, Asset, AssetRelationship, AssignedResource, AssociatedLocation, Campaign, CampaignMember, CarePreauth, CarePreauthItem, Case, ChangeRequest, CollaborationGroup, Contact, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem, EnhancedLetterhead, Incident, Lead, Location, MemberPlan, OperatingHours, Opportunity, Order, PlanBenefit, PlanBenefitItem, Problem, Pricebook2, PricebookEntry, Product2, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, PurchaserPlan, PurchaserPlanAssn, RebateMemberAggregateItem, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, Shipment, SkillRequirement, SocialPersona, SocialPost, TimeSlot, User, Visit, VoiceCall, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup ChangeRequest, Incident, Problem are available in API version 53.0 and later. RebateMemberAggregateItem is available in API version 54.0 and later. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. The current state of the action. Possible values are: - New (default) - Paused - Complete - Started - Unlinked—The action was unlinked because the flow was paused and the current record for the flow interview changed. Paused and unlinked statuses do not apply to quick actions. This field can’t be set in Process Builder. | ## Usage The RecordAction object works with the Actions & Recommendations component in Lightning Experience. Although this junction object can be used to create relationships between records and actions in Salesforce Classic, those relationships can’t be displayed in Salesforce Classic. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note API version 44.0 added a field, ActionDefinition, so that a RecordAction in future releases can support other types of actions in addition to flows. API version 44.0 and later maintain the FlowDefinition field to support processes that reference this field in earlier API versions. Upgrading an org to Winter '19 or later, which uses API version 44.0 or later, copies the FlowDefinition field to the ActionDefinition field. FlowDefinition will be deprecated in a future release, so use ActionDefinition instead. When an action is deleted that’s referenced in an ActionDefinition or FlowDefinition, the RecordAction object is deleted. RecordAction objects are also deleted when the associated parent record is deleted, or when a flow is paused and the current record context has changed. When an action is completed, the associated RecordAction object is also deleted. Deleted RecordActions are removed from the list when the page is refreshed. For more information about the Actions & Recommendations component and how it works with RecordActions, see the _[Lightning Flow for Service Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_guided_engagement.meta/salesforce_guided_engagement/salesforce_guided_engagement.htm "HTML (New Window)")_. ## Java Example Here’s an example of how to associate flows to a record using the RecordAction object. public void associateNewCustomerFlowWithAccount(Account a) { try { RecordAction newRecordAction = new RecordAction(); newRecordAction.setRecordId(a.getId()); newRecordAction.setActionDefinition(“New\_Customer\_Flow”); newRecordAction.setOrder(1); SaveResult\[\] results = connection .create(new SObject\[\] { newRecordAction }); } catch (ConnectionException ce) { ce.printStackTrace(); } } ## Data Model ![The RecordAction data model.](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/Sforce_record_action.png) ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [RecordActionHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordactionhistory.htm "Represents the lifecycle of a RecordAction as it goes through different states. Available in API version 44.0 and later.") History is available for tracked fields of the object. # RecordActionHistory Represents the lifecycle of a RecordAction as it goes through different states. Available in API version 44.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules This object is always read-only. ## Fields | Field | Details | | --- | --- | | ActionDefinitionApiName | Type string Description Required. The API name of the action associated with the record. To distinguish a quick action from a flow with the same API name, we prepend "QuickAction" to the API name of every quick action. | | ActionDefinitionLabel | Type string Description Required. The label of the action that took place. | | ActionType | Type picklist Properties Defaulted on create, Restricted picklist Description Required. The type of action associated with the record. Possible values are: - Flow (default) - QuickAction | | IsMandatory | Type boolean Properties Defaulted on create Description Optional. Specifies whether the action is mandatory. The default value is false. | | LoggedTime | Type dateTime Properties Filter, Sort Description Required. The timestamp when the state change occurred. | | ParentRecordId | Type reference Properties Filter, Sort Description Required. The parent record for the associated action. This is a relationship field. Relationship Name ParentRecord Relationship Type Lookup Refers To Account, Address, Asset, AssetRelationship, AssociatedLocation, Case, ChangeRequest, CollaborationGroup, Contact, ContactRequest, Contract, EnhancedLetterhead, Incident, Lead, Location, OperatingHours, Opportunity, Order, Pricebook2, PricebookEntry, Problem, Product2, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, RebateMemberAggregateItem, ResourceAbsence, Scorecard, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, Shipment, SkillRequirement, SocialPersona, SocialPost, TimeSlot, User, Visit, VoiceCall, WorkType ChangeRequest, Incident, Problem are available in API version 53.0 and later. RebateMemberAggregateItem is available in API version 54.0 and later. | | Pinned | Type picklist Properties Defaulted on create, Nillable, Restricted picklist Description Optional. Specifies whether the action is pinned to the top or bottom, or unpinned. Possible values are: - None - Top - Bottom | | RecordActionId | Type string Properties Filter, Sort Description Required. The ID of the RecordAction. | | State | Type picklist Properties Defaulted on create, Restricted picklist Description Required. The state of the action. A state change triggers the logging of a history event. Possible values are: - Started (default) - Paused - Resumed - Completed - Unlinked—The action was unlinked because the flow was paused and the current record for the flow interview changed. | | UserId | Type reference Description Required. The user that conducted the action. This is a polymorphic relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Usage The RecordActionHistory object represents the lifecycle of an action on a record as it goes through different states. The RecordActionHistory object is a big object. For this reason, when you use synchronous SOQL, SOAP, REST, Bulk, or Apex APIs to read this object, queries must follow a specific pattern or they fail. Queries must match one of these patterns and use fields in this precise order when more than one field is used. - ParentRecordId - ParentRecordId, LoggedTime (DESC) - ParentRecordId, LoggedTime (DESC), RecordActionId For example, this SOQL query follows the ParentRecordId, LoggedTime (DESC) pattern. SELECT ActionDefinitionApiName, User, State FROM RecordActionHistory WHERE ParentRecordId = {CaseId} ORDER BY ParentRecordId, LoggedTime DESC Asynchronous SOQL queries do not need to follow a pattern, and can query any field. Apex triggers cannot reference big object records. Use SOQL queries if you want to query RecordActionHistory records in Apex. For more information about the Actions & Recommendations component and how it works with RecordActions, see the [Lightning Flow for Service Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_guided_engagement.meta/salesforce_guided_engagement/salesforce_guided_engagement.htm "HTML (New Window)"). Learn more about big objects and how to query them in the _[Query Big Objects](https://trailhead.salesforce.com/en/modules/big_objects/units/big_objects_querying "HTML (New Window)")_ module on Trailhead. ## Java Example Here’s a Java example of how to query a RecordActionHistory object. public void queryHBPOs(String parentRecordId) { try { SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd"); // query for the RecordActionHistory associated with ParentRecord QueryResult queryResults = connection.query("SELECT ActionDefinitionApiName, LoggedTime, State " + "FROM RecordActionHistory WHERE ParentRecordId = '" + parentRecordId + "' LIMIT 50"); if (queryResults.getSize() > 0) { for (int i=0;i # RecordsetFilterCriteria Represents a set of filters that can be used to match service appointments or assets based on your criteria fields. For example, you can create recordset filter criteria so that only service appointments that satisfy the filter criteria are matched to the filtered shifts, and likewise only maintenance work rules that satisfy your criteria are matched to assets. This object is available in API version 50.0 and later. Assets and maintenance work rules are available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the recordset filter criteria. | | FilteredObject | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The object used to define the filter criteria. Available in API version 52.0 or later. Possible values are: - Asset - ServiceAppointment | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the recordset filter criteria is associated with shifts or maintenance work rules (true) or not (false). | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the recordset filter criteria was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the recordset filter criteria was last viewed. | | LogicalOperator | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Defines the logic to evaluate multiple recordset filter criteria rules. Available in API version 53.0 and later. Possible values are: - AND - OR | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the recordset filter criteria. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the recordset filter criteria. | | SourceObject | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The source object that the filtered criteria are applied to. Shifts and maintenance work rules are available in API version 52.0 and later. Appointment bundle objects are available in API version 53.0 and later. Possible values are: - ApptBundleAggrPolicy—Appointment Bundle Aggregation Policy - ApptBundleConfig—Appointment Bundle Config - Shift - ContractLineOutcome - MaintenanceWorkRule | | Usage Rate Field | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Stores the daily usage rate of the asset. The unit for the usage rate must be per day. | | Usage Rate Unit | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Defines the rate for Usage Rate Field. Possible values are: - DAYS | ## Usage Let's say an employee is open to working a 9 am to 5 pm shift on a Sunday but only for emergency appointments. In this case, the SourceObject is Shift and the FilteredObject is ServiceAppointment. The service appointments available for that shift are filtered for emergency appointments using the RecordsetFilterCriteriaRule object. RecordSetFilterCriteria isn’t available for report types. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [RecordsetFilterCriteriaFeed](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. [RecordsetFilterCriteriaHistory](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. [RecordsetFilterCriteriaOwnerSharingRule](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. [RecordsetFilterCriteriaShare](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. # RecordsetFilterCriteriaRule Represents a rule using fields from the designated source object to create filters on the filtered, or target, object. RecordsetFilterCriteriaRule is associated with the RecordsetFilterCriteria object. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | CriteriaField | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The field the filter rule is applied to. Asset fields are available in API version 52.0 and later. Possible values are derived from the source object’s standard and custom fields. Possible standard source objects are Asset and ServiceAppointment. The format is, for example, Asset.PricingSource or ServiceAppointment.GroupAppointmentAccessType. All standard and custom fields are allowed except those with these field types: - encryptedstring - multipicklist - textarea - url | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the recordset filter criteria rule was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the recordset filter criteria rule was last viewed. | | NextOccurence | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description This field’s value is compared to the Usage Field to determine if the rule is true. Possible values are derived from the source object’s standard and custom fields. Possible standard source objects are Asset and ServiceAppointment. The format is, for example, Asset.PricingSource or ServiceAppointment.GroupAppointmentAccessType. All standard and custom fields are allowed except those with these field types: - encryptedstring - multipicklist - textarea - url | | Operator | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The relational operator between CriteriaField and Value. Available in API version 52.0 or later. Possible values are: - Equals—Default - GreaterOrEqual - GreaterThan - LessOrEqual - LessThan | | RecordsetFilterCriteriaId | Type reference Properties Create, Filter, Group, Sort Description The ID of the RecordsetFilterCriteria record to associate this rule with. | | RecordsetFilterCriteriaRuleNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The automatically assigned number of the recordset filter criteria rule. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of criteria rule. Possible values are: - Criteria—Default - Usage - UsageCounter— Usage(Counter) - UsageDuration— Usage(Duration) | | Value | Type textarea Properties Create, Nillable, Update Description The expected value of CriteriaField applied to the filter rule. | | Usage Rate Field | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Stores the daily usage rate of the asset. The unit for the usage rate must be per day. Possible values are derived from the source object’s standard and custom fields. Possible standard source objects are Asset and ServiceAppointment. The format is, for example, Asset.PricingSource or ServiceAppointment.GroupAppointmentAccessType. | | Usage Rate Unit | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Defines the rate for Usage Rate Field. Possible values are: - DAYS | ## Usage If you want to create a filter rule for service appointments with a dispatched status, set CriteriaField to ServiceAppointment.Status and Value to Dispatched. Then add the ID from a RecordsetFilterCriteria record to RecordsetFilterCriteriaId to associate this rule with a filter criteria for shifts. # RecordsetFltrCritMonitor Monitors whether the value of an asset attribute is within the threshold of a recordset filter criteria (RFC). You can monitor one or more RFCs for an Asset. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the asset to link the RFC to. This field is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the RFC associated with the recordset filter criteria monitor. | | IsWithinThreshold | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the value of the asset attribute is within the threshold of the RFC. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the recordset filter criteria monitor. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the value was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the value was last viewed. | | RecordsetFilterCriteriaId | Type reference Properties Create, Filter, Group, Sort Description The ID of the recordset filter criteria. This field is a relationship field. Relationship Name RecordsetFilterCriteria Relationship Type Lookup Refers To RecordsetFilterCriteria | ## 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. [RecordsetFltrCritMonitorChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [RecordsetFltrCritMonitorHistory](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. #### See Also - [AssetAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetattribute.htm "Stores asset attributes to track and analyze asset conditions to improve their uptime. This object is available in API version 57.0 and later.") - [AttributeDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributedefinition.htm "Represents a product, asset, or object attribute, for example, a hardward specification or software detail. This object is available in API version 57.0 and later.") - [AttributePicklist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklist.htm "Represents a custom picklist for an asset attribute. This object is available in API version 57.0 and later.") - [AttributePicklistValue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklistvalue.htm "Represents the values of an asset attribute picklist. This object is available in API version 57.0 and later.") # RecordType Represents a record type. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Don’t use record types as an access control mechanism. Profile assignment governs create and edit access for an object but doesn’t govern read access. For example, a user assigned to a profile that isn't enabled for a particular record type can't create records with that record type, but can access records associated with that record type. Users with access to an object can read all record type information for that object. We strongly recommend against storing sensitive information in the record type description, name, or label. Instead, store sensitive information in a separate object or fields to which you’ve applied appropriate access controls. | Field | Details | | --- | --- | | BusinessProcessId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required for Opportunity and Lead record types in API version 17.0 and later. ID of an associated BusinessProcess. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A description of this record. Limit: 255 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. 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 **Record Type Name**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this record is active (true) or not (false). Only active record types can be applied to records. Label is **Active**. | | IsPersonType | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this record has been designated as a person account (true) or not (false). Visible only if the organization has the person account feature enabled. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Label of the record type in the user interface. Limit: 80 characters. Label is **Record Type Label**. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | SobjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Object to which this record type applies, including custom objects. | ## Usage Use this object to offer different BusinessProcess records and subsets of picklist values to different users based on their Profile. Your client application can describe or query RecordType records. Client applications can create or update values in RecordTypeId on these objects, specifying a valid record type ID associated with these objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t create or update the RecordTypeId field on the CampaignMember records. Set the CampaignMember record type using the CampaignMemberRecordTypeId field on Campaign. A client application can retrieve the list of valid record type IDs for a given object by querying the RecordType. # RecordTypeLocalization Represents the translated value of a label for a record type when the Translation Workbench is enabled for your organization. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - Your organization must be using Professional, Enterprise, Developer, Unlimited, or Performance Edition and be enabled for the Translation Workbench. - To view this object, you must have the “View Setup and Configuration” permission. ## Fields | Field | Details | | --- | --- | | Language | Type string Properties Create, Filter, Nillable, Restricted picklist Description The language for this translated label. | | NamespacePrefix | Type string Properties Filter, Nillable Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Nillable Description The ID of the RecordType associated with the label that is being translated. | | Value | Type string Properties Create, Filter, Nillable, Update Description The actual translated label for the record type. Label is **Translation**. | ## Usage Use this object to translate the labels of your record types into other supported languages. # RecordVisibility (Pilot) Represents the visibility attributes that determine a record’s read access. This object is read only and is available in API version 46.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you need a CRM Analytics license or to contact Salesforce to participate in the pilot program. You must also have the “View All Data” or “Enable RecordVisibility API” user permission. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note We provide the RecordVisibility object to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to change, and we can’t guarantee acceptance. The RecordVisibility object isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the RecordVisibility object in the group in the [Trailblazer Community](https://success.salesforce.com/_ui/core/chatter/groups/GroupProfilePage?g=0F93A000000DN7N). ## Fields | Field Name | Details | | --- | --- | | RecordId | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The ID of the record. | | VisibilityAttribute | Type string Properties Filter, Nillable, Sort Description The visibility attributes that determine the read access of a given record. For example, a user ID, parent record ID, or group ID. The output of visibility attributes is in JSON format and must be deserialized. | ## Usage Use this object to query the attributes that determine the visibility of one or more records. You can’t create, delete, or update any records using this object. Up to 200 record IDs can be queried. You can include an ORDER BY clause for any field that is being selected in the query. This sample query returns the visibility attributes for the indicated record. SELECT RecordId, VisibilityAttribute FROM RecordVisibility WHERE RecordId=\[single ID\] // or Record IN \[list of IDs\] The RecordId and VisibilityAttribute fields must be a part of the fields that are being selected despite RecordId being used in the filter criteria as well. RecordVisibility is a foreign key on the records. This query returns the visibility attributes for Account records: SELECT Id, Name, RecordVisibility.VisibilityAttribute FROM Account You can’t filter RecordId fields when using RecordVisibility as a lookup or foreign key. You can use RecordVisibilityContext to filter WITH clauses in queries. For more information, see [WITH _filteringExpression_](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_with.htm) in the SOQL and SOSL Reference. # RedirectWhitelistUrl Represents a trusted URL for external user redirections. Redirections to a different Salesforce org, including its publicly served pages and content, are allowed from your Salesforce org only when the URL is a RedirectWhitelistUrl. For non-Salesforce URLs, a session setting controls whether redirections from pages and components built in Salesforce Classic are restricted to RedirectWhitelistUrl objects. Except for cross-org redirections, you can’t restrict redirections that originate from pages and components built with Lightning Experience. This object is available in API version 48.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Only authenticated internal and external users with the View Setup and Customize Application permissions can access or edit this object. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the custom help section 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. The label corresponds to the section title in the user interface. Limit: 80 characters. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Language of the label. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label of the trusted URL. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Url | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The trusted URL. These formats are accepted: example.com, \*.example.com, and https://example.com. The host section of the URL can include an asterisk (\*) as a wildcard. Otherwise, the URL cannot be malformed. Examples of malformed URLs that fail a syntax check are malformed^url.example.com, and https://{subdomain}.example.com. To add a URL to a RedirectWhitelistUrl based on parameters, build the URL before you update the Url field. | ## Usage Only redirections are restricted to the URLs in this object. A direct anchor link to an external URL is always allowed, even if that URL isn’t in the allowlist. An example of a direct anchor link is linkText. Redirections include parameters that redirect the user and anchor links that include a redirection. For example, this anchor link includes a redirection: linkText. And this form action redirects the user through the saveURL parameter: . If the targetUrl belongs to another Salesforce org, the redirection is permitted only when the target URL is a RedirectWhitelistUrl. If the targetUrl isn’t a Salesforce org URL, the redirection is checked against the RedirectWhitelistUrl object only when both of these conditions are met. - The redirection originates from a Salesforce Classic page or component. - Either the redirectBlockModeEnabled or redirectionWarning SessionSettings field in the [SecuritySettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_securitysettings.htm) Metadata API is true. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Salesforce verifies the initial redirection outside of Salesforce against the RedirectWhitelistUrl object. However, Salesforce can’t verify subsequent redirections. For example, if a link on a Visualforce page takes the user to https://www.example.com, Salesforce verifies that you allowed redirections to https://www.example.com. If that URL then redirects the user to https://spam.example.com, Salesforce can’t check that redirection, because it occurs outside of Salesforce. For non-Salesforce URLs, you can choose whether to alert users about untrusted external redirections or to block those redirections entirely via the redirectBlockModeEnabled and redirectionWarning fields on the SecuritySettings metadata API type. These restrictions apply only to redirections from pages and components built in Salesforce Classic. There’s one last special case to cover. For Salesforce org URLs, Salesforce always allows redirections to URLs within the same org, including redirections from previous My Domain URLs. When the enableCrossOrgRedirect field on the SecuritySettings metadata API type is false, Salesforce checks user redirections to other Salesforce orgs via a direct link, a post-action URL, or a post-login URL. If the URL isn’t a RedirectWhitelistURL, the user isn’t redirected. An example of a direct link is # RemoteKeyCalloutEvent The documentation has moved to [RemoteKeyCalloutEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_remotekeycalloutevent.htm "HTML (New Window)") in the Platform Events Developer Guide. # Reply Represents a reply that a user has submitted to a question in an answers zone. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Body | Type textarea Properties Create, Update Description Body of this reply. | | CommunityId | Type reference Properties Filter, Group, Nillable, Sort Description The zone ID associated with the question and its reply. This field is available in API version 27.0 and later. | | CreatorFullPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | CreatorName | Type string Properties Filter, Group, Nillable, Sort Description Name of the user who posted the question or reply. Only the first name of internal users (agents) appears to portal users in the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later | | CreatorSmallPhotoUrl | Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later. | | DownVotes | Type int Properties Filter, Group, Nillable, Sort Description The total number of down votes for a reply. | | Name | Type string Properties Filter, Group, idLookup, Sort Description When creating a Reply, the Name field is automatically populated with a truncated, plain text version of the Reply Body field. | | NumReportAbuses | Type int Properties Filter, Group, Nillable, Sort Description Represents the number of reported abuses on the reply by users. This field is available in API version 24.0 and later. | | QuestionId | Type reference Properties Create, Filter, Group, Sort Description ID of the Question to which this reply was made. | | UpVotes | Type int Properties Filter, Group, Nillable, Sort Description The total number of up votes for a reply. | | VoteTotal | Type double Properties Filter, Nillable, Sort Description The total number of all votes for a reply, including up and down votes. | ## Usage Use this object to track replies to a Question. # ReplyEmailSettings Represents a reply mail management configuration, which is used to configure emails that are received by an email sending domain. This object is available in API version 62.0 and later. When you send an email campaign in Marketing Cloud, you often receive several replies to your messages, including unsubscribe requests and automatic out-of-office replies. Reply mail management (RMM) reduces the time and effort required to review these messages, and provide a better experience by automatically handling opt-outs and forwarding messages to the appropriate teams. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AutoReplyMessage | Type textarea Properties Create, Nillable, Update Description The content of the reply message. This reply is sent when a message is received at the sending address. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | DomainName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The domain that the reply mail management settings apply to. This field is unique within your organization. | | FwdEmailAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The email address to forward a copy of each incoming message to. This value is honored only if the value of IsEmailForwardingEnabled is true. | | IsAutoReplyEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to forward automatic replies, such as out-of-office messages, to the address specified in the FwdEmailAddress field. This value is honored only if the value of IsEmailForwardingEnabled is true. The default value is false. | | IsDeleteAutoRepliesEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to delete automatic replies, such as out-of-office messages. This value is honored only if the value of IsEmailForwardingEnabled is true. The default value is false. | | IsEmailForwardingEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to forward email replies to the address specified in the FwdEmailAddress field. The default value is false. | | IsUnsubscribeManualRequestsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether subscribers can opt out of your campaigns by replying to your email with a keyword such as unsubscribe. The default value is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The combined language and locale ISO code, which controls the language of the ReplyEmailSettings object. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for this ReplyEmailSettings value. This value is the internal label that doesn’t get translated. | # ReplyReportAbuse Represents a user-reported abuse on a Reply in a Chatter Answers zone. This object is available in API version 24.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the Reply from which the user reported abuse. | | Reason | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The reason the user reported abuse on the Reply, such as Spam, Hateful, or Inappropriate. | | ReplyId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Reply from which the user reported abuse. | ## Usage Use this object to track user-reported abuse on replies created in a Chatter Answers zone. # ReplyText A text reply generated by Einstein Reply Recommendations that is based on closed chat transcripts. Admins review replies and publish them to quick text, editing them as needed. Einstein recommends relevant published replies to support agents in the Lightning Service Console, and agents can insert replies into chats or messaging sessions. This object is available in API version 49.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Because the replies generated by Einstein are taken from closed chats with your customers, they may contain customer data. You can edit replies before they are recommended to agents. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Fields | Field | Details | | --- | --- | | Language | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The language used in the reply. This field is available in API version 51.0 and later. Possible values are languages supported in Einstein Reply Recommendations. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Eight-digit auto-generated number identifying the reply. | | RawTextMessage | Type textarea Properties Description The text of the reply. | | Source | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates who last modified the reply. Possible values are: - EINSTEIN\_GENERATED—Reply was generated by Einstein and has not been edited. - USER\_EDITED—Reply was generated by Einstein and then edited by a user. - USER\_GENERATED—This value is not currently in use. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the reply. Possible values are: - NEW—Einstein has generated the reply and it hasn’t yet been published. - PUBLISHED—The reply has been published to quick text. When the reply recommendation model is activated, the reply can be recommended to support agents. - PUBLISH\_FAILED— An attempt to publish the reply to quick text failed. Publishing failure can be due to validation errors, access errors, or corrupted files. To hide the reply from the list of generated replies, delete it. | ## Usage To get started with Einstein Reply Recommendations, create a predictive model that analyzes closed chats for frequently used text snippets. When the model is ready, Einstein generates a list of these snippets as ReplyText records for you to review and publish, or convert, to quick text. ReplyText records appear on the Einstein Reply Recommendations Setup page. You can select one or more replies to publish at a time. If you publish a single reply, you can edit the reply text during publishing. If you publish multiple replies at once, you can edit each reply’s text on the quick text page after publishing is complete. Replies aren’t recommended to support agents until you activate your reply recommendation model. When a reply is published, a corresponding [QuickText](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quicktext.htm "This object stores a snippet of text that allows users to send a quick response to a customer. Use quick text to create greetings, answers to common questions, short notes, and more. This object is available in API version 24.0 and later.") record is created. During publishing, select a quick text folder to add the replies to and make sure that agents have access to the folder. To edit a reply after it is published, edit the related quick text record. Einstein generates the list of replies only once, when your model finishes building. It’s not possible to generate a new list. **Copyright** Rights of ALBERT EINSTEIN are used with permission of The Hebrew University of Jerusalem. Represented exclusively by Greenlight. # Report Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only. This object is available in API version 20.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Filter, Group, Nillable, Sort Description The description of the report. Limit: 255 characters. | | DeveloperName | Type string Properties Filter, Group, Sort Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. 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 **Report Unique Name**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | FolderName | Type string Properties Filter, Nillable, Sort Description Name of the folder that contains the report. Available in API version 35.0 and later. | | Format | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. Indicates the format of the report. This field is available in API version 29.0 and later. Can have one of these values: - **Tabular** for reports in that format. In the application, the label is Tabular. - **Summary** for reports in that format. In the application, the label is Summary. - **Matrix** for reports in that format. In the application, the label is Matrix. - **Multiblock** for reports in joined format. In the application, the label is Joined. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | LastRunDate | Type dateTime Properties Filter, Nillable, Sort Description Returns the date the report was last run. Label is **Last Run**. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. The report label used in the user interface. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. This field can’t be accessed unless the logged-in user has the Customize Application permission. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the folder that contains the report. There are 2 special folders: - Private, where the ID is the user ID - Public, where the ID is the org ID This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Folder, Organization, User | ## Supported Query Scopes Use these scopes to help specify the data your SOQL query returns. allPrivate Records saved in all users’ private folders. Requires the user permission "Manage All Private Reports and Dashboards" and [Enhanced Analytics Folder Sharing](https://help.salesforce.com/HTViewHelpDoc?id=analytics_sharing_enable.htm&language=en_US). If your organization was created after the Summer ’13 release, you already have Enhanced Analytics Folder Sharing. Available in API version 36.0 and later. created Records created by the user running the query. everything All records except records saved in other users’ private folders. mine Records saved in the private folder of the user running the query. organizationOwned Records saved in Unfiled Public Reports. In Lightning Experience, the Unfiled Public Reports folder is called Public Reports. ## Usage Use the report object to get report metadata. Query, search, or retrieve specific metadata on reports. Report object fields are read-only. ## Example: Reports with “Sales” in Their Name This SOQL query returns reports that contain the name “Sales” and lists their developer names, format, ID, and report name. SELECT DeveloperName,Format,Id,Name FROM Report WHERE Name LIKE '%Sales%' ## Example: Reports in an Inactive User’s Private Folder This SOQL query returns reports saved in a specific user’s private folder. SELECT Id FROM Report USING SCOPE allPrivate WHERE OwnerId = ‘005A0000000Bc2deFG’ ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ReportFeed](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. #### See Also - [ReportTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reporttag.htm "Associates a word or short phrase with a Report. This object is available in API version 20.0 and later.") - [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dashboard.htm "Represents a dashboard, which shows data from custom reports as visual components. Access is read-only. This object is available in API version 20.0 and later.") # Report Event Type Report events contain information about what happened when a user ran a report. This event type includes all activity that's in the Report Export event type, plus more. For example, it has user activity for reports exported as both Formatted Report and Details Only output. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Exporting a report directly from the report result captures the event in both the Report and Report Export logs. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
AVERAGE_ROW_SIZE
Type
Number
Description
The average row size of all rows in the Report event, in bytes. A large average size, coupled with a high ROW_COUNT, can indicate that a user is downloading information for fraudulent purposes. For example, a salesperson who downloads all sales leads before departing for a competitor.
Example
700
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
DISPLAY_TYPE
Type
String
Description
The report display type, indicating the run mode of the report.
Possible values are:
  • D—Dashboard
  • S—Show Details
  • H—Hide Details
ENTITY_NAME
Type
String
Description
The name of the object affected by the trigger.
EVENT_TYPE
Type
String
Description
The type of event. The value is always Report.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
NUMBER_BUCKETS
Type
Number
Description
The number of buckets that were used in the report.
NUMBER_COLUMNS
Type
Number
Description
The number of columns in the report.
NUMBER_EXCEPTION_FILTERS
Type
Number
Description
The number of exception filters that are used in the report.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
ORIGIN
Type
String
Description
The context in which the report executed, such as from a UI (Classic, Lightning, Mobile), through an API (synchronous, asynchronous, Apex), or through a dashboard.
Possible Values
  • ReportOpenedFromMobileDashboard: Report executed when a user clicked a dashboard component on a mobile device and drilled down to a report.
  • DashboardComponentUpdated: Report executed when a user refreshed a dashboard component.
  • DashboardComponentPreviewed: Report executed from a Lightning dashboard component preview.
  • ReportRunUsingSynchronousApi: Report executed from a synchronous API.
  • ReportRunUsingAsynchronousApi: Report executed from an asynchronous API.
  • ReportRunUsingApexSynchronousApi: Report executed from the synchronous Apex API.
  • ReportRunUsingApexAsynchronousApi: Report executed from the asynchronous Apex API.
  • ReportExported: Report executed from a printable view or report export that was not asynchronous nor an API export.
  • ReportRunFromClassic: Report executed from the Run Report option of Salesforce Classic.
  • ReportRunFromMobile: Report executed from the Run Report option of the mobile Salesforce app.
  • ReportRunFromLightning: Report executed from the Run option in Lightning Experience from a non-mobile browser.
  • ReportRunFromRestApi: Report executed from REST API.
  • ReportPreviewed: Report executed when a user got preview results while using the report builder.
  • ReportScheduled: Report was scheduled.
  • ProbeQuery: Report executed from a probe query.
  • ReportRunFromReportingSnapshot: Report executed through Snapshot Analytics.
  • ReportExportedAsynchronously: Report was exported asynchronously.
  • ReportExportedUsingExcelConnector: Report was exported using the Excel connector.
  • ChartRenderedOnVisualforcePage: Report executed from a rendered chart on a VisualForce Page.
  • ChartRenderedInEmbeddedAnalyticsApp: Report executed from a rendered chart in an embedded Analytics app.
  • ReportRunAndNotificationSent: Report executed through the notifications API.
  • ChartRenderedOnHomePage: Report executed from a rendered chart on the home page.
  • ReportResultsAddedToWaveTrending: Report executed when a user trended a report in CRM Analytics.
  • ReportAddedToCampaign: Report was added from an Add to Campaign action.
  • ReportResultsAddedToEinsteinDiscovery: Report executed synchronously from Einstein Discovery.
  • Unknown: Report execution origin is unknown.
  • Test: Report execution resulted from a test.
RENDERING_TYPE
Type
String
Description
Describes the format of the report output in Salesforce Classic. If the report was exported in Lightning Experience, this field is blank.
Possible Values
  • W: Web (HTML)
  • E: Email
  • P: Printable
  • X: Excel
  • C: Comma-separated values (CSV)
  • J: JavaScript Object Notation (JSON)
  • D: Dummy data
REPORT_ID
Type
Id
Description
The 15-character ID of the report that was run.
REPORT_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the report that was run.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
ROW_COUNT
Type
Number
Description
The number of rows that were processed in the Report event. High row counts, coupled with a high AVERAGE_ROW_SIZE, can indicate that a user is downloading information for fraudulent purposes. For example, a salesperson who downloads all sales leads before departing for a competitor.
Example
150
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
SORT
Type
String
Description
The sort column and order that was used in the report.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
UI_NUMBER_COLUMNS
Type
Number
Description
The number of columns in the report. The fields that have multiple components (for example, addresses) are considered as a single column.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
## Usage **Example: Identify Large Report Exports by User** Get Report event type data from the EventLogFile object using REST: /services/data/v40.0/query?q=SELECT+Id+,+EventType+,+LogFile+,+LogDate+,+LogFileLength+FROM+EventLogFile+WHERE+ LogDate+>+Yesterday+AND+EventType+=+'Report' After you download the report data to a ReportData database table, query it and filter on reports that were exported with high row counts and size: SELECT USER\_ID FROM ReportData WHERE (RENDERING\_TYPE=C OR RENDERING\_TYPE=X OR RENDERING\_TYPE=P) AND ROW\_COUNT>150000 AND AVERAGE\_ROW\_SIZE>1500 #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Report Export Event Type Report Export events contain details about reports that a user exported. For example, this event type captures when a user exports a report as Details Only output. But it doesn’t capture reports that users export as Formatted Report or XLSX Detail output. For that data, see the Report event type. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CLIENT_INFO
Type
String
Description
Information about the client that’s using Salesforce services.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
EVENT_TYPE
Type
String
Description
The type of event. The value is always ReportExport.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
REPORT_DESCRIPTION
Type
String
Description
Information about the report that was run.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # ReportEventLog Report event logs contain information about what happened when a user ran a report. This event type includes all activity that's in the Report Export event type, and additional information. For example, it has user activity for reports exported as both Formatted Report and Details Only output. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AverageRowSize | Type double Properties Filter, Nillable, Sort Description The average row size of all rows in the Report event, in bytes. A large average size, coupled with a high RowCount, can indicate that a user is downloading information for fraudulent purposes. For example, a salesperson who downloads all sales leads before departing for a competitor. For example: 700. | | BucketCount | Type double Properties Filter, Group, Nillable, Sort Description The number of buckets that were used in the report. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | ColumnCount | Type int Properties Filter, Group, Nillable, Sort Description The number of columns in the report. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseBlocks | Type double Properties Filter, Nillable, Sort Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance. | | DatabaseCpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DatabaseCpuTime. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | DisplayType | Type string Properties Filter, Group, Nillable, Sort Description The report display type, indicating the run mode of the report. Possible values are: - D—Dashboard - S—Show Details - H—Hide Details | | ExceptionFilterCount | Type int Properties Filter, Group, Nillable, Sort Description The number of exception filters that are used in the report. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | ObjectName | Type string Properties Filter, Group, Nillable, Sort Description The name of the object referenced by the report. | | Origin | Type string Properties Filter, Group, Nillable, Sort Description The context in which the report executed, such as from a UI (Classic, Lightning, Mobile), through an API (synchronous, asynchronous, Apex), or through a dashboard. Possible values are: - ReportOpenedFromMobileDashboard: Report executed when a user clicked a dashboard component on a mobile device and drilled down to a report. - DashboardComponentUpdated: Report executed when a user refreshed a dashboard component. - DashboardComponentPreviewed: Report executed from a Lightning dashboard component preview. - ReportRunUsingSynchronousApi: Report executed from a synchronous API. - ReportRunUsingAsynchronousApi: Report executed from an asynchronous API. - ReportRunUsingApexSynchronousApi: Report executed from the synchronous Apex API. - ReportRunUsingApexAsynchronousApi: Report executed from the asynchronous Apex API. - ReportExported: Report executed from a printable view or report export that was not asynchronous nor an API export. - ReportRunFromClassic: Report executed from the Run Report option of Salesforce Classic. - ReportRunFromMobile: Report executed from the Run Report option of the mobile Salesforce app. - ReportRunFromLightning: Report executed from the Run option in Lightning Experience from a non-mobile browser. - ReportRunFromRestApi: Report executed from REST API. - ReportPreviewed: Report executed when a user got preview results while using the report builder. - ReportScheduled: Report was scheduled. - ProbeQuery: Report executed from a probe query. - ReportRunFromReportingSnapshot: Report executed through Snapshot Analytics. - ReportExportedAsynchronously: Report was exported asynchronously. - ReportExportedUsingExcelConnector: Report was exported using the Excel connector. - ChartRenderedOnVisualforcePage: Report executed from a rendered chart on a VisualForce Page. - ChartRenderedInEmbeddedAnalyticsApp: Report executed from a rendered chart in an embedded Analytics app. - ReportRunAndNotificationSent: Report executed through the notifications API. - ChartRenderedOnHomePage: Report executed from a rendered chart on the home page. - ReportResultsAddedToWaveTrending: Report executed when a user trended a report in CRM Analytics. - ReportAddedToCampaign: Report was added from an Add to Campaign action. - ReportResultsAddedToEinsteinDiscovery: Report executed synchronously from Einstein Discovery. - Unknown: Report execution origin is unknown. - Test: Report execution resulted from a test. | | RenderingType | Type string Properties Filter, Group, Nillable, Sort Description Describes the format of the report output in Salesforce Classic. If the report was exported in Lightning Experience, this field is blank. Possible values are: - W: Web (HTML) - E: Email - P: Printable - X: Excel - C: Comma-separated values (CSV) - J: JavaScript Object Notation (JSON) - D: Dummy data | | ReportIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the report that was run. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RowCount | Type int Properties Filter, Group, Nillable, Sort Description The number of rows that were processed in the Report event. High row counts, coupled with a highAverageRowSize, can indicate that a user is downloading information for fraudulent purposes. For example, a salesperson who downloads all sales leads before departing for a competitor. For example: 150. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | SortOrder | Type string Properties Filter, Group, Nillable, Sort Description The sort column and order that was used in the report. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # ReportExportEventLog Report Export events contain details about reports that a user exported. For example, this event type captures when a user exports a report as Details Only output. But it doesn’t capture reports that users export as Formatted Report or XLSX Detail output. For that data, see the Report event type. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientInfo | Type string Properties Filter, Group, Nillable, Sort Description Information about the client that’s using Salesforce services. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | ReportDescription | Type string Properties Filter, Group, Nillable, Sort Description Information about the report that was run. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943 | # ReportTag Associates a word or short phrase with a Report. This object is available in API version 20.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage ReportTag stores the relationship between its parent TagDefinition and the Report being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. #### See Also - [Report](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_report.htm "Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only. This object is available in API version 20.0 and later.") # ReputationLevel Represents a reputation level defined for an Experience Cloud site. This object is available in API version 32.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules This object is available only if digital experiences is enabled in your org. Only users with permissions to create or manage an Experience Cloud site can view the ReputationPointsRule records. ## Fields | Field Name | Details | | --- | --- | | Label | Type string Properties Filter, Group, Nillable, Sort Description The label for the reputation level. | | LevelNumber | Type int Properties Filter, Group, Sort Description The rank of the reputation level. | | ParentId | Type reference Properties Filter, Group, Sort Description The ID of the parent Experience Cloud site the reputation level applies to. | | Threshold | Type double Properties Filter, Sort Description The lower limit of reputation points associated with this reputation level. The maximum number of reputation points a user can accrue is 999,999,999,999,999. | # ReputationLevelLocalization Represents the translated value of a reputation level. Reputation level localization only applies for reputation levels in Experience Cloud sites. This object is available in API version 35.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available only if digital experiences is enabled in your org and reputation is enabled in your Experience Cloud site. ## Fields | Field Name | Details | | --- | --- | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language the reputation level is translated into. The picklist contains the following fully-supported languages: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the reputation level this translated value applies to. | | Value | Type string Properties Create, Filter, Sort, Update Description The translated text for the reputation level. Label is **Translation Text**. | # ReputationPointsRule Represents the reputation point rules for an Experience Cloud site. Each rule specifies an action that members can earn points from and the points associated with those actions in a particular site. This object is available in API version 32.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules This object is available only if digital experiences is enabled in your org. Only users with permissions to create or manage an Experience Cloud site can view the ReputationPointsRule records. ## Fields | Field Name | Details | | --- | --- | | ParentId | Type reference Properties Filter, Group, Sort Description The ID of the parent Experience Cloud site that the point rule applies to. | | Points | Type int Properties Filter, Group, Sort Description The reputation points associated with the member action this rule is for. The maximum value this field can contain is 999,999. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The member action associated with this rule, limited to one of these actions: - Write a post (FeedItemWriteAPost) - Write a comment (FeedItemWriteAComment) - Receive a comment (FeedItemReceiveAComment) - Like something (FeedItemLikeSomething) - Receive a like (FeedItemReceiveALike) - Share a post (FeedItemShareAPost) - Someone shares your post (FeedItemSomeoneSharesYourPost) - Mention someone (FeedItemMentionSomeone) - Receive a mention (FeedItemReceiveAMention) - Ask a question (FeedItemPostQuestion) - Answer a question (FeedItemAnswerAQuestion) - Receive an answer (FeedItemReceiveAnAnswer) - Mark an answer as best (FeedItemMarkAnswerAsBest) - Someone marks your answer as best (FeedItemYourAnswerMarkedBest) - Endorse someone for knowledge on a topic (EndorseSomeoneForKnowledgeOnATopic) - Someone endorses you for knowledge on a topic (EndorsedForKnowledgeOnATopic) - Upload a profile picture (ProfilePhotoUpload) This action is available in API version 45.0 and later. | # Required Fields Required fields must have a non-null value. This rule affects the create and update calls: - In a create call, the system automatically populates the data for certain required fields (such as system fields and the object ID fields). Similarly, if a required field has a default value (its defaultedOnCreate attribute is set to true, then the system implicitly assigns a value for this field when the object is created, even if a value for this field is not explicitly passed in on the create call. For all other required fields, such as ID fields that are analogous to foreign keys in SQL, a client application must explicitly assign a value when the object is created (it cannot be null). - In updates, a required field cannot be set to null, and many required fields can’t be changed. Any field not specified as required in the object description is optional, that is, it can be null when updated or created. Some required fields for some objects require special handling. # ResourceAbsence Represents a time period in which a service resource is unavailable to work in Field Service, Salesforce Scheduler, or Workforce Engagement. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Field Service or Workforce Engagement must be enabled. ## Fields | Field Name | Details | | --- | --- | | AbsenceNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read only) An auto-generated number identifying the absence. | | Address | Type address Properties Filter Description The compound form of the address associated with the absence. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address associated with the absence. Maximum length is 40 characters. | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address associated with the absence. Maximum length is 80 characters. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the absence. | | End | Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the absence ends. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. This field is available in the API only. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the resource absence was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the resource absence was last viewed. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address associated with the absence. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address associated with the absence. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | Postal Code | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address associated with the absence. Maximum length is 20 characters. | | ResourceId | Type reference Properties Create, Filter, Group, Sort, Update Description The absent service resource. This is a relationship field. Relationship Name Resource Relationship Type Lookup Refers To ServiceResource | | Start | Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the absence begins. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address associated with the absence. Maximum length is 80 characters. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name of the address associated with the absence. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The type of absence: Meeting, Training, Medical, or Vacation. The default value is Vacation. You can add custom values if needed, but the name Break is reserved for the Field Service managed package. | ## Usage Resource absences you define periods of time when a service resource is unavailable to work. Unless you’re using the Field Service managed package, service resources can still be assigned to appointments that conflict with their absences. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip Create a trigger that sends an approval request to a supervisor when a service resource creates an absence. If you’re not using the Field Service managed package, a calendar view isn’t available for individual service resources. ## 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. [ResourceAbsenceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ResourceAbsenceFeed](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. [ResourceAbsenceHistory](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. # ResourcePreference Represents an account’s preference for a specified service resource on field service work. Resource preferences indicate which service resources can be assigned to field service work. You can designate service resources as preferred, required, or excluded on specific accounts, assets, locations, work orders, or work order line items. Work orders inherit their associated account’s resource preferences. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the resource preference was last modified. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the resource preference was last viewed. | | PreferenceType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Resource preference type. Values include: - Preferred: Indicates that the customer would like their field service work assigned to the resource. - Required: Indicates that the resource must be assigned to the customer’s field service work. - Excluded: Indicates that the customer doesn’t want their field service work assigned to the resource. Resource preferences serve more as a suggestion than a requirement. You can still assign a service appointment to any resource regardless of the related work order’s resource preferences. | | RelatedRecordId | Type reference Properties Create, Filter, Group, Sort Description The work order or account with the resource preference. This field is a polymorphic relationship. Relationship Name RelatedRecord Relationship Type Lookup Refers To Accounts, Assets, Locations, Work Orders, or Work Order Line Items | | ResourcePreferenceNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the resource preference. | | ServiceResourceId | Type reference Properties Create, Filter, Group, Sort, Update Description The service resource that is preferred, required, or excluded. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [ResourcePreferenceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 54.0) Change events are available for the object. [ResourcePreferenceFeed](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. [ResourcePreferenceHistory](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. # REST API Event Type REST API events contain details about REST-specific requests. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CLIENT_NAME
Type
String
Description
The name of the client that’s using Salesforce services. This field is an optional parameter that can be passed in API calls.
CONNECTED_APP_ID
Type
Reference
Description
The 15-character ID of the connected app associated with the API call. For example, 0H4RM00000000Kr0AI.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type
Set
Description
The name of the object accessed by the API request.
For example: Account, Opportunity, Contact, and so on.
EVENT_TYPE
Type
String
Description
The type of event. The value is always RestApi.
EXCEPTION_MESSAGE
Type
String
Description
The returned exception message, used to debug issues. Provide this message when seeking support.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
MEDIA_TYPE
Type
String
Description
The media type of the response.
METHOD
Type
String
Description
The HTTP method of the request.
For example: GET, POST, PUT, and so on.
NUMBER_FIELDS
Type
Number
Description
The number of fields or columns, where applicable.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
QUERY
Type
String
Description
The data that was queried.
REQUEST_SIZE
Type
Number
Description
The size of the callout request body, in bytes.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RESPONSE_SIZE
Type
Number
Description
The size of the callout response, in bytes.
ROWS_PROCESSED
Type
Number
Description
The number of rows that were processed in the request.
For example: 150.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
STATUS_CODE
Type
Number
Description
The HTTP response status code for the request.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_AGENT
Type
Number
Description
The numeric code for the type of client used to make the request (for example, the browser, application, or API).
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # RestApiEventLog REST API event logs contain details about REST-specific requests. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseBlocks | Type double Properties Filter, Nillable, Sort Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance. | | DatabaseCpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DatabaseCpuTime. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | ExceptionMessage | Type string Properties Filter, Nillable, Sort Description The exception message for a REST API request. An exception message gives details about errors in handling an API request, such as why an API request failed. For example: common.exception.ApiException: startDate cannot be more than 30 days ago. | | FieldCount | Type int Properties Filter, Group, Nillable, Sort Description The number of fields or columns, where applicable. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | MediaType | Type string Properties Filter, Group, Nillable, Sort Description The media type of the response. | | Method | Type string Properties Filter, Group, Nillable, Sort Description The HTTP method of the request. For example: GET, POST, PUT, and so on. | | ObjectName | Type string Properties Filter, Group, Nillable, Sort Description The name of the object accessed by the API request. For example: Account, Opportunity, Contact, and so on. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestSize | Type double Properties Filter, Nillable, Sort Description The size of the callout response, in bytes. | | RequestStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | ResponseSize | Type double Properties Filter, Nillable, Sort Description The size of the callout response, in bytes. | | RowsProcessed | Type int Properties Filter, Group, Nillable, Sort Description Numbers of rows that are processed by the REST API. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | StatusCode | Type int Properties Filter, Group, Nillable, Sort Description The HTTP response status code for the request. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # RetentionStoreUsage Represents the total usage of the org's retention store measured at specific points in time. This object is available in API version 66.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AttributeDetail | Type textarea Properties Nillable Description (For future use) Additional metadata or contextual details about the usage measurement. | | MetricType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Categorizes the type of usage being measured. Only DATA type is currently captured. - DATA: Total storage capacity usage (in bytes). - FILES: Files and attachments storage capacity usage (in bytes). - RECORDS: Retained record count (in rows). Only DATA type is currently captured. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the retention storage usage record. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the account owner associated with the storage. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | RetentionType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Identifies which retention system this usage record belongs to. Possible values are: - ARCHIVE - PRIVACY\_CENTER | | UnitOfMeasure | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the unit of measurement for the Usage field value. Possible values are: - BYTES - ROWS | | Usage | Type long Properties Filter, Group, Nillable, Sort Description The numeric usage value in the unit of measure specified in UnitOfMeasure. | | UsageDateTime | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the usage measurement was captured. | ## 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. [RetentionStoreUsageOwnerSharingRule](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. [RetentionStoreUsageShare](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. # ReturnOrder Represents the return or repair of inventory or products in Field Service, or the return of order products in Order Management. This object is available in API version 42.0 and later. Return orders are available in Lightning Experience, Salesforce Classic, the Salesforce mobile app, the Field Service mobile app for Android and iOS, and communities built using Salesforce Tabs + Visualforce. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service or Order Management must be enabled. If return orders are enabled by a Salesforce Order Management license, they must be created with a Status corresponding to the Status Category Activated. The default Statuses corresponding to Activated are Submitted and Approved. ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the return order. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | CaseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the return order. This is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The contact associated with the return order. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. ISO code for the currency of the OrderSummary associated with the ReturnOrder. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. This field is available in API version 49.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description Notes or context about the return order. | | DestinationLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location where the items are being returned to. For example, if the return order tracks the return of products from a technician’s van to a warehouse, the warehouse is the destination location. This is a relationship field. Relationship Name DestinationLocation Relationship Type Lookup Refers To Location | | ExpectedArrivalDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the items are expected to arrive at the destination location. | | ExpirationDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Authorizations can’t be captured after their expiration dates. This field is available in API version 50.0 and later. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments and tax, of the products, fees, and delivery charges on the return order. This includes all return order line items associated with the return order. This amount is equal to TotalAmount + TotalTaxAmount. This is a calculated field. This field is available in API version 50.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the return order was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the return order was last viewed. | | LifeCycleType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether the order summary is managed by Salesforce Order Management (MANAGED) or by an external system (UNMANAGED). An unmanaged order summary is stored in Salesforce for reference purposes. - Some Order Management APIs reject input records that are associated with unmanaged order summaries. - Order Management does not update financial bucket fields on some records that are associated with unmanaged order summaries. - A user with the EditUnmanagedOrderSummaries or B2BCommerceIntegrator permission can edit certain fields on objects related to unmanaged order summaries that are normally only accessible via APIs. Possible values are: - MANAGED—Managed - UNMANAGED—Unmanaged This field is available in API version 50.0 and later. | | OrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order associated with the return order. When you associated a return order with an order, you can associate the return order’s line items with order products. This is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | | OrderSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the order summary associated with the return order. This field is available in API version 50.0 and later. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the return order. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ProductRequestId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product request associated with the return order. When you associated a return order with a product request, you can associate the return order’s line items with the product request’s line items. A return order might be related to a product request if the return order tracks the return of unused products or products to be repaired or replaced. For example, a technician creates a product request for three motors to prepare for a field visit. If the technician finds that only two motors are needed, they can create a return order to return the third to the original location, and list the product request in this field. This is a relationship field. Relationship Name ProductRequest Relationship Type Lookup Refers To ProductRequest This field is available only if Field Service or Health Cloud is enabled. | | ProductServiceCampaignId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product service campaign associated with the return order This field is available only if Field Service is enabled. | | RefundInstructionsHint | Type textarea Properties Nillable Description Stores a JSON representation of the payment credit and refund sequences for ensure credit, ensure refund, and the change orders associated with it. This field is available in API version 65.0 and later. | | ReturnOrderNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read only) Auto-generated number identifying the return order. | | ReturnedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user returning the items. This is a relationship field. Relationship Name ReturnedBy Relationship Type Lookup Refers To User | | ShipFromAddress | Type address Properties Filter, Nillable Description The return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. | | ShipFromCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. | | ShipFromCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. | | ShipFromGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the return shipping address. See [Compound Fields Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. This field is available in the API only. | | ShipFromLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the return shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See [Compound Fields Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. This field is available in the API only. | | ShipFromLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the return shipping address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Fields Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. This field is available in the API only. | | ShipFromPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. | | ShipFromState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. | | ShipFromStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. | | ShipmentType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of shipment associated with the return order. Available values are: - Standard (default value) - Rush - Overnight - Next Business Day - Pick Up | | SourceLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The items’ location at the start of the return or repair. For example, if the return order tracks the return of products from a technician’s service vehicle to a warehouse, the service vehicle is the source location. This is a relationship field. Relationship Name SourceLocation Relationship Type Lookup Refers To Location | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the return order. Available values are: - Draft - Submitted - Approved - Canceled - Closed If return orders are enabled by a Salesforce Order Management license, they must be created with a Status corresponding to the Status Category Activated. The default Statuses corresponding to Activated are Submitted and Approved. | | StatusCategory | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Status category of the return order. Processing of the return order depends on this value. Each status category corresponds to one or more statuses. Possible values are: - Activated - Canceled - Closed - Draft - Pending This field is available in API version 50.0 and later. | | TaxLocaleType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The system used to handle tax on the original order associated with the return order. Gross usually applies to taxes like value-added tax (VAT), and Net usually applies to taxes like sales tax. Possible values are: - Automatic (displays most prices and taxes as combined values) - Gross (displays most prices and taxes as combined values) - Net (displays most prices and taxes as separate values) This field is available in API version 50.0 and later. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description Adjusted total, not including tax, of the return order line items, including products, fees, and delivery charges, on the ReturnOrder. This is a calculated field. This field is available in API version 50.0 and later. | | TotalDeliveryAdjustAmount | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the delivery charges on the return order. This value only includes adjustments to return order line items of type code Charge. This is a calculated field. This field is available in API version 50.0 and later. | | TotalDeliveryAdjustAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the delivery charges on the return order, inclusive of tax. This value only includes adjustments to return order line items of type code Charge. This amount is equal to TotalDeliveryAdjustAmount + TotalDeliveryAdjustTaxAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalDeliveryAdjustTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalDeliveryAdjustAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalDeliveryAmount | Type currency Properties Filter, Nillable, Sort Description Total of the delivery charges on the return order. This value only includes return order line items of type code Charge. This is a calculated field. This field is available in API version 50.0 and later. | | TotalDeliveryAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the delivery charges on the return order, inclusive of tax. This value only includes return order line items of type code Charge. This amount is equal to TotalDeliveryAmount + TotalDeliveryTaxAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalDeliveryTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalDeliveryAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalFeeAdjustAmount | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the fees on the return order. This value only includes adjustments to return order line items of type Fee. This is a calculated field. This field is available in API version 56.0 and later. | | TotalFeeAdjustAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the fees on the return order, inclusive of tax. This value only includes adjustments to return order line items of type Fee. This amount is equal to TotalFeeAdjustAmount + TotalFeeAdjustTaxAmount. This is a calculated field. This field is available in API version 56.0 and later. | | TotalFeeAdjustTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalFeeAdjustAmount. This is a calculated field. This field is available in API version 56.0 and later. | | TotalFeeAmount | Type currency Properties Filter, Nillable, Sort Description Total of the fees on the return order. This value only includes return order line items of type Fee. This is a calculated field. This field is available in API version 56.0 and later. | | TotalFeeAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the fees on the return order, inclusive of tax. This value only includes return order line items of type Fee. This amount is equal to TotalFeeAmount + TotalFeeTaxAmount. This is a calculated field. This field is available in API version 56.0 and later. | | TotalFeeTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalFeeAmount. This is a calculated field. This field is available in API version 56.0 and later. | | TotalProductAdjustAmount | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the products on the return order. This value only includes adjustments to return order line items of type code Product. This is a calculated field. This field is available in API version 50.0 and later. | | TotalProductAdjustAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the products on the return order, inclusive of tax. This value only includes adjustments to return order line items of type code Product. This amount is equal to TotalProductAdjustAmount + TotalProductAdjustTaxAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalProductAdjustTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalProductAdjustmentAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalProductAmount | Type currency Properties Filter, Nillable, Sort Description Total of the product charges on the return order. This value only includes return order line items of type code Product. This is a calculated field. This field is available in API version 50.0 and later. | | TotalProductAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the product charges on the return order, inclusive of tax. This value only includes return order line items of type code Product. This amount is equal to TotalProductAmount + TotalProductTaxAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalProductTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalProductAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAmount. This is a calculated field. This field is available in API version 50.0 and later. | ## Usage You can use return orders to track customer returns, customer repairs, or the return of inventory from a technician’s van stock to a warehouse or supplier. Customers can initiate a return from a community, or agents can create return orders in response to a customer call or technician request. Return orders are composed of return order line items, which allow you to add details about the items being returned. To represent the returned items, each line item must list one or more of the following: product, product item, asset, product request line item, and order product. Return orders can be associated with a product request, case, account, contact, and order if needed. This versatility lets you use return orders to track a wide range of return scenarios. ## Example { "RefundInstructionsHint": { "PaymentCreditSequence": \[ { "OrderPaymentSummaryId": "0bMxx0000000000001", "Amount": 50, "CreditType": "GIFT\_CARD", "Rank": 1 }, { "OrderPaymentSummaryId": "0bMxx0000000000002", "Amount": 50, "CreditType": "CHECK", "Rank": 2 } \] }, "RefundSequence": \[ { "OrderPaymentSummaryId": "0bMxx0000000000001", "Amount": 50, "Rank": 1 }, { "OrderPaymentSummaryId": "0bMxx0000000000002", "Amount": 50, "Rank": 2 } \], "ChangeOrders": \[ { "ChangeOrderId": "801xx000003Gd01111", "FeeChangeOrderId": null, "NetAmount": -75 } \] } ## 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. [ReturnOrderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ReturnOrderFeed](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. [ReturnOrderHistory](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. [ReturnOrderOwnerSharingRule](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. [ReturnOrderShare](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. # ReturnOrderItemAdjustment Represents a price adjustment on a return order line item. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Order Management must be enabled. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort Description Amount, not including tax, of the adjustment. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the adjustment. | | OrderItemAdjustLineSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the order item adjustment line summary associated with the adjustment. | | ReturnOrderId | Type reference Properties Create, Filter, Group, Sort Description ID of the return order associated with the return order line item to which the adjustment applies. This is a relationship field. Relationship Name ReturnOrder Relationship Type Lookup Refers To ReturnOrder | | ReturnOrderItemAdjustmentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the return order item adjustment. | | ReturnOrderLineItemId | Type reference Properties Create, Filter, Group, Sort Description ID of the return order line item to which this adjustment applies. This is a relationship field. Relationship Name ReturnOrderLineItem Relationship Type Lookup Refers To ReturnOrderLineItem | | TotalAmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the adjustment, inclusive of tax. This amount is equal to Amount + TotalTaxAmount. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the Amount. | ## 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. [ReturnOrderItemAdjustmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # ReturnOrderItemTax Represents the tax on a return order line item or return order item adjustment. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Order Management must be enabled. ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Create, Filter, Sort Description Amount of tax represented by the return order item tax. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the return order item tax. | | OrderItemTaxLineItemSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the order item tax line item summary associated with the order item summary that corresponds to the return order line item to which the tax applies. | | Rate | Type percent Properties Filter, Nillable, Sort Description Tax rate used to calculate the Amount. | | ReturnOrderId | Type reference Properties Create, Filter, Group, Sort Description ID of the associated return order. This is a relationship field. Relationship Name ReturnOrder Relationship Type Lookup Refers To ReturnOrder | | ReturnOrderItemAdjustmentId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If this object represents a tax on an adjustment, this value is the ID of the return order item adjustment to which the tax applies. If this value is null, the adjustment applies to a return order line item. This is a relationship field. Relationship Name ReturnOrderItemAdjustment Relationship Type Lookup Refers To ReturnOrderItemAdjustment | | ReturnOrderItemTaxNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the return order item tax. | | ReturnOrderLineItemId | Type reference Properties Create, Filter, Group, Sort Description If this object represents a tax on a return order line item, this value is the ID of that return order line item. If this object represents a tax on an adjustment, this value is the ID of the return order line item to which the adjustment applies. This is a relationship field. Relationship Name ReturnOrderLineItem Relationship Type Lookup Refers To ReturnOrderLineItem | | TaxEffectiveDate | Type date Properties Filter, Group, Nillable, Sort Description Date on which the Amount was calculated. Important due to tax rate changes over time. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Shows whether the amount on the tax line is an estimate or the final calculated amount. Doesn’t set a value by default. Users can define automation to set and change the value as needed. Possible values are: - Actual - Estimated | ## 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. [ReturnOrderItemTaxChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # ReturnOrderLineItem Represents a specific product that is returned or repaired as part of a return order in Field service, or a specific order item that is returned as part of a return order in Order Management. This object is available in API version 42.0 and later. Return orders are available in Lightning Experience, Salesforce Classic, the Salesforce mobile app, the Field Service mobile app for Android and iOS, and communities built using Salesforce Tabs + Visualforce. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service or Order Management must be enabled. ## Fields | Field Name | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset associated with the return order line item. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId. This is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | ChangeOrderItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the change order item associated with the return order line item. This field is available in API version 50.0 and later. This is a relationship field. Relationship Name ChangeOrderItem Relationship Type Lookup Refers To OrderItem | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the original Order associated with the ReturnOrderLineItem. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. This field is available in API version 49.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description Notes or context about the return order line item. | | DestinationLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location where the items are being returned to. For example, if the return order tracks the return of products from a technician’s van to a warehouse, the warehouse is the destination location. This is a relationship field. Relationship Name DestinationLocation Relationship Type Lookup Refers To Location | | GrossUnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description Unit price, including tax, of the product represented by the associated order item summary. This field is available in API version 50.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the return order line item was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the return order line item was last viewed. | | OrderItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order product associated with the return order line item. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId. This is a relationship field. Relationship Name OrderItem Relationship Type Lookup Refers To OrderItem | | OrderItemSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the order item summary associated with the return order line item. This field is available in API version 50.0 and later. | | ProcessingPlan | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Indicates the preferred fate of the items following their return. Available values are: - Repair—Repair the items and return them to the owner - Discard—Discard the items - Salvage—Salvage the items’ working parts - Restock—Return the items to your inventory | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product associated with the return order line item. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product item representing the location of the product at the start of the return. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId. This is a relationship field. Relationship Name ProductItem Relationship Type Lookup Refers To ProductItem | | ProductRequestLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product request line item associated with the return order line item. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId. This is a relationship field. Relationship Name ProductRequestLineItem Relationship Type Lookup Refers To ProductRequestLineItem | | ProductServiceCampaignId | Type reference Properties Filter, Group, Nillable, Sort Description The product service campaign associated with the return order line item. | | ProductServiceCampaignItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product service campaign item associated with the return order line item. | | QuantityExpected | Type double Properties Create, Filter, Nillable, Sort, Update Description The quantity of items expected to be returned. This field is available in API version 50.0 and later. | | QuantityReceived | Type double Properties Create, Filter, Nillable, Sort, Update Description The actual quantity of items received for return. This field is available in API version 50.0 and later. | | QuantityRejected | Type double Properties Create, Filter, Nillable, Sort, Update Description The quantity of items rejected for return. This field is available in API version 50.0 and later. | | QuantityReturned | Type double Properties Create, Filter, Sort, Update Description The quantity of items being returned. If multiple types of products are being returned, track each product in a different return order line item. | | QuantityUnitOfMeasure | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Units of the returned items; for example, kilograms or liters. Quantity Unit of Measure picklist values are inherited from the Quantity Unit of Measure field on products. | | ReasonForRejection | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Reason for rejecting returned items on this return order line item. Possible values are: - Damaged Item - Expired Warranty - Missing Item or Part - Wrong Item The default value is Missing Item or Part. This field is available in API version 50.0 and later. | | ReasonForReturn | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The reason the items are being returned. Available values are: - Damaged - Defective - Duplicate Order - Wrong Item - Wrong Quantity - Not Satisfied - Outdated - Other The default value is Damaged. | | ReasonForChangeText | Type string Properties Filter, Group, Sort Description Details about the reason for return change | | RepaymentMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The method by which the customer or owner will be reimbursed for the items being returned. Available values are: - Replace—The items will be replaced - Refund—The items will be returned and the owner will be refunded - Credit—The items will be returned and the owner will receive credit for them - Return—The items will be returned to the owner (for example, following their repair) | | ReturnOrderId | Type reference Properties Create, Filter, Group, Sort Description The return order that the return order line item belongs to. This is a relationship field. Relationship Name ReturnOrder Relationship Type Lookup Refers To ReturnOrder | | ReturnOrderLineItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read only) Auto-generated number that identifies the return order line item. | | SourceLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The items’ location at the start of the return or repair. For example, if the return order tracks the return of products from a technician’s service vehicle to a warehouse, the service vehicle is the source location. This is a relationship field. Relationship Name SourceLocation Relationship Type Lookup Refers To Location | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description Total of all price adjustments applied to the return order line item. This is a calculated field. This field is available in API version 50.0 and later. | | TotalAdjustmentAmountWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the return order line item, inclusive of tax. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalAdjustmentTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments and tax, of the return order line item. This is a calculated field. This field is available in API version 50.0 and later. | | TotalLineAmount | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Total, not including adjustments or tax, of the return order line item. This field is available in API version 50.0 and later. | | TotalLineAmountWithTax | Type currency Properties Filter, Nillable, Sort Description Total price of the return order line item, inclusive of tax. This amount is equal to TotalLineAmount + TotalLineTaxAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalLineTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalLineAmount. This is a calculated field. This field is available in API version 50.0 and later. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of the return order line item. Equal to UnitPrice times Quantity. This is a calculated field. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAmount. This is a calculated field. This field is available in API version 50.0 and later. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of the return order line item. Matches the type of the associated order item summary. Delivery Charge indicates that the return order line item represents a delivery charge. Fee indicates that it represents another type of fee, such as a return fee. Order Product indicates that it represents any other type of product, service, or charge. Each type corresponds to one type code, shown here in parentheses. Possible values are: - Delivery Charge (Charge) - Fee (Charge) This value is available in API v56.0 and later. - Order Product (Product) This field is available in API version 50.0 and later. | | TypeCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type code of the return order line item. Matches the type code of the associated order item summary. Processing depends on this value. Charge indicates that the return order line item represents a delivery charge. Product indicates that it represents an other type of product, service, or charge. Each type category corresponds to one or more types. Possible values are: - Charge - Product This field is available in API version 50.0 and later. | | UnitPrice | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Unit price of the return order line item. This field is available in API version 50.0 and later. | ## 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. [ReturnOrderLineItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ReturnOrderLineItemFeed](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. [ReturnOrderLineItemHistory](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. # ReturnOrderOwnerSharingRule Represents the rules for sharing a return order with user records other than the owner or anyone above the owner in the role hierarchy. This object is available in API version 42.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. A return order owned by a User in the source Group triggers the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | ServiceResourceAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group, or UserRole. The possible values are: - Read - Edit - All | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access. | # RevenueAsyncOperation Represents the status of an asynchronous process initiated by a REST request in Subscription Management. This object is available in API versions 57.0 to 59.0. Use AsyncOperationTracker instead of RevenueSyncOperation in API version 59.0 and later. For example, asset-management/assets/collection/actions/initiate-amend-quantity creates a RevenueAsyncOperation record when it initiates an asynchronous process. The ID of the record is returned in the REST response. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available with Subscription Management. ## Fields | Field | Details | | --- | --- | | AsyncOperationNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique identifier for this revenue async operation record. | | CorrelationIdentifier | Type string Properties Filter, Group, Nillable, Sort Description A unique identifier for the API request associated with this revenue async operation. | | ExpiresAt | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when this record will be deleted. | | FailedJobItems | Type integer Properties Filter, Group, Nillable, Sort Description The number of items that weren’t successfully processed by the sync operation. | | FinishedAt | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when the asynchronous process was completed. | | JobType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The REST request that initiated the asynchronous process. Valid values are: - ASMAdServerCheckAvailability - ASMAdServerIntegration - ASMApplyMediaPlanTemplateJob - ASMApplyTargetingTemplateJob - ASMBulkEditLineItemDetail. This field is available in API version 67.0 and later. - ASMCalcLinearMediaSpotPrc. This field is available in API version 66.0 and later. - ASMCreateAmendQuoteJob - ASMFileProcessorJob. This field is available in API version 66.0 and later. - ASMLinearSpotGenerationJob. This field is available in API version 67.0 and later. - ASMMediaPlanAsTemplate - ASMMediaPlanClone - ASMMediaPlanCopyJob - AbandonedCart. This field is available in API version 67.0 and later. - AssetizationAsyncJob - AutomatedNegativeInvoiceLineConversion - AutomaticRefunds - CommerceVariationsUpsert - ContextPersistence - CreateCPQContractsJob - CreditMemoRecovery. This field is available in API version 66.0 and later. - DeltaCatalogSyndicationAsyncJob - FullCatalogSyndicationAsyncJob - InvoicedDocgenJob - InvoicedDocgenPostProcessJob - InvoicedDocfenRetryJob - InvoiceDraftToPosted - InvoiceEstimatedTaxCallout - LoadSalesRecipientData. This field is available in API version 66.0 and later. - MultisiteAutoQuote. This field is available in API version 66.0 and later. - PST Base Job - Top-Level - PSTConfig - Configuration - PSTPersist - Save - PSTPrice - Price - PearAmendQtyAssets - PearCancelAssets - PearRenewAssets - PersonalizationRecommender. This field is available in API version 67.0 and later. - PlaceOrder - PlaceOrderPersistSync - PlaceOrderPriceAsync - PlaceOrderTaxAsync - PostOrderCampaign. This field is available in API version 67.0 and later. - PlaceQuote - PlaceQuotePersistAndPriceSync - PlaceQuotePersistSync - PlaceQuotePriceAsync - PlaceQuoteTaxAsync - PriceRuleDeployment - PriceSheetDeployJob - QuoteToOrderJob - RuleLibraryDeployment - SmsDltTemplateIngestion. This field is available in API version 66.0 and later. - StandaloneBillingSchedulesCreation - StatementOfAccountGeneration. This field is available in API version 66.0 and later. - TestSerialMessageStepJob - TransactionLineBom - VoidCreditMemo. This field is available in API version 66.0 and later. - energyAgreementSetup. This field is available in API version 66.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | ParentOperationId | Type reference Properties Filter, Group, Nillable, Sort Description Reserved for future use. This field is a relationship field. Relationship Name ParentOperation Relationship Type Lookup Refers To RevenueAsyncOperation | | ReferenceEntityId | Type reference Properties Filter, Group, Nillable, Sort Description Contains the ID of a record associated with the asynchronous request. For example, if the asynchronous request is associated with a credit memo, this field contains the ID of the credit memo. This field is a polymorphic field. Relationship Name ReferenceEntity Relationship Type Lookup Refers To CreditMemo, Order, Product2, Quote | | StartedAt | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when Salesforce started the asynchronous process. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the asynchronous process. Possible values are: - Completed - CompletedWithFailures - Failure - InProgress - Submitted | | SubmittedAt | Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when the asynchronous process was submitted by the REST request. | | SuccessfulJobItems | Type integer Properties Filter, Group, Nillable, Sort Description The number of items successfully processed by the sync operation. | | TotalJobItems | Type integer Properties Filter, Group, Nillable, Sort Description The total number of items processed by the sync operation, including both successfully processed items and failed items. | # RevenueTransactionErrorLog Contains information about errors that occurred while processing a request. The error record persists until another error with the same category, primary record, and (optionally) related record occurs. This object is available in API version 55.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_revenuetransactionerrorlog.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | AsyncOperationTrackerId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the async operation tracker record created by the request. Async operation tracker records contain information about the status of the asynchronous process initiated by the request. This field is available in API version 60.0 and later. This field is a relationship field. Relationship Name AsyncOperationTracker Relationship Type Lookup Refers To AsyncOperationTracker | | BillingScheduleGroupId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the group related to the billing schedule with errors. This field is available in API version 64.0 and later. This field is a relationship field. Relationship Name BillingScheduleGroup Refers To BillingScheduleGroup | | Category | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Provides context about the source of error. For example, if an error occurs while processing an /assets/collection/actions/initiate-cancellation request, the category is InitiateCancel. Valid values are: - ApplyAPI - AutomatedNegativeInvoiceLineConversion - AutomaticRefunds - ConvertNegativeInvoiceLineToCredit—Available in API version 56.0 and later. - Core Invoice Generation Failure - CreditInvoiceAPI - CreditMemoRecoveryApi—Available in API version 66.0 and later. - CreditTaxIntegrationAPI - BulkCurrencyConversion—Available in API version 66.0 and later. - InitiateAmendment—Available in API version 56.0 and later. - InitiateCancel - InitiateRenewal - InsufficientAccess—Insufficient Access to start invoice run. - InvoiceBatchRun - InvoiceBatchRunDebitConversion—Available in API version 66.0 and later. - InvoiceBatchRunInvoiceGeneration - InvoiceBatchRunPostProcessor - InvoiceBatchRunPreProcessor - InvoiceBatchRunRecovery - InvoiceBatchRunSelectionStep - InvoiceBatchRunSplitInvoiceGeneration—Available in API version 66.0 and later. - InvoiceBatchRunSummarizer - InvoiceBatchRunTaxProcessor - MaterialLineGeneration—Available in API version 58.0 and later. - Invalid Tax API Input - Invalid Tax Integration Input - LoadSalesRecipientData—Available in API version 66.0 and later. - OrderTaxCalculationFailure—Available in API version 61.0. - OrderToAsset - OrderItemToAsset—Available in API version 59.0 and later. - OrderToBillingSchedule - PaymentSale - PaymentScheduleGeneration—Available in API version 56.0 and later - ProcessAutoQuote—Available in API version 66.0 and later. - PstBaseStepFailure—Available in API version 66.0 and later. - QuotePriceCalculationFailure—Available in API version 61.0. - QuoteTaxCalculationFailure—Available in API version 61.0. - QuoteToOrder—Available in API version 56.0 and later. - Post Tax API Failure - Post-Credit Tax Failure - Pre-Credit Tax Failure - SetupEnergyAgreement—Available in API version 66.0 and later. - StandaloneCreditAPI - StatementOfAccountGeneration—Available in API version 66.0 and later. - Tax API Failure - TransactionToContract—Available in API version 59.0 and later. - Unknown Failure—Available in API version 56.0 and later. - VoidCreditMemo—Available in API version 66.0 and later. - VoidPostedInvoiceAPI | | ConfiguratorErrorMessage | Type textarea Properties Nillable Description The text of the error message. This field is available in API version 66.0 and later. | | ErrorCode | Type string Properties Filter, Group, Nillable, Sort Description The error code; for example, INVALID\_INPUT. | | ErrorLogNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated unique ID that identifies the error. | | ErrorMessage | Type textarea Description Contains information about the error and how to resolve it. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user who made the request that resulted in the creation of the error log. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PrimaryRecord2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the record that’s associated with this error. For example, if the error occurred while creating an invoice line from an order line, the primary2 ID is the ID of the order line. This field is available in API version 66.0 and later. This field is a polymorphic relationship field. Relationship Name PrimaryRecord2 Refers To Account, CreditMemoInvApplication, CreditMemoLine, CreditMemoLineInvoiceLine, CreditMemoLineTax, DebitMemo, DebitMemoLine, InvoiceLine, InvoiceLineTax, LegalEntyAccountingPeriod, Order, PaymentLineInvoice, PaymentLineInvoiceLine, RefundLinePayment | | PrimaryRecordId | Type reference Properties Filter, Group, Sort Description The ID of the record that’s associated with this error. For example, if the error occurred while creating an invoice from an order, the primary ID is the ID of the order. This field is a polymorphic relationship field. Relationship Name PrimaryRecord Relationship Type Lookup Refers To Asset, BillingBatchScheduler, BillingSchedule, CardPaymentMethod, CreditMemo, Invoice, InvoiceBatchRun, InvoiceBatchRunRecovery, Order, Payment, PaymentBatchRun, PaymentGateway, Quote, Refund | | PrimaryTextRecord | Type string Properties Filter, Group, Nillable, Sort Description The identifier of the primary record associated with the error log. For example, if the error occurred while creating an invoice from an order, the primary text Record ID is the ID of the order. There are two other fields in the same entity, PrimaryRecord and PrimaryRecord2, that are polymorphic fields, so they’re limited to storing IDs from objects in their respective domains. Use this text field for all objects. This field is available in API version 63.0 and later. | | RelatedRecord2Id | Type reference Properties Create, Filter, Group, Nillable, Sort Description Optional. The ID of a record that can provide additional context about the error. For example, if PrimaryRecord2Id is the ID of an invoice line, this field could be the ID of an invoice line tax. This field is available in API version 66.0 and later. This field is a polymorphic relationship field. Relationship Name RelatedRecord2 Refers To CreditMemoLine, CreditMemoLineInvoiceLine, CreditMemoLineTax, DebitMemo, GeneralLedgerAccount, GeneralLedgerAcctAsgntRule, InvoiceLine, InvoiceLineTax, Payment, PaymentLineInvoice, PaymentLineInvoiceLine, Refund, RefundLinePayment | | RelatedRecordId | Type reference Properties Filter, Group, Nillable, Sort Description Optional. The ID of a record that can provide additional context about the error. For example, if PrimaryRecordId is the ID of an order, this field could be the ID of an order item. This field is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To BillingBatchScheduler, BillingSchedule, BillingScheduleGroup, CreditMemo, CreditMemoLine, Invoice, InvoiceLine, OrderItem, Payment, PaymentSchedule, PaymentScheduleItem, QuoteLineItem, Refund | | Request | Type textarea Properties Nillable Description Optional. A field providing additional information linking the error with the request. This field is available in API version 66.0 and later. | | RequestIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique ID returned by the request. Use this ID to identify the revenue transaction error log records for a specific request. This field is available in API version 57.0 and later. | | RevenueAsyncOperationId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the revenue async operation record created by the request. Revenue async operation records contain information about the status of the asynchronous process initiated by the request. This field is available in API version 57.0 and later. This field is a relationship field. Relationship Name RevenueAsyncOperation Relationship Type Lookup Refers To RevenueAsyncOperation | | Severity | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The severity type for the error message. This field is available in API version 66.0 and later. Valid values are: - Error - Warning | # Review Represents a standing review of a specific business record against a defined reference standard. When a review is conducted, it automatically reflects the date and outcome of the most recently completed review execution. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Marketing Planning and Operations must be available to access this object. See [Availability of Marketing Planning and Operations](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | DefaultReviewerId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user or user group who is set as the default reviewer of executions created for the review. This field is a polymorphic relationship field. Relationship Name DefaultReviewer Refers To Group, User | | Instructions | Type textarea Properties Create, Nillable, Update Description The standing instructions that apply to every review conducted under this requirement. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastReviewDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date when the latest review execution took place. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate is not null, the user accessed this record or list view indirectly. | | LatestComplianceStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The compliance status of the latest related review execution. The value is automatically derived from the ComplianceStatus field of the latest related review execution record created. Possible values are: - Compliant - NotCompliant—Not Compliant - NotStarted—Not Started The default value is NotStarted. | | LatestReviewStage | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The stage of the latest related review execution. The value is automatically derived from the Stage field of latest related review execution record created. Possible values are: - Completed - Failed - InProgress—In Progress - None - NotStarted—Not Started - Waived The default value is None. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the review. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the review record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ReviewContextReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the regulatory or contractual standard against which the review is conducted. This field is a polymorphic relationship field. Relationship Name ReviewContextReference Refers To ComplianceControl, RegulationClauseVersion | | ReviewTargetReferenceId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the item that the review is for. This field is a polymorphic relationship field. Relationship Name ReviewTargetReference Refers To Campaign, MarketingProgram, MarketingTactic, MarketingTacticTemplate, RegltCntntVersion | | SourceType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies how the review was created. Possible values are: - ComplianceControlScope—Compliance Control Scope - UserCreated—User Created The default value is UserCreated. | | UsageType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the usage type of the review. Possible values are: - MARKETING\_PLANNING\_OPS | ## 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. [ReviewShare](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. # ReviewExecution Represents a single review event conducted by an assigned user or group to fulfill a review, capturing the outcome at a specific point in time. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Marketing Planning and Operations must be available to access this object. See [Availability of Marketing Planning and Operations](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US). ## Fields | Field | Details | | --- | --- | | AssignedToId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user or group responsible for executing this review. This field is a polymorphic relationship field. Relationship Name AssignedTo Refers To Group, User | | Category | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the category of the review execution. | | ComplianceReason | Type textarea Properties Create, Nillable, Update Description The reason due to which the review execution was set to the current compliance status. | | ComplianceStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the compliance outcome of this review execution. Possible values are: - Compliant - NotCompliant—Not Compliant - NotStarted—Not Started The default value is NotStarted. | | Instructions | Type textarea Properties Create, Nillable, Update Description The instructions specific to this review execution. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the review execution. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the review execution record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ReviewContextReferenceId | Type reference Properties Nillable Description The ID of the regulatory or contractual standard this execution is evaluated against. This field is a polymorphic relationship field. Relationship Name ReviewContextReference Refers To ComplianceControl, RegulationClauseVersion | | ReviewId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the review that this execution fulfills. This field is a relationship field. Relationship Name Review Refers To Review | | ReviewTargetReferenceId | Type reference Properties Nillable Description The ID of the business record reviewed in this execution. This field is a polymorphic relationship field. Relationship Name ReviewTargetReference Refers To Campaign, MarketingProgram, MarketingTactic, MarketingTacticTemplate, RegltCntntVersion | | Stage | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the current stage of the review execution. Possible values are: - Completed - Failed - InProgress— - None - NotStarted— - Waived The default value is None. | ## 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. [ReviewExecutionShare](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. # RpaFlowResultEvent Reserved for future use. # RpaRobot Reserved for future use. # RpaRobotAsgnMaintWindow Reserved for future use. # RpaRobotAsgnSessionInf Reserved for future use. # RpaRobotDefinition Reserved for future use. # RpaRobotMaintWindow Reserved for future use. # RpaRobotMaintWindowDef Reserved for future use. # RpaRobotPool Reserved for future use. # RpaRobotPoolAsgnRobot Reserved for future use. # RpaRobotPoolDefinition Reserved for future use. # RpaRobotPoolFlowAsgn Reserved for future use. # RpaRobotSessionInfo Reserved for future use. # RpaRobotSessionInfoDef Reserved for future use. # RuleTerritory2Association Represents a record-assignment rule and its association to an object, such as Account. Available if Sales Territories has been enabled. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Standard users can access this object. If a territory model is in Active state, any standard user can view that model, including its territories and assignment rules. For territories in an active model, any standard user can view assigned records and assigned users subject to your Salesforce sharing settings. Users cannot view territory models in other states (such as Planning or Archived). ## Fields | Field Name | Details | | --- | --- | | IsInherited | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the rule is an _inherited_ rule (true) or a _local_ rule (false). Rule inheritance flows from the parent territory where the rule is created to the rule’s descendent territories (if any) in the territory model hierarchy. A local rule is created within a single territory and affects that territory only. | | RuleId | Type reference Properties Create, Filter, Group, Sort Description The ID of the rule. | | Territory2Id | Type reference Properties Create, Filter, Group, Sort Description The ID of the territory where the rule was created. | # SalesAIScoreCycle Represents the cycle type and ID used to score records. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To see score cycle information, users need a Sales Cloud Einstein license with the View Scoring Model Factors permission enabled. The permission isn’t enabled by default. As of the Spring ’20 release, Pardot and Sales Engagement users no longer have access to this object. ## Fields | Field | Details | | --- | --- | | CycleType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The cycle used to create scores on opportunity records can be one of two types. - OpportunityScoreModeling—Provides model factors, which Sales Cloud Einstein uses to build a scoring model. - OpportunityScoreScoring—Provides scores and key factors to individual records, which are based on Sales Cloud Einstein’s scoring model. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When the value OpportunityScoreModeling is returned, use the Sales AI Score Model Factor object to get information about the model factors. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The ID of the cycle. Currently, the name is a system-generated unique value. | # SalesAIScoreModelFactor Represents the factors that Sales Cloud Einstein uses to build a scoring model. Scoring models are used by features, such as Opportunity Scoring, to score individual records. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To see model factor information, users need a Sales Cloud Einstein license with the “View Scoring Model Factors” permission enabled. The permission isn’t enabled by default. As of the Spring ’20 release, Pardot and Sales Engagement users no longer have access to this object. ## Fields | Field | Details | | --- | --- | | Factor | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A factor that contributes to a scoring model. For example, a factor could indicate that an amount increase has a positive effect on an opportunity score (AmountIncreasePositive). Or, it could indicate that a change to the close date has a negative effect on an opportunity score (CloseDateChangeNegative). | | FactorSummaryOrgLanguage | Type string Properties Filter, Group, Nillable, Sort Description Describes the factor in English. For example, the factor field value AmountChangePositive is summarized as “Amount change has positive effect”. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The ID of the model factor. Currently, the name is a system-generated value. | | OperatorType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The operator used to analyze field values. For example, the factor HighSuccessLeadSource uses the Lead Source field as the primary source field. When building the scoring model, Einstein uses the Equals operator to determine PrimarySourceFieldValue = Internet. The other supported operator is IsNull. | | PrimarySourceFieldName | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the primary field used in the model factor. For example, the factor HighSuccessIndustry uses the account’s Industry as the primary field. | | PrimarySourceFieldValue | Type string Properties Filter, Group, Nillable, Sort Description Information used to retrieve the PrimarySourceFieldValueText, such as a record ID or value. | | PrimarySourceFieldValueText | Type string Properties Filter, Group, Nillable, Sort Description The value of the primary source field used in the model factor. For example, the factor HighSuccessIndustry uses the account’s Industry as the primary field, and the value of the Industry field is manufacturing. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field’s value is retrieved from the PrimarySourceFieldValue field. If the PrimarySourceFieldValue field is a record ID, then PrimarySourceFieldValueText returns the name of the record. If OperatorType returns isNull, then PrimarySourceFieldValue returns true and PrimarySourceFieldValueText returns null. | | SalesAiScoreCycleId | Type reference Properties Filter, Group, Sort Description The ID of the score cycle used to generate model factors. Each score cycle can have multiple model factors associated to it. | | ScoreCorrelation | Type double Properties Filter, Nillable, Sort Description The strength between a model factor and a score. If score correlation value is closer to +1, it’s more likely that the model factor contributing toward a high score. If score correlation value is closer to \-1, it’s more likely that the model factor is contributing toward a low score. | | SecondarySourceFieldName | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The name of the secondary field used in the model factor. For example, the factor HighAmountActivity uses Task as the primary field and Event as the secondary field. Not all model factors use a secondary source field. | | SecondarySourceFieldValue | Type string Properties Filter, Group, Nillable, Sort Description Information used to retrieve the SecondarySourceFieldValueText, such as a record ID or value. Not all model factors use a secondary source field. This field is available in API version 50.0 and later. | | SecondarySourceFieldValueText | Type string Properties Filter, Group, Nillable, Sort Description When the model factor is based on two source fields, this field represents the value of the secondary source field. For example, the factor HighSuccessMultipleSameFieldValue might use the opportunity’s related product as the primary field and pricebook as the secondary field. The product and pricebook names are indicated by the PrimarySourceFieldValueText and SecondarySourceFieldValueText, respectively. Not all model factors use a secondary source field. This field is available in API version 50.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field’s value is retrieved from the SecondarySourceFieldValue field. If the SecondarySourceFieldValue field is a record ID, then SecondarySourceFieldValueText returns the name of the record. If OperatorType returns isNull, then SecondarySourceFieldValue returns true and SecondarySourceFieldValueText returns null. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Determines whether the model factor is active or inactive. | ## Usage Use the SalesAIScoreModelFactor object to run a query that retrieves the latest highest influencing model factors. SELECT Id,Factor,ScoreCorrelation,FactorSummaryOrgLanguage FROM SalesAIScoreModelFactor WHERE Status='Active' and SalesAIScoreCycle.CycleType='OpportunityScoreModeling' ORDER BY ScoreCorrelation desc # SalesChannel Represents the origin of an order. For example, a web storefront, physical store, marketplace, or mobile app. If you integrate Salesforce Order Management with Salesforce B2C Commerce, set up a SalesChannel corresponding to each Site in your B2C Commerce implementation. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description Description of the SalesChannel. | | ExternalChannelNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description External system identifier for the SalesChannel. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this SalesChannel. Default value is the user logged in to the API to perform the create. | | SalesChannelName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the SalesChannel. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Type of the SalesChannel. Each Type corresponds to one Type Category. You can customize the Type picklist to represent your business processes, but the Type Category picklist is fixed because some order processing is based on those values. If you customize the Type picklist, include at least one value for each Type Category. This field is available in API version 53.0 and later. Default values are: - B2B - B2C - Other | | TypeCategory | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type Category of the SalesChannel. Each Type Category corresponds to one or more Types. This field isn’t visible in the UI. This field is available in API version 53.0 and later. Possible values are: - B2B - B2C - Other | ## 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. [SalesChannelChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [SalesChannelShare](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.")(API version 66.0) Sharing is available for the object. #### See Also - [Order](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_order.htm "Represents an order associated with a contract or an account.") - [OrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm "Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.") # Salesforce Cloud Objects Cloud objects are used only by a specific cloud. These objects sometimes have different limitations, APIs, or querying behavior than standard common objects. Some Salesforce objects require special licensing or purchase. If an object is included in the Object Reference for the Salesforce Platform, the special-access section of the page about the object indicates licensing or purchasing requirements. In most cases, these objects are documented in implementation guides for their cloud, not in the Object Reference. # Salesforce Common Objects Common objects are available in any standard org for any cloud. They don’t require any special licensing. **Optimized for:** ACID transactions **Object types:** Original, Base, and Setup. **Database storage:** Relational and transactional database that scales to millions of records **Reference information:** Object Reference for the Salesforce Platform **Documentation:** Documented in Salesforce Help by product ## Original Platform Objects Original platform objects are sometimes called hero or legacy objects. They’re the oldest of the Salesforce objects. **Objects:** Account, Contact, Lead, Opportunity **Customizable:** Yes **Cloud:** Common. These objects are available in any cloud that uses an org. **Packaging:** Every form of packaging except data kits. See the Metadata Coverage Report. **Object Examples:** [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_account.htm), [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contact.htm), [Lead](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_lead.htm), [Opportunity](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm) **Documentation:** [Apex Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_dev_guide.htm), [Salesforce DX Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_intro.htm) **Reference:**[Object Reference for the Salesforce Platform](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm) ## Base Platform Objects Base platform objects (BPOs) are the objects common to most Salesforce orgs that contain data. **Object Examples:** [SocialPersona](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_socialpersona.htm?q=Person%20Account) **Customizable:** Yes **Cloud:** Common. These objects are available on any cloud that uses an org. **Packaging:** Every form of packaging except data kits. ## Setup Platform Objects Setup platform objects (SPOs) are the objects common to most Salesforce orgs that contain setup configuration information. Data about the platform is created using org Setup is stored in Setup platform objects. **Object Examples:** [CompactLayout](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_compactlayout.htm), [CustomField](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_customfield.htm) **Customizable:** Yes **Cloud:** Common. These objects are available on any cloud that uses an org. **Packaging:** The packaging available depends on the cloud, product, and feature that the objects are associated with. ## Custom Objects You can create custom objects and define the schema for the object. **Transaction type:** ACID **Object type(s):** All custom objects are user defined, so they don’t have subtypes. **Object suffix:** \_\_c **Customizable:** N/A **Cloud:** Common **Packaging:** Depends on the object. **Object Examples:** N/A **Documentation:** [Manage Custom Objects](https://help.salesforce.com/s/articleView?id=platform.dev_objectedit.htm&type=5&language=en_US) in Salesforce Help. **Reference:** N/A # Salesforce Data Cloud Objects Data Cloud objects are high-scale objects that are used to store large amounts of data over time. **Optimized for:** OLAP transactions **Object Type(s):** DLO, DMO, CIO, DG **Documentation:** [Data Object Concepts and Schema in Data Cloud](https://help.salesforce.com/s/articleView?id=data.c360_a_schema_setup_concepts.htm&type=5&language=en_US) in Salesforce Help ## DMO Object Creation ![Data Cloud Object Creation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/DataCloudObjects_DMO_ObjectCreation.png) Data Cloud objects are created from ingested data and from various operations on that data. Here's how it works. 1. Data ingested into Data Cloud is stored in data lake objects (DLOs) in the native schema of the system it was created in. Formula fields are also supported for DLOs. 2. Data lake objects are mapped to the schema for data model objects (DMOs), which is the C360 Data Model. data model objects don’t store data, only the references to data stored in data lake objects. 3. Data lake objects and data model objects can be transformed into new DLOs and DMOs by using the Data Cloud [data prep and transform feature](https://help.salesforce.com/s/articleView?id=data.c360_a_cleansing_data.htm&type=5&language=en_US). 4. Data model objects undergo identity resolution to match and resolve data across different records in the same type of DMO and combine the best data from different DMOs in a unified DMO. The unified DMO is often used to create other types of objects, such as data graphs and calculated insights, so it’s usually created before other object types. However, it’s an optional step. 5. Data in DMOs can be aggregated or calculated to create calculated insight objects (CIOS). 6. A subset of DMO data can also be used as a data graph for faster processing in near real-time transactions with high-scale data. 7. You configure search index objects for DMOs by using the Data Cloud app. These objects aren’t DMOs, but they're used to generate DMOs. 8. Search index objects automatically generate chunk-content DMOs and vector-embedding DMOs. ## UDMO Object Creation ![UDMO object creation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/DataCloudObjects_UDMO_ObjectCreation.png) 1. Unstructured data ingested into Data Cloud is stored in unstructured data lake objects (UDLOs). 2. Unstructured data lake objects are automatically mapped to the C360 Data Model schema for unstructured data model objects (UDMOs). 3. Configure a search index object on UDMOs and DMOs, so it can be used for Retrieval Augmented Generation (RAG) with Gen AI applications. 4. You can generate chunk content DMOs and vector embedding DMOs from (search) index DMOs. ## Zero Copy Object Creation ![Zero copy data federation object creation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/DataCloudObjects_ZeroCopyObjectCreation.png) Some external data sources are deeply integrated with Data Cloud, so that you can create a connection that doesn’t require data syncing or ingestion. When you share an external data source with Data Cloud, external objects are defined. You configure additional metadata about these objects so you can use the objects with Salesforce features and APIs. For example, you can configure label names that are used in apps and reports. ## Calculated Insight Objects (CIO) **Usage:** These objects contain data aggregated or calculated from DMO objects. **Customizable:** Yes. There are no standard CIOs. **Cloud:** Data Cloud. **Packaging:** Data kits **Documentation:** [Calculated Insights](https://help.salesforce.com/s/articleView?id=data.c360_a_calculated_insights.htm&type=5&language=en_US) in Salesforce Help **Reference:** N/A ## Data Lake Objects (DLO) **Usage:** Data lake objects are used to store data ingested into Data Cloud. **Object suffix:** \_\_dlo. **Customizable:** Yes **Cloud:** Data Cloud **Packaging:** DLOs can be packaged via data kits. Data streams to ingest DLOs can also be packaged. **Documentation:** [Data Object Concepts and Schema in Data Cloud](https://help.salesforce.com/s/articleView?id=data.c360_a_schema_setup_concepts.htm&type=5&language=en_US)in Salesforce Help **Reference:** DLO objects can be ingested from any external source and retain the schema from the data stream. Consult the reference documentation for the system you’re ingesting the DLO from. In addition to standard data lake objects, there are also unstructured and external data lake objects. ## Data Model Objects (DMO) **Usage:** data model objects use the C360 Data Model to provide a common representation of data. Data stored in data lake objects is mapped to data model objects. data model objects don’t store data, but they contain information on where data is stored in DLO objects. Data Cloud APIs and features use DMO objects to access data that's stored in data lake objects. **Object suffix:** \_\_dlm. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note All API Names for DMO object fields have a \_\_c suffix for both standard and custom fields. **Customizable:** Yes **Cloud:** Data Cloud. **Packaging:** Data kits (recommended). Unmanaged packages and managed packages support data kit packaging only from the default data space. However, you can deploy data kits in any data space. It’s also possible to import DMOs in unmanaged packages or through comma separated value (CSV) files. **Documentation:** [Data Object Concepts and Schema in Data Cloud](https://help.salesforce.com/s/articleView?id=data.c360_a_schema_setup_concepts.htm&type=5&language=en_US) in Salesforce Help **Reference:** data model objects don’t have a single reference. Most Salesforce DMOs mirror existing Salesforce base platform objects and original platform objects . A few of these use slightly different data types. Some Salesforce DMOs are referenced in the [Standard Data Model Objects (DMOs)](https://developer.salesforce.com/docs/atlas.en-us.c360a_api.meta/c360a_api/c360dm_DataModelObjects.htm) section of the Data Cloud Reference Guide. However, additional DMO objects are available for specific features or clouds. DMOs are also documented as a part of data kit or bundle mappings. In addition to data model objects, there are also unified data model objects and unstructured data model objects (UDMO) ## Data Graphs (DG) **Usage:** You can create a precalculated, materialized view of your data to improve query speed with high-scale data. A data graph contains a JSON blob that combines data structures from multiple DMOs and is used for real-time operations in apps. **Customizable:** Yes. All data graphs are customizable. There are no standard data graphs. **Cloud:** Data Cloud. **Packaging:** Data kits. Data graphs can be added to data kits, but they aren’t packageable directly. **Documentation:** [Data Graphs](https://help.salesforce.com/s/articleView?id=data.c360_a_data_graphs.htm&type=5&language=en_US) in Salesforce Help **Reference:** N/A ## Unified Objects **Usage:** You can create a precalculated, materialized view of your data to improve query speed with high-scale data. A data graph contains a JSON blob that combines data structures from multiple DMOs and is used for real-time operations in apps. **Customizable:** Yes. All data graphs are customized. There are no standard data graphs. **Cloud:** Data Cloud. **Packaging:** Data kits. Data graphs can be added to data kits, but they aren’t packageable directly. **Documentation:** [Data Graphs](https://help.salesforce.com/s/articleView?id=data.c360_a_data_graphs.htm&type=5&language=en_US) in Salesforce Help **Reference:** N/A ## Unstructured Data Lake Objects (UDLO) **Usage:** Unstructured data lake objects (UDLOs) reference unstructured data in Data Cloud. A UDLO is created manually. Unstructured data is ingested from a blob store. **Object suffix:** \_\_dlo. **Customizable:** Yes **Cloud:** Data Cloud **Packaging:** Not packageable. UDLOs aren’t packaged. However, connections to ingest UDLOs can be packaged. **Documentation:** [Unstructured Data Lake Objects](https://help.salesforce.com/s/articleView?id=sf.c360_a_unstructured_data_udlo_overview.htm&type=5&language=en_US) in Salesforce Help **Reference:** In addition to standard data lake objects, there are also unstructured data lake objects (UDLO) and external data lake objects. ## Unstructured Data Model Objects (UDMO) **Usage:** Unstructured data model objects represent data created from unstructured data sources. **Object suffix:** \_\_dlm. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note All API names for DMO object fields have a \_\_c suffix for both standard and custom fields. **Customizable:** Yes **Cloud:** Data Cloud. **Packaging:** Data kits (recommended). It’s also possible to import DMOs in unmanaged packages or through CSV files. **Documentation:** [Data Object Concepts and Schema in Data Cloud](https://help.salesforce.com/s/articleView?id=data.c360_a_schema_setup_concepts.htm&type=5&language=en_US) in Salesforce Help **Reference:** N/A # Salesforce External Data Objects You can store data outside Salesforce and still access in your org or Data Cloud. ## External Objects External objects are similar to custom objects, but external object record data is stored outside your org. You can access data in external objects by using OData and other adaptors. ## Zero Copy Objects In some cases, Salesforce is deeply integrated into data stored in other products, such as Snowflake or AWS. In this case, the data is stored outside Salesforce, but it's accessible through Data Cloud. # Salesforce High-Scale Objects Use high-scale objects when you have a large number of transactions, large objects, or you must store data over a long period. These objects sometimes have different limitations, APIs, or querying behavior than Salesforce common objects do. ## Big Objects **Usage:** Auditing, tracking, feeds, and historical archives. **Transaction Type:** OLTP transactions **Database Storage:** Horizontally scalable distributed databases that are non-transactional and scale to hundreds of millions or even billions of records. Big objects can contain data that’s larger than the data that Data Cloud or standard objects support. **Object Type:** BO **Object Suffix:** \_\_b **Customizable:** Yes **Cloud:** Any cloud that provides an org. However, Big Objects requires an additional license. **Packaging:** Use the deploy() and retrieve() calls to deploy and retrieve a .zip file. Standard AppExchange packaging isn’t available. **Object Examples:** [FieldHistoryArchive](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_fieldhistoryarchive.htm) **Documentation:** [Big Objects Implementation Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.bigobjects.meta/bigobjects/big_object.htm) **Reference:** [Object Reference for the Salesforce Platform](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm) ## High-Scale Order Objects **Optimized for:** OLTP transactions **Objects:** PendingOrderSummary **Documentation:** [Order Management Implementation Guide](https://help.salesforce.com/s/articleView?id=commerce.om_impl_intro.htm&type=5&language=en_US) **Reference:** [Object Reference for the Salesforce Platform](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_pendingordersummary.htm) ## Data Cloud Objects **Optimized for:** OLAP transactions **Object types:** DLO, DMO, CIO, DG **Documentation:** [Data Object Concepts and Schema in Data Cloud](https://help.salesforce.com/s/articleView?id=data.c360_a_schema_setup_concepts.htm&type=5&language=en_US) - **[Salesforce Data Cloud Objects](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_concepts_data_cloud_objects.htm)** Data Cloud objects are high-scale objects that are used to store large amounts of data over time. # Salesforce Object Behavior Learn how objects are related and how to choose the right Salesforce object for your data and transactions. Objects are categorized by data flow, storage, and transaction type, with some requiring specific licenses or managed packages. Prefer listening to reading? Check out our AI-generated podcast on object behavior. Just as you pick different tools from your toolbox for different jobs, pick an object type based on the type of data you have and the kind of transactions you expect. The type of object that you need is determined by the data you want to store in it and how you expect to interact with it. Determine the properties of the data that you want to store: - Structure—hierarchical, tabular, or unstructured - Volume—high-scale or average - Size - maximum size of data to store - Storage—short-term or long-term storage Determine how you want to interact with the data: - Transaction—ACID, OLAP, OLTP - Operation—Create, Read, Update, Delete - Latency—How often you must process or update the data for it to be useful ## Objects by Data Flow Data flows into Salesforce from a variety of data sources. With the addition of Data Cloud, data also flows between objects that contain the same data but are of different types. For example, let's say that the data for an account is entered into a Sales org and then ingested into Data Cloud via the CRM connector. Any object that contains data for your org, including standard, custom, or external objects, can use the CRM connector to ingest data into Data Cloud. Other systems also connect to Data Cloud and store account data or metadata inside Data Cloud in their own schemas as Data Lake Objects (DLOs). The different schemas for objects containing account data are mapped to a single Account data model object (DMO) schema and then harmonized into an Account unified data model object. ![Data Flow for Account Object](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/DataCloudObjects_DataFlow.png) ## Objects by Data Domain CRM objects are stored on every org as long as you have a license for the feature that uses them. These objects include standard objects, custom objects, and entity interfaces. Big Objects are available only via licenses or managed packages and are stored differently, but are accessible to any org. Data Cloud objects are stored in Data Cloud and are packaged in data kits. Additional data can be represented in your org, but stored in third-party systems using custom external objects. You can also store data in systems that participate in our zero copy program and query them like native Data Cloud objects. Data Cloud objects are stored in Data Cloud. External data is stored outside Salesforce. ![Objects organized by where they are stored](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/DataCloudObjects_DataStorage.png) ## Objects by Transaction Type For data stored outside Salesforce, the transaction type can’t be guaranteed. However, the objects are grouped according to how most data of each type is stored and integrated with Salesforce. ACID transactions are supported for standard objects, custom objects, entity interfaces, and custom external objects. OLTP transactions are supported for standard and custom Big Objects. OLAP transactions are supported for Data Cloud objects. ![Objects by transaction type.](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/DataCloudObjects_TransactionType.png) - **[Object Groups](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_concepts_object_groups.htm)** Objects can be grouped in any number of ways. Object groups are based on where data is stored, how it's used, and which licenses are required to access it. - **[Salesforce Object Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_concepts_object_types.htm)** In the Salesforce Platform, an object type used to refer to whether an object was standard or custom. A standard object has a schema determined by Salesforce. A custom object has a schema determined or created by you. However, as the platform has continued to evolve, there are now many more types of objects. - **[Object Cheatsheet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_concepts_object_cheatsheet.htm)** At a glance, see how objects compare to each other. # Salesforce Object Types In the Salesforce Platform, an object type used to refer to whether an object was standard or custom. A standard object has a schema determined by Salesforce. A custom object has a schema determined or created by you. However, as the platform has continued to evolve, there are now many more types of objects. The objects in the table are grouped by how objects are identified and accessed in Salesforce. These include objects that are visible via your org or an API, even if they are used for internal purposes. | Suffix | Object Type | Object Group | | --- | --- | --- | | \_\_b | Big object | High Scale | | \_\_c | Custom object | Common | | \_\_ChangeEvent | [Custom Object Change Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) | Common | | \_\_chn | [PlatformEventChannel](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_platformeventchannel.htm) | Common | | \_\_cio | Calculated insight object | High Scale | | \_\_dg | Data graph | High Scale | | \_\_DataCategorySelection | [Knowledge\_\_DataCategorySelection](https://developer.salesforce.com/docs/atlas.en-us.264.0.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__datacategoryselection.htm) | Common | | \_\_dlm | Data Model Object (DMOs used for queries have this extension) | High Scale | | \_\_dlo | Data Lake Object | High Scale | | \_\_dmo | Data Model Object | High Scale | | \_\_dso | Data source object | High Scale | | \_\_e | Platform event | Common | | \_\_Feed | [Knowledge article feed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_knowledge__feed.htm) or custom object feed | Common | | \_\_hd | Historical data | Common | | \_\_History | [Field History Tracking](https://help.salesforce.com/s/articleView?id=xcloud.tracking_field_history.htm&type=5&language=en_US) for custom objects | Common | | \_hst | A historical field for a custom [report type](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_reporttype.htm?q=__hqr). | Common | | \_\_ka | [Knowledge article](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_Knowledge__ka.htm) | Common | | \_\_kav | [Knowledge article version](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_Knowledge__kav.htm) | Common | | \_\_latitude\_\_s | [Geolocation custom field](https://help.salesforce.com/s/articleView?id=platform.custom_field_geolocate_overview.htm&type=5&language=en_US) with latitude coordinates | Common | | \_\_longitude\_\_s | [Geolocation custom field](https://help.salesforce.com/s/articleView?id=platform.custom_field_geolocate_overview.htm&type=5&language=en_US) with longitude coordinates | Common | | \_\_mdt | Custom metadata type | Common | | \_\_pc | Custom person account field | Common | | \_\_pr | Person account relationship field | Common | | \_\_r | Custom relationship field as used in a SOQL query to traverse the relationship | Common | | \_\_Share | Custom object sharing object | Common | | \_\_Tag | Salesforce tags | Common | | \_\_ViewStat | KnowledgeArticleViewStat | Common | | \_\_VoteStat | KnowledgeArticleVoteStat | Common | | \_\_x | External object | Common | | \_\_xo | Salesforce-to-Salesforce (S2S) spoke/proxy object | Common | | ChangeEvent | [Standard object change event](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) | Common | | Feed | [Standard object feed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) | Common | ## Identifying an Object Type You can identify an object type by its developer API name. The developer API name is a unique identifier with a standard suffix that indicates the type. You can see platform objects in the Object Manager, along with their suffix. Object Manager shows the object type. Many different types of Data Cloud objects share the same suffix. To determine the type of a Data Cloud object, view it in Data Cloud [Data Explorer](https://help.salesforce.com/s/articleView?id=data.c360_a_data_explorer.htm&type=5&language=en_US) and filter by the object type. ## Accessing an Object Access to an object type is determined by the products and features you’re licensed for and relevant user in object permissions. In some cases, you need permissions in multiple clouds to access objects for a feature. For example, you need permission from Data Cloud and your Sales Cloud org to access Data Cloud objects for Data Cloud-powered features in Sales Cloud. The security model for an org is different from the security model of Data Cloud, because objects are stored differently. # Salesforce Objects Release Notes Use the Salesforce Release Notes to learn about the most recent updates and changes to Salesforce Objects. For information on updates to Salesforce Objects with broad availability, see [New and Changed Objects](https://help.salesforce.com/s/articleView?id=release-notes.rn_api_objects.htm&language=en_US) in the Salesforce Release Notes. For changes to objects with limited availability, see the release notes for each product area. Browse all of the most recent [Salesforce Release Notes](https://help.salesforce.com/s/articleView?id=release-notes.salesforce_release_notes.htm&language=en_US). # Salesforce Surveys Object Model Learn about how Salesforce Surveys objects relate to one another in Salesforce. ![This diagram represents the object model for Salesforce Surveys.](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/salesforce-surveys-data-model.png) This diagram represents the object model for Salesforce Surveys. For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/salesforce-surveys.html "HTML (New Window)"). # SalesforceContract Read-only virtual object used in the Your Account App. Represents contract information related to your organization’s Salesforce subscription. ## Supported Calls describeLayout(), describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | AutoRenewCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Determines if contract renews automatically Possible values are: - No - Yes | | BillingAddressCity | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address. Maximum size is 40 characters. | | BillingAddressCountry | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of this contract. Maximum size is 80 characters. | | BillingAddressPostalCode | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of this contract. Maximum size is 20 characters. | | BillingAddressState | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address of this contract. Maximum size is 80 characters. | | BillingAddressStreet | Type string Properties Filter, Group, Nillable, Sort Description Street address for the billing address of this contract. | | BillingCompany | Type string Properties Filter, Group, Nillable, Sort Description Name of the billing company. | | BillingEmail | Type email Properties Filter, Group, Nillable, Sort Description Email address for billing this contract. | | BillingFrequency | Type string Properties Filter, Group, Nillable, Sort Description Define billing periods. | | BillingName | Type string Properties Filter, Group, Nillable, Sort Description Contact name for this contract. | | BillingPhone | Type phone Properties Filter, Group, Nillable, Sort Description Phone number for billing this contract. | | ContractId | Type string Properties Filter, Group, Nillable, Sort Description ID for this contract. | | ContractNumber | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Number of the contract. | | CreditCardExpirationMonth | Type string Properties Filter, Group, Nillable, Sort Description Month the credit card expires. | | CreditCardExpirationYear | Type string Properties Filter, Group, Nillable, Sort Description Year the credit card expires. | | CreditCardNumber | Type string Properties Filter, Group, Nillable, Sort Description 16-digit credit card number. | | CreditCardType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Credit card provider. Possible values are: - AmericanExpress— - JCB - MasterCard - Visa | | EndDate | Type date Properties Filter, Group, Nillable, Sort Description End date of the contract. | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description External reference ID set by Salesforce. | | FirstNameOnCreditCard | Type string Properties Filter, Group, Nillable, Sort Description Cardholder’s first name on the credit card. | | LastNameOnCreditCard | Type string Properties Filter, Group, Nillable, Sort Description Cardholder’s last name on the credit card. | | PaymentTerm | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Payment terms definition. Possible values are: - Net0—Due upon receipt - Net10—DD-Germany: Net 10 - Net30— - Net30EOM—JP-Net 30 EOM - Net45— - Net60— - Net60EOM—JP-Net 60 EOM | | PaymentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Payment type definition. Possible values are: - Check - CreditCard— - DirectDebit— - WireTransfer— | | SalesforceContractStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the contract Possible values are: - Activated - Draft - Expired - Terminated - inApproval— | | ShippingAddressCity | Type string Properties Filter, Group, Nillable, Sort Description Details of the shipping address. City maximum size is 40 characters. | | ShippingAddressCountry | Type string Properties Filter, Group, Nillable, Sort Description Details of the shipping address. Country maximum size is 80 characters. | | ShippingAddressPostalCode | Type string Properties Filter, Group, Nillable, Sort Description Details of the shipping address. Postal code maximum size is 20 characters. | | ShippingAddressState | Type string Properties Filter, Group, Nillable, Sort Description Details of the shipping address. State maximum size is 80 characters. | | ShippingAddressStreet | Type string Properties Filter, Group, Nillable, Sort Description The street address of the shipping address. Maximum of 255 characters. | | StartDate | Type date Properties Filter, Group, Nillable, Sort Description Start date of the contract. | | SubscriptionDaysLeft | Type int Properties Filter, Group, Nillable, Sort Description Days remaining for this subscription. | ## Usage Used by Your Account to manage contracts related to your organization’s Salesforce subscription. Read-only. ## 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. [SalesforceInvoice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforceinvoice.htm "Read-only virtual object used in the Your Account App. Represents information about your organization’s invoices with Salesforce.") [SalesforcePayment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcepayment.htm "Read-only virtual object used in the Your Account App. Represents information about payments related to your organization’s Salesforce invoice.") [SalesforceQuote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcequote.htm "Read-only virtual object used in the Your Account App. Represents information about your organization’s quotes with Salesforce.") # SalesforceInvoice Read-only virtual object used in the Your Account App. Represents information about your organization’s invoices with Salesforce. ## Supported Calls describeLayout(), describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | Balance | Type double Properties Filter, Nillable, Sort Description The outstanding balance for this invoice. Equal to the invoice’s total amount with tax, ignoring payments and adjustments. | | DueDate | Type date Properties Filter, Group, Nillable, Sort Description The customer must pay the invoice by the due date. Unpaid invoices past the due date can be sent to collections. | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description External reference ID set by Salesforce. | | InvoiceCurrency | Type string Properties Filter, Group, Nillable, Sort Description Currency associated with this invoice. | | InvoiceDate | Type date Properties Filter, Group, Nillable, Sort Description The date that the invoice was posted. Used with payment terms to determine the invoice’s DueDate. For example, an invoice with an InvoiceDate of April 1 and Net 30 payment terms would have a DueDate of May 1. | | InvoiceNumber | Type string Properties Filter, Group, idLookup, Nillable, Sort Description System-created ID for this invoice. | | SalesforceContractId | Type reference Properties Filter, Group, Nillable, Sort Description Salesforce Contract ID This field is a relationship field. Relationship Name SalesforceContract Relationship Type Lookup Refers To SalesforceContract | | SalesforceInvoiceStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The state of the invoice. Possible values are: - DueSoon— - Paid - PastDue— - Pending | | TotalAmount | Type double Properties Filter, Nillable, Sort Description The sum TotalAmount of the invoice items. | ## Usage Used by Your Account to manage invoices for your organization’s Salesforce contract. Read-only. ## 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. [SalesforceContract](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcecontract.htm "Read-only virtual object used in the Your Account App. Represents contract information related to your organization’s Salesforce subscription.") [SalesforcePayment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcepayment.htm "Read-only virtual object used in the Your Account App. Represents information about payments related to your organization’s Salesforce invoice.") [SalesforceQuote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcequote.htm "Read-only virtual object used in the Your Account App. Represents information about your organization’s quotes with Salesforce.") # SalesforceLoginAsEventLog Salesforce LoginAs Event provides details about the Salesforce User's login into Customer Org as Customer's authorized user. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ActualUserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The actual user's identifier. | | CaseIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The Salesforce case ID. | | IpAddress | Type string Properties Filter, Group, Nillable, Sort Description IP address of the browser. | | OperationType | Type string Properties Filter, Group, Nillable, Sort Description The type of operation. For example, login or logout. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | # SalesforcePayment Read-only virtual object used in the Your Account App. Represents information about payments related to your organization’s Salesforce invoice. ## Supported Calls describeLayout(), describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | AppliedAmount | Type double Properties Nillable, Sort Description Payment amount applied to your Salesforce invoice. | | AppliedDate | Type date Properties Nillable, Sort Description Date the payment is applied to your Salesforce invoice. | | Memo | Type string Properties Nillable, Sort Description Credit memo ID. Credit memos are issued for overpayment, rebates, and so forth. | | PaymentCurrency | Type string Properties Nillable, Sort Description Type of currency used for the payment. | | SalesforcePaymentName | Type string Properties Nillable, Sort Description Payment name. | | SalesforcePaymentType | Type picklist Properties Nillable, Sort Description Payment method. Possible values are: - Boleto - Check - Credit Card - Credit Memo - Direct Debit - Unknown - Wire Transfer | ## Usage Used by Your Account to manage payments for your organization’s Salesforce contract. Read-only. ## 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 SalesforcePayment. [SalesforceContract](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcecontract.htm "Read-only virtual object used in the Your Account App. Represents contract information related to your organization’s Salesforce subscription.") [SalesforceInvoice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforceinvoice.htm "Read-only virtual object used in the Your Account App. Represents information about your organization’s invoices with Salesforce.") [SalesforceQuote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcequote.htm "Read-only virtual object used in the Your Account App. Represents information about your organization’s quotes with Salesforce.") # SalesforceQuote Read-only virtual object used in the Your Account App. Represents information about your organization’s quotes with Salesforce. ## Supported Calls describeLayout(), describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description External reference ID set by Salesforce. | | QuoteNumber | Type string Properties Filter, Group, idLookup, Nillable, Sort Description A system-generated number that identifies the quote. | | SalesforceContractId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the contract that’s associated with the quote. This field is a relationship field. Relationship Name SalesforceContract Relationship Type Lookup Refers To SalesforceContract | | SalesforceQuoteStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the quote. Possible values are: - Complete - Expired - NeedsApproval— - NeedsSignature— - Processing | ## Usage Used by Your Account to manage quotes related to your organization’s Salesforce contract. Read-only. ## 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. [SalesforceContract](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcecontract.htm "Read-only virtual object used in the Your Account App. Represents contract information related to your organization’s Salesforce subscription.") [SalesforceInvoice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforceinvoice.htm "Read-only virtual object used in the Your Account App. Represents information about your organization’s invoices with Salesforce.") [SalesforcePayment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcepayment.htm "Read-only virtual object used in the Your Account App. Represents information about payments related to your organization’s Salesforce invoice.") # SalesMethodologyDef Represents the template of criteria for a sales methodology. This object is available in API version 67.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object turn on the userHasSalesMethodologyEnabled, OrgPreferences, SalesMethodologyPref, and PipelineInspectorUser permissions. To read records, users must have the userHasSalesMethodologyEnabled permission. To create, edit, or delete records, users must have the CustomizeApplication user permission. ## Fields | Field | Details | | --- | --- | | Category | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. Methodology categorization allows each object to add one methodology per record type and category. For example, an Opportunity with the Big Deal record type can have one Sales methodology and another Scorecard methodology. Possible values are: - Sales - Scorecard | | Description | Type string Properties Filter, Nillable, Sort Description Details about the sales methodology and its purpose. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the sales methodology. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can't include spaces - can't end with an underscore - can't contain 2 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. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates if the sales methodology is active (true) or not (false). The default value is false. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The combined language and locale ISO code, which controls the language of the sales methodology. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label for the sales methodology. This display value is the internal label that doesn't get translated. | | ObjectType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description For internal use only. Required. The type of object for which the sales methodology works. Possible values are: - Opportunity - Voice | | StandardPromptTemplate | Type string Properties Filter, Group, Nillable, Sort Description The standard prompt that can generate the criteria for the sales methodology when Agentforce is enabled. | # SalesMethodologyDefItem Represents the individual criteria for each stage of a sales methodology. This object is available in API version 67.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To access this object turn on the userHasSalesMethodologyEnabled, OrgPreferences, SalesMethodologyPref, and PipelineInspectorUser permissions. To read records, users must have the userHasSalesMethodologyEnabled permission. To create, edit, or delete records, users must have the CustomizeApplication user permission. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Filter, Nillable, Sort Description Details about a specific stage or criteria of a sales methodology and its purpose. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name for the sales methodology stage or criteria. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can't include spaces - can't end with an underscore - can't contain 2 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. | | InputType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. Indicates the input type of the sales methodology criteria. Possible values are: - Boolean - Number - Picklist | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates if the sales methodology criteria is active (true) or not (false). The default value is false. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The combined language and locale ISO code, which controls the language of the sales methodology item. | | MasterLabel | Type string Properties Filter, Group, Sort Description Required. The label for the sales methodology stage or criteria. This display value is the internal label that doesn't get translated. | | MaxValue | Type int Properties Filter, Group, Nillable, Sort Description Defines the upper bound for numeric input items. It applies when InputType is a numeric type (e.g., a slider or score field). When InputType is not numeric (e.g., picklist, boolean, text), MaxValue is not used. . | | SalesMethodologyDefId | Type reference Properties Filter, Group, Sort Description Required. The ID of the parent sales methodology definition. This field is a relationship field. Relationship Name SalesMethodologyDef Refers To SalesMethodologyDef | | ShortHand | Type string Properties Filter, Group, Sort Description Required. The initial that represents the methodology stage or criteria. | | SortOrder | Type int Properties Filter, Group, Sort Description Required. The display order number of the sales methodology stage or criteria. | # SalesStoreCatalog Represents the catalog associated with a store. This object is available in API version 49.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access a store. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The default value is USD. Possible values are: - USD—U.S. Dollar | | ImplementorType | Type string Properties Filter, Group, Nillable, Sort Description The type of implementor. WebStoreCatalog is the only available implementor type for SalesStoreCatalog. | | ProductCatalogId | Type reference Properties Filter, Group, Sort Description The ID that references the product catalog. | | SalesStoreId | Type reference Properties Filter, Group, Sort Description The ID that references the store. | # SalesTransaction Defines the business logic for a sales transaction, for example, an order or a cart. This object interface is available in API version 55.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules This object interface is available with Subscription Management and B2B Commerce. ## Fields ### ImplementorType - **Type**: string - **Properties**: Default on create, Filter, Group, Restricted picklist, Sort - **Description**: The object that is implementing this object interface, for example, an Order object. ### TotalAdjustmentAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of all adjustments applied to the sales transaction, inclusive of quantity, prorated for the duration of the subscription. Includes distributed price adjustment items and price adjustment items applied directly. This is a calculated field equal to the sum of TotalAdjustmentAmount on the related sales transaction items. ### TotalAdjustmentDistAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the distributed price adjustment items applied to the related sales transaction items, inclusive of quantity, prorated for the duration of the subscription. Does not include price adjustment items that are applied directly. This is a calculated field equal to the sum of TotalAdjustmentDistAmount on the related sales transaction items. ### TotalAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The final price of the sales transaction, after all adjustments, inclusive of quantity, prorated for the duration of the subscription. This is a calculated field equal to the sum of TotalPrice on the related sales transaction items. ### TotalListAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the list price of the related sales transaction items, inclusive of quantity, prorated for the duration of the subscription. This is a calculated field equal to the sum of ListPriceTotal on the related sales transaction items. ### TotalProductAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The total price of all related sales transaction items of type Product, before price adjustments, inclusive of quantity, prorated for the duration of the subscription. This is a calculated field equal to the sum of TotalLineAmount on the related sales transaction items of type Product. # SalesTransactionItemShape Defines the business logic for a sales transaction shape item, for example, an item in an order. This object is available in API version 57.0 and later. This object is visible in Object Manager for customization; for example, you can create custom fields for this object. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), query(), retrieve() ## Special Access Rules This object is available with Subscription Management, B2B Commerce, or B2C Commerce. ## Fields | Field | Details | | --- | --- | | BasisTransactionItemShapeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the sales transaction shape item to use as a reference when pricing this transaction. For example, when pricing an order, this field refers to the order being canceled. This field is available if Subscription Management is enabled. This field is a relationship field. Relationship Name BasisTransactionItemShape Relationship Type Lookup Refers To SalesTransactionItemShape | | BillingFrequency | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The time period that indicates how often the sales transaction shape item is billed. This field is available if Subscription Management is enabled. Possible values are: - Annual - Monthly - Quarterly - Semi-Annual | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort Description The last day the sales transaction shape item is available. For example, the last day of the subscription. This field is available if Subscription Management is enabled. | | ListPrice | Type currency Properties Create, Filter, Nillable, Sort Description The list price for the sales transaction shape item. This value is inherited from the related price book entry. | | ListPriceTotal | Type currency Properties Create, Filter, Nillable, Sort Description The list price, inclusive of quantity. This calculated field is equal to ListPrice times Quantity. | | NetUnitPrice | Type currency Properties Create, Filter, Nillable, Sort Description The final unit price of the product, after all adjustments are applied. | | ObligatedAmount | Type currency Properties Create, Filter, Nillable, Sort Description Description In a subscription, the amount a subscriber is billed for products used during the subscription period that the subscriber returns before the subscription end date. This field's value is the price for use of the product. This field is available in version 57.0 and later. This field is available when Subscription Management is enabled. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - A subscriber must submit a quantity amendment in order to change the subscription's product quantity. A quantity amendment request is only valid until the subscription end date. - A subscriber is eligible for a refund only for the periods when the products weren’t used. - The subscription's proration policy indicates whether the obligated amount and the refund are prorated for partial periods. | | ParentTransactionItemShapeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the parent TransactionItemShape. This field is a relationship field. Relationship Name ParentTransactionItemShape Refers To SalesTransactionItemShape | | PeriodBoundary | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The period boundary helps determine the start and end date of the billing periods. This field is available if Subscription Management is enabled. Possible values are: - AlignToCalendar—The period starts on the first day of the term unit, for example, the first day of the month. - Anniversary— The start date determines the boundary. For example, if a monthly subscription starts on September 13, the subscription starts on the 13th day of each month. - DayOfPeriod— The period starts on the day indicated by PeriodBoundaryDay. - LastDayOfPeriod— The period starts on the last day of the pricing term unit; for example, the last day of the month. | | PeriodBoundaryDay | Type int Properties Create, Filter, Group, Nillable, Sort Description Required when PeriodBoundary is DayOfPeriod. Indicates day of the week or month that marks the period boundary. Must be an integer from 1 through 31. This field is available if Subscription Management is enabled. | | PeriodBoundaryStartMonth | Type picklist Properties Create, Filter, Group, Restricted picklist, Nillable, Sort, Update Description Field is populated based on input in the StartDate, PeriodBoundary, and PeriodBoundaryDay when BillingFrequency is Annual or by manual user entry. Possible values are: - 1-January - 2-February - 3-March - 4-April - 5-May - 6-June - 7-July - 8-August - 9-September - 10-October - 11-November - 12-December | | PricebookEntryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related price book entry. The related price book entry contains all the pricing information about the product being sold. This field is a polymorphic relationship field. Relationship Name PricebookEntry Relationship Type Lookup Refers To PricebookEntryInterface | | PricingTermCount | Type double Properties Create, Filter, Nillable, Sort Description A calculated field indicating the number of pricing terms in the subscription. This field is available if Subscription Management is enabled. | | PricingTransactionType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the type of pricing transaction, for example, a new sale, an amendment, or a renewal. This field is available if Subscription Management is enabled. Possible values are: - AmendmentAtLastNegotiatedPrice— Calculate the price of the amended sales transaction shape item using the same price book and price adjustments as the new sale item. For example, an order item that is amended using a pricing transaction type of AmendmentAtLastNegotiatedPrice is priced using the same price book information and price adjustments as the new sale item. The amended order item has the same price as the new sale order item. - AmendmentStartingFromListPrice— Calculate the price of the amended sales transaction shape item using current price book information, disregarding any pricing information or adjustments that were applied to the new sale item. Typically, an amended transaction item has a different price than the new sale transaction item. - Cancellation— Calculate the price of the canceled transaction. For example, let’s say that a 1-year subscription was purchased on January 1, then canceled on July 31. The price of the canceled products and services from August 1 through Dec 31 is calculated. - NewSale— The price of a new transaction is calculated. - RenewalAtLastNegotiatedPrice— Calculate the price of the renewal sales transaction shape item using the same price book and price adjustments as the new sale item. For example, an order item that is renewed using a pricing transaction type ofRenewalAtLastNegotiatedPrice is priced using the same price book information and price adjustments as the new sale item. The renewal order item has the same price as the new sale order item. - RenewalAtListPrice— Calculate the price of the renewal sales transaction shape item using current price book information, disregarding any pricing information or adjustments that were applied to the new sale item. Typically, a renewal transaction item has a different price than the new sale transaction item. | | ProductId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related product. This field is a relationship field. Relationship Name Product Relationship Type Lookup Refers To Product2 | | ProductSellingModelId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related product selling model. The product selling model defines one method by which a product can be sold; for example, as a one-time sale, an evergreen subscription, or a termed subscription. This field is available if Subscription Management is enabled. This field is a relationship field. Relationship Name ProductSellingModel Relationship Type Lookup Refers To ProductSellingModel | | ProrationPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related proration policy. The proration policy defines how the price is calculated for each subscription period; for example, whether partial periods are allowed, and how remainder amounts are handled. This field is available if Subscription Management is enabled. This field is a relationship field. Relationship Name ProrationPolicy Relationship Type Lookup Refers To ProrationPolicy | | Quantity | Type double Properties Create, Filter, Nillable, Sort Description Number of units in the sales transaction shape item. | | SalesItemType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of sale. Possible values are: - Charge— An item that acts as a fee and can’t be fulfilled. For example, a delivery charge, a shipping fee, or a membership fee. - Product— An item that is a good or service that can be fulfilled. For example, a widget or a widget warranty. | | SalesTransactionItemShapeName | Type string Properties Create, Filter, Group, idLookup, Sort Description Required. The name of the sales transaction shape item. | | SalesTransactionShapeId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the sales transaction shape. A sales transaction shape is the way in which the sales transactions occur. For example, a cart, an order, or a quote. This field is a relationship field. Relationship Name SalesTransactionShape Relationship Type Lookup Refers To SalesTransactionShape | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort Description The start date of the subscription. This field is available if Subscription Management is enabled. | | StartingPriceTotal | Type currency Properties Create, Filter, Nillable, Sort Description The starting unit price, inclusive of quantity, prorated for the duration of the subscription. This field has two ways to obtain its value. The value can be manually entered or automatically calculated. The calculation is equal to StartingUnitPrice times Quantity. | | StartingUnitPrice | Type currency Properties Create, Filter, Nillable, Sort Description The unit price before any adjustments. | | StartingUnitPriceSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the starting unit price was inherited, entered manually, or calculated. Possible values are: - Inherited— The starting unit price is copied from a previous transaction; for example, from the order item being renewed. - Manual— The starting unit price is entered manually, for example, by a sales rep. - System — The starting unit price is calculated using pricing information that was configured by an administrator; for example, a pricing tier. | | StockKeepingUnit | Type string Properties Create, Filter, Group, Nillable, Sort Description The SKU assigned to the related product. | | SubscriptionTerm | Type int Properties Create, Filter, Group, Nillable, Sort Description The number of terms in the subscription. You can indicate a subscription’s length using either the start and end dates, or by using the start date and the subscription term. This field is available if Subscription Management is enabled. | | TotalAdjustmentAmount | Type currency Properties Create, Filter, Nillable, Sort Description The sum of all adjustments applied to the related sales transaction shape items, inclusive of quantity, prorated for the duration of the subscription. Includes distributed price adjustment items and price adjustment items applied directly. This calculated field is equal to the sum of TotalAdjustmentAmount on the related sales transaction shape items. | | TotalAdjustmentDistAmount | Type currency Properties Create, Filter, Nillable, Sort Description The sum of the distributed price adjustment items applied to the sales transaction shape item, prorated for the duration of the subscription. Doesn’t include price adjustment items that are applied directly. A distributed price adjustment is automatically created to apply a transaction-level adjustment to the transaction items. For example, let’s say that you have an order with two order items: one for a file storage service and another for a video streaming service. A 10% volume discount and a 15% manual discount are applied to the entire order. An additional 20% discount is applied to the file storage service. To distribute the order-level discounts, the system creates a 10% price adjustment item and a 15% price adjustment item for each order item. In this example, the file storage service’s sales transaction shape item has the following field values: - TotalAdjustmentAmount — The sum of all item-level adjustments, including the 10% price adjustment item, the 15% price adjustment item, and the 20% price adjustment item. - TotalAdjustmentDistAmount— The sum of the distributed item-level adjustments, including the 10% price adjustment item and the 15% price adjustment item. | | TotalLineAmount | Type currency Properties Create, Filter, Nillable, Sort Description The total price before price adjustments, inclusive of quantity, prorated for the duration of the subscription. This calculated field is equal to StartingPriceTotal times PricingTermCount. | | TotalPrice | Type currency Properties Create, Filter, Nillable, Sort Description The price after all adjustments, inclusive of quantity, prorated for the duration of the subscription. This calculated field is equal to TotalAdjustmentAmount plus StartingPriceTotal. | # SalesTransactionShape Defines the business logic for a sales transaction; for example, an order, a quote, or a cart. This object is available in API version 57.0 and later. This object is visible in Object Manager for customization; for example, you can create custom fields for this object. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Special Access Rules This object is available with Subscription Management, B2B Commerce, or B2C Commerce. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The unique identifier for the account associated with this sales transaction shape. This field is available when OrgPermissions or Platform is enabled. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | SalesTransactionShapeName | Type string Properties Create, Filter, Group, idLookup, Sort Description The name of the sales transaction shape. For example, Quote. | | TotalAdjustmentAmount | Type currency Properties Create, Filter, Nillable, Sort Description The sum of all adjustments applied to the sales transaction shape, inclusive of quantity, prorated for the duration of the subscription. Includes distributed price adjustment items and price adjustment items applied directly. This calculated field is equal to the sum of TotalAdjustmentAmount on the related sales transaction shape items. | | TotalAdjustmentDistAmount | Type currency Properties Create, Filter, Nillable, Sort Description The sum of the distributed price adjustment items applied to the related sales transaction shape items, inclusive of quantity, prorated for the duration of the subscription. Does not include price adjustment items that are applied directly. This calculated field is equal to the sum of TotalAdjustmentDistAmount on the related sales transaction shape items. | | TotalAmount | Type currency Properties Create, Filter, Nillable, Sort Description The final price of the sales transaction shape, after all adjustments, inclusive of quantity, prorated for the duration of the subscription. This calculated field equal to the sum of TotalPrice on the related sales transaction shape items. | | TotalListAmount | Type currency Properties Create, Filter, Nillable, Sort Description The sum of the list price of the related sales transaction shape items, inclusive of quantity, prorated for the duration of the subscription. This calculated field is equal to the sum of ListPriceTotal on the related sales transaction shape items. | | TotalProductAmount | Type currency Properties Create, Filter, Nillable, Sort Description The total price of all related sales transaction shape items of type Product, before price adjustments, inclusive of quantity, prorated for the duration of the subscription. This calculated field is equal to the sum of TotalLineAmount on the related sales transaction shape items of type Product. | # SalesTransactionType Represents the type of sales transaction, such as an initial, renewal, or amendment sale, and its related pricing configuration.. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available when Revenue Cloud is enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the sales transaction type. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the sales transaction type. | | PricingProcedureId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The pricing procedure related to the sales transaction type. This field is a relationship field. Relationship Name PricingProcedure Refers To ExpressionSetDefinition | ## Associated Objects This object has the following associated objects. [SalesTransactionTypeShare](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. # SalesTrxnItemRelationShape Describes the relationship between sales transaction shape items; for example, a bundle or set. This object is available in API version 57.0 and later. ## Supported Calls create() describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available with Subscription Management, B2B Commerce, or B2C Commerce. ## Fields | Field | Details | | --- | --- | | AssocSalesTrxnItemShapeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the associated sales transaction shape item. This field is a relationship field. In a bundle relationship, this sales transaction shape item is the bundle component. Relationship Name AssocSalesTrxnItemShape Relationship Type Lookup Refers To SalesTransactionItemShape | | AssocSalesTrxnItemShapeRole | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Describes the position of the associated sales transaction shape item in the relationship. Possible values are: - BundleComponent—The associated sales transaction shape item is part of a bundle. - SetComponent—The associated sales transaction shape item is part of a set. | | AssociatedItemShapePricing | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Describes how the associated sales transaction shape item is priced, relative to the main sales transaction shape item. Possible values are: - IncludedInBundlePrice— The associated sales transaction shape item’s cost is $0 because it’s included in the bundle’s price. - NotIncludedInBundlePrice— The associated sales transaction shape item has a cost because it’s not included in the bundle’s price. | | MainSalesTrxnItemShapeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the main sales transaction shape item. This field is a relationship field. In a bundle relationship, this sales transaction shape item is the bundle parent. Relationship Name MainSalesTrxnItemShape Relationship Type Lookup Refers To SalesTransactionItemShape | | MainSalesTrxnItemShapeRole | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the position of the main sales transaction shape item in the relationship. Possible values are: - AddOnComponent— The main sales transaction shape item is an add on component. Available in API version 58.0 and later. - Bundle— The main sales transaction shape item is the bundle parent. - Set— The main sales transaction shape item is the set parent. | | ProductRelationshipTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the record that describes the relationship between the main and associated sales transaction shape items. This field is a relationship field. Relationship Name ProductRelationshipType Relationship Type Lookup Refers To ProductRelationshipType | | QuantityScaleMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description How to scale the quantity of the associated sales transaction shape item, relative to the main sales transaction shape item. The value is informative; the system doesn’t check whether the scaled quantities are correct. If this field has a non-null value, you can't edit the associated sales transaction shape item’s quantity. Possible values are: - Constant—The associated sales transaction’s item quantity remains the same in relation to the main sales transaction shape item’s quantity. For example, let’s say that the main sales transaction shape item has a quantity of one and the associated sales transaction shape item has a quantity of one. If you increase the quantity of the main sales transaction shape item to two, the associated sales transaction shape item’s quantity remains at one. - Proportional—The associated sales transaction’s item quantity increases or decreases based on the main sales transaction shape item’s quantity. For example, let’s say that the main sales transaction shape item has a quantity of one and the associated sales transaction shape item has a quantity of two. If you increase the quantity of the main order item to two, the associated order item’s quantity increases to four. The default value is Proportional. | | SalesTransactionShapeId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related sales transaction shape. This field is a relationship field. Relationship Name SalesTransactionShape Relationship Type Lookup Refers To SalesTransactionShape | | SalesTrxnItemRelationShapeName | Type string Properties Create, Filter, Group, idLookup, Sort Description Name of the relationship of the sales transaction shape item. | # SalesWorkQueueSettings Represents settings used to customize work queue options for third-party scoring. Third-party scoring enables custom number fields on person accounts, contacts, and leads. You must be a Sales Engagement customer to update this object. Previously, you could only use the Einstein Intelligence Score for third-party scoring. Available starting in Version 47.0. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object can’t be packaged. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | FeatureName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description A value that represents the name of the work queue settings. To use custom number fields in the work queue, the value must be entered as ThirdPartyScore. | | TargetEntity | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The related record object of the custom number field. Acceptable SObjects include PersonAccount, Contact, and Lead. | | TargetField | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the DeveloperName of the custom number field related to the TargetEntity. Custom fields must have a custom number data type. - To use Einstein Intelligence Score for lead scoring, enter ScoreIntelligence.Score for the DeveloperName. - To remove custom number fields from the work queue, enter None. | # SamlSsoConfig Represents a SAML Single Sign-On configuration.This object is available in API version 32.0 and later. Single sign-on is a process that allows network users to access all authorized network resources without having to log in separately to each resource. Single sign-on allows you to validate usernames and passwords against your corporate user database or other client application rather than having separate user passwords managed by Salesforce. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Summer ’20 and later, only users with the View Setup and Configuration permission or both the Customize Application and Modify All Data permissions can access this object. ## Fields | Field Name | Details | | --- | --- | | AttributeFormat | Type string Properties Filter, Group, Nillable, Sort Description For SAML 2.0 only and when identityLocation is set to Attribute. Possible values include unspecified, emailAddress, or persistent. All legal values can be found in the “Name Identifier Format Identifiers” section of the [Assertions and Protocols SAML 2.0 specification](http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf "Adobe Acrobat PDF (New Window)"). | | AttributeName | Type string Properties Filter, Group, Nillable, Sort Description The name of the identity provider’s application. Get this name value from your identity provider. | | Audience | Type string Properties Filter, Group, Sort Description The Issuer, also called the “Entity ID.” The value is a URL that uniquely identifies the SAML identity provider. | | DeveloperName | Type string Properties Filter, Group, Sort 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | ErrorUrl | Type string Properties Filter, Nillable, Sort Description When there's an error during login, specify the URL of the page where users are directed. It must be publicly accessible, such as a public site Visualforce page. The URL can be absolute or relative. | | ExecutionUserID | Type reference Properties Filter, Group, Nillable, Sort Description The user that runs the Apex handler class. The user must have the “Manage Users” permission. A user is required if you specify a SAML JIT handler class. This is a relationship field. Relationship Name ExecutionUser Relationship Type Lookup Refers To User | | IdentityLocation | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The location in the assertion where a user is identified. Valid values are: - SubjectNameId—The identity is in the statement of the assertion. - Attribute—The identity is specified in an , located in the of the assertion. | | IdentityMapping | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The identifier that the service provider uses for the user during Just-in-Time user provisioning. Valid values are: - Username—The user’s Salesforce username. - FederationId—The federation ID from the user object; the identifier that’s used by the service provider for the user. - UserId—The user ID from the user’s Salesforce organization. | | Issuer | Type string Properties Filter, idLookup, Group, Sort Description Also called the “Entity ID.” The value is a URL that uniquely identifies the SAML identity provider. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language for the organization. | | LoginUrl | Type string Properties Filter, Nillable, Sort Description For SAML 2.0 only: The URL where Salesforce sends a SAML request to start the login sequence. | | LogoutUrl | Type string Properties Filter, Nillable, Sort Description For SAML 2.0 only: The URL to direct users to where they click the Logout link. The default is https://salesforce.com. | | MasterLabel | Type string Properties Filter, Group, Sort Description The text that’s used to identify the Visualforce page in the Setup area of Salesforce. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | OptionsSpInitBinding | Type boolean Properties Filter Description The service provider initiated request binding, either HTTP Redirect (true) or HTTP POST (false). | | OptionsUseConfigRequestMethod | Type boolean Properties Filter Description If true, applies the selected Request Signature Method (RSM) during single logout. If false, the default RSM (RSA-SHA1) is applied. | | OptionsUseSameDigestAlgoForSigning | Type boolean Properties Filter Description If true, uses a SAML digest algorithm based on the selected Request Signature Method (RSM). For example, if the selected RSM is RSA-SHA256, the digest algorithm is set to SHA-256. If false, uses the default digest algorithm (SHA-1), regardless of the selected RSM. This field is available in API version 55.0 and later. You can edit this field only for legacy SAML configurations created before the Spring ’22 release. For configurations created after Spring ’22, this field is true by default. | | OptionsRequireMfaSaml | Type boolean Properties Filter Description Requires multi-factor authentication (MFA) for single sign-on with this SAML configuration based on the MFA status of each user. For this setting to trigger MFA, you must apply MFA directly to users via one of two methods. 1) Assign the user permission Multi-Factor Authentication for User Interface Logins. 2) Enable the org setting Require multi-factor authentication (MFA) for all direct UI logins to your Salesforce org. | | OptionsUserProvisioning | Type boolean Properties Filter Description If true, Just-in-Time user provisioning is enabled, which creates users on the fly the first time that they try to log in. Specify Federation ID for the identityMapping value to use this feature. | | RequestSignatureMethod | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The method that’s used to sign the SAML request. Valid values are: - RSA-SHA1 - RSA-SHA256 | | SamlJitHandlerId | Type reference Properties Filter, Group, Nillable, Sort Description The name of an existing Apex class that implements the Auth.SamlJitHandler interface. This is a relationship field. Relationship Name SamlJitHandler Relationship Type Lookup Refers To ApexClass | | SingleLogoutBinding | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Determines where to put the LogoutRequest or LogoutResponse in the SAML request during single logout (SLO). The value is base64 encoded. Valid values are: - RedirectBinding — Sent in the query string, deflated. - PostBinding — Sent in the POST body, not deflated. | | SingleLogoutUrl | Type string Properties Filter, Group, Nillable, Sort Description The SAML single logout endpoint. This URL is the endpoint where Salesforce sends LogoutRequests (when Salesforce initiates a logout), or LogoutResponses (when the identity provider initiates a logout). | | ValidationCert | Type string Properties Filter, Sort Description The certificate that’s used to validate the request. Get this certificate value from your identity provider. | | Version | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The SAML version. Valid values are: - SAML1\_1 - SAML2\_2 | # Sandbox Event Type Sandbox events contain details about sandbox copies. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CURRENT_SANDBOX_ORG_ID
Type
Id
Description
The 15-character ID of the current sandbox organization.
EVENT_TYPE
Type
String
Description
The type of event. The value is always Sandbox.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
PENDING_SANDBOX_ORG_ID
Type
Id
Description
The 15-character ID of the target sandbox org.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
SANDBOX_ID
Type
Id
Description
The 15-character ID of the sandbox organization.
STATUS
Type
String
Description
The status of the sandbox copy.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # SandboxStatusEventLog SandboxStatusEventLog stores details about Sandbox copies. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | CurrentSandboxOrganizationIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the current sandbox organization. | | PendingSandboxOrganizationIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the target sandbox org. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | SandboxOrganizationIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the target sandbox org. | | Status | Type string Properties Filter, Group, Nillable, Sort Description The status of the sandbox copy. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943YAS . | # SavedPaymentMethod Represents a payment method saved by an authenticated customer. This object is available in API version 58.0 and later ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | AccountHolderEmail | Type string Properties Filter, Group, Nillable, Sort Description Email address of the payment method holder. | | AccountHolderName | Type string Properties Filter, Group, Nillable, Sort Description Full name of the payment method holder. | | AsyncGatewayRefNumber | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort Description The payment transaction ID created by the payment gateway for asynchronous payments. This field is available in API version 66.0 and later. - For Adyen, use the pspReference. - For Stripe, use the fingerprint value. | | BankAccountHolderType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Determines whether the bank account is held by a business or an individual. Possible values are: - Business - Individual | | BankAccountType | Type string Properties Filter, Group, Nillable, Sort Description Characterizes the bank account, such as a checking or savings account. | | BankCode | Type string Properties Filter, Group, Nillable, Sort Description Code that represents the bank who issued the payment method. | | BankName | Type string Properties Filter, Group, Nillable, Sort Description Name of the bank that issued the payment method. | | BillingAddress | Type address Properties Filter, Nillable Description The billing address of the account holder of the payment method. This is the compound form of the billing address. Read-only. For details on compound address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 40 characters. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 80 characters. | | BillingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the billing address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 20 characters. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 80 characters. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. | | ExpiryMonth | Type int Properties Filter, Group, Nillable, Sort Description Month the payment method expires. | | ExpiryYear | Type int Properties Filter, Group, Nillable, Sort Description Year the payment method expires. | | ExtendedPaymentMethodType | Type string Properties Create, Filter, Group, Nillable, Sort Description Other saved payment methods used for the transaction. This field is required when the value of the Type field is extd\_altrn\_payment\_method\_type or extd\_wallet. This field is available in API version 66.0 and later. | | GatewayReference | Type string Properties Filter, Group, idLookup, Nillable, Sort Description A reference to the saved payment owner at the payment gateway. For example, a Stripe customer ID. | | GatewayToken | Type encryptedstring Properties Nillable Description Unencrypted unique token ID generated by the payment gateway to represent the card payment method during transactions. GatewayToken is for use with APIs earlier than version 52.0. For version 53.0 and latter, use the GatewayTokenEncrypted field. To secure the token, use the GatewayTokenEncrypted field. An error message appears if you try to record a GatewayToken for a card payment method that already has a GatewayToken or GatewayTokenEncrypted value. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Customer’s default payment method. The default value is false. | | IsMerchantCreated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the merchant saved the payment method on behalf of the payer. The Payer must provide consent to the merchant to save this information. The default value is false. | | IsSharedWithinSameAccount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the saved payment method is visible to all contacts in an account (true) or only to the contact who created it (false). The default value is false. This field is available in API version 64.0 and later. | | Issuer | Type string Properties Filter, Group, Nillable, Sort Description Financial institution issuing the payment method. | | Last4 | Type string Properties Filter, Group, Nillable, Sort Description Last four digits of the payment method account number. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record or list view related to this record, but didn’t access it directly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it's possible the user referenced this record but didn’t view it directly. | | MerchantAccountId | Type reference Properties Filter, Group, Sort Description Identifies the Salesforce Payments Merchant Account. This field is a relationship field. Relationship Name MerchantAccount Relationship Type Lookup Refers To MerchantAccount | | Name | Type string Properties Filter, Group, idLookup, Sort Description Name of the saved payment method. | | Network | Type string Properties Filter, Group, Nillable, Sort Description Saved payment method card network, for example Visa or Union Pay. | | Nickname | Type string Properties Filter, Group, Nillable, Sort Description Additional name or label to easily identify the payment method. | | PaymentGatewayId | Type reference Properties Filter, Group, Sort Description The payment gateway that is used to create a gateway token. For transactions with a saved payment method in Salesforce, this field stores the payment gateway ID used in the transaction. This field is a relationship field. This field is a relationship field. Relationship Name PaymentGateway Relationship Type Lookup Refers To PaymentGateway | | PaymentMethodSubType | Type string Properties Create, Filter, Group, Nillable, Sort Description A payment method that exists as a subtype of a payment method type. For example, Visa, Mastercard, and American Express exist as subtypes of the Card payment method. This field is available in API version 66.0 and later. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the payment was made outside of the Salesforce platform. This field is available in API version 66.0 and later. Possible values are: - External - Salesforce | | ReferenceOwnerId | Type reference Properties Filter, Group, Sort Description ID of the Account or Contact record that owns the payment method. This field is a polymorphic relationship field. Relationship Name ReferenceOwner Relationship Type Lookup Refers To Account or Contact | | StandardEntryClassCode | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A three-letter code that indicates how a customer or a business initiated and authorized an ACH payment. Possible values are: - CCD—Corporate credit or debit entry - PPD—Prearranged payment or deposit entry - TEL—Telephone-initiated entry - WEB—Internet or mobile-initiated entry | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Status of the saved payment method. Possible values are: - Active - AwaitingPayment - Errored—Failed - Expired | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of saved payment method. Possible values are: - au\_becs\_debit - bacs\_debit - bancontact - card - extd\_apm\_type - extd\_wallet - ideal - sepa\_debit - us\_bank\_account – ACH Direct Debit | | UsageType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates if the payment method is used on or off session. Possible values are: - OffSession - OnSession - RestrictedOffSession | ## Associated Objects This object has these 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. [SavedPaymentMethodChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [SavedPaymentMethodFeed](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. [SavedPaymentMethodHistory](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. [SavedPaymentMethodOwnerSharingRule](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. [SavedPaymentMethodShare](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. # SavedPaymentMethodEvent Represents a saved payment method platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later. For more information about platform events, see the [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_intro.htm "HTML (New Window)"). ## Supported Calls describeSObjects() ## Special Access Rules To access Salesforce Payments objects, you must have a Salesforce Payments license and Payments must be enabled for your org. Salesforce Payments objects are available only in Lightning Experience. ## Fields | Field | Details | | --- | --- | | ChangeType | Type picklist Properties Restricted picklist Description Type of saved payment method event, which triggers an event notification. You can write code to operate conditionally on the value of this field. For example, you can ignore a create change but get notified of updates. Possible values are: - Create–Saved payment method created. - Delete–Saved payment method deleted. - Update–Saved payment method property changed. | | SavedPaymentMethodId | Type reference Properties Nillable Description Identifies the SavedPaymentMethod record for which the event occurs. This field is a relationship field. Relationship Name SavedPaymentMethod Relationship Type Lookup Refers To SavedPaymentMethod | # SchedulingAdherenceDetail Represents the breakdown of daily shift adherence data by agent status. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org requires a Workforce Engagement license, and both Workforce Engagement and Omni-Channel must be enabled. The user requires the Workforce Engagement Planner or Workforce Engagement Admin permission set. ## Fields | Field | Details | | --- | --- | | IsShrinkage | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the linked status is considered as shrinkage time (true) or not (false). Shrinkage time is time, such as breaks, when an agent doesn’t receive work. The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A number that identifies this detail record. | | SchedulingAdherenceSummaryId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Scheduling Adherence Summary. This is a relationship field. Relationship Name SchedulingAdherenceSummary Relationship Type Lookup Refers To SchedulingAdherenceSummary | | StatusId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the agent status represented by this detail record. This is a relationship field. Relationship Name Status Relationship Type Lookup Refers To ServicePresenceStatus | | StatusName | Type string Properties Filter, Group, Nillable, Sort Description The name of the agent status represented by this detail record. | | TotalStatusMinutes | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Total minutes that the agent was present with this status. | # SchedulingAdherenceSummary Represents daily shift adherence data for a service resource in a service territory and job profile on a specific date. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org requires a Workforce Engagement license, and both Workforce Engagement and Omni-Channel must be enabled. The user requires the Workforce Engagement Planner or Workforce Engagement Admin permission set. ## Fields | Field | Details | | --- | --- | | AdherencePercentage | Type double Properties Filter, Sort Description Percentage of time that the agent was present during the scheduled shift time. This is a calculated field. Formula AdherencePercentage = TotalAdherenceMinutes / TotalScheduledMinutes | | ConformancePercentage | Type double Properties Filter, Sort Description Percentage of time when the agent was present versus the duration of scheduled shifts. The time that the agent is present can extend beyond the scheduled shift. This is a calculated field. Formula ConformancePercentage = TotalPresenceMinutes / TotalScheduledMinutes | | Date | Type date Properties Create, Filter, Group, Sort, Update Description Date for which the adherence data is calculated. | | JobProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the job profile. This is a relationship field. Relationship Name JobProfile Relationship Type Lookup Refers To JobProfile | | JobProfileName | Type string Properties Filter, Group, Nillable, Sort Description The name of the job profile. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A number that identifies this summary record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who owns the schedule adherence summary. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ServiceResourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service resource. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | | ServiceResourceName | Type string Properties Filter, Group, Nillable, Sort Description The name of the service resource. | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service territory. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | ServiceTerritoryName | Type string Properties Filter, Group, Nillable, Sort Description The name of the service territory. | | TotalAdherenceMinutes | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Total minutes that the agent was present during a shift. | | TotalInteractionMinutes | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Total minutes that the agent was actively receiving work. | | TotalPresenceMinutes | Type int Properties Filter, Group, Nillable, Sort Description Total minutes of agent presence time. This is a calculated field. Formula TotalPresenceMinutes = TotalInteractionMinutes + TotalShrinkageMinutes | | TotalScheduledMinutes | Type int Properties Create, Filter, Group, Sort, Update Description Total minutes of scheduled shift time for the agent. | | TotalShrinkageMinutes | Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Total minutes that the agent was present but not receiving work, such as break times. | ## 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. [SchedulingAdherenceSummaryOwnerSharingRule](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. [SchedulingAdherenceSummaryShare](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. # SchedulingConstraint Represents scheduling constraints on each service resource. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules The org requires the Workforce Engagement license. To view records, the user requires the Workforce Engagement Agent permission set. To create, edit, or delete records, the user requires the Workforce Engagement Planner permission set. ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the scheduling constraint was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the scheduling constraint was last viewed. | | MaxNonstandardShiftsPerMonth | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of non-standard shifts assigned to an agent in a month. This field is available in API version 54.0 and later. | | MaxShiftsPerDay | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of shifts an agent can have in a day. | | MaxShiftsPerMonth | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of shifts an agent can have in a month. | | MaxShiftsPerWeek | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of shifts an agent can have in a week. | | MaxWorkingHoursPerDay | Type double Properties Create, Filter, Nillable, Sort, Update Description The maximum number of hours an agent can have in a day. | | MaxWorkingHoursPerMonth | Type double Properties Create, Filter, Nillable, Sort, Update Description The maximum number of hours an agent can have in a month. | | MaxWorkingHoursPerWeek | Type double Properties Create, Filter, Nillable, Sort, Update Description The maximum number of hours an agent can have in a week. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The scheduling constraint record name. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the scheduling constraint. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RestTimeMinutes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The minimum rest time, in minutes, between an agent’s consecutive shifts. This field is available in API versions 56.0 and later. | ## 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. [SchedulingConstraintOwnerSharingRule](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. [SchedulingConstraintShare](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. # SchedulingObjective Represents business goals that the scheduling tools consider. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license. To view, create, edit, and delete records, the user needs to have the Workforce Engagement Planner permission set. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The scheduling objective description. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer name of the record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are the supported languages for Workforce Engagement. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The scheduling objective name. | | SchedulingCategory | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The record that the scheduling objective applies to. Possible values are: - A—Appointment - B—Shift | | SchedulingObjectiveType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of scheduling objective. Possible values are: - AgentPreference—Scheduling tools consider agents’ service resource preferences. In the UI, this value appears as Maximized Preferences. - BalanceNonStandardShifts—Scheduling tools balance the number of shifts across available agents within a time period. - BalanceShifts—Scheduling tools balance the number of non-standard shifts across available agents within a time period. | # SchedulingRule Represents scheduling rules that are hard constraints in the scheduling logic engine. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license. To view, create, edit, and delete records, the user needs to have the Workforce Engagement Planner permission set. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The scheduling rule description. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The developer name value of the record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the scheduling rule. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The scheduling rule name. | | SchedulingCategory | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Shifts. Possible values are: - A—Appointment - B—Shift | | SchedulingRuleType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The scheduling rule type. Possible values are: - A—Active Resources - B—Match Skills - C—Availability - LimitNonstandardShifts—Specifies a rule type that limits how many non-standard shifts can be assigned to each agent. This type is available in API version 54.0 and later. - M—Match Territory - Q—Match Queues - RestTimeMinutes—Specifies a rule type that requires the agent to have a minimum rest time between consecutive shifts. This type is available in API version 56.0 and later. - W—Work Limit | # SchedulingRuleParameter Represents scheduling rule parameters associated with a scheduling rule. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license. To view, create, edit, or delete records, the user needs to have the Workforce Engagement Planner permission set. ## Fields | Field | Details | | --- | --- | | SchedulingParameterKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The scheduling rule parameter name. Possible values are: - ConsiderAbsence—Consider absences when determining a service resource’s availability. This type is available in API version 56.0 and later. - ConsiderSTM—Consider service territory membership when determining a service resource’s availability. Service territory membership defines the resource’s working hours in a location. This type is available in API version 56.0 and later. - C—Constraint Field Name - L—Limit Type - R—Resolution - T—Time Resolution - W—Work Unit | | SchedulingRuleId | Type reference Properties Create, Filter, Group, Sort Description The scheduling rule ID. This is a relationship field. Relationship Name SchedulingRule Relationship Type Lookup Refers To SchedulingRule | | Value | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The scheduling rule parameter value. | # Scontrol A custom s-control, which is custom content that is hosted by the system but executed by the client application. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them. Existing s-controls are unaffected, and can still be edited. We recommend that you move your s-controls to Visualforce. We continue to support the Scontrol object. Represents a custom s-control, which is custom content that the system hosts, but client applications execute. An s-control can contain any type of content that you can display or run in a Web browser. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - Your organization must be using Enterprise, Developer, or Unlimited Edition and be enabled for custom s-controls. - Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | Binary | Type base64 Properties Create, Nillable, Update Description Binary content of this custom s-control, such as an ActiveX control or a Java archive. Can be specified when created, but not when updated. Limit: 5 MB. | | BodyLength | Type int Properties Filter, Group, Sort Description The length of the custom s-control. Label is **Binary Length**. | | ContentSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the source of the s-control content, either custom HTML, a snippet (s-controls that are included in other s-controls), or a URL. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the custom s-control. | | DeveloperName | Type string Properties 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 org. 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 **S-Control Name**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | EncodingKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Picklist of character set encodings, including ISO-08859-1, UTF-8, EUC, JIS, Shift-JIS, Korean (ks\_c\_5601-1987), Simplified Chinese (GB2312), and Traditional Chinese (Big5). | | Filename | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An uploaded object to display when the custom s-control is added to a custom link. Can be a Java applet, an ActiveX control, or any other type of desired content. | | HtmlWrapper | Type textarea Properties Create, Update Description Required. HTML page that will be delivered when the user views this custom s-control. This HTML page can be the entire content of the custom s-control, or it can reference the binary. Limit: 1,048,576 characters. Label is **HTML Body**. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Required. Name of this custom s-control. Label is **Label**. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | SupportsCaching | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the s-control supports caching (true) or not (false). | ## Usage Use custom s-controls to manage custom content that extends application functionality. All users can view custom s-controls, but the “Customize Application” permission is required to create or update custom s-controls. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # ScontrolLocalization The translated value of the field label for an s-control. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them. Existing s-controls are unaffected, and can still be edited. When the Translation Workbench is enabled for your organization, provides the translation of the field label of an s-control. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - Your organization must be using Professional, Enterprise, Developer, or Unlimited Edition and be enabled for the Translation Workbench. - To view this object, you must have the “View Setup and Configuration” permission. ## Fields | Field | Details | | --- | --- | | LanguageLocaleKey | Type picklist Properties Create, Filter, Nillable, Restricted picklist Description This field is available in API version 16.0 and earlier. It is the same as the Language field. | | Language | Type picklist Properties Create, Filter, Nillable, Restricted picklist Description This field is available in API version 17.0 and later. The combined language and locale ISO code, which controls the language for labels displayed in an application. This picklist contains the following fully-supported languages: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. The following end-user only languages are available. - Arabic: ar - Bulgarian: bg - Croatian: hr - Czech: cs - English (UK): en\_GB - Greek: el - Hebrew: iw - Hungarian: hu - Indonesian: in - Polish: pl - Portuguese (European): pt\_PT - Romanian: ro - Slovak: sk - Slovenian: sl - Turkish: tr - Ukrainian: uk - Vietnamese: vi The following platform languages are available for organizations that use Salesforce exclusively as a platform. - Albanian: sq - Afrikaans: af - Amharic: am - Arabic (Algeria): ar\_DZ - Arabic (Bahrain): ar\_BH - Arabic (Egypt): ar\_EG - Arabic (Iraq): ar\_IQ - Arabic (Jordan): ar\_JO - Arabic (Kuwait): ar\_KW - Arabic (Lebanon): ar\_LB - Arabic (Libya): ar\_LY - Arabic (Morocco): ar\_MA - Arabic (Oman): ar\_OM - Arabic (Qatar): ar\_QA - Arabic (Saudi Arabia): ar\_SA - Arabic (Sudan): ar\_SD - Arabic (Syria): ar\_SY - Arabic (Tunisia): ar\_TN - Arabic (United Arab Emirates): ar\_AE - Arabic (Yemen): ar\_YE - Armenian: hy - Basque: eu - Bosnian: bs - Bengali: bn - Burmese: my - Catalan: ca - Chinese (Hong Kong): zh\_HK - Chinese (Singapore): zh\_SG - Chinese (Malaysia): zh\_MY - Dutch (Belgium): nl\_BE - English (Australia): en\_AU - English (Belgium): en\_BE - English (Canada): en\_CA - English (Cyprus): en\_CY - English (Germany): en\_DE - English (Hong Kong): en\_HK - English (India): en\_IN - English (Ireland): en\_IE - English (Israel): en\_IL - English (Malaysia): en\_MY - English (Malta): en\_MT - English (Netherlands): en\_NL - English (New Zealand): en\_NZ - English (Philippines): en\_PH - English (Singapore): en\_SG - English (South Africa): en\_ZA - English (United Arab Emirates): en\_AE - Estonian: et - Farsi: fa - French (Belgium): fr\_BE - French (Canada): fr\_CA - French (Luxembourg): fr\_LU - French (Morocco): fr\_MA - French (Switzerland): fr\_CH - Georgian: ka - German (Austria): de\_AT - German (Belgium): de\_BE - German (Luxembourg): de\_LU - German (Switzerland): de\_CH - Greek (Cyprus): el\_CY - Greenlandic: kl - Gujarati: gu - Hawaiian: haw - Haitian Creole: ht - Hindi: hi - Icelandic: is - Irish: ga - Italian (Switzerland): it\_CH - Kannada: kn - Kazakh: kk - Khmer: km - Latvian: lv - Lithuanian: lt - Luxembourgish: lb - Macedonian: mk - Malay: ms - Malayalam: ml - Maltese: mt - Marathi: mr - Montenegrin: sh\_ME - Romanian (Moldova): ro\_MD - Romansh: rm - Russian (Armenia): ru\_AM - Russian (Belarus): ru\_BY - Russian (Kazakhstan): ru\_KZ - Russian (Kyrgyzstan): ru\_KG - Russian (Lithuania): ru\_LT - Russian (Moldova): ru\_MD - Russian (Poland): ru\_PL - Russian (Ukraine): ru\_UA - Samoan: sm - Serbian (Cyrillic): sr - Serbian (Latin): sh - Spanish (Argentina): es\_AR - Spanish (Bolivia): es\_BO - Spanish (Chile): es\_CL - Spanish (Colombia): es\_CO - Spanish (Costa Rica): es\_CR - Spanish (Dominican Republic): es\_DO - Spanish (Ecuador): es\_EC - Spanish (El Salvador): es\_SV - Spanish (Guatemala): es\_GT - Spanish (Honduras): es\_HN - Spanish (Nicaragua): es\_NI - Spanish (Panama): es\_PA - Spanish (Paraguay): es\_PY - Spanish (Peru): es\_PE - Spanish (Puerto Rico): es\_PR - Spanish (United States): es\_US - Spanish (Uruguay): es\_UY - Spanish (Venezuela): es\_VE - Swahili: sw - Tagalog: tl - Tamil: ta - Te reo: mi - Telugu: te - Urdu: ur - Welsh: cy - Xhosa: xh - Zulu: zu The values in this field are not related to the default locale selection. | | NamespacePrefix | Type string Properties Filter, Nillable Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ScontrolId | Type reference Properties Create, Filter, Nillable Description The ID of the Scontrol that is being translated. | | Value | Type string Properties Create, Filter, Nillable, Update Description The actual translated field label of the s-control. Label is **Translation**. | ## Usage Use this object to translate your s-controls into a supported language. Users with the Translation Workbench enabled can view s-control translations, but either the “Customize Application” or “Manage Translation” permission is required to create or update s-control translations. #### See Also - [CategoryNodeLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_categorynodelocalization.htm "When the Translation Workbench is enabled for your organization, the CategoryNodeLocalization object provides the translation of the label of a solution category.") - [WebLinkLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_weblinklocalization.htm "Represents the translated value of the field label for a custom link to a URL or s-control when the Translation Workbench is enabled for your organization.") # Scorecard Use scorecards to measure partner performance and establish benchmarks for channel programs within Experience Cloud. Display any report summary results that your channel account manager or executive team wants to see. This object is available in API version 40.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the scorecard. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the scorecard visible to end users. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the scorecard. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Usage The Scorecard object is used in tandem with the ScorecardMetric and ScorecardAssociation objects. ## 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. [ScorecardOwnerSharingRule](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. [ScorecardShare](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. # ScorecardAssociation Represents a connection between a specific scorecard and the associated account, channel program, or channel program level. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the Scorecard Association. | | ScorecardId | Type reference Properties Create, Filter, Group, Sort Description The ID of the scorecard that the association is related to. Several metrics can be tied to a single scorecard. This is a relationship field. Relationship Name Scorecard Relationship Type Lookup Refers To Scorecard | | TargetEntityId | Type reference Properties Create, Filter, Group, Sort, Update Description The associated object that a specific scorecard is associated with. This is a polymorphic relationship field. Relationship Name TargetEntity Relationship Type Lookup Refers To Account, ChannelProgram, ChannelProgramLevel | # ScorecardMetric Stores information about a Salesforce report that is run and summarized to get a single value. The stored value is added as a metric to the related Scorecard object. This object is available in API version 40.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Category | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Groups metrics together. It comes with a predefined set of dropdown list entries and can be extended to address vendor’s needs each category is user-generated and can be localized through translation workbench. Possible values are: - Adoption - Field Enablement - Marketing - Sales - Support The default value is 'Sales'. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the metric that appears on a scorecard. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the metric that appears on a scorecard. | | ReportId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the report that is run and summarized to return a single value. This is a relationship field. Relationship Name Report Relationship Type Lookup Refers To Report | | ScorecardId | Type reference Properties Create, Filter, Group, Sort Description The ID of the scorecard that the metric is related to. Several metrics can be tied to a single scorecard. This is a relationship field. Relationship Name Scorecard Relationship Type Lookup Refers To Scorecard | # ScoreIntelligence For internal use only. # ScratchOrgInfo Represents a scratch org and its audit log. Use this object to create a scratch org and keep a log of its creation and deletion. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AdminEmail | Type email Properties Create, Filter, Group, Nillable, Sort Description The email address of the scratch org’s Administration user. The read only SignupEmail field is populated with this value. If you don't provide a value for AdminEmail, the field is left blank and the SignupEmail is populated with the email address of the org user who is creating this object. | | AuthCode | Type string Properties Filter, Group, Nillable, Sort Description A one-time authorization code that can be exchanged for an OAuth access token and refresh token using standard Salesforce APIs. It’s used with ConnectedAppCallbackUrl and ConnectedAppConsumerKey, when the specified connected app hasn't been configured with an X.509 certificate. This field is read only. | | ConnectedAppCallbackUrl | Type textarea Properties Create Description Required. When used with ConnectedAppConsumerKey, it specifies the callback URL used for OAuth. If using Salesforce CLI, the default is http://localhost:1717/OauthRedirect. | | ConnectedAppConsumerKey | Type string Properties Create, Filter, Group, Sort Description Required. When used with ConnectedAppCallbackUrl, it specifies the connected app that is approved automatically during scratch org creation. If using Salesforce CLI and the default connected app, indicate PlatformCLI. | | Country | Type string Properties Create, Filter, Group, Nillable, Sort Description The two-character, upper-case ISO-3166 country code. You can find a full list of these codes at several sites, such as: [www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html](http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html). The language of the scratch org is auto-determined based on the value of this field. If you don’t specify a value, this field defaults to the Dev Hub’s country code. | | DeletedBy | Type string Properties Filter, Group, Nillable, Sort Description The user who requested that the scratch org be deleted. This field is read only. | | DeletedDate | Type date Properties Filter, Group, Nillable, Sort Description The date when the DeletedBy user requested that the scratch org be deleted. This field is read only. | | Description | Type textarea Properties Create, Nillable, Update Description A free-form text field for you to enter a description of this scratch org. | | DurationDays | Type int Properties Create, Filter, Nillable, Group, Sort Description Number of days after which the scratch org expires. Valid values are 1–30. The default is 7. | | Edition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Required if you don’t provide Snapshot or SourceOrg. The org edition of this scratch org. Valid values are Group, Developer, Enterprise, and Professional. | | ErrorCode | Type string Properties Filter, Group, Nillable, Sort Description The error code if the scratch org creation isn’t successful. This field is read only. | | ExpirationDate | Type date Properties Filter, Group, Nillable, Sort Description Date when the scratch org expires. This field is read only. | | Features | Type textarea Properties Create, Nillable Description A semi-colon delimited list of the features enabled in this scratch org, such as MultiCurrency. See the Salesforce DX Developer Guide for the full list of valid features. | | HasSampleData | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Specifies whether the scratch org contains sample data. If set to true, the sample data is similar to the data in a Salesforce free trial org. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the scratch org being created. Specify the language using a language code listed under "Supported Languages" in Salesforce Help. For example, use zh\_CN for simplified Chinese. The value you select overrides the language set by locale. If you don’t specify a value, the language is based on the Country used during scratch org creation. If you don’t specify a value for Country, the value defaults to the Dev Hub’s country. | | LastLoginDate | Type date Properties Filter, Group, Nillable, Sort Description The date of the last user login to the scratch org. This field is read only. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. This field is read only. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. This field is read only. | | LoginUrl | Type textarea Properties Nillable Description A URL that logs you in to the scratch org. This field is read only. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The auto-generated ID of this scratch org. This field is read only. | | Namespace | Type string Properties Create, Filter, Group, Nillable, Sort Description The namespace you want to associate with this scratch org. The value of this field corresponds to the NamespacePrefix field of the NamespaceRegistry object that describes your namespace. | | OrgName | Type string Properties Create, Filter, Group, Sort Description Required. The name of the scratch org. This name appears as the Organization Name in the Company Information Setup page. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who created this scratch org. | | Release | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The release of the scratch org. During Salesforce's major release transitions, this field allows you to select the Salesforce release version, based on the version of your Dev Hub. This field is available in API version 46.0 and later. Valid values are: - Current - Preview - Previous See [Select the Salesforce Release for a Scratch Org](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_version_selection.htm) for more information. | | ScratchOrg | Type string Properties Filter, Group, Nillable, Sort Description The org ID of the scratch org. This field is read only. | | SignupCountry | Type string Properties Filter, Group, Sort Description The country code of the scratch org. This field is populated with the value of the Country field. If you didn’t provide a value for Country, it’s the country code of the Dev Hub. This field is read only. | | SignupEmail | Type email Properties Filter, Group, Sort Description The email address of the scratch org’s Administration user. This field is populated with the value of the AdminEmail field. If you didn't provide a value for AdminEmail, it's the email address of your user in the Dev Hub. This field is read only. | | SignupInstance | Type string Properties Filter, Group, Nillable, Sort Description The Salesforce instance on which this scratch org resides. This field is read only. | | SignupLanguage | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the scratch org. This field is populated with the value of the Language field. If you didn’t provide a value for Language, it’s the language of the Dev Hub. This field is read only. | | SignupTrialDays | Type int Properties Filter, Group, Nillable, Sort Description The number of days between the scratch org's creation and expiration. This field is read only. | | SignupUsername | Type string Properties Filter, Group, Sort Description The username of the Administration user of this scratch org. This field is populated with the value of the Username field. If you didn’t provide a value for Username, the value of this field is auto-generated. This field is read only. | | Snapshot | Type string Properties Create, Filter, Group, Nillable, Sort Description If this scratch org was created from a scratch org snapshot, then this field contains either the name or ID of the snapshot. Specifically, the name corresponds to the Name field of the snapshot’s record in the OrgSnapshot standard object; the ID corresponds to the record ID. If this scratch org wasn’t created from a snapshot, this field is empty. If you specify Snapshot, you can’t specify Edition or SourceOrg. This field is available in API version 61.0 and later. | | SourceOrg | Type string Properties Create, Filter, Group, Nillable, Sort Description The ID of the org whose shape (features, settings, limits, and licenses) information is used for creating scratch orgs. If you specify SourceOrg, you can’t specify Edition or Snapshot. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The status of the scratch org, such as active, expired, or deleted. This field is read only. | | Username | Type string Properties Create, Filter, Group, Nillable, Sort Description The username of the Administration user of this scratch org. | ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [ScratchOrgInfoFeed](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. [ScratchOrgInfoHistory](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. [ScratchOrgInfoShare](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. #### See Also - [ActiveScratchOrg](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activescratchorg.htm "Represents an active scratch org. This object is available in API version 41.0 and later.") - [NamespaceRegistry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_namespaceregistry.htm "Represents a namespace that you can link to scratch orgs that were created from your org’s Dev Hub. You use the namespace when developing, packaging, and releasing an app. You can’t create this object with the API. Use the Link Namespace action in the Dev Hub graphical interface to insert a NamespaceRegistry record. This object is available in API version 41.0 and later.") - [_Salesforce DX Developer Guide_](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev " Salesforce DX Developer Guide - HTML (New Window)") # Search Click Event Type Search Click events contain details about the user’s interaction with the search results in the search results page. Interactions with search results in the instant result dialog are not recorded by this event. All searches within the app, including Experience Cloud sites, are included. However, unauthenticated users won’t have a unique Salesforce user ID. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CLICKED_RECORD_ID
Type
String
Description
The 15-character ID of the result the user clicked in the search results page.
Example
a07B00000031pRV
EVENT_TYPE
Type
String
Description
The type of event. The value is always SearchClick.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
QUERY_ID
Type
String
Description
Unique ID of the search query.
Example
-2vx8relit08r
RANK
Type
Number
Description
Ranking of the result clicked in the search results page.
Example
2
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
USER_ID
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Search Event Type Search events contain details about the user’s search query. All searches within the app, including Experience Cloud sites, are included. However, unauthenticated users won’t have a unique Salesforce user ID. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
EVENT_TYPE
Type
String
Description
The type of event. The value is always Search.
NUM_RESULTS
Type
Number
Description
Number of results returned by the search query.
Possible Values
  • 0
  • 25
  • 1000
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
PREFIXES_SEARCHED
Type
String
Description
Space-separated list of key prefixes that were searched.
Example
001 006 ka0
QUERY_ID
Type
String
Description
Unique ID of the search query.
Example
-2vx8relit08r
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
SEARCH_QUERY
Type
String
Description
The first 100 characters of the search query.
Example
Salesforce
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
USER_ID
Type
Id
Description
The 15-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # SearchActivity Represents search activity on a Knowledge article. Also known as KnowledgeSearchActivity. This object is available in API version 38.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules The Knowledge Base Search Dashboard permission must be enabled in your org. ## Fields | Field | Details | | --- | --- | | AvgNumResults | Type double Properties Filter, Sort Description The number of search results returned for the search term. If Period is also included, this value is aggregated based on the time period specified. | | ClickRank | Type double Properties Filter, Nillable, Sort Description The order that the article appeared in the search results when the user sorted the results by relevance and clicked it from the list of results. | | ClickedRecordId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the clicked article. This field is a polymorphic relationship field. Relationship Name ClickedRecord Relationship Type Lookup Refers To Knowledge\_\_kav | | ClickedRecordName | Type string Properties Filter, Group, Nillable, Sort Description The title of the clicked article taken when the user sorts the search results by relevance. | | CountQueries | Type int Properties Filter, Group, Sort Description The number of searches for the period (day, month, or year). | | CountUsers | Type int Properties Filter, Group, Sort Description The number of individual users who clicked the article. | | KbChannel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The channel that’s applicable to the article. Possible values are: - AllChannels—All Channels - App—Internal App - Csp—Customer - Pkb—Public Knowledge Base - Prm—Partner | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of search activity. | | Period | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The time period that the search count is applied to. For example, a record where the Count is 70 and the Period is Monthly indicates that 70 searches took place over the past month. Totals are aggregated daily for the current month, monthly from the past full month through the past full year, and yearly beyond that. Activity totals are collected nightly and aren’t in real time. Possible values are: - DAY - MONTH - YEAR | | QueryDate | Type date Properties Filter, Group, Sort Description The date of the search. | | QueryLanguage | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language filter that’s applied to the user’s search. | | SearchTerm | Type string Properties Filter, Group, Sort Description The first 100 characters of the search term that was used to search published articles in the knowledge base. | # SearchClickEventLog Search Click Event Log contains details about the user’s interaction with the search results. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClickedRecordIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the result the user clicked in the search results page. | | QueryIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Unique ID of the search query. | | Rank | Type int Properties Filter, Group, Nillable, Sort Description Ranking of the result clicked in the search results page. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | ## Usage All searches within the app, including Experience Cloud sites, are included. However, unauthenticated guest users don’t have a unique Salesforce user ID. # SearchEventLog Search Event Log provides details about the user’s search query. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | PrefixesSearched | Type string Properties Filter, Group, Nillable, Sort Description A space-delineated list of key prefixes that are searched. | | QueryIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Unique ID of the search query. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | ResultCount | Type int Properties Filter, Group, Nillable, Sort Description Number of results returned by the search query. | | SearchQuery | Type string Properties Filter, Group, Nillable, Sort Description The first 100 characters of the search query. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | ## Usage All searches within the app, including Experience Cloud sites, are included. However, unauthenticated guest users don’t have a unique Salesforce user ID. # SearchLayout Represents a search layout defined for an object. This object is available in API version 35.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules Users with the View Setup and Configuration permission can access this object. ## Fields | Field | Details | | --- | --- | | ButtonsDisplayed | Type [SearchLayoutButtonsDisplayed](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_searchlayout.htm#searchlayoutbuttonsdisplayed) Properties Nillable Description The list of buttons available in list views for an object. This field is equivalent to the listViewButtons field on [SearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_searchlayouts.htm) in Metadata API. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. DurableId in queries allows you to find the right record without having to retrieve the entire record. | | EntityDefinitionId | Type string Properties Filter, Group, Nillable, Sort Description ID of the record in EntityDefinition. Use in subqueries. This field is a relationship field. Relationship Name EntityDefinition Refers To EntityDefinition | | FieldsDisplayed | Type [SearchLayoutFieldsDisplayed](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_searchlayout.htm#searchlayoutfieldsdisplayed) Properties Nillable Description The list of fields displayed in a search result for the object. The name field is required. It’s always displayed as the first column header, so it isn’t included in this list; all additional fields are included. The field name relative to the object name, for example MyCustomField\_\_c, is specified for each custom field. This field is equivalent to searchResultsAdditionalFields on [SearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_searchlayouts.htm) in Metadata API. | | Label | Type string Properties Filter, Group, Nillable, Sort Description The label for this search layout. | | LayoutType | Type string Properties Filter, Group, Nillable, Sort Description The type of search layout. | | ListLayout | Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the field. Identifies the list layout a search layout is related to. Available in API version 48.0 and later. | | Profile | Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the field. Identifies the profile to which a search layout applies. Available in API version 48.0 and later. | | ProfileName | Type string Properties Filter, Group, Nillable, Sort Description The name of the profile to which a search layout applies. Available in API version 48.0 and later. | ## Usage Use the SearchLayout object to control the fields displayed and actions available to a user profile. The search layout applies to global and lookup searches. # SearchPromotionRule Represents a promoted search term, which is one or more keywords that you associate with a Salesforce Knowledge article. When a user’s search query includes these keywords, the associated article is returned first in search results. This object is available in API version 31.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules A user must have the “Manage Promoted Search Terms” permission. ## Fields | Field Name | Details | | --- | --- | | PromotedEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the KnowledgeArticleVersion that the promoted search term is associated with. The article must be in published status. | | Query | Type string Properties Create, Filter, Group, Sort, Update Description The text of the promoted search term. Maximum length: 100 characters. You can associate the same promoted search term with multiple articles. If the user’s search matches the promoted term, all associated articles are promoted in search results, ordered by relevancy. For best results, create promoted search terms selectively and limit the number of articles that are promoted per term. | ## Usage Use this object to optimize article search results in Salesforce Knowledge. # SecurityCustomBaseline Provides the ability to read, create, and delete user-defined custom security baselines, which define an org’s security standards. This object is available in API version 39.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules You must have the “View Health Check” permission to read a custom baseline, and the “Manage Health Check” permission to create, edit, or delete one. ## Fields | Field Name | Details | | --- | --- | | Baseline | Type textarea Properties Create, Nillable, Update Description The definition of an org’s security settings standards. | | DeveloperName | Type string Properties 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 org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Sets the baseline as the default in Security Health Check. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the presence status. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Label for the category node. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with the package. | # SecurityHealthCheckAlertRecipient Represents a recipient configuration for Security Health Check alerts. Use this object to manage who receives Security Health Check notifications and how they are delivered. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | IsAdminNotifyEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether admin notification is enabled for Security Health Check alerts. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Security Health Check alert recipient configuration. | | NotificationType | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The type of notification sent. For example, a Chatter feed or push notification. | | RecipientEmails | Type textarea Properties Create, Nillable, Update Description The email addresses of the recipients who receive Security Health Check alerts. | # SecurityHealthCheckResult Stores Security Health Check results, including the baseline used and the score calculated. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BaselineApiName | Type string Properties Create, Filter, Group, Sort, Update Description The API name of the baseline used to calculate the Health Check score. | | BaselineName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the baseline. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Health Check result record. | | ProcessedTime | Type dateTime Properties Create, Filter, Sort, Update Description The time when the Health Check score was calculated. | | ResultDetails | Type textarea Properties Create, Nillable, Update Description The detailed information about the Security Health Check results. | | Score | Type double Properties Create, Filter, Sort, Update Description The Health Check score for the org. The score can range from 0 to 100. | # SelfServiceUser Represents a Contact who has been enabled to use your organization’s Self-Service portal, where he or she can obtain online support. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Starting with Spring ’12, the Self-Service portal isn’t available for new Salesforce orgs. Existing orgs continue to have access to the Self-Service portal. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | ContactId | Type reference Properties Create, Filter, Group, Sort Description Required. All Self-Service users must be associated with a Contact. The contact’s email should match the Self-Service user email. The contact must have a value in the AccountId field or an error occurs. | | Email | Type email Properties Create, Filter, Group, Sort, Update Description Required. Make this the same as the email address for the Contact associated with this SelfServiceUser. Password resets and other system communication will be sent to this email address. | | FirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description First name of the Self-Service user. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Self-Service user is allowed to log in to the Self-Service portal (true) or not (false). Note that there is no way to delete a Self-Service user. They can only be marked as inactive. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | LanguageLocaleKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This is a restricted picklist field. It is the primary language for the user. All on-screen text in the Self-Service portal is displayed in this language. | | LastLoginDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the Self-Service user last logged in. | | LastName | Type string Properties Create, Filter, Group, Sort, Update Description Required. Last name of the Self-Service user. | | LocaleSidKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This is a restricted picklist field. The value of this field affects the formatting and parsing of values, especially numeric values, in the Self-Service portal. Values are two-letter codes that indicate language and sometimes language and country. The codes are based on ISO standards. | | Name | Type string Properties Filter, Group, Sort Description Concatenation of FirstName and LastName. Limited to 203 characters, including whitespaces. | | SuperUser | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this Self-Service user is a super user with additional access on his or her company's Self-Service portal (true) or not (false). | | TimeZoneSidKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This is a restricted picklist field. The time zone of a affects the offset used when displaying or entering times in the Self-Service portal. | | Username | Type string Properties Create, Filter, Group, Sort, Update Description Required. This contains the name that a Self-Service user enters to log into the Self-Service portal. Value must be unique in your organization. If you try to create or update a user with a duplicate value, the operation is rejected and an error is returned. | ## Usage For security reasons, you can’t query Self-Service user passwords via the API or the user interface. However, the API allows you to set and reset Self-Service user passwords using the setPassword() and resetPassword() calls. SelfServiceUser records created from the API don’t cause a notification email to be sent. If you want to notify the user, you must send them an email after creating the user. #### See Also - [Contact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm "Represents a contact, which is a person associated with an account.") - [User](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_user.htm "Represents a user in your organization.") # Seller Represents the seller role of an individual with respect to a particular company or organization. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActiveFromDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the seller’s role became active. | | ActiveToDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the seller’s role is no longer active. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of this seller. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account owner associated with this seller. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PartyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. Represents the record based on the Individual object you want to associate the seller with. This is a relationship field. Relationship Name Party Relationship Type Lookup Refers To Individual | | SalesAmount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total revenue amount gained from this seller. | | SellerTier | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The tier at which this seller is ranked. Possible values are: - Bronze - Gold - Silver | | SellerType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of sales this seller specializes in. Possible values are: - Distributor - Reseller - SalesPartner - Wholesaler | ## 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. [SellerHistory](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. [SellerShare](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. # SenderEmailAddress Represents a From address in a marketing email. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DisplayName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A descriptive name that makes the sender email address easier to identify. | | EmailDomainKeyId | Type reference Properties Create, Filter, Group, Sort, Update Description The unique system ID of the domain associated with the sender email address. This field is a relationship field. Relationship Name EmailDomainKey Refers To EmailDomainKey | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique identifier for the sender email address. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The unique user ID of the user who owns the sender email address object. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Username | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The part of the email address that comes before the @ symbol. | # SerializedProductTransaction Represents transactions performed on a serialized product. This object is available in API version 57.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The last date and time this record was referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The last date and time this record was viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the serialized product record. This is auto-generated. | | RelatedRecordId | Type reference Properties Filter, Group, Sort Description The serialized product being transferred. This field is a polymorphic relationship field. Relationship Name SerializedProduct Relationship Type Lookup Refers To ProductConsumed, ProductTransfer | | SerializedProductId | Type reference Properties Filter, Group, Sort Description The serialized product being transferred. This field is a relationship field. Relationship Name SerializedProduct Relationship Type Lookup Refers To SerializedProduct | | TransactionType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The action that the transaction tracks. Possible values are: - Adjusted - Consumed - Damaged - Found - Lost - Received - Repaired - Replenished - Sent - Withdrawn | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [SerializedProductTransactionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 64.0) Change events are available for the object. [SerializedProductTransactionFeed](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. [SerializedProductTransactionHistory](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. # ServiceAppointment Represents an appointment to complete work for a customer in Field Service, Lightning Scheduler,Intelligent Appointment Management, and Virtual Care.This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The account associated with the appointment. If the parent record is a work order or work order line item, this field’s value is inherited from the parent. Otherwise, it remains blank. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | ActualDuration | Type double Properties Create, Filter, Nillable, Sort, Update Description The number of minutes that it took the resource to complete the appointment after arriving at the address. When values are first added to the Actual Start and Actual End fields, the Actual Duration is automatically populated to list the difference between the Actual Start and Actual End. If the Actual Start and Actual End fields are subsequently updated, the Actual Duration field doesn’t re-update, but you can manually update it. | | ActualEndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The actual date and time the appointment ended. | | ActualStartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The actual date and time the appointment started. | | Address | Type address Properties Filter Description The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item. | | AppointmentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-assigned number that identifies the appointment. | | ArrivalWindowEndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The end of the window of time in which the technician is scheduled to arrive at the site. This window is typically larger than the Scheduled Start and End window to allow time for delays and scheduling changes. You may choose to share the Arrival Window Start and End with the customer, but keep the Scheduled Start and End internal-only. | | ArrivalWindowStartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The beginning of the window of time in which the technician is scheduled to arrive at the site. This window is typically larger than the Scheduled Start and End window to allow time for delays and scheduling changes. You may choose to share the Arrival Window Start and End with the customer, but keep the Scheduled Start and End internal-only. | | BundlePolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to the bundle policy associated with this service appointment. This is a relationship field. Relationship Name BundlePolicy Relationship Type Lookup Refers To ApptBundlePolicy | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where the appointment is completed. Maximum length is 40 characters. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The contact associated with the parent record. If needed, you can manually update the service appointment contact. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the work order is completed. Maximum length is 80 characters. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the appointment. | | DueDate | Type dateTime Properties Create, Filter, Sort, Update Description The date by which the appointment must be completed. Earliest Start Permitted and Due Date typically reflect terms in the customer’s service-level agreement. | | Duration | Type double Properties Create, Nillable, Filter, Sort, Update Description The estimated length of the appointment. If the parent record is work order or work order line item, the appointment inherits its parent’s duration, but it can be manually updated. The duration is in minutes or hours based on the value selected in the Duration Type field. | | DurationType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of the Duration: Minutes or Hours. | | EarliestStartTime | Type dateTime Properties Create, Filter, Sort, Update Description The date after which the appointment must be completed. Earliest Start Permitted and Due Date typically reflect terms in the customer’s service-level agreement. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. This field is available in the API only. | | IsAnonymousBooking | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a service resource was automatically assigned to the appointment. The default value is false. This field is available in API version 49.0 and later. | | IsBundle | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if this service appointment is a bundle service appointment. The default value is false. This field is available in API version 54.0 and later. | | IsBundleMember | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if this service appointment is a bundle member service appointment. The default value is false. This field is available in API version 54.0 and later. | | IsManuallyBundled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if this bundle was created manually. The default value is false. This field is available in API version 54.0 and later. | | IsOffsiteAppointment | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Any type of work that can be done remotely. This field is available in API version 58.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service appointment was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service appointment was last viewed. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the service appointments is completed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. To integrate data from an external data source for latitude, map your data to the ServiceAppointment.Latitude and not the ServiceAppointment.FSL\_\_InternalSLRGeolocation\_\_Latitude\_\_s field. This field is available in the API only. | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the service appointment is completed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. To integrate data from an external data source for longitude, map your data to the ServiceAppointment.Longitude and not the ServiceAppointment.FSL\_\_InternalSLRGeolocation\_\_Longitude\_\_s field. This field is available in the API only. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the service appointment. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The parent record associated with the appointment. The parent record can’t be updated after the service appointment is created. This is a polymorphic relationship field. Relationship Name ParentRecord Relationship Type Lookup Refers To Account, Asset, Lead, Opportunity, ServiceAppointmentGroup, WorkOrder, WorkOrderLineItem | | ParentRecordStatusCategory | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description (Read only) The Status Category of the parent record. If the parent record is a work order or work order line item, this field is populated; otherwise, it remains blank. | | ParentRecordType | Type string Properties Filter, Group, Nillable, Sort Description (Read only) The type of parent record: Account, Asset, Lead, Opportunity, Work Order, or Work Order Line Item. | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code where the work order is completed. Maximum length is 20 characters. | | RelatedBundleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The bundle that this service appointment is a member of. This is a relationship field. Relationship Name RelatedBundle Relationship Type Lookup Refers To ServiceAppointment | | SchedEndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time at which the appointment is scheduled to end. If you are using the Field Service managed package with the scheduling optimizer, this field is populated once the appointment is assigned to a resource. Scheduled End – Scheduled Start = Estimated Duration. | | SchedStartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time at which the appointment is scheduled to start. If you are using the Field Service managed package with the scheduling optimizer, this field is populated once the appointment is assigned to a resource. | | ServiceDocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The template ID which sets the template for each service document for the Document Builder feature. | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service territory associated with the appointment. If the parent record is a work order or work order line item, the appointment inherits its parent’s service territory. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the service appointment is completed. Maximum length is 80 characters. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the appointment. The picklist includes the following values, which can be customized: - None—Default value. - Scheduled—Appointment has been assigned to a service resource. - Dispatched—Assigned service resource has been notified about their assignment. - In Progress—Work has begun. - Completed—Work is complete. - Cannot Complete—Work could not be completed. - Canceled—Work is canceled, typically before any work began While you can set the status to null via the API, setting the status to null returns an error. To prevent errors, use one of the picklist values. | | StatusCategory | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each Status value falls into. The Status Category field’s values are identical to the default Status values. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Customer Absent value, you may decide that it belongs in the Cannot Complete category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name where the service appointment is completed. | | Subject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A short phrase describing the appointment. | | Transaction | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last transaction ID of the scheduling and optimization request that updated this object. The transaction ID is automatically generated and populated by the Enhanced Scheduling and Optimization engine. Available in API version 63.0 and later. | | WorkTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work type associated with the service appointment. The work type is inherited from the appointment’s parent record if the parent is a work order or work order line item. If Lightning Scheduler is also in use, this field is editable. However, users see an error if they update it to list a different work type than the parent record’s work type. This is a relationship field. Relationship Name WorkType Relationship Type Lookup Refers To WorkType | ## Usage Service appointments always have a parent record, which can be a work order, work order line item, opportunity, account, or asset. The type of parent record tells you about the nature of the service appointment: - Service appointments on _work orders_ and _work order line items_ offer a more detailed view of the work being performed. While work orders and work order line items let you enter general information about a task, service appointments are where you add the details about scheduling and ownership. - Service appointments on _assets_ represent work being performed on the asset. - Service appointments on _accounts_ represent work being performed for the account. - Service appointments on _opportunities_ represent work that is related to the opportunity. - Service appointments on _leads_ represent work that is related to lead—for example, a site visit to pursue a promising lead. ## 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. [ServiceAppointmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ServiceAppointmentFeed](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. [ServiceAppointmentHistory](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. [ServiceAppointmentOwnerSharingRule](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. [ServiceAppointmentShare](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. # ServiceAppointmentStatus Represents a possible status of a service appointment in field service. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description The API name of the status value. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the status value is the default status on service appointments. Only one status value can be the default. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The label for the picklist value that appears in the UI. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description The value’s position in the drop-down list of values in the UI. | | StatusCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status category that the value corresponds to. The Status Category field has seven values which are identical to the default Status values. | ## Usage The Status field on service appointments comes with the following values: - None—Default value. - Scheduled—Appointment has been assigned to a service resource. - Dispatched—Assigned service resource has been notified about their assignment. - In Progress—Work has begun. - Completed—Work is complete. - Cannot Complete—Work could not be completed. - Canceled—Work is canceled, typically before any work began - CheckedIn—The customer has arrived for their scheduled appointment. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important While you can set the status to null via the API, setting the status to null returns an error. To prevent errors, use one of the documented picklist values. The ServiceAppointmentStatus object corresponds to the Status field. Adding a value to the Status field—for example, Waiting—creates a service appointment status record, and vice versa. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Service appointments also come with a StatusCategory field whose values are identical to the default Status values. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Customer Absent value, you may decide that it belongs in the Cannot Complete category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) # ServiceChannel Represents a channel of work items that are received from your organization—for example, cases, chats, or leads. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | AcwExtensionDuration | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum length of time, measured in seconds, an agent can spend on After Conversation Work (ACW) each time they extend the timer. You must set this field if HasAcwExtensionEnabled is set to true. Specify a value from 10 through 3600. Available only for service channels of type Messaging or Voice. | | AfterConvoWorkMaxTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum length of time, measured in seconds, an agent has to complete After Conversation Work (ACW). You must set this field if HasAfterConvoWorkTimer is set to true. Specify a value from 10 through 3600. Available only for service channels of type Messaging or Voice. For service channels of type Voice, this field is available in API version 52.0 and later. For service channels of type Messaging, this field is available in API version 56.0 and later. | | CapacityModel | Type picklist Properties Create, Filter, Group, Nillable, RestrictedPicklist, Sort, Update Description The method that determines when an agent's capacity for a work item is released. With the Status-Based capacity routing model, work remains assigned and applied to an agent’s capacity until the work is completed or reassigned to a different agent. In contrast, the tab-based capacity model releases an agent’s capacity when a work tab is closed in the service console. Possible values are StatusBased and TabBased. | | CustomSoundId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Relationship Name CustomSound Relationship Type Lookup Refers To StaticResource Description The ID of the static resource for the custom sound selected to play for the PresenceUserConfig object. | | DeveloperName | Type string Properties 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | DoesCheckCapOnOwnerChange | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description In the Status-Based capacity routing model, when work is reassigned to a specific agent, you can choose to override the capacity check and keep the work assigned to the agent. The default value is false. | | DoesCheckCapOnStatusChange | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description In the Status-Based capacity routing model, when work is reopened, you can choose to override the capacity check keep the work assigned to a specific agent. The default value is false. | | DoesMinimizeWidgetOnAccept | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Automatically minimizes the Omni-Channel widget when an agent accepts work. The default value is false. | | DoesOverridePresenceAudio | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Service channel settings override the audio settings for each agent’s presence configuration. The default value is false. | | HasAcwExtensionEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If set to true, agents can extend their After Conversation Work (ACW) time. Available only if HasAfterConvoWorkTimer is set to true. If set to true, you must also set the AcwExtensionDuration and MaxExtensions fields. The default value is false. Available only for service channels of type Messaging or Voice. This field is available in API version 56.0 and later. | | HasAfterConvoWorkTimer | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If set to true, After Conversation Work (ACW) time can be configured for the channel. If set to true, you must also set the AfterConvoWorkMaxTime field. The default value is false. Available only for service channels of type Messaging or Voice. For service channels of type Voice, this field is available in API version 52.0 and later. For service channels of type messaging, this field is available in API version 56.0 and later. | | HasAutoAcceptEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Work items in a service channel open automatically in the agent’s workspace so that the agent doesn’t have to manually accept them. The default value is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the service channel. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label of the service channel. | | MaxExtensions | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The maximum number of times an agent can extend their After Work Conversation (ACW) time. Specify a value from 1 through 10. You must set this field if HasAcwExtensionEnabled is set to true. Available only for service channels of type Messaging or Voice. This field is available in API version 56.0 and later. | | RelatedEntity | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of object that’s associated with this service channel. This field is unique within your organization. | | RoutingConfigurationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Relationship Name RoutingConfiguration Refers To QueueRoutingConfig Description The ID of the routing configuration. This field is a relationship field. This field is available in API version 63.0 and later. | | SecRoutingPriorityField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The name of the standard field or the id of the custom field that is used for secondary routing priority. This field is unique within your organization. | | SoundLength | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The length of time that a sound plays when new work is assigned to an agent. | | StatusField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The picklist field that you use to track work status in the Status-Based capacity routing model. Use ServiceChannelStatusField to specify the values that indicate completed and in-progress work-item status. | # ServiceChannelFieldPriority Represents a secondary routing priority field-value mapping. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. ## Fields | Field | Details | | --- | --- | | Priority | Type int Properties Create, Filter, Group, Sort, Update Description The priority number assigned to the mapped field value. | | ServiceChannelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the service channel. | | Value | Type string Properties Create, Filter, Group, Sort, Update Description The value of the SecRoutingPriorityField field defined in parent ServiceChannel. | # ServiceChannelStatus Represents the status that’s associated with a specific service channel. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), query(), update(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | ServiceChannelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the service channel. | | ServicePresenceStatusId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the presence status that’s associated with the service channel that’s specified by the ServicePresenceChannelId. | # ServiceChannelStatusField Represents the values that you use to indicate completed and in-progress work item status for the status field in the Status-Based Capacity routing model. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) and Status-Based Capacity Model must be enabled. ## Fields | Field | Details | | --- | --- | | ServiceChannelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the service channel. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description For the field that you use to track work status, specifies whether the values are for completed or in-progress work. | | Value | Type string Properties Create, Filter, Group, Sort Description Specifies the values that you use to indicate completed and in-progress work status. Valid values are Completed, InProgress, and Paused. | # ServiceContract Represents a customer support contract (business agreement). This object is available in API version 18.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the account associated with the service contract. | | ActivationDate | Type dateTime Properties Filter, Nillable, Sort Description The initial day the service contract went into effect (whereas StartDate may include a renewal date). | | AdditionalDiscount | Type percent Properties Create, Filter, Nillable, Sort, Update Description Extra discount percentage for the service contract. Available in API version 55.0 and later. | | ApprovalStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description Approval status of the service contract. | | BillingAddress (beta) | Type address Properties Filter, Nillable Description The compound form of the billing address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | BillingCity | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address. Maximum size is 40 characters. | | BillingCountry | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address. Maximum size is 40 characters. | | BillingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the service contract’s billing address. | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | BillingPostalCode | Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address. Maximum size is 20 characters. | | BillingState | Type string Properties Group, Sort, Filter, Nillable Description Details for the billing address. Maximum size is 20 characters. | | BillingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the service contract’s billing address. | | BillingStreet | Type textarea Properties Filter, Group, Nillable, Sort Description Street address for the billing address. | | ContactId | Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the Contact associated with the service contract. Must be a valid ID. | | ContractNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Unique number automatically assigned to the service contract. | | Description | Type textarea Properties Nillable Description Description of the service contract. | | Discount | Type percent Properties Filter, Nillable, Sort Description Discount percentage for the service contract. | | EndDate | Type date Properties Filter, Group, Nillable, Sort Description The last day the service contract is in effect. | | GrandTotal | Type currency Properties Filter, Nillable, Sort Description Total price of the service contract plus shipping and taxes. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | LastReferencedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last interacted with this record, directly or indirectly. Some sample scenarios are: | | LastViewedDate | Type date Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | LineItemCount | Type int Properties Filter, Nillable, Group, Sort Description Number of ContractLineItem records associated with the service contract. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Name of the service contract. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns the service contract. | | ParentServiceContractId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service contract’s parent service contract, if it has one. | | Pricebook2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Pricebook2 associated with the service contract. Must be a valid ID. | | RootServiceContractId | Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level service contract in a service contract hierarchy. Depending on where a service contract lies in the hierarchy, its root could be the same as its parent. | | ShippingAddress (beta) | Type address Properties Filter, Nillable Description The compound form of the shipping address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | ShippingCity | Type string Properties Filter, Group, Nillable, Sort Description Details of the shipping address. Maximum size is 40 characters. | | ShippingCountry | Type string Properties Filter, Group, Nillable, Sort Description Details of the shipping address. Country maximum size is 40 characters. | | ShippingCountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the service contract’s shipping address. | | ShippingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | ShippingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. | | ShippingPostalCode | Type string Properties Create, Filter, Nillable, Update Description Details of the shipping address. Postal code maximum size is 20 characters. | | ShippingState | Type string Properties Create, Filter, Nillable, Update Description Details of the shipping address. State maximum size is 20 characters. | | ShippingStateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the service contract’s shipping address. | | ShippingStreet | Type textarea Properties Create, Filter, Nillable, Update Description The street address of the shipping address. Maximum of 255 characters. | | SpecialTerms | Type textarea Properties Create, Nillable, Update Description Any terms specifically agreed to and tracked in the service contract. | | StartDate | Type date Properties Create, Filter, Nillable, Update Description The first day the service contract is in effect. | | Status | Type picklist Properties Filter, Nillable Description The status of the service contract, such as Inactive. | | Subtotal | Type currency Properties Filter, Nillable Description Total of the service contract line items (products) before discounts, taxes, and shipping are applied. | | Tax | Type currency Properties Create, Filter, Nillable, Update Description Total taxes for the service contract. | | Term | Type int Properties Create, Filter, Nillable, Update Description Number of months that the service contract is valid. | | TotalPrice | Type currency Properties Filter, Nillable Description Total of the contract line items (products) after discounts and before taxes and shipping. | ## 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. [ServiceContractChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [ServiceContractFeed](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.") (API version 23.0) Feed tracking is available for the object. [ServiceContractHistory](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. [ServiceContractOwnerSharingRule](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. [ServiceContractShare](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. #### See Also - [ServiceContractOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicecontractownersharingrule.htm "Represents the rules for sharing a ServiceContract (customer service agreement) with users other than the owner. This object is available in API version 18.0 and later.") # ServiceContractOwnerSharingRule Represents the rules for sharing a ServiceContract (customer service agreement) with users other than the owner. This object is available in API version 18.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Sort, Update Description A value that represents the type of sharing allowed. The possible values are: - Read - Edit | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. This field is available in API version 24.0 and later. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort, Description The ID representing the source group. Service contracts owned by users in the source group trigger the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** in the user interface. | | UserorGroupId | Type reference Properties Create, Filter Description The ID representing the target user or group. Target users or groups are given access. | ## Usage Use this object to manage the sharing rules for a service contract. General sharing and territory management-related sharing use this object. #### See Also - [ServiceContract](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicecontract.htm "Represents a customer support contract (business agreement). This object is available in API version 18.0 and later.") - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") # ServiceCrew Represents a group of service resources who can be assigned to service appointments as a unit. A service crew is a group of service resources whose combined skills and experience make them a good fit to work together on appointments. For example, a wellhead repair crew might include a hydrologist, a mechanical engineer, and an electrician. Service appointments can only be assigned to service resources. To assign a service crew to service appointments, you must create a service resource with a resource type of Crew that represents the crew, then use the resource for assignment purposes. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | CrewSize | Type int Properties Create, Filter, Group, Sort, Update Description The number of members on the crew. This field is manual, so it doesn’t auto-update when you add or remove members. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service crew was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service crew was last viewed. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description The name of the service crew. For example, Repair Crew. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The crew owner. By default, the owner is the person who created the service crew. | ## 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. [ServiceCrewChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ServiceCrewFeed](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. [ServiceCrewHistory](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. [ServiceCrewOwnerSharingRule](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. [ServiceCrewShare](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. # ServiceCrewMember Represents a technician service resource that belongs to a service crew. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | EndDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last day that the service resource belongs to the crew. You can use this field to track employment dates for contractors. | | IsLeader | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the member is the crew leader. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service crew member was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service crew member was last viewed. | | ServiceCrewId | Type reference Properties Create, Filter, Group, Sort Description The crew that the service resource belongs to. | | ServiceCrewMemberNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the service crew member. | | ServiceResourceId | Type reference Properties Create, Filter, Group, Sort, Update Description The service resource that belongs to the crew. Only service resources whose resource type is Technician can be added to service crews. | | StartDate | Type dateTime Properties Create, Filter, Sort, Update Description Required. The day the service resource joins the crew. Service resources can belong to multiple crews as long as their start and end dates don’t overlap. | ## 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. [ServiceCrewMemberChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ServiceCrewMemberFeed](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. [ServiceCrewMemberHistory](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. # ServiceCrewOwnerSharingRule Represents the rules for sharing a service crew with user records other than the owner or anyone above the owner in the role hierarchy. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. A service crew owned by a User in the source Group triggers the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | ServiceResourceAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group, or UserRole. The possible values are: - Read - Edit - All | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access. | # ServicePresenceStatus Represents a presence status that can be assigned to a service channel. This object is available in API version 32.0 and later. ## Supported Calls create(), query(), update(), retrieve() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. As of Spring ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the presence status. | | MasterLabel | Type string Properties Create, Filter, Group, Sort Description The label of the presence status. | # ServiceReport Represents a report that summarizes a work order, work order line item, or service appointment. The fields that appear on a service report are determined by its service report template. Service reports can be signed by the customer and shared as a PDF. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()update( ) ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | ContentVersionDocumentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the service report version, used for storage. | | DocumentBody | Type base64 Properties Create, Nillable Description The report output. DocumentBody can’t be retrieved via REST API. | | DocumentContentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of data used for the report output.. Possible values are: - audio/ogg - text/calendar - video/3gpp2 - video/3gpp - image/avif - text/calendar - audio/x-caf - image/webp | | DocumentLength | Type int Properties Filter, Group, Nillable, Sort Description The length of the report output. | | DocumentName | Type string Properties Create, Filter, Group, Nillable, Sort Description The name of the report output, always set to Service Report. | | DocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort Description The template used to generate service documents for the Document Builder feature. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important DocumentTemplate is different from Template. The document template needs to reference a flexipage that is of type serviceDocument and must target the object used to generate the service document. For example, you can't use an Account flexipage for a service report tied to a work order. | | IsSigned | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the service report contains one or more signatures. This field isn’t supported for Document Builder. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip Add this field to the Service Reports related list on work orders, work order line items, and service appointments. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the service appointment, work order, or work order line item that the service report summarizes. For example, if you click **Create Service Report** on a service appointment, this field lists the service appointment’s record ID. | | ServiceReportLanguage | Type picklist Properties Create, Filter, Group, Nillable, Sort, Restricted picklist Description The language used for the service report. The language is selected in the ServiceReportLanguage field on the associated work order. If the work order doesn’t specify a service report language, the report is translated in the default language in Salesforce of the person generating the report. | | ServiceReportNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the service report. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the service report. Available in API version 53.0 and later. Possible values are: - Completed - Failed - Generating - In Progress - None - Queued The default value is None. | | Template | Type string Properties Create, Filter, Group, Nillable, Sort Description The service report template used to generate the service report. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If the person creating the service report doesn’t have access to certain objects or fields that are included in the service report template, those fields aren’t visible in the report they create. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ServiceReportChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. Available in API version 55.0 and later. [ServiceReportHistory](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. # ServiceReportLayout Represents a service report template in field service. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Field Service must be enabled. All users with Field Service Standard user permission can view the ServiceReportLayout object via the API. ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The developer name of the service report template. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language that the service report template uses. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the service report template was last viewed. | | MasterLabel | Type string Properties Filter, Group, Sort Description The name of the service report template. For example, Maintenance Report Template. | | TemplateType | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of the service report template. Available in API version 46.0 and later. Possible values are: - DigitalForm - ServiceReport The default value is ServiceReport. | ## 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. [ServiceReportLayoutChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. Available in API version 55.0 and later. # ServiceRequest Represents a formal request from a user for something to be provided, such as access, information, hardware, or software. This object manages the lifecycle of these tasks, which are typically low-risk, and can be fulfilled through a defined, repeatable process. For example, a Service Request can be created for an employee requesting a new laptop or a student needing a transcript. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssignedGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user group assigned to the service request. This field is a relationship field. Relationship Name AssignedGroup Refers To Group | | AssignedUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user assigned to the service request. This field is a relationship field. Relationship Name AssignedUser Refers To User | | BusinessHoursId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID for the business hours used to determine the SLA calculation. This field is a relationship field. Relationship Name BusinessHours Refers To BusinessHours | | ClosedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the service request was closed. | | Description | Type textarea Properties Create, Nillable, Update Description A detailed description of the service request. | | IsClosed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the service request is closed (true) or not (false). The default value is false. The default value is false. | | IsPaused | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the SLA timer is paused (true) or not (false). The default value is false. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record | | MilestoneStatus | Type string Properties Group, Nillable, Sort Description Information about the milestone the service request reached. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the service request record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who created the record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ParentServiceRequestId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the parent request that this service request belongs to. This field is a relationship field. Relationship Name ParentServiceRequest Refers To ServiceRequest | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Priority of a service request. Valid values are: - High - Medium - Low The default value is Low. | | ReportedById | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the person who reported the service request. This field is a polymorphic relationship field. Relationship Name ReportedBy Refers To Account, User | | ResolutionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the service request was resolved. | | ResolutionSummary | Type textarea Properties Create, Nillable, Update Description Resolution summary for the service request. | | SlaEndDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the SLA timer ended. | | SlaPauseDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the SLA timer was paused. | | SlaStartDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the SLA timer started. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the status of a service request. | | StatusCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The code that displays the status of the service request lifecycle. Valid values are: - Closed - Canceled - InProgress - New - OnHold - Resolved The default value is New. | | Subject | Type string Properties Create, Filter, Group, Sort, Update Description A short description of the service request. | ## 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. [ServiceRequestFeed](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. [ServiceRequestHistory](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. [ServiceRequestShare](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. # ServiceResource Represents a service technician or service crew in Field Service and Salesforce Scheduler, or an agent in Workforce Engagement. This object is available in API version 38.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Field Service or Workforce Engagement must be enabled. ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the resource. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description When selected, this option means that the resource can be assigned to work orders. For service tracking purposes, resources can’t be deleted, so deactivating a resource is the best way to send them into retirement. Deactivating a user doesn’t deactivate the related service resource. You can’t create a service resource that is linked to an inactive user. | | IsCapacityBased | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Capacity-based resources are limited to a certain number of hours or appointments in a specified time period. The Capacities related list shows a resource’s capacity. | | IsOptimizationCapable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description This field is reserved for Field Service and the managed package. Create a custom field instead of using this field to include a service resource in optimization. | | LastKnownLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude of the last known location. | | LastKnownLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude of the last known location. | | LastKnownLocation | Type location Properties Nillable Description The service resource’s last known location. You can configure this field to display data collected from a custom mobile app. This field isn’t visible in the user interface, but you can expose it on service resource page layouts or set up field tracking to be able to view a resource’s location history. | | LastKnownLocationDate | Type dateTime Properties Filter, Nillable, Sort, Update Description The date and time of the last known location. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service resource was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service resource was last viewed. | | LocationId | Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description The location associated with the service resource. For example, a service vehicle driven by the service resource. LocationId is a relationship field. Relationship Name Location Relationship Type Lookup Refers To Location | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The resource’s name, for example the name or title of the associated user or service crew. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the service resource. OwnerId is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RelatedRecordId | Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description The associated user. Its label in the UI is User. If the service resource represents a service crew rather than a user, leave the User field blank and select the related crew in the ServiceCrewId field. RelatedRecordId is a relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To User | | ResourceType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the resource is a Technician (T), Dispatcher (D), Crew (C), Asset (S), Agent (A), or Planner (P). The default value is Technician (T). Resources who are dispatchers can’t be capacity-based or included in scheduling optimization. Only users with the Field Service Dispatcher permission-set license can be dispatchers. You can’t add additional resource types. To create a dependent lookup filter with ServiceResource.ResourceType, use only the first letter of the picklist value, for example T for Technician. | | ServiceCrewId | Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description The associated service crew. If the service resource represents a crew, select the crew. This field is hidden for all users by default. To use it, update its field-level security settings in Setup and add it to your service resource page layouts. | ## 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. [ServiceResourceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ServiceResourceFeed](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. [ServiceResourceHistory](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. [ServiceResourceOwnerSharingRule](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. [ServiceResourceShare](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. # ServiceResourceCapacity Represents the maximum number of scheduled hours or number of service appointments that a capacity-based service resource can complete within a specific time period. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | CapacityInHours | Type double Properties Create, Filter, Nillable, Sort, Update Description The number of hours that the resource can work per time period. You must fill out this field, the CapacityInWorkItems field, or both. | | CapacityInWorkItems | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of service appointments that the resource can complete per time period. You must fill out this field, the CapacityInHours field, or both. | | CapacityNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read only) An auto-generated number identifying the capacity record. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the capacity ends; for example, the end date of a contract. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | ServiceResourceId | Type reference Properties Create, Filter, Group, Sort Description The associated service resource. You can set multiple capacities for a resource as long as their start and end dates do not overlap. | | StartDate | Type date Properties Create, Filter, Group, Sort Description The date the capacity goes into effect. | | TimePeriod | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Days, Hours, or Months. For example, if a resource can work 80 hours per month, the capacity’s Time Period would be Month and Hours per Time Period would be 80. | ## Usage Service resources who are capacity-based can only work a certain number of hours or complete a certain number of service appointments within a specified time period. Contractors tend to be capacity-based. To indicate that a service resource is capacity-based, select **Capacity-Based** on the service resource record, then create a capacity record for the service resource. You must fill out at least one of these fields: CapacityInWorkItems and CapacityInHours. If you’re using the Field Service managed package and would like to measure capacity both in hours and in number of work items, enter a value for both. The resource is considered to reach their capacity based on whichever term is met first—hours or number of work items. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important If you aren’t using the Field Service managed package, capacity serves more as a suggestion than a rule. Resources can still be as scheduled beyond their capacity, and you aren’t notified when a resource exceeds their capacity. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ServiceResourceCapacityChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 54.0) Change events are available for the object. [ServiceResourceCapacityFeed](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. [ServiceResourceCapacityHistory](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. # ServiceResourceCapacityHistory Represents the history of changes made to tracked fields on a service resource capacity record. This object is available in API version 38.0 and later. ## Supported Calls getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules Field Service must be enabled in your organization, and field tracking for service resource capacity fields must be configured. ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The value of the field before it was changed. | | ServiceResourceCapacityId | Type reference Properties Filter, Group, Sort Description ID of the service resource capacity being tracked. The history is displayed on the detail page for this record. | # ServiceResourceDataTranslation Represents the translated values of the data stored within a [ServiceResource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceresource.htm "Represents a service technician or service crew in Field Service and Salesforce Scheduler, or an agent in Workforce Engagement. This object is available in API version 38.0 and later.") record’s fields. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules - Your organization must be using Enterprise, Performance, Unlimited, or Developer edition. - Translation Workbench and data translation must be enabled in your org. - To view this object, you must have the “View Setup and Configuration” permission ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The translated value for the ServiceResource description. | | IsOutOfDate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the translation is out-of-date (true) or current (false). A translation is out-of-date if the parent ServiceResource record is updated after the last translation was filed. | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language for these translated values. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The translated value for the ServiceResource record name. This field is required to translate the text in other fields. | | ParentId | Type reference Properties Create, Filter, Group, Sort, Update Description The record ID of the ServiceResource associated with the data that is being translated. | ## Usage Use this object to translate the data stored in a ServiceResource record into the different languages supported by Salesforce. If data translation is enabled for custom fields on the ServiceResource object, additional ServiceResourceDataTranslation fields exist for translating the data contained within those fields. You can’t use a custom external id field in an upsert call for a ServiceResourceDataTranslation object. # ServiceResourceOwnerSharingRule Represents the rules for sharing a service resource with user records other than the owner or anyone above the owner in the role hierarchy. This object is available in API version 38.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. A service resource owned by a User in the source Group triggers the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | ServiceResourceAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group, or UserRole. The possible values are: - Read - Edit - All | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access. | # ServiceResourcePreference Represents the service resource scheduling preferences that are considered as a business objective in the scheduling logic engine. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license. To view, create, edit, and delete records, the user must have the Workforce Engagement Agent or Workforce Engagement Planner permission set. ## Fields | Field | Details | | --- | --- | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The end date period that this preference is effective. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service resource preference was last modified. Its label in the user interface is **Last Modified Date**. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the service resource preference was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The service resource preference record name. | | OperatingHoursId | Type reference Properties Create, Filter, Group, Sort, Update Description The operating hours associated with the service resource preference. This is a relationship field. Relationship Name OperatingHours Relationship Type Lookup Refers To OperatingHours | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the service resource preference. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ServiceResourceId | Type reference Properties Create, Filter, Group, Sort, Update Description The service resource associated with the service resource preference. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description The start date period that this preference is effective. | # ServiceResourceSkill Represents a skill that a service resource possesses in Field Service and Lightning Scheduler. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | EffectiveEndDate | Type datetime Properties Create, Filter, Nillable, Sort, Update Description The date when the skill expires. For example, if a service resource needs to be re-certified after six months, the end date would be the date their certification expires. | | EffectiveStartDate | Type datetime Properties Create, Filter, Sort, Update Description The date when the service resource gains the skill. For example, if the skill represents a certification, the start date would be the date of certification. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the resource skill was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the resource skill was last viewed. | | ServiceResourceId | Type reference Properties Create, Filter, Group, Sort Description The service resource who possesses the skill. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | | SkillId | Type reference Properties Create, Filter, Group, Sort, Update Description The skill the service resource possesses. This is a relationship field. Relationship Name Skill Relationship Type Lookup Refers To Skill | | SkillLevel | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The service resource’s skill level. Skill level can range from zero to 99.99. | | SkillNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the resource skill assignment. | ## Usage You can assign skills to all service resources in your org to indicate their certifications and areas of expertise, and specify each resource’s skill level from 0 to 99.99. For example, you can assign Maria the “Welding” skill, level 50. If you intend to use the skills feature, determine which skills you want to track and how skill level should be determined. For example, you may want the skill level to reflect years of experience, certification levels, or license classes. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ServiceResourceSkillChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 54.0) Change events are available for the object. [ServiceResourceSkillFeed](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. [ServiceResourceSkillHistory](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. # ServiceSetupProvisioning Represents a task completed by the Service Setup Assistant. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules ServiceSetupProvisioning is accessible only if the Service Setup Assistant is turned on. Users need the Customize Application permission to access it. ## Fields | Field | Details | | --- | --- | | JobName | Type string Properties Filter, Group, idLookup, Sort Description The name of a group of tasks completed by the Service Setup Assistant. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An automatically generated ID. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the task being completed by the Service Setup Assistant. Possible values are: - \` - Completed—The task completed successfully. - ExistingSetup—The task couldn’t be completed due to conflicting configurations. - FailedFatalError—The task couldn’t be completed. - InProgress—The task is in progress. - PRE\_CONDITION\_NOT\_MET—The task couldn’t be completed because one or more prerequisites weren’t met. - VALIDATION\_NOT\_MET—The task is considered as completed but the condition defined in the implementation was not true. No retry will be executed. | | TaskAction | Type string Properties Filter, Group, Nillable, Sort Description The action taken by the task. Possible values are: - updatesOrgSettings - updatesOrgValues - sortApps - setForecastingUserFeatureLicense - recalculatePermissionSetGroup - deploysMetadata - createsSetupEntityAccess - clearGuidanceCenterCache - callsConnectApi - assignsPermissionSets - assignsPermissionSetGroups | | TaskActionContext | Type string Properties Filter, Group, Nillable, Sort Description Additional details about the TaskAction parameter, including how much of the action has been processed. | | TaskContext | Type textarea Properties Nillable Description The description of the changes included in the task. | | TaskName | Type string Properties Filter, Group, Nillable, Sort Description The name of the task. | # ServiceTerritory Represents a geographic or functional region in which work can be performed in Field Service, Salesforce Scheduler, or Workforce Engagement. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | Address | Type address Properties Filter Description An address to associate with the territory. For example, you can list the address of the territory’s headquarters. | | AvgTravelTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average travel time for this service territory. The value is added to the Work Capacity Usage for each scheduled service appointment in the service territory. Available in API version 59.0 and later. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the associated address. Maximum length is 40 characters. | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country to associate with the territory. Maximum length is 80 characters. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the territory. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. This field is available in the API only. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the service territory is meant to be used. If a territory is inactive, you can’t add members to it or link it to work orders, work order line items, or service appointments. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the territory was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the territory was last viewed. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address associated with the territory. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. This field is available in the API only. | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address associated with the territory. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. This field is available in the API only. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the territory. | | OperatingHoursId | Type reference Properties Create, Filter, Group, Sort, Update Description The territory’s operating hours, which indicate when service appointments within the territory can occur. Service resources who are members of a territory automatically inherit the territory’s operating hours unless different hours are specified on the resource record. This field is a relationship field. Relationship Name OperatingHours Relationship Type Lookup Refers To OperatingHours | | ParentTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The territory’s parent service territory, if it has one. For example, a Northern California territory can have a State of California territory as its parent. A service territory hierarchy can contain up to 10,000 territories. This field is a relationship field. Relationship Name ParentTerritory Relationship Type Lookup Refers To ServiceTerritory | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address associated with the territory. Maximum length is 20 characters. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address associated with the territory. Maximum length is 80 characters. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name of the address associated with the territory. | | TopLevelTerritoryId | Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level territory in a hierarchy of service territories. Depending on where a territory lies in the hierarchy, its top-level territory can be the same as its parent. This field is a relationship field. Relationship Name TopLevelTerritory Relationship Type Lookup Refers To ServiceTerritory | | TravelModeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the TravelMode used for travel time calculations. The travel mode includes information about the type of transportation, such as a car or walking, whether a vehicle can take toll roads, and whether a vehicle is transporting hazardous materials. This field is a relationship field. Relationship Name TravelMode Relationship Type Lookup Refers To TravelMode | | TravelTimeBuffer | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Add additional time to driving time, such as time to find parking or to walk to the site. This value overrides the Travel Time Buffer value defined in Field Service Settings | Scheduling | Routing. | | TypicalInTerritoryTravelTime | Type double Properties Create, Filter, Nillable, Sort, Update Description Estimated number of minutes needed to travel from one location to another within the service territory. You can use this field in Apex customization. | ## Usage If you want to use service territories, determine which territories to create. Depending on how your business works, you can create territories based on cities or counties, or on functional categories such as sales versus service. If you plan to build out a hierarchy of service territories, create the highest-level territories first. For example, you can create a hierarchy of territories to represent the areas where your team works in California. Include a top-level territory named California, three child territories named Northern California, Central California, and Southern California, and a series of third-level territories corresponding to California counties. Assign service resources to each county territory to indicate who is available to work in that county. ## Associated Objects This object has these 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. [ServiceTerritoryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ServiceTerritoryFeed](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. [ServiceTerritoryHistory](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. [ServiceTerritoryOwnerSharingRule](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. [ServiceTerritoryShare](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. # ServiceTerritoryDataTranslation Represents the translated values of the data stored within a [ServiceTerritory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceterritory.htm "Represents a geographic or functional region in which work can be performed in Field Service, Salesforce Scheduler, or Workforce Engagement. This object is available in API version 38.0 and later.") record’s fields. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules - Your organization must be using Enterprise, Performance, Unlimited, or Developer edition. - Translation Workbench and data translation must be enabled in your org. - To view this object, you must have the “View Setup and Configuration” permission ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable,Update Description The translated value for the ServiceTerritory description. | | IsOutOfDate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the translation is out-of-date (true) or current (false). A translation is out-of-date if the parent ServiceTerritory record is updated after the last translation was filed. | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language for these translated values. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The translated value for the ServiceTerritory record name. This field is required to translate the text in other fields. | | ParentId | Type reference Properties Create, Filter, Group, Sort, Update Description The record ID of the ServiceTerritory associated with the data that is being translated. | ## Usage Use this object to translate the data stored in a ServiceTerritory record into the different languages supported by Salesforce. If data translation is enabled for custom fields on the ServiceTerritory object, additional ServiceTerritoryDataTranslation fields exist for translating the data contained within those fields. You can’t use a custom external id field in an upsert call for a ServiceTerritoryDataTranslation object. # ServiceTerritoryLocation Represents a location associated with a particular service territory in field service. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | LocationId | Type reference Properties Create, Filter, Group, Sort, Update Description The location that is associated with the service territory. | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Sort Description The associated service territory. | | ServiceTerritoryLocationNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description (Read only) Auto-generated number identifying the service territory location. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ServiceTerritoryLocationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. [ServiceTerritoryLocationFeed](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. [ServiceTerritoryLocationHistory](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. # ServiceTerritoryMember Represents a service resource who can be assigned in a service territory in Field Service, Salesforce Scheduler, or Workforce Engagement. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Field Service or Workforce Engagement must be enabled. ## Fields | Field Name | Details | | --- | --- | | Address | Type address Properties Filter Description The member’s address. You may want to list the related service resource’s address in this field. | | City | Type string Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The city of the member’s address. Maximum length is 40 characters. | | Country | Type string Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The country of the member’s address. Maximum length is 80 characters. | | EffectiveEndDate | Type datetime Properties Create, Filter, Nillable, Sort, Update Description The date when the service resource is no longer a member of the territory. If the resource will be working in the territory for the foreseeable future, leave this field blank. This field is mainly useful for indicating when a temporary relocation ends. | | EffectiveStartDate | Type datetime Properties Create, Filter, Sort, Update Description The date when the service resource becomes a member of the service territory. | | GeocodeAccuracy | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the territory member was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the territory member was last viewed. | | Latitude | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the member’s address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | Longitude | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the member’s address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | MemberNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read only) An auto-generated number identifying the service territory member. | | OperatingHoursId | Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description The operating hours assigned to the service territory member. If no operating hours are specified, the member is assumed to use their parent service territory’s operating hours. If a member needs special operating hours, create them in Setup and select them in the Operating Hours lookup field on the member’s detail page. This is a relationship field. Relationship Name OperatingHours Relationship Type Lookup Refers To OperatingHours | | PostalCode | Type string Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The postal code of the member’s address. Maximum length is 20 characters. | | ServiceResourceId | Type reference Properties Create, Filter, Group, Sort, Update Description The service resource assigned to the service territory. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Sort Description The service territory that the service resource is assigned to. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | State | Type string Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The state of the member’s address. Maximum length is 80 characters. | | Street | Type textarea Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The street number and name of the member’s address. | | TerritoryType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Primary, Secondary, or Relocation. - The primary territory is typically the territory where the resource works most often—for example, near their home base. Service resources can only have one primary territory. - Secondary territories are territories where the resource can be assigned to appointments if needed. Service resources can have multiple secondary territories. - Relocation territories represent temporary moves for service resources. If you’re using the Field Service managed packages with the scheduling optimizer, resources with relocation territories are always assigned to services within their relocation territories during the specified relocation dates; if they don’t have a relocation territory, the primary territories are favored over the secondary. For example, a service resource might have the following territories: - Primary territory: West Chicago - Secondary territories: - East Chicago - South Chicago - Relocation territory: Manhattan, for a three-month period | | TravelModeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the TravelMode used for travel time calculations. The travel mode includes information about the type of transportation, such as a car or walking, whether a vehicle can take toll roads, and whether a vehicle is transporting hazardous materials. This field is a relationship field. Relationship Name TravelMode Relationship Type Lookup Refers To TravelMode | ## Usage If you delete a service territory with members, the service resources who were members no longer have any connection to the territory. ## 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. [ServiceTerritoryMemberChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ServiceTerritoryMemberFeed](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. [ServiceTerritoryMemberHistory](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. # ServiceTerritoryWorkType Represents the relationship between a ServiceTerritory object and a WorkType object for Salesforce Scheduler appointments. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | IsSlotPublished | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicate whether records in the Shift object are created for the selected Service Territory and Work Type. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the current user last viewed a record related to this object. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this object. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of this service territory-work type relationship. | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Sort Description The ID of the service territory that’s related to the work type indicated in the WorkTypeId field. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | TeamId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the team associated with the service territory for a specific work type. This field is a relationship field and is available in API version 58.0 and later. Relationship Name Team Relationship Type Lookup Refers To Team | | WorkTypeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the work type that’s related to the service territory indicated in the ServiceTerritoryId field. This is a relationship field. Relationship Name WorkType Relationship Type Lookup Refers To WorkType | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ServiceTerritoryWorkTypeFeed](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. [ServiceTerritoryWorkTypeHistory](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. # SessionPermSetActivation The SessionPermSetActivation object represents a permission set assignment activated during an individual user session. When a SessionPermSetActivation object is inserted into a permission set, an activation event fires, allowing the permission settings to apply to the user’s specific session. This object is available in API versions 37.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you include session-based permission sets in a permission set group, the permissions in them don’t require session-based activation for users assigned to the group. ## Special Access Rules As of Summer ’20 and later, only users who have one of these permissions can access this object: - View Setup and Configuration - Manage Session Permission Set Activations ## Fields | Field Name | Details | | --- | --- | | AuthSessionId | Type reference Properties Create, Filter, Group, Sort Description The session ID related to this permission set assignment for its duration. This is a relationship field. Relationship Name AuthSession Relationship Type Lookup Refers To AuthSession | | Description | Type string Properties Create, Filter, Group, Nillable, Sort Description The session details, such as device used and browser. | | PermissionSetGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The permission set group ID related to this permission set group assignment and user for its duration. This field is available in API version 53.0 and later. This is a relationship field. Relationship Name PermissionSetGroup Relationship Type Lookup Refers To PermissionSetGroup | | PermissionSetId | Type reference Properties Create, Filter, Group, Sort Description The permission set ID related to this permission set assignment and user for its duration. This is a relationship field. Relationship Name PermissionSet Relationship Type Lookup Refers To PermissionSet | | UserId | Type reference Properties Filter, Group, Sort Description The user ID of the user to whom this permission set assignment applies for its duration. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Usage Use SessionPermSetActivation to create a permission set available only for a specified session’s duration. For example, create permission sets that provide access to specific applications only during authenticated sessions. In the following Apex example, an identified session is activated after session information is submitted via a button. Successful activation results in a confirmation message displayed to the user. public class SessionPermSetActivationController { // id of the session permission set to be activated private final String sessionPermSetId = '0PSxx00000004rJ'; private final String sessionId; public SessionPermSetActivationController() { Map sessionManagement = Auth.SessionManagement.getCurrentSession(); String parentSessionId = sessionManagement.get('ParentId'); String currentSessionId = sessionManagement.get('SessionId'); sessionId = parentSessionId != null ? parentSessionId : currentSessionId; } public PageReference activate() { // activate the permission set SessionPermSetActivation activation = new SessionPermSetActivation(); activation.AuthSessionId = sessionId; activation.PermissionSetId = sessionPermSetId; activation.Description = 'created by SessionPermSetActivationController'; insert activation; return null; } public boolean getActivated() { Integer alreadyActivated = \[SELECT count() FROM SessionPermSetActivation WHERE AuthSessionId = :sessionId And PermissionSetId = :sessionPermSetId LIMIT 1\]; return alreadyActivated > 0; } }

Activate Session Permission Set

Session Permission Set is already active.

 To deactivate a session-based permission set for the current session, delete the matching SessionPermSetActivation record. Removing that record ends the activation for that permission set in that session. In this example, a deactivate() method is added to the class from the previous example. public PageReference deactivate() { List activations = \[ SELECT Id FROM SessionPermSetActivation WHERE AuthSessionId = :sessionId AND PermissionSetId = :sessionPermSetId \]; if (!activations.isEmpty()) { delete activations; } return null; } # SetupAssistantStep For internal use only. # SetupAuditTrail Represents changes you or other admins made in your org’s Setup area for at least the last 180 days. This object is available in API version 15.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note SetupAuditTrail is not a supported standard controller. Using SetupAuditTrail as a standard controller in a Visualforce page results in an error. ## Supported Calls query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Aggregate queries aren’t supported on this object. For example, SELECT count() FROM SetupAuditTrail works but SELECT count(Id) FROM SetupAuditTrail fails. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Sort Description The category of the change made in Setup. For example, a value of PermSetCreate indicates that an administrator created a permission set. The Display field contains more specific information. | | CreatedByContext | Type string Properties Filter, Group, Nillable, Sort Description The context under which the Setup change was made. For example, if Einstein uses cloud-to-cloud services to make a change in Setup, the value of this field is Einstein. This field is available in API version 48.0 and later. | | CreatedByIssuer | Type string Properties Filter, Group, Nillable, Sort Description Reserved for future use. | | DelegateUser | Type string Properties Filter, Nillable, Sort Description The Login-As user who executed the action in Setup. If a Login-As user didn’t perform the action, this field is blank. This field is available in API version 35.0 and later. | | Display | Type string Properties Nillable, Sort Description The full description of changes made in Setup. For example, if the Action field has a value of PermSetCreate, the Display field has a value like “Created permission set MAD: with user license Salesforce.” | | Section | Type string Properties Nillable, Sort Description The section in the Setup menu where the action occurred. For example, Manage Users or Company Profile. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can use SOQL joins to get the information you need more quickly. For example, running SELECT CreatedBy.Name FROM SetupAuditTrail LIMIT 10 returns the first and last names of the last 10 people to make changes in Setup. # SetupEntityAccess Represents the enabled setup entity access settings (such as for Apex classes) for the parent PermissionSet. This object is available in API version 25.0 and later. To grant users access to an entity, associate the appropriate SetupEntityAccess record with a PermissionSet that’s assigned to a user. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only users with "View Setup and Configuration" permission can access this object. ## Fields | Field Name | Details | | --- | --- | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the entity’s parent PermissionSet. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To PermissionSet | | SetupEntityId | Type reference Properties Create, Filter, Group, Sort Description The ID of the entity for which access is enabled, such as an Apex class or Visualforce page. | | SetupEntityType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of setup entity for which access is enabled. Valid values are: - ApexClass for Apex classes - ApexPage for Visualforce pages - In API version 64.0 and later, BotDefinition for agents - In API version 28.0 and later, ConnectedApplication for OAuth connected apps - In API version 48.0 and later, CustomEntityDefinition for Custom Settings and Custom Metadata Types - In API version 31.0 and later, CustomPermission for custom permissions - In API version 62.0 and later, EmailRoutingAddress for email routing addresses. - In API version 60.0 and later, ExternalClientApplication for external client apps. - In API version 58.0 and later, ExternalCredentialParameter for external credential principals. - In API version 58.0 and later, FlowDefinition for flows - In API version 62.0 and later, MessagingChannel for messaging channels - In API version 58.0 and later, OrgWideEmailAddress for organization-wide email addresses - In API version 28.0 and later, ServiceProvider for service providers - In API version 60.0 and later, StandardInvocableActionType for standard invocable actions. - In API version 28.0 and later, TabSet for apps | ## Usage Because SetupEntityAccess is a child of the PermissionSet object, the usage is similar to other PermissionSet child objects like FieldPermissions and ObjectPermissions. For example, the following code returns all permission sets that grant access to any setup entities for which access is enabled: SELECT Id, ParentId, Parent.Name, SetupEntityId FROM SetupEntityAccess The following code returns permission sets that grant access only to Apex classes: SELECT Id, ParentId, Parent.Name, SetupEntityId FROM SetupEntityAccess WHERE SetupEntityType='ApexClass' The following code returns permission sets that grant access to any setup entities, and are not owned by a profile: SELECT Id, ParentId, Parent.Name, SetupEntityId FROM SetupEntityAccess WHERE ParentId IN (SELECT Id FROM PermissionSet WHERE isOwnedByProfile = false) You may want to return only those permission sets that have access to a specific setup entity. To do this, query the parent object. For example, this code returns all permission sets that grant access to the helloWorld Apex class: SELECT Id, Name, (SELECT Id, Parent.Name, Parent.Profile.Name FROM SetupEntityAccessItems) FROM ApexClass WHERE Name = 'helloWorld' While it’s possible to return permission sets that have access to a ConnectedApplication, ServiceProvider, or TabSet by SetupEntityId, it’s not possible to return permission sets that have access to these SetupEntityType fields by any other AppMenuItem attribute, such as Name or Description. For example, to find out if a user has access to the Recruiting app, you’d run two queries. First, query to get the AppMenuItem ID: SELECT Id, Name, Label FROM AppMenuItem WHERE Name = 'Recruiting' Let’s say the previous query returned the AppMenuItem ApplicationId 02uD0000000GIiMIAW. Using this ID, you can now run a query to find out if a user has access to the Recruiting app: SELECT Id, SetupEntityId, SetupEntityType FROM SetupEntityAccess WHERE ParentId IN (SELECT PermissionSetId FROM PermissionSetAssignment WHERE AssigneeId = '005D0000001QOzF') AND (SetupEntityId = '02uD0000000GIiMIAW') #### See Also - [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.") - [FieldPermissions](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fieldpermissions.htm "Represents the enabled field permissions for the parent PermissionSet. This object is available in API version 24.0 and later.") - [ObjectPermissions](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectpermissions.htm "Represents the enabled object permissions for the parent PermissionSet. This object is available in API version 24.0 and later.") - [ApexClass](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexclass.htm "Represents an Apex class.") - [ApexPage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexpage.htm "Represents a single Visualforce page.") # SfdcCustomerForPartner Represents a customer associated with a Salesforce partner. Records appear in the Partner Business Org (PBO) and represent a partner's customer for the purpose of storing billing information. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References a specific account from the Account object in the PBO. This field is a relationship field. Relationship Name Account Refers To Account | | BillingAddress | Type address Properties Filter, Nillable Description The default billing address for the customer, used to seed the billing address into new offers. Compound field. | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The customer billing city. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The customer billing country. | | BillingCustomerOrg | Type string Properties Create, Filter, Group, Sort Description Required. 18 chararacter org ID that represents the billing org for a partner's customer. Must be a Paid Org. | | BillingEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The default email address of the customer who receives billing details, used to seed new offers. This is typically someone in the accounting department. | | BillingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of geocoded billing address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude geo-coordinate for customer billing address. | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude geo-coordinate for customer billing address . | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal/zip code of the customer billing address. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the customer billing address. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the customer billing address. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the customer. | | ShippingAddress | Type address Properties Filter, Nillable Description The default shipping address of the partner's customer. Compound field. | | ShippingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the customer shipping address. | | ShippingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the customer shipping address. | | ShippingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of geocoded shipping address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | ShippingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude geo-coordinate for customer shipping address. | | ShippingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude geo-coordinate for customer shipping address. | | ShippingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal/zip code of the shipping address. | | ShippingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the customer shipping address. | | ShippingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the customer shipping address. | ## 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. [SfdcCustomerForPartnerOwnerSharingRule](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. [SfdcCustomerForPartnerShare](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. # SfdcPartnerOffer Represents a private offer that an ISV partner creates and sends to a customer. This object includes information about the offer, and is parent to multiple Partner Offer line items, and includes information used in the Partner Business Org (BPO) transaction. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AcceptedDate | Type date Properties Filter, Group, Nillable, Sort Description The date the offer is accepted by the customer. | | BillingCustomerOrg | Type string Properties Filter, Group, Nillable, Sort Description Derived field. Formula field that returns the BillingCustomerOrg value from the related SfdcCustomerForPartner record. | | BillingFrequency | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The frequency with which the customer is billed for their purchases. Possible values are: - Annually | | ContractTerm | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The duration of the contract between the customer and the partner in months. The max value is 12. | | CustBillingAddress | Type address Properties Filter, Nillable Description Compound field used for the customer billing address. | | CustBillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The customer billing city. | | CustBillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The customer billing country. | | CustBillingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of geocoded billing address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | CustBillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude geo-coordinate for customer billing address. | | CustBillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude geo-coordinate for customer billing address . | | CustBillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal/zip code of the customer billing address. | | CustBillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the customer billing address. | | CustBillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The billing street of the customer. | | CustShippingAddress | Type address Properties Filter, Nillable Description Compound field for the customer shipping address. | | CustShippingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the customer shipping address. | | CustShippingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the customer shipping address. | | CustShippingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocoded shipping address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | CustShippingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude geo-coordinate for customer shipping address. | | CustShippingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude geo-coordinate for customer shipping address. | | CustShippingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal/zip code of the shipping address. | | CustShippingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the customer shipping address. | | CustShippingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the customer shipping address. | | CustomerBillingEmailAddress | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The default email address of the customer who receives billing details, used to seed new offers. This is typically someone in the accounting department. | | CustomerEmailAddress | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The customer email address that receives the offer notification. This email can be different from customer billing email address. | | CustomerId | Type reference Properties Create, Filter, Group, Sort, Update Description The associated Customer record where licenses are provisioned and invoices are sent. This field is a relationship field. Relationship Name Customer Refers To SfdcCustomerForPartner | | CustomerName | Type string Properties Filter, Group, Nillable, Sort Description Derived field. Returns the company name, which is stored in the Name field from the related SfdcCustomerForPartner record. | | CustomerOrgSyncError | Type string Properties Create, Filter, Nillable, Sort, Update Description Stores information about any error that occurs during syncing to make support easier. | | CustomerOrgSyncLastUpdate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Tracks the timestamp of the last time the customer org performed the sync operation. | | CustomerOrgSyncStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Status of the customer org sync operation. Possible values are: - READY - IN\_PROGRESS - COMPLETE - ERROR - TERMINAL\_ERROR The default value is READY. | | CustomerPaymentTerms | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The terms of payment for the customer. Indicates that the customer has 30 days from the invoice date to pay for services. Provides invoice due date. Possible values are: - NET 30 The default value is NET 30. | | CustomerPurchaseOrderNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The purchase order number that is internal to customer's organization and provided during private offer process. This value is added to the customer invoice. | | ExpirationDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the offer expires. When expired, the offer moves to the Expired status and is no longer actionable. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The autogenerated number of the offer. | | OfferType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of offer, which indicates whether an offer is net new or an addition to a previous order. Possible values are: - Add-On - Initial The default value is Initial. | | OpportunityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the associated opportunity. This field is a relationship field. Relationship Name Opportunity Refers To Opportunity | | OrderPrebillDays | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the number of days, before the service date, that an invoice is sent to a customer. | | ParentOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the associated initial order. This field is a relationship field. Relationship Name ParentOrder Refers To SfdcPartnerOrder | | PartnerPurchaseOrderNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The purchase order number provided during private offer creation. This value is available to Salesforce but is not shared with the customer and can be used by the partner to reconcile transactions. | | PartnerTermSetId | Type reference Properties Create, Filter, Group, Sort, Update Description Partner term set associated with the offer. This field is a relationship field. Relationship Name PartnerTermSet Refers To SfdcPartnerTermSet | | PaymentMethod | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The possible payment methods available to the customer. Possible values are: - ACH The default value is ACH. | | RespondingEmail | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Email of the user that responded to the offer. | | RespondingFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description First name of the user that responded to the offer | | RespondingLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Last name of the user that responded to the offer. | | SentToCustomerById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description User ID for the user that sent the offer to the customer. This field is a relationship field. Relationship Name SentToCustomerBy Refers To User | | SentToCustomerDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when the offer was sent to the customer. | | ServiceEndDate | Type date Properties Filter, Group, Nillable, Sort Description Derived field. The date when the contract terms end. Service end date is calculated as ServiceStartDate + ContractTerm in months. | | ServiceStartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date and time when the order is activated, if it is converted from an offer. | | ServiceTerm | Type double Properties Filter, Nillable, Sort Description Period between Service Start date and Service End date. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the offer. Possible values are: - Accepted - Draft - Rejected - Sent - SentError The default value is Draft. | | SubTotal | Type currency Properties Filter, Nillable, Sort Description Derived field. Formula summing all offer item line item totals and the contract term. Excludes taxes. | | TermsAndConditions | Type textarea Properties Create, Nillable, Update Description The terms and conditions set forth by the partner. | # SfdcPartnerOfferItem Represents a line item within a partner offer. Line items map to defined products or SKUs that are sold as part of the offer. Includes quantity. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CustomerUnitPricePerMonth | Type currency Properties Create, Filter, Nillable, Sort, Update Description The unit price of the product per month. For example, if the unit price is $1 and a customer orders 10 items, the cost is $10/month. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | LineItemPeriodTotal | Type currency Properties Filter, Nillable, Sort Description The line item total calculated as CustomerPricePerMonth \* Quantity. | | LineItemTotal | Type currency Properties Filter, Nillable, Sort Description Derived field. The total cost of a single line item within an offer, calculated as CustomerPricePerMonth \* Quantity \* Offer.ServiceTerm. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Auto-generated offer item number | | OfferItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Autonumber field for the offer item. | | PartnerOfferId | Type reference Properties Create, Filter, Group, Sort Description The offer to which the offer item belongs. This field is a relationship field. Relationship Name PartnerOffer Relationship Type Master-detail Refers To SfdcPartnerOffer | | PartnerProvisionProductId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Partner Provision Product being sold as part of this offer line item. Used for provisioning of order or commodity code for tax calculations. This field is a relationship field. Relationship Name PartnerProvisionProduct Refers To SfdcPartnerProvisionProduct | | PartnerProvisionProductName | Type string Properties Filter, Group, Nillable, Sort Description Derived field. The name of the related partner provisionable product. | | PartnerPurchaseOrderNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used to override the value of the Partner PO Number at the item level. | | Quantity | Type int Properties Create, Filter, Group, Sort, Update Description Required. Number of units being sold on this offer line item. | | ServiceStartDate | Type date Properties Filter, Group, Nillable, Sort Description Derived field. The date when the contract terms begin. Copied from the SfdcPartnerOffer object when the offer item is created and used to assist provisioning. | # SfdcPartnerOrder Represents the order record generated after a customer accepts an offer and initiates a purchase. Orders are viewable from the Go-To-Market App in the Partner Business Org (PBO). This object is available in API version 64.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | AcceptedDate | Type date Properties Filter, Group, Nillable, Sort Description The date the offer is accepted, which triggers order creation. | | BillingFrequency | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The frequency with which the customer is billed for their purchases. Possible values are: - 1: Monthly - 3: Quarterly - 6: Bi-annually - 12: Annually | | ContractTerm | Type int Properties Filter, Group, Sort Description The duration of the contract between the customer and the partner in months. The fixed value is 12. | | CustBillingAddress | Type address Properties Filter, Nillable Description The billing address of the customer. | | CustBillingCity | Type string Properties Filter, Group, Nillable, Sort Description The billing city of the customer. | | CustBillingCountry | Type string Properties Filter, Group, Nillable, Sort Description The billing country of the customer. | | CustBillingGeocodeAccuracy | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Accuracy level of geocoded billing address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | CustBillingLatitude | Type double Properties Filter, Nillable, Sort Description The latitude geo-coordinate for customer billing address. | | CustBillingLongitude | Type double Properties Filter, Nillable, Sort Description The longitude geo-coordinate for customer billing address . | | CustBillingPostalCode | Type string Properties Filter, Group, Nillable, Sort Description The postal/zip code of the customer billing address. | | CustBillingState | Type string Properties Filter, Group, Nillable, Sort Description The state of the customer billing address. | | CustBillingStreet | Type textarea Properties Filter, Group, Nillable, Sort Description The billing street of the customer. | | CustShippingAddress | Type address Properties Filter, Nillable Description Compound field for the customer shipping address. | | CustShippingCity | Type string Properties Filter, Group, Nillable, Sort Description The shipping city of the customer. | | CustShippingCountry | Type string Properties Filter, Group, Nillable, Sort Description The shipping country of the customer. | | CustShippingGeocodeAccuracy | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Accuracy level of the geocoded shipping address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | CustShippingLatitude | Type double Properties Filter, Nillable, Sort Description The latitude geo-coordinate for customer shipping address. | | CustShippingLongitude | Type double Properties Filter, Nillable, Sort Description The longitude geo-coordinate for customer shipping address. | | CustShippingPostalCode | Type string Properties Filter, Group, Nillable, Sort Description The postal/zip code of the shipping address. | | CustShippingState | Type string Properties Filter, Group, Nillable, Sort Description The state of the customer shipping address. | | CustShippingStreet | Type textarea Properties Filter, Group, Nillable, Sort Description The street of the customer shipping address. | | CustomerBillingEmailAddress | Type email Properties Filter, Group, Nillable, Sort Description The default email address of the customer who receives billing details, used to seed new offers. This is typically someone in the accounting department. | | CustomerName | Type string Properties Filter, Group, Nillable, Sort Description Derived field. Returns the company name, which is stored in the Name field from the related SfdcCustomerForPartner record. | | CustomerPaymentTerms | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The terms of payment for the customer. Indicates that the customer has 30 days from the invoice date to pay for services. Provides invoice due date. Possible values are: - NET 30 The default value is NET 30. | | CustomerPurchaseOrderNumber | Type string Properties Filter, Group, Nillable, Sort Description The purchase order number that is internal to customer's organization and provided during private offer process. This value is added to the customer invoice. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | LicenseProvisionedStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status of the license provisioning process, indicating whether a license has been provisioned. Possible values are: - Error - Expired - New - Pending - Provisioned The default value is New. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the order. | | OfferAcceptedBy | Type string Properties Filter, Group, Nillable, Sort Description The first and last name of the user who accepted the offer. | | OrderNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The unique ID associated with the order. | | OrderPrebillDays | Type int Properties Filter, Group, Nillable, Sort Description Represents the number of days, before the service date, that an invoice is sent to a customer. Harcoded value is 1. | | OrderType | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of order, which indicates whether an order is net new or an addition to a previous order. Possible values are: - Add-On - Initial The default value is Initial. | | OriginatingOfferId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the partner offer that was accepted to originate this order. This field is a relationship field. Relationship Name OriginatingOffer Refers To SfdcPartnerOffer | | ParentOrderId | Type reference Properties Filter, Group, Nillable, Sort Description The associated initial order. Contains a value for non-initial order types, like add-on and reduction. This field is a relationship field. Relationship Name ParentOrder Refers To SfdcPartnerOrder | | PartnerOrderStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the order. Possible values are: - Activated - Error - Expired - New - Processing | | PartnerPurchaseOrderNumber | Type string Properties Filter, Group, Nillable, Sort Description Represents the purchase order number provided during the private offer creation process. This value is available to Salesforce and can be used by the partner to reconcile transactions, but isn't shared with the customer. | | PaymentMethod | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The possible payment methods available to the customer. Possible values are: - ACH The default value is ACH. | | SentByUserId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who sent the partner order. This field is a relationship field. Relationship Name SentByUser Refers To User | | ServiceEndDate | Type date Properties Filter, Group, Nillable, Sort Description Derived field. The date when the contract terms end. Service end date is calculated as ServiceStartDate + ContractTerm in months. | | ServiceStartDate | Type date Properties Filter, Group, Sort Description The date and time when the order is activated, if it is converted from an offer. | | ServiceTerm | Type double Properties Filter, Nillable, Sort Description Period between Service Start date and Service End date. | | SfdcCustomerForPartnerId | Type reference Properties Filter, Group, Nillable, Sort Description The customer associated with the order. This field is a relationship field. Relationship Name SfdcCustomerForPartner Refers To SfdcCustomerForPartner | | SfdcPartnerTermSetId | Type reference Properties Filter, Group, Nillable, Sort Description Partner term set associated with the offer. This field is a relationship field. Relationship Name SfdcPartnerTermSet Refers To SfdcPartnerTermSet | | SubTotal | Type currency Properties Filter, Nillable, Sort Description Derived field. Formula summing all offer item line item totals and the contract term. Excludes taxes. | | TermsAndConditions | Type textarea Properties Nillable Description The terms and conditions set forth by the partner. | | TotalProducts | Type int Properties Filter, Group, Nillable, Sort Description Derived field. The number of individual products in the order. This field is a calculated field. | # SfdcPartnerOrderBillingTrxn Represents the junction between SfdcPartnerOrder and SfdcPartnerBillingTrxn in a Partner Business Org (PBO). This allows for a many-to-many relationship between the two objects and is used as the customer facing link between Orders and Stripe invoice data. This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated transaction name that uses the format: SPOBT-{00000000}. | | PartnerBillingTransactionId | Type string Properties Filter, Group, Sort Description The Stripe invoice ID. This field is a relationship field. Relationship Name PartnerBillingTransaction Refers To SfdcPartnerBillingTrxn | | SfdcPartnerOrderId | Type reference Properties Filter, Group, Sort Description The ID of the associated partner order. This field is a relationship field. Relationship Name SfdcPartnerOrder Relationship Type Master-detail Refers To SfdcPartnerOrder (the master object) | # SfdcPartnerOrderItem Represents a line item within a partner order, including provisioning information and billing details from a customer's purchase, in a Partner Business Org (PBO). This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CustomerUnitPricePerMonth | Type currency Properties Create, Filter, Nillable, Sort, Update Description The customer unit price per month. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | LineItemPeriodTotal | Type currency Properties Filter, Nillable, Sort Description Derived field. The line item period total, calculated as CustomerUnitPricePerMonth \* Quantity. | | LineItemTotal | Type currency Properties Filter, Nillable, Sort Description Derived field. The line item total, calculated as CustomerUnitPricePerMonth \* Quantity \* ContractTerm on the Order object. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Auto-generated ID number for the order item. | | OrderItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Auto-generated order item number. | | PartnerOrderId | Type reference Properties Create, Filter, Group, Sort Description The associated partner order that this order item belongs to. This field is a relationship field. Relationship Name PartnerOrder Relationship Type Master-detail Refers To SfdcPartnerOrder (the master object) | | PartnerProvisionProductId | Type reference Properties Create, Filter, Group, Sort, Update Description A provisionable product included in this order item. This field is a relationship field. Relationship Name PartnerProvisionProduct Refers To SfdcPartnerProvisionProduct | | PartnerProvisionProductName | Type string Properties Filter, Group, Nillable, Sort Description Derived field. The name of the Partner Provision Product from SfdcPartnerProvisionProduct object. | | PartnerPurchaseOrderNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Partner purchase order number for this order item. | | PartnerTenantId | Type reference Properties Create, Filter, Group, Sort, Update Description The Salesforce org ID that purchased products from the partner. This field is a relationship field. Relationship Name PartnerTenant Refers To SfdcPartnerTenant | | ProvisionedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the order item is provisioned. | | ProvisionedDateSyncStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the provisioned date sync process. | | ProvisioningStatus | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. The provisioning status of the order item. Possible values are: - Error - Expired - New - Pending - Provisioned The default value is New. | | Quantity | Type int Properties Create, Filter, Group, Sort, Update Description Required. The number of units sold. | | ServiceDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date range when the service is active. Used to assist provisioning. | # SfdcPartnerPackage Represents a managed package owned by a partner in a Partner Business Org (PBO). This object is available in API version 64.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | Id | Type string Properties Defaulted on create, Filter, Group, idLookup, Sort Description System field. The unique identifier for the record. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The prefix of the namespace where this package lives. | | Package | Type string Properties Filter, Group, Nillable, Sort Description The external ID of the associated managed package. | | PackageName | Type string Properties Filter, Group, Nillable, Sort Description The public name of the associated package. | # SfdcPartnerPackageVersion Represents a released version of a first generation (1GP) or second generation (2GP) package in a Partner Business Org (PBO) with the Go-To-Market app enabled. This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | Id | Type string Properties Defaulted on create, Filter, Group, idLookup, Sort Description System field. The unique identifier for the record. | | IsSecondGeneration | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the package is 2GP. The default value is false. | | PackageVersion | Type string Properties Filter, Group, Nillable, Sort Description The 18-character external ID of the package version. | | PartnerPackageId | Type string Properties Filter, Group, Nillable, Sort Description The partner package from which this package version was created. This field is a relationship field. Relationship Name PartnerPackage Refers To SfdcPartnerPackage | | VersionName | Type string Properties Filter, Group, Nillable, Sort Description The version name of the package. | | VersionNumber | Type string Properties Filter, Group, Nillable, Sort Description The version number of the package. | # SfdcPartnerPayout Represents an invoice payout from Stripe to a partner in a Partner Business Org (PBO). This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | Amount | Type currency Properties Filter, Nillable, Sort Description The net amount of all invoices, subtracting the partner net revenue (PNR) and taxes, in a 30 day period. Value is shown in cents and must be converted to dollars. | | ArrivalDate | Type date Properties Filter, Group, Nillable, Sort Description The date that a partner can expect a payout to arrive in their designated bank account. The value factors in delays for weekends and bank holidays. | | BankAccountNumber | Type string Properties Filter, Group, Nillable, Sort Description The last four digits of the bank account number where the payout is sent. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The ISO code of the currency for the payout. | | DestinationBankName | Type string Properties Filter, Group, Nillable, Sort Description Name of the destination bank for the payout. | | ExternalId | Type string Properties Filter, Group, Nillable, Sort Description The external ID for the payout record from Stripe. | | Id | Type string Properties Defaulted on create, Filter, Group, idLookup, Sort Description System field. The unique identifier for the record. | | PayoutType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the payout. | | ReferenceToken | Type string Properties Filter, Group, Nillable, Sort Description The payout reference token from Stripe that appears on bank statements for reconciliation. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the payout. Possible values are: - Pending - In\_Transit - Failed | # SfdcPartnerPermSetLicense Represents a Permission Set License Definition (PSLD) from a released managed package in a Partner Business Org (PBO) with the Go-To-Market app enabled. This object is available in API version 66X.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description The external ID and developer name of the Permission Set License Definition (PSLD). | | Id | Type string Properties Defaulted on create, Filter, Group, idLookup, Sort Description System field. The unique identifier for the record. | | PartnerPackageId | Type string Properties Filter, Group, Nillable, Sort Description The associated package in which the PSLD is defined. This field is a relationship field. Relationship Name PartnerPackage Refers To SfdcPartnerPackage | # SfdcPartnerProductLicense Represents the mapping between a provisionable product and a package license or permission set licenses (PSL) in a Partner Business Org (PBO). This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | LicenseId | Type string Properties Create, Filter, Group, Sort, Update Description The ID of the license (package or PSL) being mapped to this product. This field is a polymorphic relationship field. Relationship Name License Refers To SfdcPartnerPackage, SfdcPartnerPermSetLicense | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated name of the license, with the format: PPL-{00000000}. | | PartnerProvisionProductId | Type reference Properties Create, Filter, Group, Sort, Update Description The associated provisionable product. This field is a relationship field. Relationship Name PartnerProvisionProduct Refers To SfdcPartnerProvisionProduct | | Quantity | Type int Properties Create, Filter, Group, Sort, Update Description Required. The quantity of mapped licenses. | # SfdcPartnerProvisionProduct Represents a product used to map licenses for customer provisioning in a Partner Business Org (PBO). This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the provisionable product. | | PartnerTermSetProductId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The partner term set product associated with this provisionable product. This field is a relationship field. Relationship Name PartnerTermSetProduct Refers To SfdcPartnerTermSetProduct | # SfdcPartnerSbscrOffer Represents a partner offer as seen by the customer in their subscriber org. Synced from Partner Business Org SfdcPartnerOffer record. This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | BillingFrequency | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The frequency that a customer is billed. A hardcoded value copied from the PBO. Possible values are: - 1—Monthly - 3—Quarterly - 6—Bi-annually - 12—Annually | | ContractTerm | Type int Properties Filter, Group, Nillable, Sort Description Term duration of the contract. Max value of 12 months. | | CustBillingAddress | Type address Properties Filter, Nillable Description The default billing address for the customer, used to seed the billing address into new offers. Compound field. | | CustBillingCity | Type string Properties Filter, Group, Nillable, Sort Description The customer billing city. | | CustBillingCountry | Type string Properties Filter, Group, Nillable, Sort Description The customer billing country. | | CustBillingGeocodeAccuracy | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Accuracy level of geocoded billing address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | CustBillingLatitude | Type double Properties Filter, Nillable, Sort Description The latitude geo-coordinate for customer billing address. | | CustBillingLongitude | Type double Properties Filter, Nillable, Sort Description The longitude geo-coordinate for customer billing address. | | CustBillingPostalCode | Type string Properties Filter, Group, Nillable, Sort Description The postal/zip code of the customer billing address. | | CustBillingState | Type string Properties Filter, Group, Nillable, Sort Description The state of the customer billing address. | | CustBillingStreet | Type textarea Properties Filter, Group, Nillable, Sort Description The street of the customer billing address. | | CustShippingAddress | Type address Properties Filter, Nillable Description The default shipping address of the partner's customer. Compound field. | | CustShippingCity | Type string Properties Filter, Group, Nillable, Sort Description The city of the customer shipping address. | | CustShippingCountry | Type string Properties Filter, Group, Nillable, Sort Description The country of the customer shipping address. | | CustShippingGeocodeAccuracy | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Accuracy level of geocoded shipping address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | CustShippingLatitude | Type double Properties Filter, Nillable, Sort Description The latitude geo-coordinate for customer shipping address. | | CustShippingLongitude | Type double Properties Filter, Nillable, Sort Description The longitude geo-coordinate for customer shipping address. | | CustShippingPostalCode | Type string Properties Filter, Group, Nillable, Sort Description The postal/zip code of the customer shipping address. | | CustShippingState | Type string Properties Filter, Group, Nillable, Sort Description The state of the customer shipping address. | | CustShippingStreet | Type textarea Properties Filter, Group, Nillable, Sort Description The street of the customer shipping address. | | CustomerBillingEmailAddress | Type email Properties Filter, Group, Nillable, Sort Description The email address used as the billing email address for the resulting order. Recieves the invoice and a copy of the offer. Typically, this person is in the finance department. | | CustomerEmailAddress | Type email Properties Filter, Group, Nillable, Sort Description Offer recipient who can approve or reject the offer. | | CustomerName | Type string Properties Filter, Group, Nillable, Sort Description The name of the customer company. | | CustomerPaymentTerms | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates that the customer has 30 days from the invoice date to pay for services. Possible values are: - NET 30 The default value is NET 30. | | CustomerPurchaseOrderNumber | Type string Properties Filter, Group, Nillable, Sort Description Customer provided purchase order number, which is added to an order upon offer acceptance. | | ExpirationDate | Type date Properties Filter, Group, Nillable, Sort Description The date the offer expires and the customer can't take further action. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. Auto-generated offer number copied from the PBO. | | OfferType | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Type of order that is created once the customer accepts the offer. Possible values are: - Add-On - Initial The default value is Initial. | | OrderPrebillDays | Type int Properties Filter, Group, Nillable, Sort Description Represents the number of days before the service date that an invoice is sent to the customer. | | PartnerCompanyName | Type string Properties Filter, Group, Nillable, Sort Description Name of the partner company. | | PartnerOffer | Type string Properties Filter, Group, Nillable, Sort Description 18 character ID of the corresponding PartnerOffer record in the PBO. | | PartnerOrg | Type string Properties Filter, Group, idLookup, Nillable, Sort Description 18 Character org ID where the offer originated. This field is automatically populated with the PBO ID. | | PaymentMethod | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The possible payment methods that customers can use to pay for their order. Possible values are: - ACH The default value is ACH. | | RespondingUserId | Type reference Properties Filter, Group, Nillable, Sort Description The user ID in the Subscriber Org that corresponds to the user that accepted or rejected the offer. This field is a relationship field. Relationship Name RespondingUser Refers To User | | ServiceEndDate | Type date Properties Filter, Group, Nillable, Sort Description Derived field. The date when the contract terms end. Service end date is calculated as ServiceStartDate + ContractTerm in months. | | ServiceStartDate | Type date Properties Filter, Group, Nillable, Sort Description The date and time when the order is activated, if it is converted from an offer. | | ServiceTerm | Type double Properties Filter, Nillable, Sort Description Period between Service Start date and Service End date. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the offer. Possible values are: - Accepted - Expired - New - Rejected - Void - Withdraw | | SubTotal | Type currency Properties Filter, Nillable, Sort Description Derived field. Formula summing all offer item line item totals and the contract term. Excludes taxes. | | SyncToPboError | Type string Properties Filter, Nillable, Sort Description Any error occurs during syncing. | | SyncToPboLastUpdate | Type dateTime Properties Filter, Nillable, Sort Description Tracks the timestamp of the last operation performed by the sync operation. | | SyncToPboStatus | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Status of the sync operation to the customer org. Possible values are: - Not ready - Ready - Processing - Sync Complete - Error The default value is Not ready. | | TermsAndConditions | Type textarea Properties Nillable Description The terms and conditions set forth by the partner. | # SfdcPartnerSbscrOfferItem Represents a line item within a partner subscriber offer. Includes all necessary information about the line-item being sold, including quantity and cost. This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | CustomerUnitPricePerMonth | Type currency Properties Filter, Nillable, Sort Description The price of each line item unit per month. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | LineItemPeriodTotal | Type currency Properties Filter, Nillable, Sort Description The total cost of the line item. Is equal to Quantity\* CustomerUnitPricePerMonth. | | LineItemTotal | Type currency Properties Filter, Nillable, Sort Description The total cost of the line item. Is equal to Quantity\* CustomerUnitPricePerMonth\*ContractTerm on the SfdcPartnerOffer object. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Auto-generated offer item number. | | PartnerProvisionProductName | Type string Properties Filter, Group, Nillable, Sort Description The Partner Provision Product being sold as part of this offer line item. Used for provisioning the order or commodity code for tax calculations. | | PartnerSubscriberOfferId | Type reference Properties Filter, Group, Sort Description Parent offer to which this line item belongs. This field is a relationship field. Relationship Name PartnerSubscriberOffer Relationship Type Master-detail Refers To SfdcPartnerSbscrOffer (the master object) | | Quantity | Type int Properties Filter, Group, Nillable, Sort Description Number of units being sold for this offer line item. | | ServiceStartDate | Type date Properties Filter, Group, Nillable, Sort Description The start date of the contract. Used to inform provisioning. | # SfdcPartnerTenant Represents a Salesforce org that contains information about a partner's customer's tenants and is stored in a Partner Business Org (PBO). This object is available in API version 64.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | CustomerId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the customer associated with this tenant. This field is a relationship field. Relationship Name Customer Refers To SfdcCustomerForPartner | | IsSandbox | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Derived field. Describes whether this tenant is a sandbox org. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the tenant record. | | Tenant | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Required. The core org 18 character ID. This field is unique within your organization. | | TenantStatus | Type string Properties Filter, Group, Nillable, Sort Description Derived field. The current status of the tenant. | | TimeZoneSidKey | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Derived field. The timezone of the tenant org. | # SfdcPartnerTenantPackage Represents a package installed in a tenant org and tracked in a Partner Business Org (PBO). This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | InstalledDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the package was initially installed. | | LastInstalledDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the package was last installed. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated name of the tenant package, in the format: PTP-{00000000}. | | PartnerPackageId | Type reference Properties Filter, Group, Sort Description The ID of the package that is installed in the tenant org. This field is a relationship field. Relationship Name PartnerPackage Refers To SfdcPartnerPackage | | PartnerPackageVersion | Type reference Properties Filter, Group, Sort Description The ackage version that is installed in the tenant org. This field is a relationship field. Relationship Name SfdcPartnerTenantPackageVersions Refers To SfdcPartnerPackageVersion | | PartnerTenantId | Type reference Properties Filter, Group, Sort Description The ID of the Salesforce org that installed the package. This field is a relationship field. Relationship Name PartnerTenant Refers To SfdcPartnerTenant | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The install status of the package in the tenant org. Possible values are: - i—Installed - u—Uninstalled | # SfdcPartnerTermSet Represents a set of contractual terms for a partner relationship. SfdcPartnerTermSet is a Partner Business Org (PBO) standard object storing partner contract terms that are propagated from the Channel Orders Application (COA). This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | CoaSyncTimestamp | Type dateTime Properties Filter, Nillable, Sort Description Timestamp that indicates when the PBO refreshed data from the COA. | | DefaultBillingFrequency | Type int Properties Filter, Group, Nillable, Sort Description Determines the default billing frequency in months for this channel contract. | | DefaultCancellationTerms | Type int Properties Filter, Group, Nillable, Sort Description Default number of days that the customer has to cancel an order. | | DefaultContractCurrency | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Determines the default currency for this channel contract. Possible values are: - AUD - EUR - GBP - INR - JPY - SEK - USD | | DefaultRenewalLength | Type int Properties Filter, Group, Nillable, Sort Description Default renewal length in months. | | IsDefaultContractAutoRenew | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Default value for whether a contracts auto-renews. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the partner term set. | | OverrideLevel | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Determines the level of override allowed for contract terms on orders. Possible values are: - Order | | PartnerApiKey | Type string Properties Filter, Group, Nillable, Sort Description The API Key for the channel contract record on used to validate a request. | | PartnerContractTerm | Type string Properties Filter, Group, Nillable, Sort Description Partner term set copied from the COA. | | PartnerContractTermPbo | Type string Properties Filter, Group, Nillable, Sort Description 18 character ID that references the PBO. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of the Partner Contract Terms record in the COA. Possible values are: - Active - Inactive - Retired | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of Partner Contract Terms record in the COA, which determines where the partner sells. Possible values are: - ISVForce\_TM | ## 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. [SfdcPartnerTermSetOwnerSharingRule](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. [SfdcPartnerTermSetShare](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. # SfdcPartnerTermSetProduct Represents a product within a partner term set. SfdcPartnerTermSetProduct is a Partner Business Org (PBO) standard object storing Partner Product Catalogue that are propagated from the Channel Orders Application (COA). This object is available in API version 66.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Records for this object shouldn't be created manually. All records sync from the COA. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields | Field | Details | | --- | --- | | CancellationTerms | Type int Properties Filter, Group, Nillable, Sort Description Controls the amount of time a customer has to cancel the contract in days. | | FloorPrice | Type currency Properties Filter, Nillable, Sort Description The minimum product price. | | IsContractAutoRenew | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Controls whether a contract associated with this product is set to auto renew or not. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the product. | | PartnerProductCatalog | Type string Properties Filter, Group, Sort Description Required. The 18 character ID of the associated Partner Product Catalog record in the COA. | | PartnerTermSetId | Type reference Properties Filter, Group, Sort Description Required. Associated Partner Term Set record from the COA. This field is a relationship field. Relationship Name PartnerTermSet Refers To SfdcPartnerTermSet | | Product | Type string Properties Filter, Group, Sort Description Required. Copied from the COA field Product ID. | | ProductDescription | Type textarea Properties Nillable Description Description of the partner product. | | ProductSpecialTerms | Type textarea Properties Nillable Description Special terms applicable to this product. | | RenewalTerms | Type int Properties Filter, Group, Nillable, Sort Description Represents the length of a renewed contract for this product in months. | | RevenueSharePercentage | Type percent Properties Filter, Nillable, Sort Description The percentage of net revenue that Salesforce receives from the sale of the product. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The current status of the partner product. Possible values are: - Active - Inactive - Retired | ## 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. [SfdcPartnerTermSetProductOwnerSharingRule](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. [SfdcPartnerTermSetProductShare](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. # SfdcPartnerTntPermSetLic Represents Permission Set License (PSL) tracking for a tenant package in a Partner Business Org (PBO). Used to track seats, expiration dates, and license statuses from both the management and subscriber org for PSLs. This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | ManagementExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the license expires for the management org. | | ManagementLicenseStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes whether the licenses from the management org have been provisioned. Possible values are: - Active - Free - Trial | | ManagementProvisionedSeats | Type int Properties Filter, Group, Nillable, Sort Description Number of seats provisioned from the partner org. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated name of the PSL in the format: PTPL-{00000000}. | | PartnerTenantPackageId | Type reference Properties Filter, Group, Sort Description The ID of the tenant package this PSL record belongs to. This field is a relationship field. Relationship Name PartnerTenantPackage Refers To SfdcPartnerTenantPackage | | SfdcPartnerPermSetLicenseId | Type string Properties Filter, Group, Sort Description The ID of the PSL definition being tracked. This field is a relationship field. Relationship Name SfdcPartnerPermSetLicense Refers To SfdcPartnerPermSetLicense | | SubscriberExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the license expires for the subscriber. | | SubscriberLicenseStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes whether the licenses for the subscriber have been provisioned. Possible values are: - Active - Free - Trial | | SubscriberProvisionedSeats | Type int Properties Filter, Group, Nillable, Sort Description The number of seats provisioned in the Subscriber Org. | | UsedSeats | Type int Properties Filter, Group, Nillable, Sort Description The number of seats for the license that have been assigned at the subscriber org. | # SfdcPartnerTntPkgLicense Represents package license tracking for a tenant package in a Partner Business Org (PBO). Used to track seats, expiration dates, and license statuses from both the Management and Subscriber org for package licenses. This object is available in API version 66.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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. | | ManagementExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the license expires for the management org. | | ManagementLicenseStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes whether the licenses from the management org have been provisioned. Possible values are: - Active - Free - Trial | | ManagementProvisionedSeats | Type int Properties Filter, Group, Nillable, Sort Description Number of seats provisioned from the partner org. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated name of the license in the format: PTL-{00000000}. | | PartnerTenantPackageId | Type reference Properties Filter, Group, Sort Description The ID of the tenant package this package license record belongs to. This field is a relationship field. Relationship Name PartnerTenantPackage Refers To SfdcPartnerTenantPackage | | SubscriberExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the license expires for the subscriber. | | SubscriberLicenseStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes whether the licenses for the subscriber have been provisioned. Possible values are: - Active - Free - Trial | | SubscriberProvisionedSeats | Type int Properties Filter, Group, Nillable, Sort Description The number of seats provisioned in the Subscriber Org. | | UsedSeats | Type int Properties Filter, Group, Nillable, Sort Description The number of seats for the license that have been assigned at the subscriber org. | # ShapeRepresentation Contains information about the shape of an org. The shape of an org includes licenses and limits information. You can easily create scratch orgs based on a source org’s shape. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A free-form text field for you to enter a description of this org shape. This field has a maximum length of 255 characters. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Date when the org shape was last referenced. This field is read-only. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date when the org shape was last viewed. This field is read-only. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The alias for the org shape. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Status of this org shape. You can use an org shape when it’s Active. This field is read-only. Possible values are: - Active - Error - InProgress - Inactive - New | # SharingRecordCollection Represents a collection of records. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() Record collections are limited to 100 items and 100 members for each record collection. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the record collection. | | GroupId | Type reference Properties Filter, Group, Nillable, Sort Description The group ID of the record collection. | | LastAdded | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when an item was last added to the record collection. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the record collection. | | NumberOfRecords | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of records in the record collection. The limit is 100. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the record collection owner. | # SharingRecordCollectionItem Represents a single record in a collection of records. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() Record collections are limited to 100 items for each record collection. ## Fields | Field | Details | | --- | --- | | CollectionId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related record collection. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the record collection item. | | ItemId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the record collection item. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the record collection item. | # SharingRecordCollectionMember Represents a user with access to a collection of records. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() Record collections are limited to 100 members for each record collection. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Read, Edit Description The access level on the related record collection. | | CollectionId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related record collection. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the user or group with access to the record collection. | # Shift Represents a shift for service resource scheduling. Available in API versions 46.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), upsert() ## Special Access Rules Field Service, Service Engagement, or Workforce Engagement must be enabled. For Field Service, users must have Field Service permissions. For Service Engagement, users must have the Service Engagement Planner permission set. For Workforce Engagement, users must have the Workforce Engagement Admin or Planner permission set. ## Fields | Field | Details | | --- | --- | | BackgroundColor | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Sets a background color when shifts are displayed in the UI. Use a 3- or 6-digit hexadecimal format, for example #FF00FF. Available in API version 54.0 and later. | | EndTime | Type dateTime Properties Create, Filter, Sort, Update Description The date and time that the shift ends. | | IsHolidayShift | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates a shift that overlaps with holiday hours. The default value is false. Available in API version 55.0 and later. | | IsNonStandard | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift is nonstandard, such as overtime or on-call shifts. The default value is false. Available in API version 54.0 and later. | | JobProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The job profile associated with the shift. Available in API versions 47.0 and later. | | Label | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The label that a shift is given. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the current user last viewed a related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the current user last viewed this record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the shift. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RecordsetFilterCriteriaId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the recordset filter criteria selected for the shift. Available in API version 49.0 and later. This is a relationship field. Relationship Name RecordsetFilterCriteria Relationship Type Lookup Refers To RecordsetFilterCriteria | | ServiceResourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service resource the shift belongs to. Available in API versions 47.0 and later. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service territory the shift belongs to. Available in API versions 47.0 and later. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | ShiftNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The number automatically given to the shift upon creation. | | ShiftTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The shift template ID, if the shift was created from a shift template. Available in API version 53.0 and later. This is a relationship field. Relationship Name ShiftTemplate Relationship Type Lookup Refers To ShiftTemplate | | StartTime | Type dateTime Properties Create, Filter, Sort, Update Description The date and time that the shift starts. | | Status | Type picklist Properties Create, Filter, Group, Sort, Update Description Describes the status of the shift. Users can create custom values. Default values are: - Tentative - Published - Confirmed | | StatusCategory | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes the status of the shift using static values. This field is derived from Status using the mapping defined in setup. Possible values are: - Tentative - Published - Confirmed | | TimeSlotType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Type of time slot for the shift. The same setup values as the TimeSlot field in the OperatingHours object. Possible values are: - Normal (default value) - Extended | ## Usage Scheduling and dispatching service resources using shift data is not supported in API version 46.0, and is a pilot feature in API version 47.0. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ShiftChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 54.0) Change events are available for the object. [ShiftFeed](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. [ShiftHistory](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. [ShiftOwnerSharingRule](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. [ShiftShare](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. # ShiftHistory Represents the history of changes made to tracked fields on a time sheet. Available in API versions 46.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules Field Service must be enabled in your organization, and field tracking for shift fields must be configured. ## Fields | Field | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The value of the field before it was changed. | | ShiftId | Type reference Properties Filter, Group, Sort Description ID of the shift being tracked. The history is displayed on the detail page for this record. This is a relationship field. Relationship Name Shift Relationship Type Lookup Refers To Shift | ## Usage Scheduling and dispatching service resources using shift data is not supported in API version 46.0. # ShiftOwnerSharingRule Represents the rules for sharing a shift with user records other than the owner or anyone above the owner in the role hierarchy. Available in API versions 46.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. | | 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 org. 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. Corresponds to **Rule Name** in the user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. A time sheet owned by a User in the source Group triggers the rule to give access. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | ServiceResourceAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group, or UserRole. The possible values are: - Read - Edit - All | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access. | ## Usage Scheduling and dispatching service resources using shift data is not supported in API version 46.0. # ShiftPattern Represents a pattern of templates for creating shifts. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. Users must have Field Service permission. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description A short description of the shift pattern to help users identify the pattern. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the shift pattern can be used to create shifts. The default value is ‘false’. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the shift pattern was last used. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the shift pattern was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description A short, descriptive name of the shift pattern. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the shift pattern. Default is the user who creates the shift pattern. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PatternLength | Type int Properties Create, Filter, Group, Sort, Update Description The duration in days of the shift pattern. | ## 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. [ShiftPatternChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 54.0) Change events are available for the object. [ShiftPatternFeed](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. [ShiftPatternHistory](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. [ShiftPatternShare](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. #### See Also - [ShiftPatternEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftpatternentry.htm "ShiftPatternEntry links a shift template to a shift pattern. This object is available in API version 51.0 and later.") - [Shift Patterns](https://help.salesforce.com/articleView?id=fs_shift_patterns.htm&language=en_US "Shift Patterns - HTML (New Window)") # ShiftPatternEntry ShiftPatternEntry links a shift template to a shift pattern. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. Users must have Field Service permission. ## Fields | Field | Details | | --- | --- | | DayOrder | Type int Properties Create, Filter, Group, Sort, Update Description DayOrder links the shift template to the specific day within the shift pattern duration that the template. For example, if the DayOrder is 2 then a shift from the associated template is created on the second day of the pattern. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the shift pattern entry was last used. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the shift pattern entry was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated reference number for the shift pattern entry. | | ShiftPatternId | Type reference Properties Create, Filter, Group, Sort Description The ID of the shift pattern that the shift pattern entry is linked to. This is a relationship field. Relationship Name ShiftPattern Relationship Type Lookup Refers To ShiftPattern | | ShiftTemplateId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the shift template that’s used to create shifts for this shift pattern entry. This is a relationship field. Relationship Name ShiftTemplate Relationship Type Lookup Refers To ShiftTemplate | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ShiftPatternEntryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 54.0) Change events are available for the object. #### See Also - [ShiftPattern](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftpattern.htm "Represents a pattern of templates for creating shifts. This object is available in API version 51.0 and later.") # ShiftSegment Represents a scheduled activity within a shift. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license and Workforce Engagement must be enabled. The user requires the Workforce Engagement Planner or Workforce Engagement Admin permission set. ## Fields | Field | Details | | --- | --- | | EndTime | Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the shift segment ends. | | IsInAdherence | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the agent is in adherence (true) or not (false) for the scheduled segment activity. The default value is true. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the shift segment. | | SegmentTypeId | Type reference Properties Create, Filter, Group, Sort, Update Description The unique ID of the associated shift segment type. This is a relationship field. Relationship Name SegmentType Relationship Type Lookup Refers To ShiftSegmentType | | ShiftId | Type reference Properties Create, Filter, Group, Sort Description The unique ID of the shift in which the segment is scheduled. This is a relationship field. Relationship Name Shift Relationship Type Lookup Refers To Shift | | StartTime | Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the shift segment starts. | # ShiftSegmentType Represents a type of activity scheduled within a shift. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license and Workforce Engagement must be enabled. The user requires the Workforce Engagement Planner or Workforce Engagement Admin permission set. ## Fields | Field | Details | | --- | --- | | AdherenceThreshold | Type int Properties Create, Filter, Group, Sort, Update Description A threshold, in minutes. If the agent starts the scheduled activity within this threshold, the shift segment activity is in adherence. | | Category | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A category for the type of shift segment. Possible values are: - Break—Break times, such as a coffee or lunch break. - NonWork—Non-working activities, such as training or meetings. - Work—Work activities, such as answering calls, responding to chats, or handling cases. | | Color | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Sets a background color when shift activities of this type are displayed in the UI. Use a 3- or 6-digit hexadecimal format, for example #FF00FF. | | Description | Type textarea Properties Create, Nillable, Update Description A description of the shift segment type. | | DeveloperName | Type string Properties 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the shift segment type is active (true) or not (false). The default value is true. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the shift segment type. Possible values are the languages that Workforce Engagement supports. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The label of the shift segment type. | | ServicePresenceStatusId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique ID of the associated service presence status for segments of this type. This is a relationship field. Relationship Name ServicePresenceStatus Relationship Type Lookup Refers To ServicePresenceStatus | # ShiftShare Represents a sharing entry on a field service shift. Available in API versions 46.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the shift. The possible values are: - Read - Edit - All (This value isn’t valid for create or update calls.) Set to an access level that is at least equal to the organization’s default shift access level. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The shift associated with the sharing entry. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Shift | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Manual—The User or Group has access because a user with “All” access manually shared the shift record. - Owner—The User is the owner of the shift. - Rule—The User or Group has access via a shift sharing rule. - GuestRule—The User or Group has access via a shift guest user sharing rule. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description (Read only) ID of the user or group that has access to the shift record. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage Scheduling and dispatching service resources using shift data is not supported in API version 46.0. # ShiftStatus Represents a shift, such as Tentative, Published, or Confirmed. Available in API versions 46.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an ID or master label. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default shift status value (true) or not (false) in the picklist. Only one value can be the default value. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Master label for this shift status value. This display value is the internal label that does not get translated. Limit: 255 characters. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the shift status picklist. These numbers are not guaranteed to be sequential, as some previous shift status values might have been deleted. | | StatusCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes the status of the shift using static values. Possible values are: - Tentative - Published - Confirmed | ## Usage Scheduling and dispatching service resources using shift data is not supported in API version 46.0. # ShiftTemplate Represents a template for creating shifts. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Field Service or Workforce Engagement must be enabled. For Field Service, users must have Field Service permission. For Workforce Engagement, the user needs to have a Workforce Engagement Admin or Planner permission set. ## Fields | Field | Details | | --- | --- | | BackgroundColor | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Sets a background color when shifts are displayed in the UI. Use a 3- or 6-digit hexadecimal format, for example #FF00FF. Available in API version 54.0 and later. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Additional information about the shift like number of breaks or activities. | | Duration | Type double Properties Create, Filter, Sort, Update Description How long the shift lasts. The unit of measurement for this field is determined by ShiftTemplateDurationType. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift is active or inactive. | | IsNonStandard | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift is nonstandard, such as overtime or on-call shifts. The default value is false. Available in API version 54.0 and later. | | JobProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Job Profile record. This field is optional. This is a relationship field. Relationship Name JobProfile Relationship Type Lookup Refers To JobProfile | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the shift template was last modified. Its label in the user interface is **Last Modified Date**. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the shift template was last viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The shift template record name. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the shift template. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RecordsetFilterCriteriaId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the recordset filter criteria selected for the shift template. Available in API version 53.0 and later. This is a relationship field. Relationship Name RecordsetFilterCriteria Relationship Type Lookup Refers To RecordsetFilterCriteria | | ShiftTemplateDurationType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The unit of measurement for the shift template duration. Possible values are: - H—Hours - M—Minutes The default value is H. | | StartTime | Type time Properties Create, Filter, Sort, Update Description The time of day when the shift starts. | | TimeSlotType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of time slot. Possible values are: - Normal - Extended You can use Extended to represent overtime shifts. Available in API version 55.0 and later. | ## 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. [ShiftTemplateOwnerSharingRule](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. [ShiftTemplateShare](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. [ShiftTemplateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change Data Capture events are available for the object. Available in API version 54.0 and later. # Shipment Represents the transport of inventory in field service or a shipment of order items in Order Management. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules At least one of these features must be enabled: - Order Management - Field Service - B2B Commerce - Consumer Goods Cloud Retail Execution ## Fields | Field Name | Details | | --- | --- | | ActualDeliveryDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product was delivered. | | DeliveredToId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The person or entity the product was delivered to. This is a polymorphic relationship field. Relationship Name DeliveredTo Relationship Type Lookup Refers To Group, User | | DeliveryMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The delivery method used for the shipment. This field is available in API version 51.0 and later. | | Description | Type textarea Properties Create, Nillable, Update Description Details not recorded in the provided fields | | DestinationLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The place the product is to be delivered. This is a relationship field. Relationship Name DestinationLocation Relationship Type Lookup Refers To Location | | ExpectedDeliveryDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product is expected to be delivered. | | FulfillmentOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The fulfillment order that the shipment belongs to. This field is available in API version 51.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OrderSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order summary associated with the shipment. This field is available in API version 51.0 and later. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the shipment. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Provider | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The company or person making the transfer. | | ReturnOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description For a return Shipment, the associated ReturnOrder. This field is available in API version 53.0 and later. | | ShipFromAddress | Type address Properties Filter, Nillable Description The place the product is coming from. The compound form of the ship to address. Read-only. For details on compound address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | ShipFromCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address where the shipment originates. | | ShipFromCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address where the shipment originates. | | ShipFromGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address where the shipment originates. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | ShipFromLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the shipment originates. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | ShipFromLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the shipment originates. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | ShipFromPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the shipment originates. | | ShipFromState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address where the shipment originates. | | ShipFromStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the address where the shipment originates. | | ShipToAddress | Type address Properties Filter, Nillable Description The physical address where the shipment is delivered. The compound form of the ship to address. Read-only. For details on compound address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | ShipToCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address where the shipment is delivered. | | ShipToCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address where the shipment is delivered. | | ShipToGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address where the shipment is delivered. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | ShipToLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the shipment is delivered. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | ShipToLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the shipment is delivered. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | ShipToName | Type string Properties Create, Filter, Group, Sort, Update Description The shipment recipient. | | ShipToPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the shipment is delivered. | | ShipToState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address where the shipment is delivered. | | ShipToStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the address where the shipment is delivered. | | ShipmentNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the shipment. | | SourceLocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The field service location where the shipment originates. This is a relationship field. Relationship Name SourceLocation Relationship Type Lookup Refers To Location | | Status | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The status of the shipment. The picklist includes the following values, which can be customized: - Created—Shipment has been created. - Delivered—Shipment has been delivered. - In Transit—Shipment is in transit. - Shipped—Order has been shipped. - Voided—Shipment has been cancelled. | | TotalItemsQuantity | Type double Properties Filter, Nillable, Sort Description The total quantity of items included in the shipment. This value is calculated as the sum of the quantities of the shipment items in the shipment. This field is available in API version 51.0 and later. | | TrackingNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Tracking number for the shipment. | | TrackingUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description URL of website used for tracking the shipment. | ## 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. [ShipmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ShipmentFeed](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. [ShipmentHistory](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. [ShipmentOwnerSharingRule](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. [ShipmentShare](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. #### See Also - [ShipmentItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shipmentitem.htm "Represents an order item included in a shipment. This object is available in API version 51.0 and later.") # ShipmentItem Represents an order item included in a shipment. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules At least one of these features must be enabled: - Order Management - Field Service - B2B Commerce - Health Cloud Visit Inventory - Consumer Goods Cloud Retail Execution ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the shipment item. | | ExpectedDeliveryDate | Type dateTime Properties Filter, Nillable, Sort Description Expected delivery date of the shipment that contains the shipment item. | | FulfillmentOrderLineItemId | Type reference Properties Filter, Nillable, Sort Description The FulfillmentOrderLineItem (fulfillment order product) corresponding to the shipment item. | | OrderItemSummaryId | Type reference Properties Filter, Nillable, Sort Description The OrderItemSummary (order product summary) corresponding to the shipment item. | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product represented by the shipment item. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | Quantity | Type double Properties Create, Filter, Sort, Update Description The quantity of products represented by the shipment item. | | ReturnOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description For a return ShipmentItem, the associated ReturnOrderLineItem. This field is available in API version 53.0 and later. | | ShipmentId | Type reference Properties Create, Filter, Group, Sort Description (Master-Detail) The shipment that contains the shipment item. This is a relationship field. Relationship Name Shipment Relationship Type Lookup Refers To Shipment | | ShipmentItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the shipment item. | | TrackingNumber | Type string Properties Filter, Group, Nillable, Sort Description The tracking number of the shipment that contains the shipment item. | | TrackingUrl | Type url Properties Filter, Group, Nillable, Sort Description The tracking URL of the shipment that contains the shipment item. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ShipmentItemFeed](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. [ShipmentItemHistory](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. #### See Also - [Shipment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shipment.htm "Represents the transport of inventory in field service or a shipment of order items in Order Management.") - [FulfillmentOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderlineitem.htm "Represents a product or delivery charge belonging to a FulfillmentOrder. Corresponds to an OrderItemSummary. This object is available in API version 48.0 and later.") # ShippingCarrier Shipping company or carrier responsible for transporting goods or packages. Examples include UPS, FedEx, and USPS. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The ShippingCarrier object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | ExternalReference | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Unique code, reference, or identifier for the shipping carrier associated with the delivery. Can be used for internal tracking or integration purposes. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the record was last viewed. | | ManagedShippingCarrier | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Salesforce-managed shipping carrier information that provides estimated transit times. This field is available in API version 65.0 and later. Possible values are: - FEDEX - UPS - USPS | | Name | Type text Properties Create, Filter, Group, Sort, Update Description Name of the shipping carrier associated with the delivery. | | ShipFromCountry | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Country where the shipment originates. This field is available in API version 65.0 and later. Possible values are: - AD—Andorra - AE—United Arab Emirates - AF—Afghanistan - AG—Antigua and Barbuda - AI—Anguilla - AL—Albania - AM—Armenia - AO—Angola - AQ—Antarctica - AR—Argentina - AS—American Samoa - AT—Austria - AU—Australia - AW—Aruba - AX—Aland Islands - AZ—Azerbaijan - BA—Bosnia and Herzegovina - BB—Barbados - BD—Bangladesh - BE—Belgium - BF—Burkina Faso - BG—Bulgaria - BH—Bahrain - BI—Burundi - BJ—Benin - BL—Saint Barthélemy - BM—Bermuda - BN—Brunei Darussalam - BO—Bolivia, Plurinational State of - BQ—Bonaire, Sint Eustatius and Saba - BR—Brazil - BS—Bahamas - BT—Bhutan - BV—Bouvet Island - BW—Botswana - BY—Belarus - BZ—Belize - CA—Canada - CC—Cocos (Keeling) Islands - CD—Congo, the Democratic Republic of the - CF—Central African Republic - CG—Congo - CH—Switzerland - CI—Cote d'Ivoire - CK—Cook Islands - CL—Chile - CM—Cameroon - CN—China - CO—Colombia - CR—Costa Rica - CU—Cuba - CV—Cape Verde - CW—Curaçao - CX—Christmas Island - CY—Cyprus - CZ—Czechia - DE—Germany - DJ—Djibouti - DK—Denmark - DM—Dominica - DO—Dominican Republic - DZ—Algeria - EC—Ecuador - EE—Estonia - EG—Egypt - EH—Western Sahara - ER—Eritrea - ES—Spain - ET—Ethiopia - FI—Finland - FJ—Fiji - FK—Falkland Islands (Malvinas) - FM—Micronesia - FO—Faroe Islands - FR—France - GA—Gabon - GB—United Kingdom - GD—Grenada - GE—Georgia - GF—French Guiana - GG—Guernsey - GH—Ghana - GI—Gibraltar - GL—Greenland - GM—Gambia - GN—Guinea - GP—Guadeloupe - GQ—Equatorial Guinea - GR—Greece - GS—South Georgia and the South Sandwich Islands - GT—Guatemala - GU—Guam - GW—Guinea-Bissau - GY—Guyana - HK—Hong Kong SAR China - HM—Heard Island and McDonald Islands - HN—Honduras - HR—Croatia - HT—Haiti - HU—Hungary - ID—Indonesia - IE—Ireland - IL—Israel - IM—Isle of Man - IN—India - IO—British Indian Ocean Territory - IQ—Iraq - IR—Iran, Islamic Republic of - IS—Iceland - IT—Italy - JE—Jersey - JM—Jamaica - JO—Jordan - JP—Japan - KE—Kenya - KG—Kyrgyzstan - KH—Cambodia - KI—Kiribati - KM—Comoros - KN—Saint Kitts and Nevis - KP—Korea, Democratic People's Republic of - KR—Korea, Republic of - KW—Kuwait - KY—Cayman Islands - KZ—Kazakhstan - LA—Lao People's Democratic Republic - LB—Lebanon - LC—Saint Lucia - LI—Liechtenstein - LK—Sri Lanka - LR—Liberia - LS—Lesotho - LT—Lithuania - LU—Luxembourg - LV—Latvia - LY—Libya - MA—Morocco - MC—Monaco - MD—Moldova, Republic of - ME—Montenegro - MF—Saint Martin (French part) - MG—Madagascar - MH—Marshall Islands - MK—North Macedonia - ML—Mali - MM—Myanmar - MN—Mongolia - MO—Macao - MP—Northern Mariana Islands - MQ—Martinique - MR—Mauritania - MS—Montserrat - MT—Malta - MU—Mauritius - MV—Maldives - MW—Malawi - MX—Mexico - MY—Malaysia - MZ—Mozambique - NA—Namibia - NC—New Caledonia - NE—Niger - NF—Norfolk Island - NG—Nigeria - NI—Nicaragua - NL—Netherlands - NO—Norway - NP—Nepal - NR—Nauru - NU—Niue - NZ—New Zealand - OM—Oman - PA—Panama - PE—Peru - PF—French Polynesia - PG—Papua New Guinea - PH—Philippines - PK—Pakistan - PL—Poland - PM—Saint Pierre and Miquelon - PN—Pitcairn - PR—Puerto Rico - PS—Palestine - PT—Portugal - PW—Palau - PY—Paraguay - QA—Qatar - RE—Reunion - RO—Romania - RS—Serbia - RU—Russian Federation - RW—Rwanda - SA—Saudi Arabia - SB—Solomon Islands - SC—Seychelles - SD—Sudan - SE—Sweden - SG—Singapore - SH—Saint Helena, Ascension and Tristan da Cunha - SI—Slovenia - SJ—Svalbard and Jan Mayen - SK—Slovakia - SL—Sierra Leone - SM—San Marino - SN—Senegal - SO—Somalia - SR—Suriname - SS—South Sudan - ST—Sao Tome and Principe - SV—El Salvador - SX—Sint Maarten (Dutch part) - SY—Syrian Arab Republic - SZ—Eswatini - TC—Turks and Caicos Islands - TD—Chad - TF—French Southern Territories - TG—Togo - TH—Thailand - TJ—Tajikistan - TK—Tokelau - TL—Timor-Leste - TM—Turkmenistan - TN—Tunisia - TO—Tonga - TR—Türkiye - TT—Trinidad and Tobago - TV—Tuvalu - TW—Taiwan - TZ—Tanzania, United Republic of - UA—Ukraine - UG—Uganda - UM—U.S. Outlying Islands - US—United States - UY—Uruguay - UZ—Uzbekistan - VA—Holy See (Vatican City State) - VC—Saint Vincent and the Grenadines - VE—Venezuela, Bolivarian Republic of - VG—Virgin Islands, British - VI—U.S. Virgin Islands - VN—Vietnam - VU—Vanuatu - WF—Wallis and Futuna - WS—Samoa - YE—Yemen - YT—Mayotte - ZA—South Africa - ZM—Zambia - ZW—Zimbabwe | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who currently owns this ShippingCarrier object. Default value is the user logged in to the API to perform the create. This is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | # ShippingCarrierMethod Shipping service provided by a shipping carrier. Examples include Ground, 2Day, and NextDay. Service depends on the range of transit times available for each carrier. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The ShippingCarrierMethodId object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | ExternalReference | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Unique code, reference, or identifier for the shipping carrier associated with the delivery. Can be used for internal tracking or integration purposes. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the record was last viewed. | | ManagedShippingCarrierMethod | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Salesforce-managed shipping carrier method that provides estimated transit times. This field is available in API version 65.0 and later. | | MaxTransitTime | Type integer Properties Create, Filter, Group, Sort, Update Description Maximum amount of time required for the carrier to transport and deliver an order. Measured in a specific unit, such as days, hours, or weeks. For example, if the maximum transit time is set to 3, the carrier takes no more than 3 units of the specified transit time unit to deliver the order. | | MinTransitTime | Type integer Properties Create, Filter, Group, Nillable, Sort, Update Description Minimum amount of time required for the carrier to transport and deliver an order. Measured in a specific unit, such as days, hours, or weeks. For example, if the minimum transit time is set to 1, the carrier takes at least 1 unit of the specified transit time unit to deliver the order. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the shipping carrier associated with the delivery. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who currently owns this ShippingCarrierMethod object. Default value is the user logged in to the API to perform the create. This is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ShippingCarrierId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Id of the company or service responsible for transporting and delivering the order to the customer. This is a relationship field. Relationship Name ShippingCarrier Refers To ShippingCarrier | | ShippingScope | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of shipping carrier method. This field is available in API version 65.0 and later. Possible values are: - Domestic - DomesticAndInternational - International The default value is Domestic. | | TransitTimeUnit | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Unit of measurement used for transit time. Specifies the time interval in which the minimum and maximum transit times are expressed. The available options are: - Days - Hours - Weeks | # ShippingConfigSetProduct Represents a product associated with a shipping configuration. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The ShippingConfigSetProduct object is available only if you've a B2B Commerce or D2C Commerce license and the MultipleShippingProfile org perm is enabled. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the shipping configuration set product record. | | Product2Id | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the Product2 record that is associated with shipping configuration set record. This field is a relationship field. Relationship Name Product2 Refers To Product2 | | ShippingProfileId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the shipping profile. This field is a relationship field. Relationship Name ShippingProfile Relationship Type Master-detail Refers To ShippingConfigurationSet (the master object) | # ShippingConfigurationSet Shipping configuration for a set of products in a store. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The ShippingConfigurationSet object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shipping configuration is the default (True) or not (False). The default value is False. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the shipping configuration set. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the shipping configuration owner. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ProcessTime | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The amount of time to process an order before it is ready to ship. The default value is 1 Day. | | ProcessTimeUnit | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Unit of time to process an order. Possible values are: - Days - Hours - Weeks | | TargetRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the target record. This field is a relationship field. Relationship Name TargetRecord Relationship Type Lookup Refers To WebStore | # ShippingRateArea A designated geographical area that’s available for shipping. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The ShippingRateArea object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | Countries | Type textarea Properties Create, Nillable, Update Description Countries in the shipping rate area. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the shipping rate area. | | Regions | Type textarea Properties Create, Nillable, Update Description Reserved for future use. | | ShippingRateGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the shipping rate group This field is a relationship field. Relationship Name ShippingRateGroup Relationship Type Lookup Refers To ShippingRateGroup | # ShippingRateGroup Available shipping rates based on shipping destination. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The ShippingRateGroup object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the shipping rate group. | | ShippingProfileId | Type reference Properties Create, Filter, Group, Sort Description ID of the shipping profile. This field is a relationship field. Relationship Name ShippingProfile Relationship Type Lookup Refers To ShippingConfigurationSet | # SignupRequest Represents a request for a new sign-up. SignupRequest isn’t supported in sandbox instances and will result in an error. This object is available in API version 27.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You’re limited to 20 sign-ups per day. To make additional sign-ups, log a support case in the [Salesforce Partner Community](https://partners.salesforce.com "HTML (New Window)"). For product, specify **Sales**. For topic, specify **AppExchange & Managed Packages**. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Fields | Field Name | Details | | --- | --- | | AuthCode | Type string Properties Create, Filter, Group, Sort Description A one-time authorization code that can be exchanged for an OAuth access token and refresh token using standard Salesforce APIs. It’s used with ConnectedAppCallbackUrl and ConnectedAppConsumerKey when the specified connected app hasn’t been configured with an X.509 certificate. The system provides this read-only field after the sign-up request has been processed. This field is available in API version 29.0 and later. | | Company | Type string Properties Create, Filter, Group, Sort Description The name of the company requesting the trial sign-up. | | ConnectedAppCallbackUrl | Type string Properties Create, Filter, Group, Sort Description When used with ConnectedAppConsumerKey, specifies a connected app that’s approved automatically during the sign-up creation. This field is available in API version 28.0 and later. | | ConnectedAppConsumerKey | Type string Properties Create, Filter, Group, Sort Description When used with ConnectedAppCallbackUrl, specifies a connected app that’s approved automatically during the sign-up creation. This field is available in API version 28.0 and later. | | Country | Type string Properties Create, Filter, Group, Sort Description The default value is the country of the requesting org. To override the default, enter the two-character, uppercase ISO-3166 country code (Alpha-2 code). A complete list of the codes is located at [https://www.iso.org/obp/ui/#search](https://www.iso.org/obp/ui/#search). The language of the trial org is auto-determined based on the value of this field. | | CreatedOrgId | Type string Properties Filter, Group, Nillable, Sort Description The 15-character org ID of the trial org created. The system provides this read-only field after the sign-up request has been processed. | | CreatedOrgInstance | Type string Properties Filter, Group, Nillable, Sort Description The server instance of the new trial org, for example, “na8.” This field is available in API version 29.0 and later. | | Edition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The Salesforce template that is used to create the trial org. Possible values are Partner Group, Professional, Partner Professional, Sales Enterprise, Professional TSO, Enterprise, Partner Enterprise, Service Professional, Enterprise TSO, Developer, and Partner Developer. This field is available in API version 35.0 and later. | | ErrorCode | Type string Properties Filter, Group, Nillable, Sort Description The error code if the sign-up request isn’t successful. The system provides this read-only field for support purposes. | | FirstName | Type string Properties Create, Filter, Nillable, Sort Description The first name of the admin user for the trial sign-up. | | LastName | Type string Properties Create, Filter, Group, Sort Description The last name of the admin user for the trial sign-up. | | PreferredLanguage | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the trial org being created. Specify the language using a language code listed under Fully Supported Languages in [Supported Languages](https://help.salesforce.com/articleView?id=faq_getstart_what_languages_does.htm&type=5&language=en_US) in Salesforce Help. For example, use zh\_CN for simplified Chinese. The value you select overrides the language set by the locale. If you specify an invalid language, the org defaults to the default language of the country. Likewise, if you specify a language that isn’t supported by the Salesforce edition associated with your trial template, the trial org defaults to the default language of the country. This field is available in API version 35.0 and later. | | ResolvedTemplateId | Type string Properties Filter, Group, Nillable, Sort Description Populated during the sign-up request and for internal use by Salesforce. This field is available in API version 35.0 and later. | | ShouldConnectToEnvHub | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description When set to true, the trial org is connected to the Environment Hub. The sign-up must take place in the hub main org or a spoke org. This field is available in API version 35.0 and later. | | SignupEmail | Type email Properties Create, Filter, Group, Sort Description The email address of the admin user for the trial sign-up. | | SignupSource | Type string Properties Create, Filter, Group, Nillable, Sort Description A user-specified description of the trial sign-up, up to 60 characters. This field is available in API version 36.0 and later. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Sort, Update Description The status of the request. Possible values are New, In Progress, Error, or Success. The default is New. | | Subdomain | Type string Properties Create, Filter, Group, Sort Description The My Domain name for the new trial org used in the org’s login and application URLs. In Developer Edition orgs, your name must contain at least 3 characters and no more than 27 characters. In all other editions, it must be at least 3 characters and no more than 34 characters. It can include letters, numbers, and hyphens, but you can’t start the name with a hyphen. If you don’t choose a My Domain during sign-up, Salesforce assigns one for you based on your company name. If you don’t like the one we set, you can change it. For details, see [My Domain](https://help.salesforce.com/articleView?id=domain_name_overview.htm&language=en_US) in Salesforce Help. | | SuppressSignupEmails | Type boolean Properties Filter, Group, Nillable, Sort Description When set to true, no sign-up emails are sent when the trial org is created. This field is used for the Proxy Signup feature and is available in API version 29.0 and later. | | TemplateId | Type string Properties Create, Filter, Group, Nillable, Sort Description The 15-character ID of the Trialforce template that is the basis for the trial sign-up. Salesforce must approve the template. If you don’t specify an edition, a template ID is required. | | TrialDays | Type anyType Properties Create, Defaulted on create, Filter, Group, Sort Description The duration of the trial sign-up in days. Must be equal to or less than the trial days for the approved Trialforce template. If not provided, it defaults to the trial duration specified for the Trialforce template. | | TrialSourceOrgId | Type string Properties Filter, Group, Nillable, Sort Description The 15-character org ID of the Trialforce Source Organization (TSO) from which the Trialforce template was created. | | Username | Type string Properties Create, Filter, Group, Sort Description The username of the admin user for the trial sign-up. It must follow the address convention specified in RFC822: [www.w3.org/Protocols/rfc822/#z10](http://www.w3.org/Protocols/rfc822/#z10). | ## Usage The Java class uses REST API to create a SignupRequest object. It authenticates to the Trialforce Management Organization (TMO) and then posts a request to the SignupRequest object. Here are the variables to specify in this example. - SERVER—The name of the host server for the TMO, for example, yourInstance.salesforce.com. - USERNAME—The admin username for the TMO. - PASSWORD—The concatenation of the admin password and the security token for the TMO. To get an email with the security token, from your personal settings in Salesforce, select **Reset My Security Token** and click **Reset Security Token**. - CLIENT\_ID—From Setup in Salesforce, in the Quick Find box, enter Apps, and then select **Apps**. Under Connected Apps, click **New**. Enter values for the required fields (Callback URL is required, but you can initially set it to any valid URL because it’s not used). Grant full access for the OAuth scopes in the Selected OAuth Scopes selector, and click **Save**. Then copy the value of Consumer Key and use it for this variable. - CLIENT\_SECRET—On the same page, click **Click to reveal**. Then copy the value of Consumer Secret and use it for this variable. public class IsvSignupDriver { private static final String SERVER = server\_name:port; private static final String USERNAME = tmo\_username; private static final String PASSWORD = tmo\_passwordsecurity\_token; private static final String CLIENT\_ID = consumer\_key; private static final String CLIENT\_SECRET = consumer\_secret; private static SignupRequestInfo signupRequest = null; public static String createSignupRequest (SignupRequestInfo sr) throws JSONException, IOException { JSONObject createResponse = null; signupRequest = sr; JSONObject loginResponse = login(SERVER, USERNAME, PASSWORD); String instanceUrl = loginResponse.getString("instance\_url"); String accessToken = loginResponse.getString("access\_token"); createResponse = create(instanceUrl, accessToken); System.out.println("Created SignupRequest object: " + createResponse + "\\n"); return createResponse.toString(); } /\* Authenticates to the TMO using the required credentials \*/ private static JSONObject login(String server, String username, String password) throws ClientProtocolException, IOException, JSONException { String authEndPoint = server + "/services/oauth2/token"; HttpClient httpclient = new DefaultHttpClient(); try { HttpPost post = new HttpPost(authEndPoint); List params = new ArrayList(); params.add(new BasicNameValuePair("grant\_type", "password")); params.add(new BasicNameValuePair("client\_id", CLIENT\_ID)); params.add(new BasicNameValuePair("client\_secret", CLIENT\_SECRET)); params.add(new BasicNameValuePair("username", username)); params.add(new BasicNameValuePair("password", password)); post.setEntity(new UrlEncodedFormEntity(params, Consts.UTF\_8)); BasicResponseHandler handler = new BasicResponseHandler(); String response = httpclient.execute(post, handler); return new JSONObject(response); } finally { httpclient.getConnectionManager().shutdown(); } } /\* Posts a request to the SignupRequest object \*/ private static JSONObject create(String instanceUrl, String accessToken) throws ClientProtocolException, IOException, JSONException { HttpClient httpClient = new DefaultHttpClient(); try { HttpPost post = new HttpPost(instanceUrl + "/services/data/v27.0/sobjects/SignupRequest/"); post.setHeader("Authorization", "Bearer " + accessToken); post.setHeader("Content-Type", "application/json"); JSONObject requestBody = new JSONObject(); requestBody.put("TemplateId", signupRequest.getTemplateID()); requestBody.put("SignupEmail", signupRequest.getEmail()); requestBody.put("username", signupRequest.getUsername()); requestBody.put("Country", "US"); requestBody.put("Company", signupRequest.getCompanyName()); requestBody.put("lastName", signupRequest.getLastName()); StringEntity entity = new StringEntity(requestBody.toString()); post.setEntity(entity); BasicResponseHandler handler = new BasicResponseHandler(); String response = httpClient.execute(post, handler); return new JSONObject(response); } finally { httpClient.getConnectionManager().shutdown(); } } } ## Error Codes If the sign-up fails, the system generates an error code that can help you identify the cause. This table shows the most important error codes.
Error Code Description
C-1007 Duplicate username.
C-1015 Error while establishing the new org’s My Domain (subdomain) settings. Contact Salesforce support for assistance.
C-1016 Error while configuring the OAuth connected app for Proxy Signup. Verify that your connected app has a valid consumer key, callback URL, and unexpired certificate (if applicable).
C-1018 Invalid subdomain value provided during sign-up.
C-1019 Subdomain in use. Choose a new subdomain value.
C-1020 Template not found. Either the template doesn’t exist or it was deleted.
C-1033 Template is the wrong version.
C-1034 Can’t create the org. Contact Salesforce Customer Support for assistance.
C-9999 Generic fatal error. Contact Salesforce Customer Support for assistance.
S-1006 Invalid email address (not in a proper email address format).
S-1014 Invalid or missing parameters during the sign-up process. Possible solutions include:
  • Indicate a valid callback URL.
  • If indicated, be sure to provide both a Consumer Key and callback URL.
S-1018 Invalid My Domain (subdomain) name. Select a name that doesn’t:
  • Contain double hyphens
  • End in a hyphen
  • Include restricted words
  • Exceed 40 characters (33 for Developer Edition)
S-1019 My Domain (subdomain) already in use.
S-1026 Invalid namespace. A namespace must begin with a letter, can’t contain consecutive underscores, can’t be a restricted or reserved namespace, and must be 15 characters or fewer.
T-0001 Template ID not valid (not in the format 0TTxxxxxxxxxxxx).
T-0002

Template not found. Either the template doesn't exist or it was deleted.
T-0003 Template not approved for use by Salesforce. Contact Salesforce Customer Support for assistance.
T-0004 The Trialforce Source Organization (TSO) for the template doesn’t exist or has expired.
VR-0001 Can’t create the scratch org. Try again later.
VR-0002 Can’t create the scratch org. Check that the release value is valid. If no release value was specified, contact Salesforce Customer Support.
VR-0003 Can’t create the scratch org. Check that the release value is valid. If no release value was specified, contact Salesforce Customer Support.
## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. - [SignupRequestFeed](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. - [SignupRequestHistory](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. - [SignupRequestOwnerSharingRule](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 - [SignupRequestShare](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. # Site Represents a public website that is integrated with an org. This object is available in API version 16.0 and later. To access this object, Digital Experiences, Salesforce Sites, or Site.com must be enabled. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules - Customer Portal users can’t access this object. - To view this object, you must have the View Setup and Configuration permission. ## Fields | Field | Description | | --- | --- | | AdminId | Type reference Properties Filter, Group, Sort Description The site administrator designated as the contact for the site. This user receives site-related communications from site visitors and from Salesforce. This is a relationship field. Relationship Name Admin Relationship Type Lookup Refers To User | | AnalyticsTrackingCode | Type string Properties Filter, Group, Nillable, Sort Description The tracking code associated with your site. This code can be used by services like Google Analytics to track page request data for your site. | | ArchiveStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The archived status of a site. Possible values are: - NotArchived - TemporaritlyArchived | | ArchivedById | Type reference Properties Filter, Group, Nillable, Sort Description The user that archived the site. Relationship Name: ArchivedBy Relationship Type: Lookup Refers To: User | | ArchivedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the site was archived. | | ClickjackProtectionLevel | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Sets the clickjack protection level. The options are: - AllowAllFraming—Allow framing by any page (no protection) - SameOriginOnly—Allow framing by the same origin only (recommended) - NoFraming—Don’t allow framing by any page (most protection) This field is available in API version 30.0 and later. | | DailyBandwidthLimit | Type int Properties Filter, Group, Nillable, Sort Description The rolling 24-hour daily bandwidth limit for the sites in your organization. | | DailyBandwidthUsed | Type int Properties Filter, Group, Nillable, Sort Description The current rolling 24-hour daily bandwidth usage for the sites in your organization. | | DailyRequestTimeLimit | Type int Properties Filter, Group, Nillable, Sort Description The rolling 24-hour daily service request time limit for the sites in your organization. Service request time is calculated as the total server time in minutes required to generate pages for the site. | | DailyRequestTimeUsed | Type int Properties Filter, Group, Nillable, Sort Description The current rolling 24-hour daily service request time for the sites in your organization. | | Description | Type textarea Properties Filter, Nillable, Sort Description An optional description of the site. | | GuestRecordDefaultOwnerId | Type reference Properties Filter, Group, Nillable, Sort Description A user in the Salesforce org that is the default owner of records created by unauthenticated (guest) users. This is a relationship field. Relationship Name GuestRecordDefaultOwner Relationship Type Lookup Refers To User | | GuestUserId | Type reference Properties Filter, Group, Nillable, Sort Description The site or Experience Cloud sites specific user that anonymous, unauthenticated users run as when interacting with the site. This is a relationship field. Relationship Name GuestUser Relationship Type Lookup Refers To User | | MasterLabel | Type string Properties Filter, Group, Sort Description The name of the site as it appears in the user interface. | | MonthlyPageViewsEntitlement | Type int Properties Filter, Group, Nillable, Sort Description The number of page views allowed for the current calendar month for the sites in your organization. | | Name | Type string Properties Filter, Group, Sort Description The name used when referencing the site in the API. | | OptionsAllowGuestPaymentsApi | Type boolean Properties Filter Description Indicates whether unauthenticated guest users can access the Payments API (true) or not (false). The default is false. This field is available in API version 49.0 and later. | | OptionsAllowGuestSupportApi | Type boolean Properties Filter Description The option to enable unauthenticated users to access the Support API. | | OptionsAllowHomePage | Type boolean Properties Filter Description The option to enable the standard page associated with the Home tab (/home/home.jsp). | | OptionsAllowStandardAnswersPages | Type boolean Properties Filter Description The option to enable standard pages associated with an answers Experience Cloud site. If you want to use default Answers pages (such as AnswersHome), enable these pages. | | OptionsAllowStandardIdeasPages | Type boolean Properties Filter Description The option to enable standard pages associated with an Ideas Experience Cloud site. If you want to use default Ideas pages (such as IdeasHome), enable these pages. | | OptionsAllowStandardLookups | Type boolean Properties Filter Description The option to enable the standard lookup pages. These are the windows associated with lookup fields on Visualforce pages. | | OptionsAllowStandardPortalPages | Type boolean Properties Filter Description The option to enable authenticated users to access the standard Salesforce pages. | | OptionsAllowStandardSearch | Type boolean Properties Filter Description The option to enable the standard search pages. To allow public users to perform standard searches, enable these pages. | | OptionsBrowserXssProtection | Type boolean Properties Filter Description The option to enable the browser's cross-site scripting protection. | | OptionsCachePublicVfPagesInProxies | Type boolean Properties Filter Description Indicates whether proxy servers cache this site’s publicly available pages only for unauthenticated guest users (true) or not (false). When this field is false, this site’s cache-enabled Visualforce pages are cached in the web browser for both authenticated and unauthenticated users. The default is true. See [Configure Site Caching](https://help.salesforce.com/articleView?id=platform.sites_caching.htm&type=5&language=en_US) in Salesforce Help for more information. This field is available in API version 52.0 and later. | | OptionsContentSniffingProtection | Type boolean Properties Filter Description The option to enable content-sniffing protection. | | OptionsCookieConsent | Type boolean Properties Filter Description Indicates whether only required Salesforce-supplied cookies are allowed within the site (true) or all cookies types are allowed: required, functional, and advertising (false). The default is false. This field is available in API version 52.0 and later. | | OptionsCspUpgradeInsecureRequests | Type boolean Properties Filter Description This field is removed in API version 52.0 and later. In API version 51.0 and earlier, the value in the field is ignored. | | OptionsEnableFeeds | Type boolean Properties Filter Description The option that displays the Syndication Feeds related list, where you can create and manage syndication feeds for users on your public sites. This field is visible only if you have the feature enabled for your organization. | | OptionsHasStoredPathPrefix | Type boolean Properties Filter Description Indicates whether this Experience Cloud site has a customized urlPathPrefix (true) or instead uses the Experience Cloud site's UrlPathPrefix plus /s (false). The default is false. In other sites, this field has no effect. This field is available in API version 50.0 and later. | | OptionsRedirectToCustomDomain | Type boolean Properties Filter Description Indicates whether requests to this site’s system-managed URLs are redirected to the HTTPS custom domain serving this site (true) or not (false). System-managed site URLs end in \*.my.salesforce-sites.com or \*.my.site.com. In Experience Cloud sites, the default is false. In Salesforce Sites, the default is true. If multiple custom domains serve this site and this field is set to true, requests are routed to the site’s primary custom URL only if it’s an HTTPS custom domain. Otherwise, requests are redirected to the first HTTPS custom domain associated with this site, in alphanumeric order. If no HTTPS custom domain serves this site, this option has no effect. This field is available in API version 52.0 and later. | | OptionsReferrerPolicyOriginWhenCrossOrigin | Type boolean Properties Filter Description The option to enable referrer policy (origin-when-cross-origin). | | OptionsRequireHttps | Type boolean Properties Filter Description This field is removed in API version 52.0 and later. In API version 51.0 and earlier, the value in the field is ignored. | | SiteType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Identifies whether the site is a Visualforce (Salesforce Sites) or a Site.com site. SiteType is available in API version 21.0 and later. In API version 26.0 and later, if Experience Cloud sites are enabled for your Salesforce org, the site could also be a Network Visualforce or Network Site.com site. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status for the site. For example, Active or In Maintenance. | | Subdomain | Type string Properties Filter, Group, Nillable, Sort Description If you enabled Salesforce Sites or Digital Experiences before you enabled enhanced domains on your My Domain, this field returns this site’s previous subdomain. For example, if your domain was mycompany.force.com, then mycompany is the subdomain. If you enabled Salesforce Sites or Digital Experiences after you enabled enhanced domains, this field returns a null value. | | TopLevelDomain | Type url Properties Filter, Nillable Description The optional branded custom Web address that you registered with a third-party domain name registrar. The custom Web address acts as an alias to your Salesforce address. Beginning with API version 21.0, TopLevelDomain is no longer available. Instead, use the [Domain](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domain.htm "Read-only object that represents a custom Web address assigned to a site in your organization. This object is available in API version 26.0 and later.") and [DomainSite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domainsite.htm "Read-only junction object that joins the Site and Domain objects. This object is available in API version 26.0 and later.") objects. | | UrlPathPrefix | Type string Properties Filter, Group, Nillable, Sort Description The unique Salesforce URL that the public uses to access this site. | ## Usage Use this read-only object to query or retrieve information on your site. ## Associated Objects This object has the following associated objects. Unless noted, these associated objects are available in the same API version as this object. [SiteFeed](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. [SiteHistory](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. # SiteDetail Represents the details of a Salesforce site or Experience Cloud site. Available in API Version 38.0 and later. ## Supported SOAP Calls describeSObjects(), query() ## Supported REST HTTP Methods GET ## Fields | Field | Details | | --- | --- | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description The ID of the Site object. | | IsRegistrationEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the site allows users to sign up. | | SecureUrl | Type url Properties Filter, Group, Nillable, Sort Description The URL of the website. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note SiteDetail fields are exposed in SOAP API version 45.0 and later. You can use Tooling API to query for SiteDetail fields in guest user mode in API version 44.0 and earlier. In API version 45.0 and later, use SOAP API to get this data in guest user mode. SiteDetail is still exposed in Tooling API to User Profiles with the ViewSetup permission. # SiteDomain SiteDomain is a read-only object, and a one-to-many replacement for the Site.TopLevelDomain field. This object is available in API version 21.0, and has been deprecated as of API version 26.0. In API version 26.0 and later, use the [Domain](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domain.htm "Read-only object that represents a custom Web address assigned to a site in your organization. This object is available in API version 26.0 and later.") and [DomainSite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domainsite.htm "Read-only junction object that joins the Site and Domain objects. This object is available in API version 26.0 and later.") objects instead. To access this object, Digital Experiences, Salesforce Sites, or Site.com must be enabled. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules - Customer Portal users can’t access this object. - To view this object, you must have the View Setup and Configuration permission. ## Fields | Field | Description | | --- | --- | | Domain | Type url Properties Filter, Sort Description The branded custom Web address within the global namespace identified by this domain's type. In the Domain Name System (DNS) global namespace, this field is the custom Web address that you registered with a third-party domain name registrar. The custom Web address can be used to access the site of this domain. | | SiteId | Type reference Properties Filter, Group, Sort Description The ID of the associated Site. | | DomainType | Type picklist Properties Filter, Group, Sort, Nillable Description The global namespace that this custom Web address belongs to. This value is set to DNS for custom Web addresses in the global DNS. This field is available in version 24.0 of the API. | ## Usage Use this read-only object to query the domains that are associated with each site in your organization. # SiteEventLog SiteEventLog stores details of Site.com requests. Requests can originate from the browser (UI). This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB\_CPU\_TIME. Compare this field to CPU\_TIME to determine whether performance issues are occurring in the database layer or in your own code. | | HttpHeaders | Type string Properties Filter, Group, Nillable, Sort Description The HTTP headers that were sent in the request. | | HttpMethod | Type string Properties Filter, Group, Nillable, Sort Description The HTTP method of the request. For example: GET, POST, PUT, and so on. | | IsApi | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The default value is false. | | IsError | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if this page was an error page. The default value is false. | | IsFirstRequest | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if this page is the first Visualforce transaction in the request. The default value is false. | | IsGuest | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if this page was a guest (unauthenticated) request. The default value is false. | | IsSecure | Type boolean Properties Defaulted on create, Filter, Group, Sort Description True if this request is secure. The default value is false. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | PageName | Type string Properties Filter, Group, Nillable, Sort Description The name of the Visualforce page that was requested. | | QueryString | Type string Properties Filter, Group, Nillable, Sort Description The SOQL query, if one was performed. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. This field can have a blank value. For example: - S— Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F— Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U— Undefined. - A—Authorization error. - R— Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. | | RequestType | Type string Properties Filter, Group, Nillable, Sort Description The request type. Possible values are: - page—a normal request for a page - content\_UI—a content request for a page that originated in the user interface - content\_apex—a content request initiated by an Apex call - PDF\_UI—a request for a page in PDF format through the user interface - PDF\_apex—a request for PDF format by an Apex call (usually a Web Service call) | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | SiteIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the Site.com site. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 18-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943YAS. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # SiteHistory Represents the history of changes to the values in the fields of a site. This object is generally available in API version 18.0 and later. To access this object, Salesforce Sites must be enabled for your organization. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules - Customer Portal users can't access this object. - To view this object, you must have the “View Setup and Configuration” permission. ## Fields | Field | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The last value of the field before it was changed. | | SiteId | Type reference Properties Filter, Group, Sort Description The ID of the associated Site. This is a relationship field. Relationship Name Site Relationship Type Lookup Refers To Site | # SiteIframeWhitelistUrl Represents a list of external domains that you allow to frame your Salesforce site or Experience Cloud site pages. This object is available in API version 44.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules - Customer Portal users can’t access this object. - To view this object, you must have the “View Setup and Configuration” permission. ## Fields | Field Name | Details | | --- | --- | | SiteId | Type reference Properties Create, Filter, Group, Sort Description ID of the site to include in the inline frame. This is a relationship field. Relationship Name Site Relationship Type Lookup Refers To Site | | Url | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The domain allowed to frame your Salesforce site or Experience Cloud site page. Accepts these formats: example, example.com, \*example.com, and https://example.com. | # SiteRedirectMapping Represents a site redirect from an external site to an Experience Cloud site. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available only if Digital Experiences is enabled for your org and Create and Set Up Experiences is enabled. ## Fields | Field | Details | | --- | --- | | Action | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of the redirect. Possible values are: - Permanent - Temporary | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the redirect is enabled. Default value is false. | | IsDynamic | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a redirect rule is dynamic. Default value is false. This field is available in API version 57.0 and later. | | SiteId | Type reference Properties Create, Filter, Group, Sort Description The ID of the site for the redirect. This field is a relationship field. Relationship Name Site Relationship Type Lookup Refers To Site | | Source | Type url Properties Create, Filter, Sort Description The URL of the site you want to redirect. | | Target | Type url Properties Create, Filter, Sort Description The URL of the Experience Cloud site you want to users to visit. | ## Usage If you build a new site on Experience Cloud but you also have an old site on a different platform, ensure that users visit the new site. Use SiteRedirectMapping to redirect users from the external site to the Experience Cloud site. # Sites Event Type Sites events contain details of Site.com requests. Requests can originate from the browser (UI). For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
String
Description
The type of event. The value is always Sites.
HTTP_HEADERS
Type
String
Description
The HTTP headers that were sent in the request.
HTTP_METHOD
Type
String
Description
The HTTP method of the request.
For example: GET, POST, PUT, and so on.
IS_API
Type
Boolean
Description
True if this page was an API or Web Services request.
IS_ERROR
Type
Boolean
Description
True if this page was an error page.
IS_FIRST_REQUEST
Type
Boolean
Description
1 if this page is the first Visualforce transaction in the request, or 0 if it isn't.
IS_GUEST
Type
Boolean
Description
True if this page was a guest (unauthenticated) request.
IS_SECURE
Type
Boolean
Description
True if this request is secure.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
PAGE_NAME
Type
String
Description
The name of the Visualforce page that was requested.
QUERY
Type
String
Description
The SOQL query, if one was performed.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
REQUEST_TYPE
Type
String
Description
The request type.
Possible values are:
  • page—a normal request for a page
  • content_UI—a content request for a page that originated in the user interface
  • content_apex—a content request initiated by an Apex call
  • PDF_UI—a request for a page in PDF format through the user interface
  • PDF_apex—a request for PDF format by an Apex call (usually a Web Service call)
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
SITE_ID
Type
Id
Description
The 15-character ID of the Site.com site.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Skill Represents a category or group of Chat users or service resources in Field Service or Workforce Engagement. This object is available in API version 24.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For information about WDC skills on a user's profile, see the [ProfileSkill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profileskill.htm "Represents a profile skill, which describes a user’s professional knowledge. This is a global record for the organization, and users are associated through the ProfileSkillUser object.") topic. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the skill. | | DeveloperName | Type string Properties 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the skill. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed the skill. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the skill. | | TypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The skill type associated with the skill. This field is a relationship field. This field is available in API version 58.0 and later. Relationship Name Type Refers To SkillType | ## Usage Chat Use this object to assign Chat users to groups based on their abilities. The skills associated with a LiveChatButton determine which agents receive chat requests that come in through that button. Field Service Use this object to track certifications and areas of expertise in your workforce. After you create a skill, you can: - Assign it to a service resource via the Skills related list on the resource’s detail page. When you assign a skill to a service resource, you can specify their skill level and the duration of the skill. - Add it as a required skill via the Skill Requirements related list on any work type, work order, or work order line item. When you add a required skill to a work record, you can specify the skill level. Workforce Engagement Use this object to specify areas of expertise in your workforce. After you create a skill, you can: - Assign it to a service resource via the Skills related list on the resource’s detail page. - Add it as a required skill via the Skill Requirements related list on a job profile. # SkillLevelDefinition Represents a skill which can be acquired by completing enablement site (myTrailhead) modules. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org must have a Workforce Engagement license and an Enablement Sites (myTrailhead) license. User must have at least one Workforce Engagement permission set assigned to them: Workforce Engagement Analyst, Workforce Engagement Planner, Workforce Engagement Agent. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Describes the mapping. | | IsAutoApproved | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether this mapping auto-approves. The default value is 'false'. | | LearningContent | Type string Properties Filter, Nillable Description The titles of the Trailhead modules associated to this mapping. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who owns the Skill Level Definition. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | SkillId | Type reference Properties Create, Filter, Group, Sort, Update Description The skill that this mapping is for. This is a relationship field. Relationship Name Skill Relationship Type Lookup Refers To Skill | | SkillLevel | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The level to assign for the skill. | ## 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. [SkillLevelDefinitionOwnerSharingRule](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. [SkillLevelDefinitionShare](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. # SkillLevelProgress Represents training progress for a given user. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org must have a Workforce Engagement license and an Enablement Sites (myTrailhead) license. User must have at least one Workforce Engagement permission set assigned to them: Workforce Engagement Analyst, Workforce Engagement Planner, Workforce Engagement Agent. ## Fields | Field | Details | | --- | --- | | CompletedCount | Type int Properties Create, Filter, Group, Sort, Update Description Number of modules that have been completed towards this Skill Mapping. | | CompletedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when this progress was completed. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of skill level progress. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | ServiceResourceId | Type reference Properties Create, Filter, Group, Sort, Update Description The Service Resource that will be granted a service resource skill when the progress is complete. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource | | SkillLevelDefinitionId | Type reference Properties Create, Filter, Group, Sort, Update Description The corresponding skill mapping for this progress. This is a relationship field. Relationship Name SkillLevelDefinition Relationship Type Lookup Refers To SkillLevelDefinition | | SkillMasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The master label of the Skill associated with the associated SkillLevelDefinition. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents the status of the progress. Possible values are: - A—Approved - R—Review - S—Started The default value is 'S'. | | TotalCount | Type int Properties Create, Filter, Group, Sort, Update Description The total number of modules that need to be completed. | ## 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. [SkillLevelProgressOwnerSharingRule](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. [SkillLevelProgressShare](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. # SkillProfile Represents a join between Skill and Profile. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), update(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the profile. | | SkillId | Type reference Properties Create, Filter, Group, Sort Description The ID of the skill. | ## Usage Use this object to assign specific skills to specific profiles. # SkillRequirement Represents a skill that is required to complete a particular task in Field Service, Omni-Channel, Salesforce Scheduler, or Workforce Engagement. Skill requirements can be added to pending service routing objects in Omni-Channel. They can be added to work types, work orders, and work order line items in Field Service and Lightning Scheduler. And they can be added to job profiles in Workforce Engagement. This object is available in API version 38.0 and later. You also can add skill requirements to work items in Omni-Channel skills-based routing using API version 42.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules If you want to use SkillRequirement for Field Service use cases, then Field Service must be enabled. If you want to use SkillRequirement only for Omni-Channel skills-based routing use cases, then you don't need Field Service to be enabled. If you want to use SkillRequirement for Workforce Engagement use cases, then Workforce Engagement must be enabled. ## Fields | Field Name | Details | | --- | --- | | IsAdditionalSkill | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that a skill is additional. After a designated timeout period, a skill marked as additional is dropped from Omni-Channel routing. The case is then routed to the best-matched agent even if they don’t have all the skills. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | RelatedRecordId | Type reference Properties Create, Filter, Group, Sort Description The record that the skill is required for. The related record can be a work order, work order line item, work type, or pending service routing record. This is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To WorkOrder, WorkOrderLineItem, WorkType | | SkillId | Type reference Properties Create, Filter, Group, Sort, Update Description The skill that is required. This is a relationship field. Relationship Name Skill Relationship Type Lookup Refers To Skill | | SkillLevel | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The level of the skill required. Skill levels can range from zero to 99.99. Depending on your business needs, you can have the skill level to reflect years of experience, certification levels, or license classes. | | SkillNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the skill requirement. | | SkillPriority | Type int Properties Aggregatable, Create, Filter, Group, Nillable, Sort, Update Description For additional skills, specify the order in which skills are dropped if after the specified timeout no agent with that skill is available. Higher priority-value skills are dropped first. Lower priority-value skills, for example 0, are dropped last. Skills with the same priority value are dropped as a group. You can set skill priority using skills-based routing rules or Apex code. | ## Usage Field Service Skill requirements help dispatchers assign work orders to service resources with the proper expertise. You can still assign a work order, work order line item, or related service appointment to a service resource that does _not_ have the specified skills, so skill requirements serve more as a suggestion than a rule. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you’re using the Field Service managed package, use matching rules to ensure that appointments are only assigned to service resources who possess the skills listed on the parent work order. If many of your work orders require the same skills, add skill requirements to work types to save time and keep your processes consistent. When you add a skill requirement to a work type, work orders and work order line items that use that type automatically inherit the skill requirement. For example, if all annual maintenance visits for your Classic Refrigerator product require a Refrigerator Maintenance skill level of at least 50, add that skill requirement to the Annual Maintenance Visit work type. When you create a work order for a customer’s annual fridge maintenance, applying that work type adds the skill requirement as well. Omni-Channel We recommend that you use Omni-Channel flow or skills-based routing rules to create skills-based routing requests. When you do so, work items are routed by creating a PendingServiceRouting object. The PendingServiceRouting object can have multiple SkillRequirements objects associated with it. When a work item requires multiple skills, it’s routed to an agent who has all of the required skills. The PendingServiceRouting object adds attributes to the work item that represent the skill (skill id), priority, skill proficiency, and timestamp. Workforce Engagement Workforce Engagement uses skill requirements to assign shifts to agents who have the right skills. You can still assign shifts to service resources if they don’t have those skills. In a non-Omni workflow, create a scheduling rule that matches agents to shifts based on their skills and the job profile's skill requirements. Shift scheduling tools can then assign agents with the right skills. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. [SkillRequirementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 54.0) Change events are available for the object. [SkillRequirementFeed](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. [SkillRequirementHistory](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. # SkillUser Represents a join between Skill and User. This object is available in API version 24.0 and later. ## Supported Calls create(), delete(), describeSObjects(), update(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | SkillId | Type reference Properties Create, Filter, Group, Sort Description The ID of the skill. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the user. | ## Usage Use this object to assign specific skills to specific users. # SlackChannelRelatedRecord Represents the related record mapping between a Slack channel and a Salesforce record that’s made when you create a Salesforce channel. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Filter, Sort Description The name of the related record mapping. | | RelatedRecord | Type string Properties Filter, Group, Sort Description The Salesforce record ID associated with the related record mapping. | | SlackChannel | Type string Properties Filter, Group, Nillable, Sort Description The Slack channel ID of the Salesforce channel associated with the related record mapping. | | TopLevelTeam | Type string Properties Filter, Group, Nillable, Sort Description The Slack Enterprise org ID associated with the Salesforce channel. | ## Usage Use this object to retrieve and query the related record mapping between a Slack channel and a Salesforce record. You can select this object in Salesforce Flow Builder and Slack Workflow Builder to trigger actions when a Salesforce channel is created. This object is read only. You can’t create, modify, or delete the related record mappings between Slack channels and Salesforce records using this object. # SlaProcess Represents an entitlement process associated with an Entitlement. This object is available in API version 19.0 and later. An entitlement process is a timeline that includes all the steps (MilestoneType records) that your support team must complete to resolve cases. Each process includes the logic necessary to determine how to enforce the correct service level for your customers. ## Supported Calls describeSObjects(), query(), retrieve(), search(), describeLayout() ## Special Access Rules As of Summer ’20 and later, only Salesforce admin users, users with access to the Case, Entitlement, or Work Order objects, and users with the View Setup and Configuration permission can access this object. ## Fields | Field | Details | | --- | --- | | BusinessHoursId | Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the BusinessHours associated with the entitlement. Must be a valid business hours ID. | | Description | Type textarea Properties Filter, Nillable Description A description of the entitlement process. | | IsActive | Type boolean Properties Defaulted on create, Filter Description Indicates whether the entitlement process is active (true) or not (false). | | IsVersionDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the entitlement process is the default version (true) or not (false). This field is available in API version 28.0 and later in organizations that have entitlement versioning enabled. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the SlaProcess was last viewed. | | Name | Type string Properties Filter, idLookup Description The name of the entitlement process. | | NameNorm | Type string Properties Filter, Group, Sort Description The read-only value for the unique name of the entitlement process or the entitlement process version. If entitlement versioning is enabled, this value is automatically generated for each version of an entitlement process in this form: process name+\_v + x, where x is the version number (for example, “gold\_support\_v2”). If entitlement versioning isn’t enabled, this value is the same as Name. This field is available in API version 28.0 and later. | | SObjectType | Type picklist Properties Restricted picklist, Filter, Group, Sort Description The type of records that the entitlement process can run on. Its values are: - Case - Work Order An entitlement process runs only on records that match its type. For example, a Case entitlement process that’s applied to an entitlement runs only on cases associated with the entitlement, not on work orders. As a best practice, therefore, manage customers’ work orders and cases on separate entitlements. The field label in the user interface is Entitlement Process Type. | | StartDateField | Type picklist Properties Filter, Restricted picklist Description The criteria for cases to enter the entitlement process. Cases can enter the process based on: - The creation date on a case - A custom date/time field on a case | | VersionMaster | Type string Properties Filter, Group, Nillable, Sort Description Identifies the sequence of versions to which this entitlement process belongs. Must be a valid ID and must be identical among all versions of the entitlement process. This field is available in API version 28.0 and later in organizations that have entitlement versioning enabled. | | VersionNotes | Type textarea Properties Filter, Group, Nillable, Sort Description The description of the entitlement process version. This field is available in API version 28.0 and later in organizations that have entitlement versioning enabled. | | VersionNumber | Type int Properties Filter, Group, Nillable, Sort Description The version number of the entitlement process. Must be 1 or greater. This field is available in API version 28.0 and later in organizations that have entitlement versioning enabled. | ## Usage Use this object to query entitlement processes on entitlements. #### See Also - [Entitlement](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entitlement.htm "Represents the customer support an account or contact is eligible to receive. This object is available in API version 18.0 and later. Entitlements may be based on an asset, product, or service contract.") - [MilestoneType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_milestonetype.htm "Represents a milestone (required step in a customer support process). This object is available in API version 18.0 and later.") - [CaseMilestone](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casemilestone.htm "Represents a milestone (required step in a customer support process) on a Case. This object is available in API version 18.0 and later.") # Snippet Represents a snippet, which is a container for rich text that can be reused across Account Engagement emails and email templates. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Snippets are available in Account Engagement business units with the Sales, CRM, or Service permission set license. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the snippet. Limited to 32 KB. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. This field value is unique to your org and is required for a Snippet to be resolved in marketing content. Label is **API Name**. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the snippet. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of content a snippet includes. Allowable values are: Date, Image, Link, Text. This field is for organizational purposes. | | Value | Type textarea Properties Create, Nillable, Update Description The body content of a snippet. This field can contain plain or rich text. The value of a snippet is resolved when a marketing email is sent. The field does not support emojis, HTML, or image files. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [SnippetFeed](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. # SnippetAssignment Represents a relationship between a snippet and a campaign. Assignments are required to use snippet content in Account Engagement emails and email templates. A snippet can be assigned to more than one campaign. This object is available in API version 47.0 and later. ## Supported Calls create( ), delete( ), describeLayout( ), describeSObjects( ), getDeleted( ), getUpdated( ), query( ), retrieve( ) ## Special Access Rules Snippets are available in Account Engagement business units with the Sales, CRM, or Service permission set license. ## Fields | Field | Details | | --- | --- | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the parent object | | SnippetId | Type reference Properties Create, Filter, Group, Sort Description ID of the related snippet record | # SOAP API Event Type SOAP API events contain details about your org's SOAP API request activity. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
FieldDetails
API_TYPE
Type
String
Description
The type of API request.
Possible values are:
  • D—Apex Class
  • E—SOAP Enterprise
  • M—SOAP Metadata
  • P—SOAP Partner
  • S—SOAP Apex
  • T—SOAP Tooling
  • f—Feed
  • l—Live Agent
  • p—SOAP ClientSync
API_VERSION
Type
String
Description
The version of the API that’s being used.
For example: 36.0.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CLIENT_NAME
Type
String
Description
The name of the client that’s using Salesforce services. This field is an optional parameter that can be passed in API calls. If blank, the caller didn't specify a client in the CallOptions header.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type
Set
Description
The name of the object accessed by the API request.
For example: Account, Opportunity, Contact, and so on.
EVENT_TYPE
Type
String
Description
The type of event. The value is always API.
EXCEPTION_MESSAGE
Type
String
Description
The exception message for a SOAP API request. An exception message gives details about errors in handling an API request, such as why an API request failed.
For example: common.exception.ApiException: startDate cannot be more than 30 days ago.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
METHOD_NAME
Type
String
Description
The name of the calling Apex method.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
QUERY
Type
String
Description
The data that was queried.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
REQUEST_SIZE
Type
Number
Description
The size of the callout request body, in bytes.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
For example:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
This field can have a blank value.
RESPONSE_SIZE
Type
Number
Description
The size of the callout response, in bytes.
ROWS_PROCESSED
Type
Number
Description
The number of rows that were processed in the request.
For example: 150.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
#### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # SoapApiEventLog SOAP API events contain details about your org's SOAP API request activity. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ApiType | Type string Properties Filter, Group, Nillable, Sort Description The type of API request. Possible values are: - D—Apex Class - E—SOAP Enterprise - M—SOAP Metadata - P—SOAP Partner - S—SOAP Apex - T—SOAP Tooling - f—Feed - l—Live Agent - p—SOAP ClientSync | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | ClientName | Type string Properties Filter, Group, Nillable, Sort Description The name of the client that’s using Salesforce services. This field is an optional parameter that can be passed in API calls. If blank, the caller didn't specify a client in the CallOptions header. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseBlocks | Type double Properties Filter, Nillable, Sort Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance. | | DatabaseCpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DatabaseCpuTime. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | ExceptionMessage | Type string Properties Filter, Nillable, Sort Description The exception message for a SOAP API request. An exception message gives details about errors in handling an API request, such as why an API request failed. For example: common.exception.ApiException: startDate cannot be more than 30 days ago. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | MethodName | Type string Properties Filter, Group, Nillable, Sort Description The name of the calling Apex method. | | ObjectName | Type string Properties Filter, Group, Nillable, Sort Description The name of the object accessed by the API request. For example: Account, Opportunity, Contact, and so on. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestSize | Type double Properties Filter, Nillable, Sort Description The size of the callout request body, in bytes. | | RequestStatus | Type String Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | ResponseSize | Type double Properties Filter, Nillable, Sort Description The size of the callout response, in bytes. | | RowsProcessed | Type int Properties Filter, Group, Nillable, Sort Description The number of rows that were processed in the request. For example: 150. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # SocialPersona Represents a snapshot of a contact's profile on a social network such as Facebook or Twitter. This object is available in API version 22.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AreWeFollowing | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether a Salesforce social account is following the social persona or not. | | AuthorLabels | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Comma-separated list of author type tags. | | AvatarUrl | Type string Properties Nillable Description Retrieves the user's social network avatar. It's a read-only field and you can't specify or update its value. | | Bio | Type textarea Properties Create, Nillable, Update Description Biography of the social persona. | | ExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the social persona on the social network. | | ExternalPictureURL | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description URL to the picture of the social persona on the social network. | | Followers | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of followers that the social persona has. | | Following | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of people that the social persona is following. | | InfluencerScore | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Radian6 score describing the influence of the social persona. No longer used. | | IsBlacklisted | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the social persona is blacklisted or not. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the social persona supplies the default avatar image that’s displayed on the contact or account. | | IsFollowingUs | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the social persona is following a Salesforce social account or not. | | IsVerified | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the social persona is verified or not. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the social persona was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date and time when the social persona was last viewed. | | ListedCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Radian6 field. No longer used. | | MediaProvider | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Social network of the social persona. | | MediaType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Social network type of the social persona. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the social persona. | | NumberOfFriends | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of friends that the social persona has. | | NumberOfTweets | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of tweets made by the social persona. | | ParentId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the contact parent record for the social persona. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To Account, Contact, Lead, SocialPost | | ProfileType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of profile. Values are: - Person - Page | | ProfileUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description URL for the profile. | | Provider | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Social network, such as Facebook or Twitter, of the social persona. | | R6SourceId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the social persona in Social Studio. | | RealName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Real name of the social persona. | | SourceApp | Type string Properties Create, Filter, Group, Nillable, Sort Description Salesforce product that created the social persona. | | TopicType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Type of topic, such as keyword or managed. | ## Usage The fields on a SocialPersona object don’t provide real-time data. They provide a snapshot of information from the last time Salesforce collected a post from the social persona. Many of the Radian6-related fields are no longer accurate or used. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [SocialPersonaHistory](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.") (API version 26.0) History is available for tracked fields of the object. # SocialPost Represents a snapshot of a post on a social network such as a Facebook or Twitter. This object is available in API version 23.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AnalyzerScore | Type double Properties Create, Filter, Nillable, Sort, Update Description Score set on the social post in Social Studio. | | AssignedTo | Type string Properties Create, Filter, Group, Nillable, Sort Description User in Social Studio that the social post is assigned to. | | AttachmentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of the first attachment on the social post. Values are: - APPLICATION - AUDIO - IMAGE - LINK - TEXT - UNKNOWN - VIDEO | | AttachmentUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description URL for the first attachment on the social post. | | Classification | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Classification for the social post, such as inquiry or customer case. | | CommentCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of comments on the social post. | | Content | Type textarea Properties Create, Nillable, Update Description Body of the social post. | | DeletedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description If the social post is deleted, ID of the person who deleted the social post. This is a relationship field. Relationship Name DeletedBy Relationship Type Lookup Refers To User | | EngagementLevel | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Engagement level of the social post, such as reviewed or resolved. | | ExternalPostId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the social post in its social network. | | Handle | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Handle of the person who posted the social post. | | HarvestDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when Social Studio collected the social post. | | Headline | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Headline of the social post. | | HiddenById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description If the social post is hidden, ID of the person who hid it. This is a relationship field. Relationship Name HiddenBy Relationship Type Lookup Refers To User | | InboundLinkCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of links on the inbound social post. | | IsOutbound | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Specifies whether the social post is outbound or not. | | KeywordGroupName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Radian6 field that is no longer used. | | Language | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Language of the social post. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Date when the social post was last referenced. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Date when the social post was last viewed. | | LikedBy | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the managed social account in the social network that liked the social post. | | LikesAndVotes | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Radian6 number of likes and votes on the social post. | | MediaProvider | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Social network of the social post. | | MediaType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Type of social network of the social post. | | MessageType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of message. Values are: - Comment—Facebook comment - Direct—Twitter direct message - Post—Facebook post - Private—Facebook private message - Reply—Twitter or Facebook reply - Retweet—Twitter retweet - Tweet—Twitter tweet | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the social post. | | Notes | Type textarea Properties Create, Nillable, Update Description Notes added by Social Hub actions for the social post. | | OutboundSocialAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the social account used for outbound social posts. This is a relationship field. Relationship Name OutboundSocialAccount Relationship Type Lookup Refers To ExternalSocialAccount | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the social post. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the parent record of the social post, for example, the ID of a case. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Case | | PersonaId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the social persona who made the post. This is a relationship field. Relationship Name Persona Relationship Type Lookup Refers To SocialPersona | | PostPriority | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Priority of the social post set in Social Studio. | | PostTags | Type textarea Properties Create, Nillable, Update Description Comma-separated list of tags on the social post. | | PostUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description URL for the social post. | | Posted | Type dateTime Properties Create, Defaulted on create, Filter, Sort, Update Description Date and time when the social post was made. | | Provider | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Social network of the social post. | | R6PostId | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Unique ID of the post in Social Studio. | | R6SourceId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the author in Social Studio. | | R6TopicId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID for either the topic profile or the managed account in Social Studio. | | Recipient | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the recipient of the social post in Social Studio. | | RecipientType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Type of the recipient of the social post, such as a person. | | ReplyToId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Dynamically generated from replyToExternalPostId in Social Studio. This is a relationship field. Relationship Name ReplyTo Relationship Type Lookup Refers To SocialPost | | ResponseContextExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description External ID, such as a conversation ID, author ID, or post ID, for the item you’re responding to. | | ReviewScale | Type double Properties Create, Filter, Nillable, Sort, Update Description Review scale for the social post. | | ReviewScore | Type double Properties Create, Filter, Nillable, Sort, Update Description Review score for the social post. | | ReviewedStatus | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Status of the social post review. | | Sentiment | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Sentiment of the social post. Values are: - Negative - Neutral - Positive - SomewhatNegative - SomewhatPositive | | Shares | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times the social post has been shared. | | SourceTags | Type textarea Properties Create, Nillable, Update Description Comma-separated list of author type tags. | | SpamRating | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Spam rating of the social post. Values are: - NotSpam - Spam | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Status of the social post. Values are: - DELETED - FAILED - HIDDEN - PENDING - PENDING\_APPROVAL - RECALL\_APPROVAL - REJECTED\_APPROVAL - REPLIED - SENT - UNKNOWN | | StatusMessage | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Status message for the social post. | | ThreadSize | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Radian6 field. No longer used. | | TopicProfileName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the topic profile for the social post in Social Studio. | | TopicType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of topic. Values are: - Keyword - Managed | | TruncatedContent | Type string Properties Filter, Group, Nillable, Sort Description Truncated content of the social post. | | UniqueCommentors | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of unique people who commented on the social post. | | ViewCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times the social post was viewed. | | WhoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Polymorphic ID of a person such as a lead or a contact. This is a polymorphic relationship field. Relationship Name Who Relationship Type Lookup Refers To Account, Contact, Lead | ## Usage The fields on a SocialPost object don’t provide real-time data. They provide a snapshot of information from the last time Salesforce collected the post from the social network. Many of the Radian6-related fields are no longer accurate or used. ## 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. [SocialPostChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [SocialPostFeed](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.") (API version 26.0) Feed tracking is available for the object. [SocialPostHistory](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.") (API version 26.0) History is available for tracked fields of the object. [SocialPostOwnerSharingRule](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. [SocialPostShare](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. # Solution Represents a detailed description of a customer issue and the resolution of that issue. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | IsHtml | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the Solution is an HTML solution (true) or not (false). | | IsOutOfDate | Type boolean Properties Defaulted on create, Filter Description Read-only field that indicates whether a solution master has been updated since the translated version was created (true) or not (false). Note that this field does not appear in the page layout of master solutions. | | IsPublished | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Solution has been published (true) or not (false). A solution’s published state does not affect how it can be used, or whether you can query, update, or delete it. Label is **Public**. Prior to Spring ‘14, the label was **Visible in Self-Service Portal** | | IsPublishedInPublicKb | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Solution has been published as a Public Solution (true) or not (false). Label is **Visible in Public Knowledge Base**. This field only applies to solutions, not articles in the public knowledge base. | | IsReviewed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the Solution has been reviewed (true) or not (false). This flag can only be set indirectly via the Status picklist. Each predefined Status value implies an IsReviewed value. Label is **Reviewed**. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who owns the Solution. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | ParentId | Type reference Properties Create, Defaulted on create, Filter, Update Description ID of the master solution, if this is the translation of a master solution. | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Update Description ID of the RecordType to which the Solution is associated. | | SolutionLanguage | Type picklist Properties Create, Filter, Restricted picklist, Update Description The language that the solution is written in, such as French or Chinese (Traditional). | | SolutionName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. If a client application creates a new Solution and a value for this field is unspecified, a hyphen (-), the default value for this field, is used. Limit: 255 characters. Label is **Title**. | | SolutionNote | Type textarea Properties Create, Nillable, Update Description The details of the Solution record. Limit: 32,000 characters. Label is **Solution Details**. If you have HTML Solutions enabled, any HTML tags used in this field are verified before the object is created or updated. If invalid HTML is entered, an error is thrown. Any JavaScript used in this field is removed before the object is created or updated. SolutionNote operates as a special type of String. If you have HTML Solutions enabled, any HTML tags used in this field are verified before the object is created or updated. If invalid HTML is entered, an error is thrown. Any JavaScript used in this field is removed before the object is created or updated. In the following example, when the Solution displays on a detail page, the SolutionNote field has H1 HTML formatting applied to it: trigger t on Solution (before insert) { Trigger.new\[0\].SolutionNote ='

hello

'; } In the following example, when the Solution displays on a detail page, the SolutionNote field only contains HelloGoodbye: trigger t2 on Solution (before insert) { Trigger.new\[0\].SolutionNote = 'HelloGoodbye'; } For more information, see [HTML Solutions Overview](https://help.salesforce.com/s/articleView?id=service.sol_html_def.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. | | SolutionNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An identifying number that is assigned automatically when a solution is created. It can’t be set directly, and it can’t be modified. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. The status of the solution. Directly controls the IsReviewed value. To obtain the status values in the picklist, a client application can query the SolutionStatus. | | TimesUsed | Type int Properties Filter, Group, Sort Description Number of times this solution has been used. Label is **Num Related Case**. | ## Usage Use this object to manage your organization’s solutions. Client applications can create, update, delete, and query Attachment records associated with a solution. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [SolutionFeed](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.") (API version 18.0) Feed tracking is available for the object. [SolutionHistory](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. #### See Also - [CategoryData](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_categorydata.htm "Represents a logical grouping of Solution records.") - [CategoryNode](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_categorynode.htm "Represents a tree of Solution categories.") # SolutionStatus Represents the status of a Solution, such as Draft, Reviewed, and so on. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an id or primary label. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default solution status value (true) or not (false) in the picklist. Only one value can be the default value. | | IsReviewed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this solution status value represents a reviewed Solution (true) or not (false). Multiple solution status values can represent a reviewed Solution. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Label for this solution status value. This display value is the internal label that does not get translated. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the solution status picklist. These numbers are not guaranteed to be sequential, as some previous solution status values might have been deleted. | ## Usage This object represents a value in the solution status picklist. The solution status picklist provides additional information about the status of a Solution, such as whether a given status value represents a reviewed or unreviewed solution. Your client application can query this object to retrieve the set of values in the solution status picklist, and then use that information while processing Solution objects to determine more information about a given solution. For example, the application could test whether a given case has been reviewed or not based on its Status value and the value of the IsReviewed property in the associated SolutionStatus record. #### See Also - [Solution](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_solution.htm "Represents a detailed description of a customer issue and the resolution of that issue.") # SolutionTag Associates a word or short phrase with a Solution. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage SolutionTag stores the relationship between its parent TagDefinition and the Solution being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. # SOSDeployment Represents the general settings for deploying SOS video call capability in a native mobile application. This object is available in API version 34.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | DeveloperName | Type string Properties 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the deployment. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The name of the deployment. | | OptionsIsBackwardFacingCameraEnabled | Type boolean Properties Create, Filter, Update Description Determines whether customers can use the backwards-facing camera on their mobile devices to talk to SOS agents. | | OptionsIsEnabled | Type boolean Properties Create, Filter, Update Description Determines whether the deployment is enabled for customers to request new SOS video calls. | | OptionsIsVoiceOnlyMode | Type boolean Properties Create, Filter, Update Description Determines whether video functionality is disabled for customers, making it so customers can only talk to SOS agents using only audio. | | QueueId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the queue that’s associated with the SOS deployment. | ## Usage Use this object to query and manage SOS deployments. # SOSSession This object is automatically created for each SOS session and stores information about the session. This object is available in API versions 34.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AppVersion | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The version of the customer’s mobile application in which SOS is implemented. | | CaseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the case that’s associated with the SOS session. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the contact that’s associated with the SOS session. | | DeploymentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the SOS deployment that the SOS session originated from. | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time that the SOS session ended. | | IpAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description To protect the customer’s privacy, this field is now blank. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the session record was last referenced by a user. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the session record was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The name of the session. | | OpentokSession | Type encryptedstring Properties Create, Nillable, Update Description The ID of the OpenTok session that’s associated with the SOS video call. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the session record’s owner. | | SessionDuration | Type int Properties Filter, Group, Nillable, Sort Description The amount of time that the SOS session lasted. | | SessionRecordingUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL where the SOS session recording is stored. | | SosVersion | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The version of SOS that was used in your organization’s mobile application when this session occurred. | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time that the SOS session began. | | SystemInfo | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Information about the customer’s mobile device from which the SOS call originated, such as the device’s operating system. | | WaitDuration | Type int Properties Filter, Group, Nillable, Sort Description The amount of time the customer waited before an agent accepted the SOS session and the call began. | ## Usage Use this object to query and manage SOS session records. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [SOSSessionFeed](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. [SOSSessionHistory](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. [SOSSessionOwnerSharingRule](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. [SOSSessionShare](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. # SOSSessionActivity Captures information about specific events that occur during an SOS video call, such as when an SOS call begins or ends. This object is available in API version 34.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ActivityTime | Type dateTime Properties Create, Filter, Sort Description The time at which the activity occurred. | | Name | Type string Properties Autonumber, Defaulted on create, idLookup, Filter, Sort Description The name of the activity. | | SessionId | Type reference Properties Create, Filter, Group, Sort Description The ID of the SOS session that’s associated with the event. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The kind of activity that occurred. | ## Usage Use this object to query and manage SOS session activities. # SourceCodeRepoProvider Represents a supported source (version) control system like GitHub or Bitbucket. This object is available in API version 66.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BaseUrl | Type string Properties Create, Filter, Group, Sort, Update Description The base URL of the source control repository provider. For example, https://github.com. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique name for the source control repository provider. | | NamedCredential | Type string Properties Create, Filter, Group, Sort, Update Description The name of the named credential that DevOps Center uses to connect to this source control provider. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user or group that owns this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Provider | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The provider of this repository. Possible values are: - BITBUCKET - GITHUB The default value is GITHUB. | ## 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. [SourceCodeRepoProviderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [SourceCodeRepoProviderFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [SourceCodeRepoProviderHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [SourceCodeRepoProviderOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [SourceCodeRepoProviderShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # SourceCodeRepository Represents a specific version control repository hosted by a provider, such as GitHub, that stores the metadata and configuration data for a DevOps Center project. Multiple projects can reference the same repository. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DefaultBranch | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the primary branch in the repository that contains all the changes you plan to release. In GitHub, this branch is typically called main. | | ExternalRepositoryName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the repository as it appears on the provider. For example, my-dx-project. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the repository record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user or group that owns this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Provider | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The provider of this repository. Possible values are: - BITBUCKET - GITHUB The default value is GITHUB. | | ProviderInfo | Type textarea Properties Create, Nillable, Update Description Additional provider-specific configuration or metadata in a JSON or text format. | | RepositoryOwner | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The username or organization name that owns the repository. | | SourceCodeRepoProviderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the associated SourceCodeRepoProvider that handles the connection to this repository. This field is a relationship field. Relationship Name SourceCodeRepoProvider Refers To SourceCodeRepoProvider | ## 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. [SourceCodeRepositoryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [SourceCodeRepositoryFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [SourceCodeRepositoryHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [SourceCodeRepositoryOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [SourceCodeRepositoryShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. #### See Also - [SourceCodeRepoProvider](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sourcecoderepoprovider.htm "Represents a supported source (version) control system like GitHub or Bitbucket. This object is available in API version 66.0 and later.") - [SourceCodeRepositoryBranch](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sourcecoderepositorybranch.htm "Represents a specific branch within a source control repository, such as a feature branch for a work item or a release branch for a pipeline stage. Work Item and Pipeline Stage records refer to this object. This object is available in API version 66.0 and later.") - [DevopsProject](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsproject.htm "Represents a Lifecycle Center project. A project is the primary workspace where teams collaborate to manage changes for an app or customization. This object is the parent for all other Lifecycle Center objects, including pipelines, environments, and work items. This object is available in API version 67.0 and later.") # SourceCodeRepositoryBranch Represents a specific branch within a source control repository, such as a feature branch for a work item or a release branch for a pipeline stage. Work Item and Pipeline Stage records refer to this object. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | IgnoreRules | Type textarea Properties Create, Nillable, Update Description Serialized JSON representation of the preprocessed contents of the .forceignore file on the branch. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the branch as it exists in the source control provider. For example, feature/WI-000001. | | ParentRemoteReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier of the parent branch from which this branch was originally created. In GitHub, this ID is called a SHA. DevOps Center uses this ID to recreate the branch if necessary. | | RemoteReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier representing the latest synced state of this branch in the source control provider. In GitHub, this ID is called the HEAD SHA. | | RemoteReferenceDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last date and time when the branch identified by Remote Reference field was last updated or synced. | | SourceCodeRepositoryId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent SourceCodeRepository record in which the branch lives. This field is a relationship field. Relationship Name SourceCodeRepository Relationship Type Master-detail Refers To SourceCodeRepository (the master object) | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the current health or sync state of the branch. Possible values are: - DEPLOYMENT\_ERROR—A deployment to the environment associated with this branch failed. - MERGE\_CONFLICT—A conflict exists between this branch and its target promotion branch. | ## Usage Use this object to track the state of the feature branch every time a developer starts a new work item. Similarly, each stage in a pipeline is mapped to a specific branch defined in this object. It stores remote references (commit SHAs) and tracks sync issues like merge conflicts. ## 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. [SourceCodeRepositoryBranchChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [SourceCodeRepositoryBranchFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [SourceCodeRepositoryBranchHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [SourceCodeRepositoryBranchOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [SourceCodeRepositoryBranchShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. #### See Also - [SourceCodeRepository](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sourcecoderepository.htm "Represents a specific version control repository hosted by a provider, such as GitHub, that stores the metadata and configuration data for a DevOps Center project. Multiple projects can reference the same repository. This object is available in API version 66.0 and later.") - [DevopsPipelineStage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelinestage.htm "Represents a connection between a pipeline, an environment, and the source control branch used for that stage. The collection of all pipeline stages in a project make up the Lifecycle Center pipeline. This object is available in API version 66.0 and later.") - [WorkItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workitem.htm "Represents a logical unit of work, such as a user story, task, or bug, used to track the progress of metadata and configuration data changes within a Lifecycle Center project. A work item moves through multiple development lifecycle stages until all development work is complete and the work item is part of the release pipeline. This object is available in API version 67.0 and later.") - [DevopsPipelnStgPromWkItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelnstgprom.htm "Represents a stage promotion in Lifecycle Center. Stage promotion moves one or more work items to the next stage in the pipeline. This object is available in API version 66.0 and later.") # StagedEmail For internal use only. # StagedInviteeEmail Represents an email address that is included on a calendar event but that doesn’t match an existing user, contact, or lead record. This object is available in API version 66.0 and later. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules This object is available with Einstein Activity Capture when Sync Email as Salesforce Activity is turned on. ## Fields | Field | Details | | --- | --- | | Name | Type email Properties Filter, Group, idLookup, Sort Description The invited email address. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the record owner. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | # StagedUnmtchdEmailAddr Represents data about an email address identified by Einstein Activity Capture that doesn’t match to an existing user, contact, or lead record. These addresses are only stored temporarily. Related to StagedUnmtchdEmailAddrRela, which represents data about the email message or calendar event activity associated with an unmatched email. This object is available in API version 66.0 and later. These addresses are only stored temporarily. An unmatched email address is automatically deleted from StagedUnmtchdEmailAddr if it converts into a contact record. To convert, a user saves it from their Suggested Contacts list or the address crosses a threshold in the automatic contact creation setting. An unmatched email address is also deleted after 30 days from the initial appearance without subsequent activity. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() ## Special Access Rules This object is available with Einstein Activity Capture when Sync Email as Salesforce Activity is turned on. If you turn on Einstein Activity Capture in Summer ’25 or later, Sync Email as Salesforce Activity is enabled by default. ## Fields | Field | Details | | --- | --- | | CreatedContactOrLeadId | Type reference Properties Filter, Group, Nillable, Sort Description The ID for the contact or lead record created from a suggestion. Read only. This field is a polymorphic relationship field. Relationship Name CreatedContactOrLead Refers To Contact, Lead | | EmailAddress | Type email Properties Filter, Group, idLookup, Sort Description The email address of the suggested contact. This address doesn’t match any existing user, contact, or lead. (Read only.) | | FirstName | Type string Properties Filter, Group, Nillable, Sort, Update Description First name of the suggested contact. | | IgnoreSuggestionEndDate | Type date Properties Filter, Group, Nillable, Sort, Update Description If a user dismisses a suggestion, it isn't suggested again until this date. | | LastInteractionDate | Type date Properties Filter, Group, Nillable, Sort Description The date the user last interacted with the unmatched email address through email or a scheduled calendar event. (Read only.) | | LastName | Type string Properties Filter, Group, Nillable, Sort, Update Description Last name of the suggested contact. | | OccurrenceCount | Type int Properties Filter, Group, Nillable, Sort Description Total number of times the user and the unmatched email address occur together. (Read only.) | | UserId | Type reference Properties Filter, Group, Sort Description The unique ID of the user associated with the unknown email address. (Read only.) This field is a relationship field. Relationship Name User Refers To User | # StagedUnmtchdEmailAddrRela Represents data about the message or event activity associated with an email address that Einstein Activity Capture can’t match with an existing user, contact, or lead record. Related to StagedUnmtchdEmailAddr, which represents data about the unmatched email address. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available with Einstein Activity Capture when Sync Email as Salesforce Activity is turned on. If you turn on Einstein Activity Capture in Summer ’25 or later, Sync Email as Salesforce Activity is enabled by default. ## Fields | Field | Details | | --- | --- | | RelatedActivityId | Type reference Properties Filter, Group, Sort Description The unique ID of the related activity record, such as an email message or calendar event. This field is a polymorphic relationship field. Relationship Name RelatedActivity Refers To EmailMessage, Event, StagedEmail | | SourceActivity | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The activity type. Possible values are: - Event - StagedEmail - EmailAddress | | StagedUnmatchedEmailAddressId | Type reference Properties Filter, Group, Sort Description The unique ID of the related unmatched email address record. This field is a relationship field. Relationship Name StagedUnmatchedEmailAddress Relationship Type Master-detail Refers To StagedUnmtchdEmailAddr | # Stamp Represents a User Specialty. This object is available in API version 39.0 and later. Create User Specialty labels. Specialties can be any term you want, up to 50 characters, including spaces and underscores. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Description | | --- | --- | | Description | Type string Properties Filter, Group, Nillable, Sort Description Use this field to describe what the user specialty means and how it applies to a user. You have a 255 character maximum including spaces and underscores. | | MasterLabel | Type string Properties Filter, Group, Sort Description The User Specialty label that appears under the user’s profile picture. You can create any label you want as long as it’s within the 50 character maximum, including spaces and underscores. | | ParentId | Type reference Properties Filter, Group, Sort Description The id of the org or network. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To Organization | # StampAssignment Represents assignment of a User Specialty to a user. This object is available in API version 39.0 and later. Assign a User Specialty to users. This label appears beneath their profile photo. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | StampId | Type reference Properties Filter, Group, Sort Description The unique id generated when creating a user specialty. This is a relationship field. Relationship Name Stamp Relationship Type Lookup Refers To Stamp | | SubjectId | Type reference Properties Filter, Group, Sort Description The id for the user getting the User Specialty label. This is a relationship field. Relationship Name Subject Relationship Type Lookup Refers To User | # Standard Objects This section provides a list of standard objects and their standard fields. Only a subset of standard objects appear in Object Manager. Some fields may not be listed for some objects. To see the system fields for each object, see [System Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/system_fields.htm "System fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example, the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies a record."). To verify the complete list of fields for an object, use a describe call from the API, or inspect with an appropriate tool. For example, inspecting the WSDL or using a schema viewer. - **[AbnExperiment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_abnexperiment.htm)** Represents an A/B/n experiment that's used with Marketing Cloud Next content, Experience Cloud websites, and platform automations. This object is available in API version 63.0 and later. - **[AbnExperimentCohort](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_abnexperimentcohort.htm)** Represents the specified audience that's participating in an A/B/n experiment. This object is available in API version 63.0 and later. - **[AcceptedEventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_acceptedeventrelation.htm)** Represents event participants (invitees or attendees) with the status Accepted for a given event. - **[Account](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm)** Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners). - **[AccountBrand](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountbrand.htm)** Represents the brand details of a Partner Account. This object is available in API version 43.0 and later. - **[AccountContactRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountcontactrelation.htm)** Represents a relationship between a contact and one or more accounts. - **[AccountCleanInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountcleaninfo.htm)** Stores the metadata Data.com Clean uses to determine an account record’s clean status. AccountCleanInfo helps you automate the cleaning or related processing of account records. This object is removed in API version 67.0 - **[AccountContactRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountcontactrole.htm)** Represents the role that a Contact plays on an Account. - **[AccountInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountinsight.htm)** Represents an individual insight (a key business development) related to an account record. - **[AccountOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm)** Represents the rules for sharing an account with a User other than the owner. - **[AccountPartner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountpartner.htm)** This object represents a partner relationship between two Account records. An AccountPartner record is created automatically when a Partner record is created for a partner relationship between two accounts. An AccountPartner record is also created automatically between an account and an opportunity’s account when a Partner record is created between an account and an opportunity. - **[AccountPlan](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountplan.htm)** Represents customer information with measurable objectives and executable steps to proactively manage and grow customer relationships. This object is available in API version 62.0 and later. - **[AccountPlanObjective](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountplanobjective.htm)** Represents strategic objectives or initiatives pursued by a relationship team with a customer to enhance customer engagement and satisfaction. This object is available in API version 62.0 and later. - **[AccountPlanObjectiveMeasure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountplanobjectivemeasure.htm)** Represents the performance of target metrics for an objective associated with the account plan. This object is available in API version 62.0 and later. - **[AccountPlanObjMeasCalcCond](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountplanobjmeascalccond.htm)** Represents a field and value combination for filtering records to include in the calculation of a sales account plan objective measure’s current value. This object is available in API version 63.0 and later. - **[AccountPlanObjMeasCalcDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountplanobjmeascalcdef.htm)** Represents the definition of a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure. This object is available in API version 63.0 and later. - **[AccountPlanObjMeasCalcDefLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountplanobjmeascalcdeflocalization.htm)** Represents the translated value of the definition of a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure. This object is available in API version 63.0 and later when the Translation Workbench is enabled. - **[AccountPlanObjMeasRela](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountplanobjmeasrela.htm)** Represents a junction between an account plan objective measure and the related objects. This object is available in API version 62.0 and later. - **[AccountProspectingAgentResearch](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountprspagntrsrch.htm)** Represents research done by a prospecting agent on an account record. - **[AccountRelationship](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountrelationship.htm)** Represents a relationship of a given type between two accounts. This object is available in API version 45.0 and later. - **[AccountRelationshipShareRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountrelationshipsharerule.htm)** Represents the rule that determines which object records are shared, how they are shared, the account relationship type that shares the records, and the level of access granted to the records. This object is available in API version 45.0 and later. - **[AccountShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountshare.htm)** Represents a sharing entry on an account. - **[AccountTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accounttag.htm)** Associates a word or short phrase with an Account. - **[AccountTeamMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountteammember.htm)** Represents a User who is a member of an Account team. - **[AccountTerritoryAssignmentRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountterritoryassignmentrule.htm)** An account assignment rule that assigns accounts to territories based on account fields. Available if Sales Territories has been enabled. - **[AccountTerritoryAssignmentRuleItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountterritoryassignmentruleitem.htm)** A row of selection criteria for an AccountTerritoryAssignmentRule object. Available if Sales Territories has been enabled. - **[AccountTerritorySharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountterritorysharingrule.htm)** Represents the rules for sharing an Account within a territory. - **[AccountUserTerritory2View](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountuserterritory2view.htm)** Represents the view of the Users in Assigned Territories related list in Lightning Experience for Sales Territories. Available in API version 42.0 and later. - **[ActionCadence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadence.htm)** Represents the definition of a cadence. This object is available in API version 45.0 and later. - **[ActionCadenceRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerule.htm)** Represents the logic that a branch step uses to determine which branch an action cadence tracker follows in an action cadence. Use ActionCadenceRule to learn about a branch step, including its logic and what the next step is. This object is available in API version 48.0 and later. - **[ActionCadenceRuleCondition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencerulecondition.htm)** Represents the logic for a branch step. This object is available in API version 48.0 and later. - **[ActionCadenceStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencestep.htm)** Represents a step in a cadence. Use ActionCadenceStep to learn which steps belong to a cadence, and how the steps are connected to each other. This object is available in API version 48.0 and later. - **[ActionCadenceStepTracker](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencesteptracker.htm)** Represents a step in an active cadence for a specific cadence target. This object is available in API version 48.0 and later. - **[ActionCadenceStepVariant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencestepvariant.htm)** Represents an email template or call script variant associated with an action cadence step. Email and call steps can have up to 3 variants associated so sales teams can compare the engagement results. This object is available in API version 53.0 and later. - **[ActionCadenceTracker](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncadencetracker.htm)** Represents an active cadence target. This object is available in API version 45.0 and later. - **[ActionCdncStpMonthlyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actioncdncstpmonthlymetric.htm)** Represents the monthly engagement metrics for an action cadence step. This object is available in API version 49.0 and later. - **[ActionLinkGroupTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionlinkgrouptemplate.htm)** Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking on an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. Every action link belongs to an action link group and action links within the group are mutually exclusive. This object is available in API version 33.0 and later. - **[ActionLinkTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionlinktemplate.htm)** Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. This object is available in API version 33.0 and later. - **[ActionPlan](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionplan.htm)** Represents the instance of an action plan, a set of tasks created from an action plan template. This object is available in API version 44.0 and later. - **[ActionPlanItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionplanitem.htm)** Represents the instance of an action plan item.This object is available in API version 44.0 and later. - **[ActionPlanTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionplantemplate.htm)** Represents the instance of an action plan template. This object is available in API version 44.0 and later. - **[ActionPlanTemplateItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateitem.htm)** Represents the instance of an item on an action plan template version. This object is available in API version 44.0 and later. - **[ActionPlanTemplateItemValue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateitemvalue.htm)** Represents the value associated with an action plan template item. This object is available in API version 44.0 and later. - **[ActionPlanTemplateVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateversion.htm)** Represents the version of an action plan template. This object is available in API version 44.0 and later. - **[ActiveFeatureLicenseMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activefeaturelicensemetric.htm)** Represents the number of active, assigned, and purchased feature licenses in the org. This object is available in API version 52.0 and later. - **[ActivePermSetLicenseMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activepermsetlicensemetric.htm)** Represents the number of active, assigned, and purchased permission set licenses in the org. This object is available in API version 52.0 and later. - **[ActiveProfileMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activeprofilemetric.htm)** Represents the profile associated with the active, assigned, and purchased user licenses. This object is available in API version 52.0 and later. - **[ActiveScratchOrg](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activescratchorg.htm)** Represents an active scratch org. This object is available in API version 41.0 and later. - **[ActivityFieldHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activityfieldhistory.htm)** Represents a change in a field value for a tracked object or field. This object is a big object. This object is available in API version 55.0 and later. - **[ActivityHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activityhistory.htm)** This read-only object is displayed in a related list of closed activities—past events and closed tasks—related to an object. It includes activities for all contacts related to the object. ActivityHistory fields for phone calls are only available if your organization uses Salesforce CRM Call Center. - **[ActivityMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activitymetric.htm)** Represents activities that were added to Salesforce automatically by Einstein Activity Capture and manually by users. - **[ActivityUsrConnectionStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_activityusrconnectionstatus.htm)** Represents the status of the email connections for Einstein Activity Capture users. You can also see whether users accepted the required terms of service to capture emails. This object is available in API version 54.0 and later. - **[AdditionalNumber](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_additionalnumber.htm)** Represents an optional additional number for a call center. This additional number is visible in the call center's phone directory. - **[Address](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_address.htm)** Represents a mailing, billing, or home address. - **[AgentQltyEvalFormCondition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_agentqltyevalformcondition.htm)** Defines a single condition in a quality evaluation criterion. Each condition evaluates an interaction attribute such as the assigned queue, agent skill, or contact reason against expected values. This object is available in API version 68.0 and later. - **[AgentQltyEvalFormCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_agentqltyevalformcriteria.htm)** Defines a named rule with evaluation criteria and priority settings to map incoming interactions to the appropriate evaluation form. This object is available in API version 68.0 and later. - **[AgentWork](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_agentwork.htm)** Represents a work assignment that’s been routed to an agent. If the work is transferred to another agent, a new AgentWork record is created. This object is available in API version 32.0 and later. - **[AgentWorkConversationalData](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_agentworkconversationaldata.htm)** Stores conversation data for agent work sessions, such as agent interactions, transfer information, and operational metrics. This object is available in API version 66.0 and later. - **[AgentWorkSkill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_agentworkskill.htm)** Represents a skill used to route a work assignment to an agent. AgentWorkSkill is used for reporting and represents the result of a routing decision. This object is available in API version 42.0 and later. - **[AIApplication](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aiapplication.htm)** Represents an AI application such as Einstein Prediction Builder. This object is available in API version 50.0 and later. - **[AIApplicationConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aiapplicationconfig.htm)** Additional prediction information related to an AI application. This object is available in API version 50.0 and later. - **[AiGenActionItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aigenactionitem.htm)** Represents business actions suggested by generative AI. AI-generated action items are sent to either agents for automatic execution or human users for review, depending on org preference and if there are any errors in the process. This object is available in API version 64.0 and later. - **[AiGenActionItemInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aigenactioniteminfo.htm)** Represents the contextual information for AI-generated actions. It tracks the agent recommendations, their rationale, and the current action status. This object is available in API version 67.0 and later. - **[AIInsightAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aiinsightaction.htm)** Represents an Einstein prediction insight action. This object is available in API version 47.0 and later. - **[AIInsightFeedback](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aiinsightfeedback.htm)** Represents an Einstein prediction insight feedback. This object is available in API version 47.0 and later. - **[AIInsightReason](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aiinsightreason.htm)** Represents an Einstein prediction insight reason. This object is available in API version 47.0 and later. - **[AIInsightValue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aiinsightvalue.htm)** Represents an Einstein prediction insight value. This object is available in API version 47.0 and later. - **[AiJobRun](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aijobrun.htm)** Represents an execution instance of an AI job. This object tracks the overall status and manages the lifecycle of the job from initiation to completion. This object is available in API version 63.0 and later. - **[AiJobRunItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aijobrunitem.htm)** Stores an individual item associated with a parent AiJobRun, including the inputs and resulting response. This object is available in API version 63.0 and later. - **[AiModelLanguage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aimodellanguage.htm)** An object that stores language related information that is generated for each AI model. This object is available in API version 55.0 and later. - **[AIRecordInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_airecordinsight.htm)** Represents an Einstein prediction insight. This object is available in API version 47.0 and later. - **[AIResearchPromptResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_airesearchpromptresult.htm)** Represents the research result generated by Agentforce or by a generative AI feature from a standard or custom prompt template. This object is available in API version 64.0 and later. - **[AllowedEmailDomain](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_allowedemaildomain.htm)** Represents an allowed email domain for users in your organization. You can define an allowlist to restrict the email domains allowed in a user’s Email field. This object is available in API version 29.0 and later. - **[AlternativePaymentMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_alternativepaymentmethod.htm)** Represents a payment method that isn’t cash, a debit card, or a credit card. This object defines methods that aren’t defined by the [CardPaymentMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cardpaymentmethod.htm "Represents a credit card or debit card payment method, which implements the PaymentMethod object. This object is available in API version 48.0 and later.") or [DigitalWallet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_digitalwallet.htm "Represents a customer’s digital wallet service. Salesforce Payments can use a digital wallet as a payment source when processing payments through a payment gateway. This object is available in API version 48.0 and later.") objects. Examples of alternative payment methods include CashOnDeliver, Klarna, and Direct Debit. AlternativePaymentMethod functions the same as any other type of payment method for processing transactions through a payment gateway. This object is available in API version 51.0 and later. - **[AnalyticsAssetAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsassetaction.htm)** Represents a Tableau Next asset action. This object is available in API version 67.0 and later. - **[AnalyticsChangeEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticschangeeventlog.htm)** Analytics Change Event Logs represent route or page changes made in the CRM Analytics. This object is available in API version 61.0 and later. - **[AnalyticsContainerWidgetDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticscontainerwidgetdef.htm)** Represents a Tableau Next dashboard container widget definition. This object is available in API version 67.0 and later. - **[AnalyticsDashboard](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsdashboard.htm)** Represents a Tableau Next dashboard. This object is available in API version 64.0 and later. - **[AnalyticsDashboardWidget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsdashboardwidget.htm)** Represents a Tableau Next dashboard widget. This object is available in API version 67.0 and later. - **[AnalyticsDownloadEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsdownloadeventlog.htm)** AnalyticsDownloadEventLog represent downloads made from lens and dashboard in the CRM Analytics. This object is available in API version 61.0 and later. - **[AnalyticsInteractEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsinteracteventlog.htm)** Analytics Interact Event Log represents route or page changes made in the CRM Analytic UI. This object is available in API version 61.0 and later. - **[AnalyticsLicensedAsset](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticslicensedasset.htm)** Represents a licensed Analytics asset. In this context, Analytics is CRM Analytics, Sonic, or Mulesoft Data Path. Available in API version 52.0 and later. - **[AnalyticsPerfEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsperfeventlog.htm)** Analytics Perf Event Log helps track trends in your Analytics performance. This object is available in API version 61.0 and later. - **[AnalyticsVisualization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsvisualization.htm)** Represents a Tableau Next viusalization. This object is available in API version 64.0 and later. - **[AnalyticsVizField](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsvizfield.htm)** Represents a Tableau Next viusalization field. This object is available in API version 65.0 and later. - **[AnalyticsVizViewDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsvizviewdef.htm)** Represents a Tableau Next viusalization view definition. This object is available in API version 64.0 and later. - **[AnalyticsWorkspace](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsworkspace.htm)** Represents a Tableau Next workspace. This object is available in API version 54.0 and later. - **[AnalyticsWorkspaceAsset](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_analyticsworkspaceasset.htm)** Represents a Tableau Next asset in a workspace. This object is available in API version 54.0 and later. - **[Announcement](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_announcement.htm)** Represents a Chatter group announcement. This object is available in API version 30.0 and later. - **[ApexCalloutEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexcallouteventlog.htm)** Apex Callout event logs contain details about callouts (external requests) during Apex code execution. This object is available in API version 55.0 and later. - **[ApexClass](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexclass.htm)** Represents an Apex class. - **[ApexComponent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexcomponent.htm)** Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as and . - **[ApexEmailNotification](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexemailnotification.htm)** Stores a Salesforce user ID or external email address to be notified when unhandled Apex exceptions occur. This object is available in API version 35.0 and later. - **[ApexExecutionEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexexecutioneventlog.htm)** Apex Execution event logs contain details about Apex classes that are used. This object is available in API version 55.0 and later. - **[ApexExtlCalloutEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexextlcallouteventlog.htm)** Apex Extl Callout EventLog represent external data callouts via custom adapters for Salesforce Connect. This object is available in API version 61.0 and later. - **[ApexInlineEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexinlineeventlog.htm)** This object is reserved for future use. This object is available in API version 66.0 and later. - **[ApexLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexlog.htm)** Represents a debug log containing information about a transaction, including information about Apex, Visualforce, and workflow and validation rules. This object is available in API version 19.0 and later. - **[ApexPage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexpage.htm)** Represents a single Visualforce page. - **[ApexPageInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexpageinfo.htm)** Represents metadata about a single Visualforce page. This object is available in API version 48.0 and later. - **[ApexRestApiEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexrestapieventlog.htm)** Apex REST API event logs capture information about every Apex REST API request. This object is available in API version 55.0 and later. - **[ApexSoapApiEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexsoapapieventlog.htm)** Apex SOAP event logs contain details about custom SOAP web service calls. This object is available in API version 55.0 and later. - **[ApexTestQueueItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestqueueitem.htm)** Represents a single Apex class in the Apex job queue. This object is available in API version 23.0 and later. - **[ApexTestResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestresult.htm)** Repres ents the result of an Apex test method execution. This object is available in API version 23.0 and later. - **[ApexTestResultLimits](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestresultlimits.htm)** Captures the Apex test limits used for a particular test method execution. An instance of this object is associated with each ApexTestResult record. This object is available in API version 37.0 and later. - **[ApexTestRunResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestrunresult.htm)** Contains summary information about all the test methods that were run in a particular Apex job. This object is available in API version 37.0 and later. - **[ApexTestSuite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestsuite.htm)** Represents a suite of Apex classes to include in a test run. A TestSuiteMembership object associates each class with the suite. This object is available in API version 36.0 and later. - **[ApexTrigger](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextrigger.htm)** Represents an Apex trigger. - **[ApexTriggerEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextriggereventlog.htm)** Apex Trigger event logs contain details about triggers that fire in an organization. This object is available in API version 55.0 and later. - **[ApexTypeImplementor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextypeimplementor.htm)** Represents Apex classes that directly or indirectly implement an interface. Using a SOQL query, this object gets information about public or global classes and only global classes for installed managed packages. This object is available in API version 54.0 and later. - **[ApexUnexpectedExcpEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexunexpectedexcpeventlog.htm)** Apex Unexpected Excp Event Log captures information about unexpected exceptions in Apex code execution. This object is available in API version 61.0 and later. - **[ApiTotalUsageEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apitotalusageeventlog.htm)** API Total Usage Event Log contains details about Platform SOAP API, Platform REST API, and Bulk API requests. This object is available in API version 61.0 and later. - **[AppAnalyticsQueryRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appanalyticsqueryrequest.htm)** Represents a request for AppExchange App Analytics data. - **[AppDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appdefinition.htm)** Represents the metadata of an app and its navigation items. Metadata is returned only for apps that the current user can access. This object is available in API version 43.0 and later. - **[AppExtension](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appextension.htm)** Represents a connection between the Field Service mobile app and another app, typically for passing record data to the Salesforce mobile app or other apps. This object is available in API version 41.0 and later. - **[ApplicationFormTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_applicationformtemplate.htm)** Represents the fields to capture application metadata as a template which is used in application tracking and processing. This object is available in API version 59.0 and later. - **[AppMenuItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appmenuitem.htm)** Represents the organization’s default settings for items in the app menu or App Launcher. - **[AppointmentAssignmentPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appointmentassignmentpolicy.htm)** Stores information about resource assignment rules. This object is available in API version 52.0 and later. - **[AppointmentScheduleAggr](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appointmentscheduleaggr.htm)** Records the utilization of a service resource, by date, for the Load Balancing appointment assignment policy. This object is available in API version 52.0 and later. - **[AppointmentScheduleLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appointmentschedulelog.htm)** Stores service appointments of each service Resource. This object is used to calculate the utilization of a service resource for the AppointmentScheduleAggr object. This object is available in API version 52.0 and later. - **[AppointmentSchedulingPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appointmentschedulingpolicy.htm)** Represents a set of rules for scheduling appointments using Salesforce Scheduler. This object is available in API version 45.0 and later. - **[AppointmentTopicTimeSlot](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appointmenttopictimeslot.htm)** Represents a lookup to a work type or a work type group for a time slot This object is available in API version 52.0 and later. - **[Approval](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_approval.htm)** Represents an approval request for a Contract. - **[ApprovalAlertContentDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_approvalalertcontentdef.htm)** Represents the mapping that links specific user-created email templates to different notification events such as initial assignment or reassignment within an Advanced Approvals flow. This object is available in API version 66.0 and later. - **[ApprovalDelegation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_approvaldelegation.htm)** Represents an approval delegation that transfers a user's approval responsibilities to another user, group, or queue for a specified date range. This object is available in API version 68.0 and later. - **[ApprovalSubmission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_approvalsubmission.htm)** Represents the instance of an approval request that's submitted for a record of the related object. This object is available in API version 62.0 and later. - **[ApprovalSubmissionDetail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_approvalsubmissiondetail.htm)** ApprovalSubmissionDetail contains additional information about operations happening during the approval lifecycle. It will not hold any information that’s already captured in the existing ApprovalSubmission and ApprovalWorkItem entities. This object is available in API version 62.0 and later. - **[ApprovalWorkItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_approvalworkitem.htm)** Contains run-time information about each step in an approval workflow, such as assignees and their decisions regarding the object's approval. Has a master-detail relationship with ApprovalSubmission. This object is available in API version 61.0 and later. - **[ApprovalWorkItemCondition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_approvalworkitemcondition.htm)** Represents a condition for starting and concluding an approval step that's evaluated as part of the smart approval process. This object is available in API version 64.0 and later. - **[ApprovalWorkItemCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_approvalworkitemcriteria.htm)** Represents the logic by which a smart approval request is evaluated. This object is available in API version 64.0 and later. - **[AppTabMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apptabmember.htm)** Represents the list of tabs for each of the available apps. This object is available in API version 43.0 and later. - **[ApptBundleAggrDurDnscale](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apptbundleaggrdurdnscale.htm)** Sums the duration of the bundle members, reduced by a predefined percentage. This object is available in API version 54.0 and later. - **[ApptBundleAggrPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apptbundleaggrpolicy.htm)** Policy that defines how the property values of the bundle members are aggregated and assigned to the bundle. This object is available in API version 54.0 and later. - **[ApptBundleConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apptbundleconfig.htm)** Represents the general parameters that define the behavior of the bundle. This object is available in API version 54.0 and later. - **[ApptBundlePolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apptbundlepolicy.htm)** Policy that defines how the bundling of service appointments should be handled. This object is available in API version 54.0 and later. - **[ApptBundlePolicySvcTerr](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apptbundlepolicysvcterr.htm)** Represents a link between the BundlePolicy and the ServiceTerritory. This object is available in API version 54.0 and later. - **[ApptBundlePropagatePolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apptbundlepropagatepolicy.htm)** Policy that defines which property values are inherited from the bundle to the bundle members or are assigned as constant values in the bundle members. This object is available in API version 55.0 and later. - **[ApptBundleRestrictPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apptbundlerestrictpolicy.htm)** Policy that defines the restrictions that are considered while forming a bundle. This object is available in API version 54.0 and later. - **[ApptBundleSortPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apptbundlesortpolicy.htm)** Policy that defines the properties by which the bundle members are sorted within the bundle. Can also be used in the automatic mode for determining the order of the automatic selection of bundle members. This object is available in API version 54.0 and later. - **[AppUsageAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_appusageassignment.htm)** Provides application context for a record. A record can have different allowed actions or different related objects when it’s created for different applications. For example, a Revenue Lifecycle Management order has a related RevenueLifecycleManagement AppUsageAssignment, so Salesforce knows it can create assets for that order. Available in API version 50.0 and later. - **[ArchiveActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_archiveactivity.htm)** Represents metadata retrieved for a single archive process initiated by an action. Retrieved metadata can include status tracking, start and end times, record counts, and monitoring and auditing outcomes. This object is available in API version 65.0 and later. - **[ArchivePolicyDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_archivepolicydefinition.htm)** Represents a data lifecycle policy in Salesforce. Each record defines the scope, frequency, and rules that govern automated archiving or purging of records from a root entity, such as Contact or Lead. This object is available in API version 65.0 and later. - **[Article Type\_\_DataCategorySelection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_articletype__datacategoryselection.htm)** A data category selection represents a data category that classifies an article. This object is available in API version 19.0 and later. - **[Asset](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_asset.htm)** Represents an item of commercial value, such as a product sold by your company or a competitor, that a customer has purchased. - **[AssetAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetaction.htm)** Represents a change made to a lifecycle-managed asset. The fields can’t be edited. This object is available in API version 50.0 and later. - **[AssetActionSource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetactionsource.htm)** Represents an optional way to record what transactions caused changes to lifecycle-managed assets. Use it to trace financial and other information about asset actions. This object supports Salesforce order products and work order line items, and transaction IDs from other systems. The fields can’t be edited. This object is available in API version 50.0 and later. - **[AssetAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetattribute.htm)** Stores asset attributes to track and analyze asset conditions to improve their uptime. This object is available in API version 57.0 and later. - **[AssetContractRelationship](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetcontractrelationship.htm)** Represents a relationship between an asset and a contract. This object is available in API version 60.0 and later. - **[AssetDowntimePeriod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetdowntimeperiod.htm)** Represents a period during which an asset is not able to perform as expected. Downtime periods include planned activities, such as maintenance, and unplanned events, such as mechanical breakdown. This object is available in API version 49.0 and later. - **[AssetOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetownersharingrule.htm)** Represents the rules for sharing an Asset with users other than the owner. This object is available in API version 33.0 and later. - **[AssetRateAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetrateadjustment.htm)** Stores the tier rate adjustments for the asset rate card entries.This object is available in API version 62.0 and later. - **[AssetRateCardEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetratecardentry.htm)** Stores the negotiated rate card entries that are associated with an asset in Revenue Cloud. This object is available in API version 62.0 and later. - **[AssetRelationship](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetrelationship.htm)** Represents a non-hierarchical relationship between assets due to an asset modification; for example, a replacement, upgrade, or other circumstance. In Revenue Lifecycle Management, this object represents an asset or assets grouped in a bundle or set. This object is available in API version 41.0 and later. - **[AssetShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetshare.htm)** Represents a sharing entry on an Asset. This object is available in API version 33.0 and later. - **[AssetStatePeriod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetstateperiod.htm)** Represents a time span when an asset has the same quantity, amount, and monthly recurring revenue (MRR). An asset has as many asset state periods as there are changes to it (asset actions) during its lifecycle. The dashboard and related pages show the current asset state period. The fields can’t be edited. This object is available in API version 50.0 and later. - **[AssetStatePeriodAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetstateperiodattribute.htm)** Represents a virtual object that holds the key-value pair of the asset attribute in a specified asset state period. This object is a child object of AssetStatePeriod. This object is available in API version 60.0 and later. - **[AssetTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assettag.htm)** Associates a word or short phrase with an Asset. - **[AssetTokenEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assettokenevent.htm)** The documentation has moved to [AssetTokenEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_assettokenevent.htm "HTML (New Window)") in the Platform Events Developer Guide. - **[AssetWarranty](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assetwarranty.htm)** Defines the warranty terms applicable to an asset along with any exclusions and extensions. This object is available in API version 50.0 and later. - **[AssignedResource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assignedresource.htm)** Represents a service resource who is assigned to a service appointment in Field Service and Lightning Scheduler. Assigned resources appear in the Assigned Resources related list on service appointments. This object is available in API version 38.0 and later. - **[AssignmentRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_assignmentrule.htm)** Represents an assignment rule associated with a Case or Lead. - **[AssociatedLocation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_associatedlocation.htm)** Represents a link between an account and a location in Field Service. You can associate multiple accounts with one location. For example, a shopping center location may have multiple customer accounts. - **[AsyncApexJob](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_asyncapexjob.htm)** Represents an individual Apex sharing recalculation job, a batch Apex job, a method with the future annotation, or a job that implements Queueable or Schedulable. Use this object to query Apex batch jobs in your organization. - **[AsyncOperationLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_asyncoperationlog.htm)** Represents an async operations log containing progress and status information about external synchronizations to the Omnichannel Inventory service. This object is available in API version 51.0 and later. - **[AsyncOperationTracker](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_asyncoperationtracker.htm)** Represents the status of an asynchronous request initiated from the Quote, Order, and CreditMemo objects. This object is available in API version 61.0 and later. - **[AsyncOpSyndicationFeedFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_asyncopsyndicationfeedfile.htm)** Represents the sync status of file-related information shared with external channels such as Facebook and Instagram. This object is available in API version 64.0 and later. - **[AttachedContentDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attachedcontentdocument.htm)** This read-only object contains all ContentDocument objects associated with an object. - **[AttachedContentNote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attachedcontentnote.htm)** This read-only object contains all ContentNote objects associated with an object.This object is available in API version 35.0 and later. - **[Attachment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attachment.htm)** Represents a file that a User has uploaded and attached to a parent object. - **[AttachmentEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attachmenteventlog.htm)** Attachment event logs contain information about attachments. This object is available in API version 65.0 and later. - **[AttribModel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attribmodel.htm)** Represents an attribution model used with Personalization, Attribution, and Campaign Influence, including model weights and touch type. This object is available in API version 62.0 and later. - **[AttribModelStage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attribModelStage.htm)** Represents a funnel stage that’s used in a predefined or custom attribution configuration. Available in API version 62.0 and later. - **[AttribModelStageMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attribModelStageMetric.htm)** Represents the engagement signal metrics that you select when you configure a funnel stage for an attribution configuration. Available in API version 63.0 and later. - **[AttributeDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributedefinition.htm)** Represents a product, asset, or object attribute, for example, a hardward specification or software detail. This object is available in API version 57.0 and later. - **[AttributePicklist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklist.htm)** Represents a custom picklist for an asset attribute. This object is available in API version 57.0 and later. - **[AttributePicklistValue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attributepicklistvalue.htm)** Represents the values of an asset attribute picklist. This object is available in API version 57.0 and later. - **[AsyncReportRunEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_asyncreportruneventlog.htm)** Async Report Run Event Log is used for reporting scheduled requests. This category includes dashboard refreshes, asynchronous reports, schedule reports, and analytics snapshots. This object is available in API version 61.0 and later. - **[Audience](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_audience.htm)** Represents an audience that is defined by criteria and can be assigned and used for targeting in an Experience Cloud site. This object is available in API version 44.0 and later. - **[AuraDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_auradefinition.htm)** Represents an Aura component definition, such as component markup, a client-side controller, or an event. This object is available in API version 32.0 and later. - **[AuraDefinitionBundle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_auradefinitionbundle.htm)** Represents a Lightning Aura component definition bundle, such as a component or application bundle. A bundle contains a Lightning Aura component definition and all its related resources. This object is available in API version 32.0 and later. - **[AuraDefinitionBundleInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_auradefinitionbundleinfo.htm)** For internal use only. - **[AuraDefinitionInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_auradefinitioninfo.htm)** For internal use only. - **[AuraRequestEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_aurarequesteventlog.htm)** Aura Request Event Log contains details of requests to Apex methods from Aura and Lightning web components. This object is available in API version 61.0 and later. - **[AuthConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authconfig.htm)** Represents authentication options for My Domain and Experience Cloud site login pages. This object is available in API version 32.0 and later. - **[AuthConfigProviders](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authconfigproviders.htm)** Represents an authentication provider that’s configured in an organization. AuthConfigProviders is a child of the AuthConfig object. This object is available in API version 32.0 and later. - **[AuthorizationForm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authorizationform.htm)** Represents the specific version and effective dates of a form that is associated with consent, such as a privacy policy or terms and conditions. This object is available in API version 46.0 and later. - **[AuthorizationFormConsent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authorizationformconsent.htm)** Represents the date and way in which a user consented to an authorization form. This object is available in API version 46.0 and later. - **[AuthorizationFormDataUse](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authorizationformdatause.htm)** Represents the data use consented to in an authorization form. This object is available in API version 46.0 and later. - **[AuthorizationFormText](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authorizationformtext.htm)** Represents an authorization form’s text and language settings. This object is available in API version 46.0 and later. - **[AuthProvider](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authprovider.htm)** Represents an authentication provider (auth provider). An auth provider lets users log in to your Salesforce org from an external service provider, such as Facebook, Google, or GitHub. This object is available in API version 27.0 and later. - **[AuthProvParamFwdAllowlist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authprovparamfwdallowlist.htm)** Represents an allowlisted URL parameter that can be forwarded from authentication provider client configuration URLs to the authorization URL. Use this type to add custom functionality to authentication providers. For example, allowlist a ui\_locales parameter and use it to send a user's language preference from Salesforce to the third-party provider's login page. This object is available in API version 62..0 and later. - **[AuthSession](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authsession.htm)** The AuthSession object represents an individual user session in your organization. This object is available in versions 29.0 and later. - **[AutomatedAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_automatedaction.htm)** Represents the configuration of an automated action, such as a workflow rule. This object is available in API version 57.0 and later. - **[AutomatedActionCondition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_automatedactioncondition.htm)** Represents the logical operator details for evaluating conditions in an automated action. This object is available in API version 57.0 and later. - **[AutomatedActionOverride](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_automatedactionoverride.htm)** Represents a modified attribute of a shared automated action. For example, the modified attribute can contain customizations for your business. This object is available in API version 58.0 and later. - **[AutomatedActionParameter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_automatedactionparameter.htm)** Represents the values or field references evaluated by the automated action. This object is available in API version 57.0 and later. - **[AutomatedActionReminder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_automatedactionreminder.htm)** Represents a reminder to the end user to take an action in the future. This object is available in API version 58.0 and later. - **[BackgroundOperation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_backgroundoperation.htm)** Represents a background operation in an asynchronous job queue. This object is available in API version 35.0 and later. - **[BackgroundOperationResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_backgroundoperationresult.htm)** Stores error messages generated when or importing data into big objects using Bulk API. This is a big object, available in API version 37.0 and later. - **[BatchApexErrorEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_batchapexerrorevent.htm)** The documentation has moved to [BatchApexErrorEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_batchapexerrorevent.htm "HTML (New Window)") in the Platform Events Developer Guide. - **[BillingBatchScheduler](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_billingbatchscheduler.htm)** Represents a scheduled processing job that triggers recurring invoice batch runs and payment batch runs in Subscription Management. This object is available in API version 55.0 and later. - **[BillingPeriodItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_billingperioditem.htm)** Represents one payment period for a subscription. The billing period item is used to pass billing information to an invoice line item in Subscription Management. This object is available in API version 55.0 and later. - **[BillingPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_billingpolicy.htm)** Represents a group of billing treatments, which define the rules for how to invoice a customer for an order item. This object is available in API version 55.0 and later. - **[BillingSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_billingschedule.htm)** Stores the order item information used in the invoicing process. This object is available in API version 55.0 and later. - **[BillingScheduleGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_billingschedulegroup.htm)** Represents a consolidated view of all billing schedules related to the order items generated from one asset, including new orders and amendment orders. This object is available in API version 55.0 and later. - **[BillingTreatment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_billingtreatment.htm)** Defines how Subscription Management bills an order item. The Exclude From Billing field controls whether the order item is invoiced. Child billing treatment items control how much of the order item's balance is invoiced for each invoice across the subscription's lifecycle. Billing treatments are assigned to order items based on the parent billing policy's Billing Treatment Selection field. This object is available in API version 55.0 and later. - **[BillingTreatmentItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_billingtreatmentitem.htm)** A billing treatment item defines how the order item's total amount is distributed into billing schedules over the course of the order item's lifecycle. In the Subscription Management pilot, billing treatments must have only one billing treatment item, so that the billing treatment item covers 100% of the order item's total value. This object is available in API version 55.0 and later. - **[BlockedRedirectEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_blockedredirecteventlog.htm)** Blocked Redirect events capture information about blocked redirections from Salesforce to untrusted and malformed URLs. This object is available in API version 65.0 and later. - **[Bookmark](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_bookmark.htm)** Represents a link between opportunities that share common information. - **[BotDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_botdefinition.htm)** Represents a top level object for Einstein Bots or Agentforce Agents. This object is available in API version 60.0 and later. - **[BotVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_botversion.htm)** Represents a version of a bot or agent defined by a BotDefinition record. This object is available in API version 63.0 and later. - **[BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_brandingset.htm)** Represents the definition of a set of branding properties for an Experience Builder site, as defined in the Theme panel in Experience Builder. This object is available in API version 40.0 and later. - **[BrandTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_brandtemplate.htm)** Letterhead for HTML EmailTemplate. - **[Brief](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_brief.htm)** Represents a marketing brief. A brief contains information that’s used for positioning and grounding a marketing campaign. Agentforce can help you create a campaign that best fits the goals and requirements in your brief. This object is available in API version 61.0 and later. - **[BriefcaseAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_briefcaseassignment.htm)** Represents the assignment of a briefcase definition to selected users and user groups. This object is available in API version 50.0 and later. - **[BriefcaseDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_briefcasedefinition.htm)** Represents a briefcase definition. A briefcase makes selected records available for users to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android. This object is available in API version 50.0 and later. - **[BriefcaseRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_briefcaserule.htm)** Represents a rule that specifies records for a briefcase definition. This object is available in API version 50.0 and later. - **[BriefcaseRuleFilter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_briefcaserulefilter.htm)** Represents a filter criteria for a briefcase rule. This object is available in API version 50.0 and later. - **[BroadcastCommAudience](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_broadcastcommaudience.htm)** Represents the audience that the broadcast communication is sent to. This object is available in API version 56.0 and later. - **[BroadcastCommunication](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_broadcastcommunication.htm)** Represents a broadcast communication related to an incident. This object is available in API version 56.0 and later. - **[BroadcastTopic](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_broadcasttopic.htm)** Represents a definition of a broadcast topic. A broadcast topic is associated with a list of Experience Cloud network sites for Service Cloud and collaboration rooms for Sales Cloud. The topic is created for a specific user role. Collaboration rooms are linked to Slack channels. This object is available in API version 55.0 and later. - **[BroadcastTopicGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_broadcasttopicgroup.htm)** Represents a junction object that relates a group to an alert type broadcast topic. The broadcast sends the alert to this group. This object is available in API version 57.0 and later. - **[BroadcastTopicNetwork](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_broadcasttopicnetwork.htm)** Represents a link between a broadcast topic and the Experience Cloud network site for Service Cloud. This object is available in API version 56.0 and later. - **[BrowserPolicyViolation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_browserpolicyviolation.htm)** Represents a violation that occurred within the last seven days related to the Trusted URLs and Trusted URLs for External Redirects allowlists. These violations include blocked resource requests based on your content security policy (CSP) and blocked redirections. This object is available in API version 61.0 and later. - **[BulkApi2EventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_bulkapi2eventlog.htm)** Bulk API 2 event logs contain details about Bulk API 2.0 requests. This object is available in API version 61.0 and later. - **[BulkApiEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_bulkapieventlog.htm)** Bulk API event logs contain details about Bulk API requests. This object is available in API version 61.0 and later. - **[BulkApiRequestEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_bulkapirequesteventlog.htm)** The Bulk API request event captures when Bulk API requests are received to create a job, update a job, create a batch, update a batch, and when a job completes. This object is available in API version 65.0 and later. - **[BusinessBrand](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_businessbrand.htm)** Represents a unique brand for a business that belongs to a parent entity. This object is available in API version 53.0 and later. - **[BusinessAlert](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_businessalert.htm)** Represents information about insight notifications that Einstein Relationship Insights explores, such as news mentions, job updates, and relationships. This object is available in API version 57.0 and later. - **[BusinessAlertStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_businessalertstatus.htm)** Represents information about the read status of an insight alert. This object is available in API version 57.0 and later. - **[BusinessHours](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_businesshours.htm)** Specifies the business hours of your support organization. Escalation rules are run only during these hours. - **[Business Process](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_businessprocess.htm)** Represents a business process. Business Processes track separate sales, lead, support, and solution lifecycles by displaying different picklist values according to each user’s profile. - **[BusinessProcessDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_businessprocessdefinition.htm)** Setup object that stores information about stages in a customer lifecycle map. The stages are associated with surveys and questions created using Salesforce Surveys. This object is reserved for internal use, and is available in API version 49.0 and later. - **[BusinessProcessFeedback](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_businessprocessfeedback.htm)** Setup object that stores information about the survey and the question associated with each stage in a customer lifecycle map. Customer lifecycle maps are used to track the scores provided by customers across their lifecycle using Salesforce Surveys. This object is reserved for internal use, and is available in API version 49.0 and later. - **[BusinessProcessGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_businessprocessgroup.htm)** Setup object that stores information about customer lifecycle maps. Customer lifecycle maps are used to track the scores provided by customers across their lifecycle using Salesforce Surveys. This object is reserved for internal use, and is available in API version 49.0 and later. - **[BuyerAccount](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_buyeraccount.htm)** Represents an account that is enabled as a buyer for Lightning B2B Commerce. This object is available in API version 48.0 and later. - **[BuyerCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_buyercriteria.htm)** Represents the buyer context qualifier of locale for any buyer groups of type Market This object is available in API version 58.0 and later. - **[BuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_buyergroup.htm)** Associates group qualifiers (entitlements, price books, promotions, and shipping methods) with buyer members based on buyer account ID or on the localized language and currency of the market browsed in a webstore. This object is available in API version 57.0; amended to support Market in version 58.0 and later. - **[BuyerGroupBuyerCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_buyergroupbuyercriteria.htm)** Associates a buyer group that is enabled for webstores supporting multiple languages and currencies with BuyerCriteria that define those languages and currencies. This object is available in API version 58.0 and later. - **[BuyerGroupMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_buyergroupmember.htm)** Represents a member of a buyer group. This object is available in API version 55.0 and later. - **[BuyerGroupPricebook](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_buyergrouppricebook.htm)** Represents a buyer group price book used in Lightning B2B Commerce. This object is available in API version 48.0 and later. - **[BuyerGroupRelatedObject](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_buyergrouprelatedobject.htm)** Used to associate currencies and supported ship-to countries with a buyer group and its price books, promotions, and entitlements. Supports buyer experience when buyer group members shop in stores enabled for multiple locales. This object is available in API version 58.0 and later. - **[CalcProcStepRelationship](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calcprocsteprelationship.htm)** Defines a parent-child relationship between two Expression Set Steps in an Expression Set Version. The label for this object is Expression Set Step Relationship. This object is available in API version 53.0 and later. - **[CalculatedInsightRangeBound](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calculatedinsightrangebound.htm)** Stores the information required to calculate a range-bound data insight. This object is available in API version 59.0 and later. - **[CalculationProcedure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calculationprocedure.htm)** Performs a series of calculations using matrix lookups and user-defined variables and constants. The label for this object is Expression Set. This object is available in API version 53.0 and later. - **[CalculationProcedureStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calculationprocedurestep.htm)** Defines a step in an Expression Set. The label for this object is Expression Set Step. This object is available in API version 53.0 and later. - **[CalculationProcedureVariable](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calculationprocedurevariable.htm)** Defines a variable in an Expression Set. The label for this object is Expression Set Variable. This object is available in API version 53.0 and later. - **[CalculationProcedureVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calculationprocedureversion.htm)** Defines a version of an Expression Set. The label for this object is Expression Set Version. This object is available in API version 53.0 and later. - **[Calendar](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calendar.htm)** Represents a calendar. This can be a default user calendar, public calendar, resource calendar, or holiday calendar. This object is available in API version 45.0 and later. - **[CalendarView](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calendarview.htm)** These calendars can be created and assigned to users other than the creator. Available calendars include object, shared, public, resource, and user list calendars. Object calendars represent a calendar based on a Salesforce object, either standard or custom. This object is available in API version 51.0 and later. - **[CallCenter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_callcenter.htm)** Represents a call center, which is a logical representation of a single computer-telephony integration (CTI) system instance in an organization. - **[CallCenterRoutingMap](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_callcenterroutingmap.htm)** Stores a mapping between a user or queue in a Salesforce org to a user or queue in an external system’s call center. This object is available in API version 53.0 and later. - **[CallCoachingMediaProvider](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_callcoachingmediaprovider.htm)** Represents the media provider for call recordings. This object is available in API version 49.0 and later. - **[CallCtrAgentFavTrfrDest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_callctragentfavtrfrdest.htm)** Represents a transfer destination that has been marked (starred) as a favorite in the Omni-Channel softphone by a contact center agent for voice call transfers. This object is available in API version 55.0 and later. - **[CallCtrAgentFavTrfrDestShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_callctragentfavtrfrdestshare.htm)** Represents a sharing entry on a favorite transfer destination in the Omni-Channel softphone for voice call transfers. This object is available in API version 55.0 and later. - **[CallDisposition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calldisposition.htm)** Represents a call result value that sales reps select when logging a call. This object is available in API version 47.0 and later. - **[CallDispositionCategory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calldispositioncategory.htm)** Represents the call outcome of a phone call that is used in reports and branching criteria for cadences. This object is available in API version 47.0 and later. - **[CallTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calltemplate.htm)** Represents a call script for users to read when making calls. - **[Campaign](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaign.htm)** Represents and tracks a marketing campaign, such as a direct mail promotion, webinar, or trade show. - **[CampaignExt](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaignext.htm)** Represents a campaign's extended configuration, capturing its association with a marketing program and its governance and review status. This object is available in API version 68.0 and later. - **[CampaignInfluence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaigninfluence.htm)** Represents the association between a campaign and an opportunity in Customizable Campaign Influence. This object is available in API version 37.0 and later. - **[CampaignInfluenceModel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaigninfluencemodel.htm)** This read-only object represents a campaign influence model in Customizable Campaign Influence. Use campaign influence models to group CampaignInfluence records created by a specific set of triggers and workflows that you define. The Primary Campaign Source influence model is the default model. This object is available in API version 37.0 and later. - **[CampaignMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaignmember.htm)** The CampaignMember object represents the relationship between a campaign and either a lead or a contact. If the Accounts as Campaign Members setting is enabled in an org, CampaignMember can also represent the relationship between a campaign and an account. - **[CampaignMemberStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaignmemberstatus.htm)** One or more member status values defined for a campaign. - **[CampaignOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaignownersharingrule.htm)** Represents the rules for sharing a campaign with User records other than the owner or anyone above the owner in the role hierarchy. - **[CampaignShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaignshare.htm)** Represents a sharing entry on a Campaign. - **[CampaignTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaigntag.htm)** Associates a word or short phrase with a Campaign. - **[CardPaymentMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cardpaymentmethod.htm)** Represents a credit card or debit card payment method, which implements the PaymentMethod object. This object is available in API version 48.0 and later. - **[CartCheckoutSession](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartcheckoutsession.htm)** Represents a checkout session used in Lightning B2B Commerce checkout. This object is available in API version 48.0 and later. - **[CartDeliveryGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartdeliverygroup.htm)** Represents shipping information for the delivery of items in an order against a store built with B2B Commerce or D2C Commerce. This object is available in API version 49.0 and later. - **[CartDeliveryGroupMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartdeliverygroupmethod.htm)** Represents the selected delivery method for a cart delivery group used in Lightning B2B Commerce checkout. This object is available in API version 49.0 and later. - **[CartDeliveryGroupMethodAdj](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartdeliverygroupmethodadj.htm)** Represents the shipping promotion discount for a shipping method. This object is available in API version 60.0 and later. - **[CartItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartitem.htm)** Represents an item in a WebCart that’s active in a store built with B2B. Cart item can be of type Product or Charge. This object is available in API version 49.0 and later. - **[CartItemAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartitemattribute.htm)** Represents the attributes associated with a cart item, stored as key-value pairs. These attributes are derived from the product and carried forward to the order during checkout. This object is available in API version 66.0 and later. - **[CartItemPriceAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartitempriceadjustment.htm)** Price adjustment for a cart item. This object is available in API version 52.0 and later. - **[CartTax](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_carttax.htm)** Represents taxes for a line item in a WebCart that’s active in a store built with B2B Commerce or D2C Commerce. This object is available in API version 49.0 and later. - **[CartValidationOutput](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartvalidationoutput.htm)** Associate errors to cart entities, such as cart line items, delivery groups, and the like, in a store built with B2B Commerce or D2C Commerce. An example error is “Out of stock.” Available in API version 49.0 and later. - **[Case](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm)** Represents a case, which is a customer issue or problem. - **[CaseArticle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casearticle.htm)** Represents the association between a Case and a KnowledgeArticle. This object is available in API version 20.0 and later. - **[CaseComment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casecomment.htm)** Represents a comment that provides additional information about the associated Case. - **[CaseContactRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casecontactrole.htm)** Represents the role that a given Contact plays on a Case. - **[CaseHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casehistory.htm)** Represents historical information about changes that have been made to the associated Case. - **[CaseHistory2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casehistory2.htm)** Represents historical information about owner and status changes that have been made to the associated Case. This object is available in API version 59.0 and later. - **[CaseMilestone](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casemilestone.htm)** Represents a milestone (required step in a customer support process) on a Case. This object is available in API version 18.0 and later. - **[CaseOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseownersharingrule.htm)** Represents the rules for sharing a case with users other than the owner. - **[CaseParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_std_caseparticipant.htm)** Represents a junction between a case, and an account or a contact. This object stores the details of the participant associated with a case. This participant could be the applicant, co-applicant, a household, or even a business account. This object is available in API version 54.0 and later. - **[CaseRelatedIssue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caserelatedissue.htm)** This object acts as a junction between a customer issue (Case) and the Incident or Problem that represents an associated service failure. This object is available in API version 53.0 and later. - **[CaseShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseshare.htm)** Represents a sharing entry on a Case. - **[CaseSolution](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casesolution.htm)** Represents the association between a Case and a Solution. - **[CaseStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casestatus.htm)** Represents the status of a Case, such as New, On Hold, or In Process. - **[CaseSubjectParticle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casesubjectparticle.htm)** Represents the Social Business Rules custom format for the **Case Subject** field on cases created from inbound social posts. This object is available in API version 41.0 and later. - **[CaseTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_casetag.htm)** Associates a word or short phrase with a Case - **[CaseTeamMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseteammember.htm)** Represents a case team member, who works with a team of other users to help resolve a case. - **[CaseTeamRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseteamrole.htm)** Represents a case team role. Every case team member has a role on a case, such as “Customer Contact” or “Case Manager.” - **[CaseTeamTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseteamtemplate.htm)** Represents a predefined case team, which is a group of users that helps resolve a case. - **[CaseTeamTemplateMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseteamtemplatemember.htm)** Represents a member on a predefined case team, which is a group of users that helps resolve cases. - **[CaseTeamTemplateRecord](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_caseteamtemplaterecord.htm)** The CaseTeamTemplateRecord object is a linking object between the Case and CaseTeamTemplate objects. To assign a predefined case team to a case (customer inquiry), create a CaseTeamTemplateRecord record and point the ParentId to the case and the TeamTemplateId to the predefined case team. - **[CategoryData](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_categorydata.htm)** Represents a logical grouping of Solution records. - **[CategoryNode](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_categorynode.htm)** Represents a tree of Solution categories. - **[CategoryNodeLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_categorynodelocalization.htm)** When the Translation Workbench is enabled for your organization, the CategoryNodeLocalization object provides the translation of the label of a solution category. - **[ChangeRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_changerequest.htm)** Represents a decision to implement a formal request for a change (RFC). This object is available in API version 53.0 and later. - **[ChangeRequestRelatedIssue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_changerequestrelatedissue.htm)** Represents a junction object that relates a ChangeRequest to an Incident or Problem due to a service failure. This object is available in API version 53.0 and later. - **[ChangeRequestRelatedItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_changerequestrelateditem.htm)** Represents a junction object that relates a ChangeRequest to an Asset. This object is available in API version 53.0 and later. - **[ChangeSetOperationEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_changesetoperationeventlog.htm)** Change Set Operation events contain information from change set migrations. This object is available in API version 65.0 and later. - **[ChannelObjectLinkingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_channelobjectlinkingrule.htm)** Represents a rule for linking a channel interaction with an object (such as Lead or Contact). This object is available in API version 47.0 and later. - **[ChannelProgram](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_channelprogram.htm)** Represents a channel program that vendors use to market and sell their products through channel partners. This object is available in API version 41.0 and later. - **[ChannelProgramLevel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_channelprogramlevel.htm)** Represents a level, based on member experience, in a channel program. This object is available in API version 41.0 and later. - **[ChannelProgramMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_channelprogrammember.htm)** Represents a partner who is a member of a channel program. This object is available in API version 41.0 and later. - **[ChatterActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatteractivity.htm)** ChatterActivity represents the number of posts and comments made by a user and the number of comments and likes on posts and comments received by the same user. This object is available in API version 23.0 and later. - **[ChatterAnswersActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatteranswersactivity.htm)** Represents the reputation of a User in Chatter Answers zones.This object is available in API version 25.0 and later. - **[ChatterAnswersReputationLevel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatteranswersreputationlevel.htm)** Represents a reputation level within a Chatter Answers zone. This object is available in API version 26.0 and later. - **[ChatterConversation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatterconversation.htm)** Represents a private conversation in Chatter, consisting of messages that conversation members have sent or received. This object is available in API version 23.0 and later. - **[ChatterConversationMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatterconversationmember.htm)** Represents a member of a private conversation in Chatter. A member has either sent messages to or received messages from other conversation participants. This object is available in API version 23.0 and later. - **[ChatterExtension](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatterextension.htm)** Represents a Rich Publisher App that’s integrated with the Chatter publisher. This object is available in API version 41.0 and later. - **[ChatterExtensionConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chatterextensionconfig.htm)** Configuration for the Chatter extension for Experience Cloud sites. This object is available in API version 41.0 and later. - **[ChatterMessage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_chattermessage.htm)** Represents a message sent as part of a private conversation in Chatter. This object is available in API version 23.0 and later. - **[ClientBrowser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_clientbrowser.htm)** Represents a cookie added to the browser upon login, and also includes information about the browser application where the cookie was inserted. This object is available in version 28.0 and later. - **[CollaborationGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgroup.htm)** Represents a Chatter group. This object is available in API version 19.0 and later. - **[CollaborationGroupMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgroupmember.htm)** Represents a member of a Chatter group. This object is available in API version 19.0 and later. - **[CollaborationGroupMemberRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgroupmemberrequest.htm)** Represents a request to join a private Chatter group. This object is available in API version 21.0 and later. - **[CollaborationGroupRecord](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationgrouprecord.htm)** Represents the records associated with Chatter groups. - **[CollaborationInvitation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationinvitation.htm)** Represents an invitation to join Chatter, either directly or through a group. This object is available in API version 21.0 and later. - **[CollaborationRoom](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collaborationroom.htm)** Represents a collaboration room, which links Salesforce to a Slack channel used by applications with specific use cases, such as swarming or reporting. This object is available in API version 55.0 and later. - **[CollabDocumentMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collabdocumentmetric.htm)** Represents the engagement metrics for a Quip thread (document or spreadsheet) that’s linked to a Salesforce record. This object is available in API version 50.0 and later. - **[CollabDocumentMetricRecord](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collabdocumentmetricrecord.htm)** Represents an association between a CollabDocumentMetric and a Salesforce record.It tracks which Salesforce record, such as an Account or Contact, is linked to a Quip thread for which metrics were gathered using CollabDocumentMetric. CollabDocumentMetricRecord is available in API version 50.0 and later. - **[CollabTemplateMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collabtemplatemetric.htm)** Represents the engagement metrics for a Quip template.This object is available in API version 50.0 and later. - **[CollabTemplateMetricRecord](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ccollabtemplatemetricrecord.htm)** Represents an association between a CollabTemplateMetric and a Salesforce record.It tracks which Salesforce record, such as an Account or Contact, is linked to a Quip template for which metrics were gathered using CollabTemplateMetric. CollabTemplateMetricRecord is available in API version 50.0 and later. - **[CollabUserEngagementMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collabuserengagementmetric.htm)** Represents the user engagement metrics for a Quip thread in a Quip template or document. This object is available in API version 50.0 and later. - **[CollabUserEngmtRecordLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_collabuserengmtrecordlink.htm)** Represents an association between a CollabUserEngagementMetric and a Salesforce record. It tracks which Salesforce record, such as an Account or Contact, is associated with the user engagement metric. This object is available in API version 50.0 and later. - **[ColorDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_colordefinition.htm)** Represents the color-related metadata for a custom tab. This object is available in API version 43.0 and later. - **[ContCalloutSummaryEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contcalloutsummaryeventlog.htm)** Continuation Callout Summary events contain information about all of the asynchronous callouts performed during a transaction, their response status codes, execution times, and URL endpoint destinations. This object is available in API version 65.0 and later. - **[CombinedAttachment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_combinedattachment.htm)** This read-only object contains all notes, attachments, Google Docs, documents uploaded to libraries in Salesforce CRM content, and files added to Chatter that are associated with a record. - **[CommerceEntitlementBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commerceentitlementbuyergroup.htm)** Represents the entitlement policy for a buyer group. This object is available in API version 49.0 and later. - **[CommerceEntitlementPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commerceentitlementpolicy.htm)** Represents an entitlement policy, which determines what products and prices a user can see. This object is available in API version 49.0 and later. - **[CommerceEntitlementPolicyShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commerceentitlementpolicyshare.htm)** Represents the entitlement rule for sharing products and prices with users other than the owner. This object is available in API version 49.0 and later. - **[CommerceEntitlementProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commerceentitlementproduct.htm)** Represents the entitlement policy for a product. This object is available in API version 49.0 and later. - **[CommissionSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commissionschedule.htm)** Represents a commission calculation and rate definition. Calculates commission values for a commissionable event. - **[CommissionScheduleAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commissionscheduleassignment.htm)** Represents the commission calculation applicable to a specific product or producer for one or multiple commissionable events. - **[CommSubscription](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commsubscription.htm)** Represents the subscription options for a specific communication. This object is available in API version 48.0 and later. - **[CommSubscriptionChannelType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commsubscriptionchanneltype.htm)** Represents the engagement channel through which you can reach a customer for a communication subscription. This object is available in API version 48.0 and later. - **[CommSubscriptionConsent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commsubscriptionconsent.htm)** Represents a customer’s consent to a communication subscription. This object is available in API version 48.0 and later. - **[CommSubscriptionTiming](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commsubscriptiontiming.htm)** Represents a customer's timing preferences for receiving a communication subscription. This object is available in API version 48.0 and later. - **[Community (Zone)](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_community.htm)** Represents a zone that contains Idea or Question objects. - **[ComplaintCase](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_complaintcase.htm)** Represents the association between an HR complaint and a case. This object is available in API version 67.0 and later. - **[ComplaintParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_complaintparticipant.htm)** Represents a participant in an HR complaint case, linking individuals or groups to complaint records with their role and status. This object is available in API version 67.0 and later. - **[ComplianceControlScope](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_compliancecontrolscope.htm)** Represents a mandatory compliance control and the type of business record it applies to, such as a campaign, marketing program, or tactic. This object is available in API version 68.0 and later. - **[ConcurApexLimitEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concurapexlimiteventlog.htm)** Concurrent Apex Limit event logs contain information about long-running concurrent Apex requests in your org that Salesforce terminated after reaching your org’s concurrency limit. Requests with an established Apex context that execute for 5 seconds are counted towards your org’s limit of concurrent long-running requests. (Asynchronous requests don’t count towards the limit.) When the long-running requests exceed the org default limit, additional long-running requests are denied. This object is available in API version 61.0 and later. - **[ConnectedApplication](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_connectedapplication.htm)** Represents a connected app and its details; all fields are read-only. - **[ConferenceNumber](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_conferencenumber.htm)** Holds the telephone number for an external event shown in the Salesforce Today feature in the Salesforce mobile app. This object is available in API version 35.0 and later. - **[Consumption Rate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_consumption_rate.htm)** Consumption rates describe the billing rate for a range of usage within a consumption schedule. All consumption schedules require at least one consumption rate in order to rate usage on a usage product. This object is available in API version 45.0 and later. - **[Consumption Schedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_consumption_schedule.htm)** A consumption schedule organizes a set of consumption rates by which usage-based products are quoted and billed. This object is available in API version 45.0 and later. - **[Contact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm)** Represents a contact, which is a person associated with an account. - **[ContactCenterChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactcenterchannel.htm)** Represents a junction object that relates a Bring Your Own Channel for Contact Center as a Service (CCaaS) messaging channel to a CallCenter object for Bring Your Own Channel for CCaaS. This object also represents the routing details for a voicemail configuration and routing information for callback requests. This object is available in API version 56.0 and later. - **[ContactCleanInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactcleaninfo.htm)** Stores the metadata Data.com Clean uses to determine a contact record’s clean status. Helps you automate the cleaning or related processing of contact records. ContactCleanInfo includes a number of bit vector fields. This object is removed in API version 67.0 - **[ContactDailyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactdailymetric.htm)** Represents the daily engagement metrics for a contact. This object is available in API version 52.0 and later. - **[ContactMonthlyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactmonthlymetric.htm)** Represents the monthly engagement metrics for a contact. This object is available in API version 52.0 and later. - **[ContactPointAddress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactpointaddress.htm)** Represents a contact’s billing or shipping address, which is associated with an individual or person account. This object is available in API version 49.0 and later. - **[ContactPointConsent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactpointconsent.htm)** Represents a customer's consent to be contacted via a specific contact point, such as an email address or phone number. This object is available in API version 48.0 and later. - **[ContactPointEmail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm)** Represents a contact’s email, which is associated with an individual or person account. This object is available in API version 48.0 and later. - **[ContactPointPhone](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactpointphone.htm)** Represents a contact’s phone number, which is associated with an individual or person account. This object is available in API version 48.0 and later. - **[ContactPointTypeConsent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactpointtypeconsent.htm)** Represents consent for a contact point type, such as email or phone. This object is available in API version 45.0 and later. - **[ContactProspectingAgentResearch](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactprspagntrsrch.htm)** Represents research done by a prospecting agent on a contact record. - **[ContactOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactownersharingrule.htm)** Represents the rules for sharing a contact with a User other than the owner. - **[ContactRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactrequest.htm)** Represents a customer’s request for support to get back to them about an issue. This object is available in API version 45.0 and later. - **[ContactRequestShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactrequestshare.htm)** Represents a list of access levels to a ContactRequest with an explanation of the access level. This object is available in API version 45.0 and later. - **[ContactShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactshare.htm)** Represents a list of access levels to a Contact along with an explanation of the access level. For example, if you have access to a record because you own it, the ContactAccessLevel is All and RowCause is Owner. - **[ContactSuggestionInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contactsuggestioninsight.htm)** Represents a suggestion for a new contact record. Available in API versions 45.0 and later. - **[ContactTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contacttag.htm)** Associates a word or short phrase with a Contact. - **[ContentAsset](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentasset.htm)** Represents a Salesforce file that has been converted to an asset file in a custom app in Lightning Experience. Use asset files for org setup and configuration. Asset files can be packaged and referenced by other components. This object is available in API version 38.0 and later. - **[ContentBody](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentbody.htm)** Represents the body of a file in Salesforce CRM Content or Salesforce Files. This object is available in API version 40.0 and later. - **[ContentDistribution](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdistribution.htm)** Represents information about sharing a document externally. This object is available in API version 32.0 and later. - **[ContentDistributionEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdistributioneventlog.htm)** Content Distribution events contain information about content distributions and deliveries to users. This object is available in API version 65.0 and later. - **[ContentDistributionView](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdistributionview.htm)** Represents information about views of a shared document. This read-only object is available in API version 32.0 and later. - **[ContentDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm)** Represents a document that was uploaded to a library in Salesforce Files or Salesforce CRM content. This object is available in versions 17.0 and later for Salesforce CRM.This object is available in API version 21.0 and later for Salesforce Files. - **[ContentDocumentHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocumenthistory.htm)** Represents the history of a document. This object is available in versions 17.0 and later. - **[ContentDocumentLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm)** Represents the link between a Salesforce CRM Content document, Salesforce file, or ContentNote and where it's shared. A file can be shared with other users, groups, records, and Salesforce CRM Content libraries. This object is available in versions 21.0 and later for Salesforce CRM Content documents and Salesforce Files. - **[ContentDocumentListViewMapping](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlistviewmapping.htm)** Represents an association between a ListView and a Quip ContentDocument. Applies to Quip file types only. Maintains the mapping between a list view and Quip document when the list view is exported to a newly created Quip document. This object is available in API version 44.0 and later. - **[ContentDocumentSubscription](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdocumentsubscription.htm)** Represents a subscription for a user following or commenting on a file in a library. This object is available in API version 42.0 and later. - **[ContentDocLinkEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentdoclinkeventlog.htm)** Content Document Link events contain sharing information for content documents. This object is available in API version 65.0 and later. - **[ContentFolder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentfolder.htm)** Represents a folder in a content library for adding files. This object is available in API version 34.0 and later. - **[ContentFolderItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentfolderitem.htm)** Represents a file (ContentDocument) or folder (ContentFolder) that resides in a ContentFolder in a ContentWorkspace. This object is available in API version 35.0 and later. - **[ContentFolderLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentfolderlink.htm)** Defines the association between a library and its root folder. This object is available in API version 34.0 and later. - **[ContentFolderMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentfoldermember.htm)** Defines the association between a file and a folder. This object is available in API version 34.0 and later. - **[ContentHubItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenthubitem.htm)** Represents a file or folder in a Files Connect external data source, such as Microsoft SharePoint or OneDrive for Business. This object is available in API version 33.0 and later. - **[ContentHubRepository](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenthubrepository.htm)** Represents a Files Connect external data source such as Microsoft SharePoint or OneDrive for Business. This object is available in API version 33.0 and later. - **[ContentNote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentnote.htm)** Represents a note created with the enhanced note-taking tool, released in Winter ’16. This object is available in API version 32.0 and later. - **[ContentNotification](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentnotification.htm)** Represents a notification for a file. This object is available in API version 42.0 and later. - **[ContentTagSubscription](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttagsubscription.htm)** Represents a subscription for a user following a tag on a file. This object is available in API version 42.0 and later. - **[ContentTaxonomy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomy.htm)** Represents a content taxonomy, which is used to classify and organize Salesforce CMS content. To create a hierarchy of terms in a content taxonomy, use this object in addition to the ContentTaxonomyTerm, ContentTaxonomyRelatedTerm, and ContentTaxonomyTermRelatedTerm objects. This object is available in API version 63.0 and later. - **[ContentTaxonomyRelatedTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomyrelatedterm.htm)** Represents the relationship between a term and the content taxonomy to which the term belongs. This object is available in API version 63.0 and later. - **[ContentTaxonomyTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomyterm.htm)** Represents a term in a content taxonomy. Terms describe what content is or how it's used, and they’re organized in parent-child relationships in the taxonomy hierarchy. This object is available in API version 63.0 and later. - **[ContentTaxonomyTermRelatedTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomytermrelatedterm.htm)** Represents the relationship between two terms in a content taxonomy. This object is available in API version 63.0 and later. - **[ContentTaxonomyTermRelationshipType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttaxonomytermrelationshiptype.htm)** Represents the type of relationship between two terms in a content taxonomy. This object is available in API version 63.0 and later. - **[ContentTransferEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contenttransfereventlog.htm)** ContentTransferEventLog stores information about content transfer events, such as downloads, uploads, and previews. This information includes events performed on files and attachments to records. This object is available in API version 62.0 and later. - **[ContentUserSubscription](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentusersubscription.htm)** Represents a subscription for a user following another user. This object is available in API version 42.0 and later. - **[ContentVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm)** Represents a specific version of a document in Salesforce CRM content or Salesforce Files. This object is available in versions 17.0 and later for Salesforce CRM content documents. This object is available in versions 20.0 and later for Salesforce Files. - **[ContentVersionComment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentversioncomment.htm)** Represents a comment on a version of a file. This object is available in API version 42.0 and later. - **[ContentVersionHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentversionhistory.htm)** Represents the history of a specific version of a document. This object is available in version 17.0 and later. - **[ContentVersionRating](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentversionrating.htm)** Represents a rating on a version of a file. This object is available in API version 42.0 and later. - **[ContentWorkspace](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentworkspace.htm)** Represents a content library. This object is available in versions 17.0 and later. - **[ContentWorkspaceDoc](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentworkspacedoc.htm)** Represents a link between a document and a public library in Salesforce CRM Content. This object is available in versions 17.0 and later. - **[ContentWorkspaceMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentworkspacemember.htm)** Represents a member of a content library. This object is available in API version 40.0 and later. - **[ContentWorkspacePermission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentworkspacepermission.htm)** Represents a library permission. This object is available in API version 40.0 and later. - **[ContentWorkspaceSubscription](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contentworkspacesubscription.htm)** Represents a subscription for a user following a library. This object is available in API version 42.0 and later. - **[ContextParamMap](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contextparammap.htm)** Represents optional context data for a Conversation or a ConversationParticipant. This object is available in API version 57.0 and later. - **[Contract](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contract.htm)** Represents a contract (a business agreement) associated with an Account. - **[ContractContactRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractcontactrole.htm)** Represents the role that a Contact plays on a Contract. - **[ContractLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractlineitem.htm)** Represents a product covered by a service contract (customer support agreement). This object is available in API version 18.0 and later. - **[ContractLineOutcome](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractlineoutcome.htm)** Represents information on a contract line outcome’s captured data and other related parameters that are used when capturing data. This object is available in API version 58.0 and later. - **[ContractLineOutcomeData](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractlineoutcomedata.htm)** Represents the contract line outcome’s captured data. It stores the data that was captured between the contract line outcome’s start date and end date. This object is available in API version 58.0 and later. - **[ContractStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contractstatus.htm)** Represents the status of a Contract, such as Draft, InApproval, Activated, Terminated, or Expired. - **[ContractTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contracttag.htm)** Associates a word or short phrase with a Contract. - **[ConvAnalysisSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_convanalysissummary.htm)** Represents the information stored for each run or refresh of Sales Signals. This object is available in API version 63.0 and later. - **[ConvAnalysisTopic](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_convanalysistopic.htm)** Represents a topic generated from the Sales Signals refresh or run. For example, a product experiencing issues due to high pricing could be a topic identified through the analysis of multiple calls. This object is available in API version 63.0 and later. - **[ConvAnalysisTopicEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_convanalysistopicentry.htm)** Represents a single entry under the ConvAnalysisTopic object. An entry represents a segment of a video or voice call that is associated with a conversation analysis topic. This object is available in API version 63.0 and later. - **[Conversation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_conversation.htm)** Represents a conversation between an end user and an agent. Available in API version 49.0 and later. - **[ConversationApiLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_conversationapilog.htm)** Logs of an API operation on a specific conversation object done using the Conversation Service API. This object is available in API version 63.0 and later. - **[ConversationContextEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_conversationcontextentry.htm)** Represents the context of a message or an event in the chat history between an agent and a messaging user. This object is available in API version 47.0 and later. - **[ConversationChannelDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_conversationchanneldefinition.htm)** Represents a configurable definition of a conversation channel that’s implemented for Interaction Service for Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS messaging channels. This object is available in API version 60.0 and later. - **[ConversationEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_conversationentry.htm)** Represents a message or event in a voice call or messaging session. The schema on this page only applies to conversation entries for legacy chat. Refer to the ConversationEntry (Off-Core) schema in the [Messaging Object Model](https://developer.salesforce.com/docs/service/messaging-object-model/guide/overview.html) guide to see the ConversationEntry schema for Enhanced Channels. This object is available in API version 43.0 and later. - **[ConversationParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_conversationparticipant.htm)** Represents an active participant in a conversation. A new ConversationParticipant record is created each time a participant joins a conversation. This object is available in API version 49.0 and later. - **[ConvIntelligenceSignalRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_convintelligencesignalrule.htm)** Represents a conversation intelligence signal rule. The rule triggers actions based on real-time intelligence signals from your telephony system or keywords mentioned by support reps or customers. The rule contains a set of conditions (subrules) and the filter logic used to evaluate those conditions to determine whether to trigger actions. This object is available in API version 62.0 and later. - **[ConvIntelligenceSignalSubRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_convintelligencesignalsubrule.htm)** Represents a condition (subrule) within a conversation intelligence signal rule. This object is available in API version 62.0 and later. - **[ConvMessageSendRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_convmessagesendrequest.htm)** Represents a request to send a template-based messaging component to a series of messaging users in an enhanced messaging channel or Messaging for In-App. This object is available in API version 60.0 and later. - **[ConversationVendorInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_conversationvendorinfo.htm)** This setup object connects the partner vendor system to the Service Cloud feature. For example, for Salesforce Voice with Telephony Providers, this object contains information about the partner telephony or Contact Center as a Service (CCaaS) partner system. For Bring Your Own Channel for Messaging this object contains information about the partner messaging system, and for Bring Your Own Channel for CCaaS, this object contains information about the CCaaS partner system. This object is available in API version 52.0 and later. - **[CorsWhitelistEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_corswhitelistentry.htm)** Represents an entry in the cross-origin resource sharing (CORS) allowlist. Origins included in the allowlist can request REST resources from that Salesforce org. - **[Coupon](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_coupon.htm)** A coupon associated with a promotion. This object is available in API version 54.0 and later. - **[CouponCodeRedemption](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_couponcoderedemption.htm)** Tracks each coupon code redemption. This object is available in API version 58.0 and later. - **[CreditMemo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_creditmemo.htm)** Represents a document that is used to reduce the amount that a buyer owes a seller under the terms of an earlier invoice. This object is available in API version 48.0 and later. - **[CreditMemoAddressGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_creditmemoaddressgroup.htm)** Stores the buyer's address information, which is used to determine the amount of tax to credit to a buyer when a credit memo is issued. This object is available in API version 55.0 and later. - **[CreditMemoInvApplication](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_creditmemoinvapplication.htm)** Represents an amount applied from a credit memo to an invoice. This object is available in API version 48.0 and later. - **[CreditMemoLine](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_creditmemoline.htm)** Represents product, service, adjustment, or tax line items that were included in a credit memo. This object is available in API version 48.0 and later. - **[Crisis](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_crisis.htm)** Represents a major crisis event that affects an Employee in an InternalOrganizationUnit. This object is available in API version 48.0 and later. In API version 49.0 and later, this object supports reports, criteria-based sharing rules, and history tracking, plus you can exclude individual fields from custom page layouts. - **[CronJobDetail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cronjobdetail.htm)** Contains details about the associated scheduled job, such as the job’s name and type. This object is available in API version 29.0 and later. - **[CronTrigger](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_crontrigger.htm)** Contains schedule information for a scheduled job. CronTrigger is similar to a cron job on UNIX systems. This object is available in API version 17.0 and later. - **[CryptoProdCatgWalletGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cryptoprodcatgwalletgroup.htm)** Specifies if CryptoWalletGroup is in the allowlist or airdrop for the ProductCategory. A custom object between ProductCategory and CryptoWalletGroup adding the CryptoWalletGroup to allowlist or airdrop. This object is available in API version 58.0 and later. - **[CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_csptrustedsite.htm)** Represents a trusted URL. For each CspTrustedSite, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite included only CSP directives and was referred to as CSP Trusted Sites in Salesforce Setup. Available in API version 39.0 and later. - **[CspViolationEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cspviolationeventlog.htm)** CSP violation events capture details about blocked resource requests from Lightning Experience pages based on your content security policy (CSP). This object is available in API version 63.0 and later. - **[CurrencyType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_currencytype.htm)** Represents the currencies used by an organization for which the multicurrency feature is enabled. - **[CustExpIntlTransfSetup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custexpintltransfsetup.htm)** Stores information for different data sources that are processed for customer insights. This object is available in API version 65.0 and later. - **[CustomBrand](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custombrand.htm)** Represents a custom branding and color scheme. This object is available in API version 28.0 and later. - **[CustomBrandAsset](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custombrandasset.htm)** Represents a branding element in a custom branding scheme. For example, a color, logo image, header image, or footer text. A CustomBrandAsset can apply to an Experience Cloud site or to an org using the Salesforce mobile app. This object is available in API version 28.0 and later. - **[CustomFieldDisplayValue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customfielddisplayvalue.htm)** Stores variation details for the product attribute item view. This object is available in API version 63.0 and later. - **[CustomHelpMenuItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customhelpmenuitem.htm)** Represents the items within a section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources. This object is available in API version 44.0 and later. - **[CustomHelpMenuSection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customhelpmenusection.htm)** Represents a section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources. This object is available in API version 44.0 and later. - **[CustomHttpHeader](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customhttpheader.htm)** Represents a custom HTTP header that provides context information from Salesforce such as region, org details, or the role of the person viewing the external object. This object is available in API version 43.0 and later. - **[CustomMsgChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custommsgchannel.htm)** Represents a custom conversation channel and stores event-driven Messaging settings. Custom conversation channels are implemented for Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS Messaging channels. This object is available in API version 63.0 and later. - **[CustomNotificationType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customnotificationtype.htm)** Stores information about custom notification types. This object is available in API version 47.0 and later. - **[CustomPermission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custompermission.htm)** Represents a permission created to control access to a custom process or app, such as sending email. This object is available in API version 31.0 and later. - **[CustomPermissionDependency](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custompermissiondependency.htm)** Represents the dependency between two custom permissions when one custom permission requires that you enable another custom permission. This object is available in API version 32.0 and later. - **[CustomReportType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customreporttype.htm)** A custom report type for Lightning Experience and Data 360 reports. This object is available in API version 68.0 and later. - **[Customer](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customer.htm)** Represents the customer role of an individual with respect to a particular company or organization. This object is available in API version 53.0 and later. - **[DandBCompany](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dandbcompany.htm)** Represents a Dun & Bradstreet® company record, which is associated with an account added from Data.com. This object is available in API version 25.0 and later. - **[Dashboard](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dashboard.htm)** Represents a dashboard, which shows data from custom reports as visual components. Access is read-only. This object is available in API version 20.0 and later. - **[DashboardComponent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dashboardcomponent.htm)** Represents a dashboard component, which can be a chart, metric, table, or gauge on a dashboard. Access is read-only. This object is available in API version 21.0 and later. - **[DashboardTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dashboardtag.htm)** Associates a word or short phrase with a Dashboard. This object is available in API version 20.0 and later. - **[DataAssessmentFieldMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataassessmentfieldmetric.htm)** Represents summary statistics for matched, blank, and differing fields in account records of an org compared to records in Data.com. This object is available in API version 37.0 and later. - **[DataAssessmentMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataassessmentmetric.htm)** Represents a summary of statistics for fields matched and unmatched in your account records with Data.com account records. This object is available in API version 37.0 and later. - **[DataAssessmentValueMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataassessmentvaluemetric.htm)** Summarizes the number of fields matched for your account records with Data.com account records.This object is available in API version 37.0 and later. - **[DatabaseSaveEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_databasesaveeventlog.htm)** Database Save events track when records are created,updated, or deleted This object is available in API version 64.0 and later. - **[DatacloudCompany](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datacloudcompany.htm)** Represents the fields for Data.com company records. This object is available in API version 30.0 or later. - **[DatacloudContact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datacloudcontact.htm)** The fields and properties for Data.com contact records. This object is available in API version 30.0 or later. - **[DatacloudDandBCompany](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataclouddandbcompany.htm)** Represents a set of read-only fields that are used to return D&B company data from Data.com API calls. This object is available in API version 30.0 or later. - **[DatacloudOwnedEntity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datacloudownedentity.htm)** Represents fields in the DatacloudOwnedEntity object. The DatacloudOwnedEntity object tracks user-purchased records. This object is available in API version 30.0 or later. - **[DatacloudPurchaseUsage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datacloudpurchaseusage.htm)** Represents an object used to identify and track Data.com record purchases. This object is available in API version 30.0 or later. - **[DataDetectJobObjectSession](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetectjobobjectsession.htm)** For internal use only. This object is available in API version 63.0 and later. - **[DataDetectJobSession](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetectjobsession.htm)** Represents a run of a DataDetect scan policy that's triggered manually. This object is available in API version 63.0 and later. - **[DataDetectJobSessSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetectjobsesssummary.htm)** For internal use only. This object is available in API version 66.0 and later. - **[DataDetectPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetectpolicy.htm)** Represents a set of parameters that specifies the types of sensitive data for search with in a data scan. DataDetect scan policies can also apply filters to a data scan, along with specific objects and fields for scanning. This object is available in API version 60.0 and later. - **[DataDetectPolicyObject](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetectpolicyobject.htm)** Represents an object of the DataDetect scan policy to be scanned. This object is available in API version 62.0 and later. - **[DataDetectScanResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetectscanresult.htm)** Represents the results of a DataDetect data policy scan. This object is available in API version 63.0 and later. - **[DataDetectPolicyObjField](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetectpolicyobjfield.htm)** Represents an object field of the DataDetect scan policy object to be scanned. This object is available in API version 64.0 and later. - **[DataDetectPolicySnapshot](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetectpolicysnapshot.htm)** For internal use only. This object is available in API version 64.0 and later. - **[DataDetPlcyDataSrchExps](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetplcydatasrchexps.htm)** Represents data search expressions for scanning DataDetect scan policies based on Java regex. This object is available in API version 64.0 and later. - **[DataDetPlcyMdatScanCrit](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetplcymdatscancrit.htm)** Represents inclusion and exclusion criteria that filter what DataDetect scan policy object fields are to be scanned based on metadata tags. This object is available in API version 64.0 and later. - **[DataDetPlcySstvDataCatg](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datadetplcysstvdatacatg.htm)** Represents the sensitive data categories that the DataDetect scan policy is required to scan. This object is available in API version 64.0 and later. - **[DataEncryptionKey](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataencryptionkey.htm)** The DataEncryptionKey object is part of the Bring Your Own Key (BYOK) feature, which allows users to upload a data encryption key (DEK) using a public key generated by the Salesforce Shield Key Management Service (KMS). Customers create their own DEKs and upload them to Salesforce. Users access this entity via the API to list DEK keys for auditing purposes. They can also programmatically use this object to create the certificate and to upload key material. This object is available in API version 63.0 and later. - **[DataIntegrationRecordPurchasePermission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataintegrationrecordpurchasepermission.htm)** Indicates Lightning Data purchase credits that a Salesforce admin has granted to users. - **[DataKitDeployEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datakitdeployevent.htm)** Represents a data kit deployment event that notifies subscribers of the status of the data kit component deployment. This object is available in API version 61.0 or later. - **[DataKitDeploymentLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datakitdeploymentlog.htm)** Represents the log details of a data kit component deployment. This object is available in API version 61.0 or later. - **[DataLakeObjectInstance](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datalakeobjectinstance.htm)** Represents a data lake object (DLO). This object is available in API version 63.0 and later. - **[DatasetExport](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datasetexport.htm)** Represents a dataset exported from CRM Analytics. When a dataset is exported, the data is converted into a .csv file and the schema is stored in a separate JSON file. These files are stored in two objects: DatasetExport and DatasetExportPart. DatasetExport acts as the header and includes the JSON schema. - **[DatasetExportPart](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datasetexportpart.htm)** Represents a dataset exported from CRM Analytics. When a dataset is exported, the data is converted into a .csv file and the schema is stored in a separate JSON file. These files are stored in two objects: DatasetExport and DatasetExportPart. DatasetExportPart contains parts of the .csv file. - **[DataMaskCustomValueLibrary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datamaskcustomvaluelibrary.htm)** Represents a set of user-inputted values in a custom library in Data Mask. This object is available in API version 64.0 and later. - **[DataSemanticSearch](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datasemanticsearch.htm)** Represents a Data 360 search index object. This object is available in API version 67.0 and later. - **[DataStatistics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datastatistics.htm)** For internal use only. - **[DataUseLegalBasis](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datauselegalbasis.htm)** Represents the legal basis for contacting a customer, such as billing or contract. This object is available in API version 45.0 and later. - **[DataUsePurpose](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datausepurpose.htm)** Represents the reason for contacting a prospect or customer, such as for billing, marketing, or surveys. This object is available in API version 45.0 and later. - **[DataWeaveResource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dataweaveresource.htm)** Represents the DataWeaveScriptResource class that is generated for all DataWeave scripts. This object is available in API version 58.0 and later. - **[DatedConversionRate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_datedconversionrate.htm)** Represents the dated exchange rates used by an organization for which the multicurrency and the effective dated currency features are enabled. - **[DealIndirectPartner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dealindirectpartner.htm)** Represents an indirect partner’s involvement in a deal. This object is available in API version 63.0 and later. - **[DeclinedEventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_declinedeventrelation.htm)** Represents event participants (invitees or attendees) with the status Declined for a given event. This object is available in API versions 29.0 and later. - **[DelegatedAccount](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_delegatedaccount.htm)** Represents the external managed account. This object is available in API version 49.0 and later. - **[DeleteEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_deleteevent.htm)** Represents a record that has been soft deleted. Search on this object was available in API version 48.0, then removed in API version 50.0. - **[DeliveryEstimationSetup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_deliveryestimationsetup.htm)** Shows the configuration options for the commerce delivery service offered through a web store or sales channel. Includes settings such as delivery location group, channel, fulfillment types, and default fulfillment time. This object is available in API version 61.0 and later. - **[DevopsActivityLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsactivitylog.htm)** Represents the history of activities performed within Lifecycle Center. The object provides visibility into the users, actions, and outcomes. This object is available in API version 67.0 and later. - **[DevopsEnvDeployment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsenvdeployment.htm)** Represents a record created during the promotion or deployment process to track deployment actions, status, and associated details within a Lifecycle Center pipeline. This object is available in API version 66.0 and later. - **[DevopsEnvDeploymentMbr](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsenvdeploymentmbr.htm)** Represents a metadata component or configuration data record included in a deployment to a Lifecycle Center pipeline environment. Use it to verify what was promoted or deployed. This object is available in API version 66.0 and later. - **[DevopsEnvironment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsenvironment.htm)** Represents a connection from Lifecycle Center to an environment, which currently can be only a Salesforce org. Developers use development environments to do their work. Each pipeline stage has an associated environment. This object is available in API version 66.0 and later. - **[DevopsPipeline](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipeline.htm)** Represents a release pipeline in Lifecycle Center, which is the ordered path work items follow from development to production. Related DevopsPipelineStage records store the pipeline stages. This object is available in API version 67.0 and later. - **[DevopsPipelineEnvironment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelineenvironment.htm)** Represents the association between a DevopsPipeline and DevopsEnvironment objects. This object defines which orgs are part of the release pipeline. This object is available in API version 66.0 and later. - **[DevopsPipelineStage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelinestage.htm)** Represents a connection between a pipeline, an environment, and the source control branch used for that stage. The collection of all pipeline stages in a project make up the Lifecycle Center pipeline. This object is available in API version 66.0 and later. - **[DevopsPipelineStageTrigger](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelinestagetrigger.htm)** Defines trigger points within a pipeline stage where automated validations, test suite executions, and quality gate evaluations can be initiated. It tracks execution history, trigger type, associated records, and the number of linked test suites and quality gates, enabling organizations to enforce testing and quality controls at specific stages of the deployment lifecycle. This object is available in API version 67.0 and later. - **[DevopsPipelineTestProvider](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelinetestprovider.htm)** Establishes the association between a pipeline and an external test provider. It stores provider-specific configuration and project information required for integrating testing services into a pipeline. This object enables pipelines to connect with external testing platforms, manage provider settings, and facilitate the execution and synchronization of tests as part of the workflow. This object is available in API version 67.0 and later. - **[DevopsPipelnStgProm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelnstgprom.htm)** Represents a stage promotion in Lifecycle Center. Stage promotion moves one or more work items to the next stage in the pipeline. This object is available in API version 66.0 and later. - **[DevopsPipelnStgPromWkItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopspipelnstgpromwkitem.htm)** Represents the association between a work item and a pipeline stage promotion. The object tracks the merge status of the work item into the target stage branch in source control. This object is available in API version 66.0 and later. - **[DevopsProject](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsproject.htm)** Represents a Lifecycle Center project. A project is the primary workspace where teams collaborate to manage changes for an app or customization. This object is the parent for all other Lifecycle Center objects, including pipelines, environments, and work items. This object is available in API version 67.0 and later. - **[DevopsProjectPipeline](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsprojectpipeline.htm)** Represents an association between a Lifecycle Center project and a release pipeline. In Lifecycle Center, each project is associated with a pipeline to define the sequence of stages work items move through, from initial development to final release. This association is typically established during the pipeline setup. This object is available in API version 67.0 and later. - **[DevopsQualityGate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsqualitygate.htm)** Defines a set of quality requirements that must be satisfied before a deployment or pipeline stage can proceed. It acts as a container for quality gate rules, enabling organizations to enforce testing and quality standards by evaluating test execution results against predefined criteria. Quality gates help ensure that only changes meeting established quality thresholds advance through the DevOps lifecycle. This object is available in API version 67.0 and later. - **[DevopsQualityGateResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsqualitygateresult.htm)** Stores the outcome of a quality gate evaluation performed during a test suite execution. It records the overall status of the quality gate and associates the result with both the quality gate definition and the corresponding test suite execution. This object enables tracking, reporting, and auditing of quality gate compliance before a deployment progresses through the DevOps pipeline. This object is available in API version 67.0 and later. - **[DevopsQualityGateRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsqualitygaterule.htm)** Defines the criteria that must be evaluated as part of a quality gate assessment within the DevOps process. Each rule specifies a validation condition, such as severity, pass percentage, or essential test requirements, along with an optional threshold value. These rules are used to determine whether a quality gate passes or fails before allowing progression through the deployment pipeline. This object is available in API version 67.0 and later. - **[DevopsQualityGateRuleResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsqualitygateruleresult.htm)** Stores the outcome of an individual quality gate rule evaluation performed during a quality gate assessment. It records the execution status of a specific quality gate rule and associates the result with the overall quality gate evaluation, enabling detailed tracking, monitoring, and reporting of quality gate compliance within the DevOps process. This object is available in API version 67.0 and later. - **[DevopsRequestInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsrequestinfo.htm)** Represents a specific request for a Lifecycle Center operation, such as a commit, deploy, promotion, rebase, or back sync, and tracks its overall status and outcome. This object is available in API version 66.0 and later. - **[DevopsTest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopstest.htm)** Stores and manages individual test definitions within the Lifecycle testing framework. It maintains metadata about tests imported from external test providers, including test type, severity, execution status, configuration details, and associations with pipelines and environments. This object enables the organization, tracking, and execution of tests as part of automated quality assurance and deployment processes. This object is available in API version 67.0 and later. - **[DevopsTestExecution](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopstestexecution.htm)** Tracks the execution of individual tests within a test suite execution. It records execution timing, status, results, severity, error messages, and related reporting information, enabling teams to monitor, analyze, and troubleshoot test outcomes as part of the Lifecycle testing process. This object is available in API version 67.0 and later. - **[DevopsTestProvider](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopstestprovider.htm)** Stores the configuration and metadata of both internal and external testing providers integrated with the DevOps framework. It serves as a central registry of supported test providers, maintaining provider-specific information such as implementation identifiers, language settings, URLs, and integration details required to connect and manage external testing systems within DevOps processes. This object is available in API version 67.0 and later. - **[DevopsTestProviderSyncLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopstestprovidersynclog.htm)** Tracks synchronization activities between the DevOps framework and external test providers. It records the lifecycle of synchronization operations, including execution start and end times, status, error details, and the associated DevOps pipeline and test provider. This object enables monitoring, troubleshooting, and auditing of test provider synchronization processes. This object is available in API version 67.0 and later. - **[DevopsTestSuite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopstestsuite.htm)** Stores and manages collections of related test definitions that can be executed together as part of a DevOps pipeline. It serves as a logical grouping mechanism for tests sourced from external test providers, enabling teams to organize, configure, and execute sets of tests within specific pipelines and environments. This object is available in API version 67.0 and later. - **[DevopsTestSuiteExecution](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopstestsuiteexecution.htm)** Records the individual execution lifecycle, results, and metrics of a specific test suite within a DevOps pipeline stage. It tracks granular outcomes like code coverage, pass/fail rates, and links directly back to the overarching test suite group. This object is available in API version 67.0 and later. - **[DevopsTestSuiteGroupExec](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopstestsuitegroupexec.htm)** Records the execution lifecycle of a test suite group within a DevOps pipeline stage, including execution status, quality gate outcomes, timing information, and deployment request details. This object is available in API version 67.0 and later. - **[DevopsTestSuiteStage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopstestsuitestage.htm)** Represents the association between a Test Suite and a Pipeline Stage within the DevOps process. It is used to configure which test suites are executed at specific pipeline stages and optionally link quality gates that must be evaluated before progressing through the deployment pipeline. This object is available in API version 67.0 and later. - **[DevopsTestSuiteTest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopstestsuitetest.htm)** Represents the association between a Lifecycle centre Test Suite and an individual DevOps Test, enabling tests to be organized, managed, and synchronized within a test suite. This object is available in API version 67.0 and later. - **[DevopsWkItmTstSteGrpExec](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopswkitmtststegrpexec.htm)** Represents the association between a DevOpsWork Item and a DevOpsTestSuiteGroupExecution. This object is used to track which work items are linked to specific test suite group execution records, enabling traceability between development work and test execution activities within the DevOps lifecycle. This object is available in API version 67.0 and later. - **[DigitalSignature](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_digitalsignature.htm)** Represents a signature captured on a service report in field service. - **[DigitalWallet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_digitalwallet.htm)** Represents a customer’s digital wallet service. Salesforce Payments can use a digital wallet as a payment source when processing payments through a payment gateway. This object is available in API version 48.0 and later. - **[DirectMessage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_directmessage.htm)** Represents a direct message conversation between multiple users in Chatter. This object is available in API version 38.0 and later. - **[Division](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_division.htm)** A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled. - **[DivisionLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_divisionlocalization.htm)** When the Translation Workbench is enabled for your organization, the DivisionLocalization object provides the translation of the label for a division. - **[DocAtchDownloadEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_docatchdownloadeventlog.htm)** Document Attachment Downloads events contain details of document and attachment downloads. This object is available in API version 65.0 and later. - **[DocProcReview](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_docprocreview.htm)** Represents a document processing review task that manages human verification and correction of data extracted by the Intelligent Document Processing (IDP). This object is available in API version 68.0 and later. - **[Document](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_document.htm)** Represents a file that a user has uploaded. Unlike Attachment records, documents are not attached to a parent object. - **[DocumentAttachmentMap](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_documentattachmentmap.htm)** Maps the relationship between an EmailTemplate and its attachment, which is stored as a Document. - **[DocumentRecipient](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_documentrecipient.htm)** Connects a Service Report to a Digital Signature. This object is available in API version 55.0 and later. - **[DocumentTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_documenttag.htm)** Associates a word or short phrase with a Document. - **[Domain](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domain.htm)** Read-only object that represents a custom Web address assigned to a site in your organization. This object is available in API version 26.0 and later. - **[DomainSite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domainsite.htm)** Read-only junction object that joins the Site and Domain objects. This object is available in API version 26.0 and later. - **[DsarPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dsarpolicy.htm)** Represents a Data Subject Access Request (DSAR) policy created in the Privacy Center managed package. DSAR policies anonymize or transfer personal data from your org at your customer’s request. This object is available in API version 50.0 and later. - **[DsarPolicyLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dsarpolicylog.htm)** Represents the history of Data Subject Access Request (DSAR) policy execution requests. This log records the status and results of executed DSAR policies for a customer. This object is available in API version 50.0 and later. - **[DuplicateJob](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_duplicatejob.htm)** Represents an instance of a job that identifies duplicates among existing records in the system. - **[DuplicateJobDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_duplicatejobdefinition.htm)** Setup object defining a job that identifies duplicate record items globally. - **[DuplicateJobMatchingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_duplicatejobmatchingrule.htm)** Represents a MatchingRule to be used with a DuplicateJob sharing the corresponding DuplicateJobMatchingRuleDefinition. - **[DuplicateJobMatchingRuleDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_duplicatejobmatchingruledefinition.htm)** Setup object specifying a MatchingRule to use with DuplicateJob instances that share a DuplicateJobDefinition. - **[DuplicateRecordItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_duplicaterecorditem.htm)** Represents a record that’s been identified as a duplicate. DuplicateRecordItems are included in a DuplicateRecordSet, which are processed in duplicate jobs. Use this object to create custom report types for duplicates. - **[DuplicateRecordSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_duplicaterecordset.htm)** Represents a group of records that have been identified as duplicates. Each duplicate record set contains one or more duplicate record items. Use this object to create custom report types and view the results of duplicate jobs. - **[DuplicateRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_duplicaterule.htm)** Represents a duplicate rule for detecting duplicate records. - **[DynamicDataCapture](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_dynamicdatacapture.htm)** DynamicDataCapture is a junction object that adds a Form tab to Work Order Overview, and to the related list of a work order, work order line item, or service appointment in the Field Service mobile app. This object is available in API version 62.0 and later. - **[ElectronicMediaGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_electronicmediagroup.htm)** Represents the type of media that you can associate with a product or category.This object is available in API version 49.0 and later. - **[ElectronicMediaUse](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_electronicmediause.htm)** Represents the usage of media. This object is available in API version 49.0 and later. - **[EmailContent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailcontent.htm)** Represents a marketing email asset for use with Account Engagement. This object is available in API version 50.0 and later. - **[EmailDomainFilter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emaildomainfilter.htm)** Represents a filter that determines whether an email relay is restricted to a specific list of domains. This object is available in API version 43.0 and later. - **[EmailDomainKey](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emaildomainkey.htm)** Represents a domain key for an organization’s domain, used to authenticate outbound email that Salesforce sends on the organization’s behalf. This object is available in API version 28.0 and later. - **[EmailInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailinsight.htm)** Represents an insight generated from an email interaction. EmailInsights acts as a central place to store various types of insights related to email messages. The insights stored include status, type, and time of generation. Only certain types of insights can be created based on a pre-configured list of insight types. This object is available in API version 63.0 and later. - **[EmailInsightAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailinsightaction.htm)** Represents the actions that have been taken, or could be taken, in relation to email insights. It logs different types of actions and associated metadata, helping to track and manage the activities and decisions made based on email insights. This object is available in API version 63.0 and later. - **[EmailMessage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailmessage.htm)** Represents an email in Salesforce. - **[EmailMessageMigration](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailmessagemigration.htm)** For internal use only. - **[EmailMessageRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailmessagerelation.htm)** Represents the relationship between an email and contacts, leads, and users. This object is available in API version 37.0 and later. - **[EmailRelay](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailrelay.htm)** Represents the configuration for sending an email relay. An email relay routes email sent from Salesforce through your company’s email servers. This object is available in API version 43.0 and later. - **[EmailRoutingAddress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailroutingaddress.htm)** An email address used for Email-to-Case. Email routing addresses store a unique email services address provided by Salesforce and configuration options for emails received by this address. - **[EmailServicesAddress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailservicesaddress.htm)** An email service address. - **[EmailServicesFunction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailservicesfunction.htm)** An email service. - **[EmailStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailstatus.htm)** Represents the status of email sent. - **[EmailTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailtemplate.htm)** Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only. - **[EmailTemplateMonthlyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailtemplatemonthlymetric.htm)** Represents the monthly engagement metrics for an email template. This object is available in API version 53.0 and later. - **[EmbeddedServiceDetail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_embeddedservicedetail.htm)** Represents a metadata catalog object that exposes fields from the underlying Embedded Service setup objects defined in each EmbeddedServiceConfig deployment for guest users. Guest users don’t have direct access to the Embedded Service setup objects. Available in API version 39.0 and later. - **[EmbeddedServiceLabel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_embeddedservicelabel.htm)** Represents a customized label in Embedded Chat or embedded Appointment Management.This object is available in API version 44.0 and later. - **[Employee](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_employee.htm)** Represents an employee within a company or organization. This object is available in API version 48.0 and later. In API version 49.0 and later, this object supports reports, criteria-based sharing rules, and history tracking, plus you can exclude individual fields from custom page layouts. - **[Employee2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_employee2.htm)** Represents an employee within a company or an organization. This object is available in API version 62.0 and later. - **[EmployeeCrisisAssessment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_employeecrisisassessment.htm)** Represents a crisis assessment of an Employee. This object is available in API version 48.0 and later. In API version 49.0 and later, this object supports reports, criteria-based sharing rules, and history tracking, plus you can exclude individual fields from custom page layouts. - **[EmpUserProvisioningProcess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_empuserprovisioningprocess.htm)** Represents an employee-user provisioning process. This object is available in API version 52.0 and later. - **[EmpUserProvisionProcessErr](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_empuserprovisionprocesserr.htm)** Represents an employee-user provisioning process error. This object is available in API version 52.0 and later. - **[EnablementMeasureDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enablementmeasuredefinition.htm)** Represents an Enablement measure, which specifies the job-related activity that a user performs to complete a milestone or outcome in an Enablement program. A measure identifies a source object and optional related objects, with optional field filters and filter logic, for tracking the activity. This object also represents Enablement measure information in Metadata API. This object is available in API version 56.0 and later. - **[EnablementProgram](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enablementprogram.htm)** Represents an Enablement program, which includes exercises and measurable milestones to help users such as sales reps achieve specific outcomes related to your company’s revenue goals. This object is available in API version 56.0 and later. - **[EnablementProgramDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enablementprogramdefinition.htm)** Represents Enablement program information in Metadata API. This object is available in API version 61.0 and later. - **[EnblMeasureObjectDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enblmeasureobjectdefinition.htm)** Represents the criteria for an object that tracks the job-related activity for an Enablement measure in an Enablement program. A separate EnblMeasureObjectDefinition is used for a measure's source object and each optional related object. This object is available in API version 56.0 and later. - **[EnblPgmTaskMeasureProgress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enblpgmtaskmeasureprogress.htm)** Represents a user’s progress through the object and field requirements that an Enablement measure defines for an outcome or milestone in an Enablement program. This object is available in API version 61.0 and later. - **[EnblProgramSection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enblprogramsection.htm)** Represents an optional section in an Enablement program. A section can include other program items, such as milestones and exercises. This object is available in API version 60.0 and later. - **[EnblProgramTaskDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enblprogramtaskdefinition.htm)** Represents an outcome, a milestone, or an exercise in an Enablement program. A program task is also known as a program item. This object is available in API version 60.0 and later. - **[EnblProgramTaskMeasure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enblprogramtaskmeasure.htm)** Represents the connection between an Enablement measure and a specific milestone or outcome in an Enablement program. This object is available in API version 61.0 and later. - **[EnblProgramTaskProgress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enblprogramtaskprogress.htm)** Represents a user’s progress towards completing an outcome, a milestone, or an exercise in an Enablement program. This object is available in API version 60.0 and later. - **[EnblProgramTaskSubCategory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enblprogramtasksubcategory.htm)** Represents a custom exercise type that an Enablement admin adds to an Enablement program in Program Builder. A custom exercise type also requires a corresponding EnblProgramTaskDefinition record for Program Builder and corresponding LearningItem and LearningItemType records for when users take the exercise in the Guidance Center. This object is available in API version 62.0 and later. - **[EngagementChannelType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_engagementchanneltype.htm)** Represents a channel through which a customer can be reached for communication. This object is available in API version 48.0 and later. - **[EngagementSignal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_engagementsignal.htm)** Represents data about an individual’s engagement action, such as a web click, an email response, or a PDF download. This object is available in API version 62.0 and later. - **[EngagementSignalCmpndMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_engagementsignalcmpndmetric.htm)** Represents a rate metric that measures the ratio between two engagement signal metrics, such as product orders and product views to calculate a conversion rate, or email clicks and email opens to determine a click-through rate. Use this object to create complex measurements for A/B testing and web experimentation. This object is available in API version 62.0 and later. - **[EngagementSignalMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_engagementsignalmetric.htm)** Represents a measurable quantity that’s derived from an engagement signal, such as the sum of revenue or a count of clicks. Use this object to track user engagement for A/B tests, machine learning model training, and attribution configurations. This object is available in API version 62.0 and later. - **[EnhancedLetterhead](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_enhancedletterhead.htm)** Represents an enhanced letterhead that can be associated with a Lightning email template that doesn’t use the Salesforce Merge Language (SML). This object is available in API version 46.0 and later. - **[Entitlement](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entitlement.htm)** Represents the customer support an account or contact is eligible to receive. This object is available in API version 18.0 and later. Entitlements may be based on an asset, product, or service contract. - **[EntitlementContact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entitlementcontact.htm)** Represents a Contact eligible to receive customer support via an Entitlement. This object is available in API version 18.0 and later. - **[EntitlementTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entitlementtemplate.htm)** Represents predefined terms of customer support for a product (Product2). This object is available in API version 18.0 and later. - **[EntityHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entityhistory.htm)** Represents historical information about an object’s changed field values. This object is only available to users with the “View All Data” permission. This object is unavailable beginning with API version 8.0. Use the object-specific [History](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.xml "HTML (New Window)")objects instead. - **[EntityMilestone](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entitymilestone.htm)** Represents a required step in a customer support process on a work order. The Salesforce user interface uses the term “object milestone. This object is available in API version 37.0 and later. - **[EntitySubscription](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_entitysubscription.htm)** Represents a subscription for a user following a record or another user. This object is available in API version 34.0 and later. - **[EnvironmentHubMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_environmenthubmember.htm)** Represents a member organization in the Environment Hub. This object is available in API version 29.0 and later. - **[Event](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_event.htm)** Represents an event in the calendar. In the user interface, event and task records are collectively referred to as activities. - **[EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm)** Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later. - **[EventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventattendee.htm)** Represents a person (a user, lead, or contact) or a resource (such as a conference room) invited to an event. This object lets you add or remove invitees from an event and use the API to manage invitees’ responses to invitations. If Shared Activities is enabled, EventRelation can also represent other objects that are related to an event. EventRelation does not support triggers, workflow, or data validation rules. - **[EventBusSubscriber](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventbussubscriber.htm)** Represents a trigger, process, or flow that’s subscribed to a platform event or a change data capture event. Doesn’t include CometD or Pub/Sub API subscribers. - **[EventRelayConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventrelayconfig.htm)** Represents the configuration of an event relay, which relays platform events and change data capture events from Salesforce to Amazon EventBridge. This object is available in API version 56.0 and later. - **[EventRelayFeedback](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventrelayfeedback.htm)** Represents execution state information about an event relay from Salesforce to Amazon EventBridge for platform events and change data capture events. Query this object to get information such as the event relay status and any error message. This object is available in API version 56.0 and later. - **[EventStagedInviteeEmail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventstagedinviteeemail.htm)** Represents the relationship between an event and an email address invited to the event that doesn’t match to a user, contact, or lead record. Data about the unmatched email address is represented in StagedInviteeEmail. This object represents event-related details, such as the invitee's attendance response to the event. This object is available in API version 66.0 and later. - **[EventTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventtag.htm)** Associates a word or short phrase with an Event. - **[EventWhoRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventwhorelation.htm)** Represents the relationship between an event and a lead or contacts. This derived object is a filtered version of the [EventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventattendee.htm "Represents a person (a user, lead, or contact) or a resource (such as a conference room) invited to an event. This object lets you add or remove invitees from an event and use the API to manage invitees’ responses to invitations. If Shared Activities is enabled, EventRelation can also represent other objects that are related to an event. EventRelation does not support triggers, workflow, or data validation rules.") object; that is, IsParent is true and IsWhat is false. It doesn’t represent relationships to invitees or to accounts, opportunities, or other objects. This object is available in API versions 29.0 and later. - **[Expense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expense.htm)** Represents an expense linked to a work order. Service resource technicians can log expenses, such as tools or travel costs. This object is available in API version 49.0 and later. - **[ExpenseReport](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expensereport.htm)** Represents a report that summarizes expenses. This object is available in API version 50.0 and later. - **[ExpenseReportEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expensereportentry.htm)** Represents an entry in an expense report. This object is available in API version 50.0 and later. - **[ExpressionFilter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expressionfilter.htm)** Represents a logical expression that’s used to control the execution of macro instructions. This object is available in API version 46.0 and later. - **[ExpressionFilterCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expressionfiltercriteria.htm)** Represents a condition in an expression that’s used to control the execution of macro instructions. This object is available in API version 46.0 and later. - **[ExpressionSetConstraintObj](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_expressionsetconstraintobj.htm)** Represents the association between a Product object and the constraint model tags defined in a given constraint model. This object is available in API version 63.0 and later. - **[ExtConvParticipantIntegDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extconvparticipantintegdef.htm)** Represents the integration configuration for external conversation participants, used for communication between Salesforce and external messaging platforms. This object is available in API version 66.0 and later. - **[ExtDataShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extdatashare.htm)** Represents a data share, which is a collection of Data Cloud objects that can be shared with other Data Cloud orgs or third-party partners. This object is available in API version 56.0 and later. - **[ExternalAccountHierarchy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externalaccounthierarchy.htm)** Represents the external account hierarchy, which works like a role-based hierarchy. Use ExternalAccountHierarchy to allow partner and customer users to share data with other external accounts in their hierarchy.This object is available in API version 49.0 and later. - **[ExternalAccountHierarchyHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externalaccounthierarchyhistory.htm)** Represents the history of changes to values in the fields of an external account hierarchy. This object is available in API version 50.0 and later. - **[ExternalClientApplication](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externalclientapplication.htm)** For internal use only. - **[ExternalDataSource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externaldatasource.htm)** Represents an external data source, which defines connection details for integration with data and content that are stored outside the Salesforce org. This object is available in API version 27.0 and later. - **[ExternalDataUserAuth](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externaldatauserauth.htm)** Stores authentication settings for a Salesforce user to access an external system. The external system must be defined in an external data source or a named credential that’s configured to use per-user authentication. This object is available in API version 27.0 and later. - **[ExternalEncryptionRootKey](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externalencryptionrootkey.htm)** Represents metadata about root keys stored in third-party key stores that are used to generate and secure keys that encrypt Salesforce data. This object is available in API version 58.0 and later. - **[ExternalEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externalevent.htm)** Holds native iOS or Android calendar event details for the Salesforce Today feature in the Salesforce mobile app. This object is available in API version 35.0 and later. - **[ExternalEventMapping](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externaleventmapping.htm)** Holds native iOS or Android calendar event details for the Salesforce Today feature in the Salesforce mobile app. This object is available in API version 35.0 and later. - **[ExternalSocialAccount](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_externalsocialaccount.htm)** Represents a managed social media account on a social network such as Facebook or Twitter. This object is available in API version 29.0 and later. - **[ExtKnowledgeConnector](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extknowledgeconnector.htm)** Represents a connector to a third-party knowledge source for Unified Knowledge. This object is available in API version 60.0 and later. - **[ExtlClntAppOauthPlcyCnfg](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlclntappoauthplcycnfg.htm)** For internal use only. - **[ExtlClntAppOauthSettings](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlclntappoauthsettings.htm)** For internal use only. - **[ExtlClntAppPlcyCnfg](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlclntappplcycnfg.htm)** For internal use only. - **[ExtlIntrIdMapping](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlintridmapping.htm)** Represents a mapping between a Salesforce record and its corresponding record in an external system, such as Workday. This object is available in API version 66.0 and later. - **[ExtlRecShrCnct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshrcnct.htm)** Represents authentication data to make outbound calls to and inbound calls from an external system to publish events for Partner Connect. This object is available in API version 62.0 and later. - **[ExtlRecShrCnctAccnt](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshrcnctaccnt.htm)** Represents an association between an account and an external record share connection for Partner Connect. This object is available in API version 62.0 and later. - **[ExtlRecShrField](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshrfield.htm)** Represents an imported, exported, or updated external record share field for Partner Connect. This object is available in API version 63.0 and later. - **[ExtlRecShrFieldMap](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshrfieldmap.htm)** Represents the external record share field mapping between the sender and receiver for Partner Connect. This object is available in API version 62.0 and later. - **[ExtlRecShrLead](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshrlead.htm)** Represents the Lead record of a vendor org if you’re a partner. If you’re a vendor for Partner Connect, this object represents a partner org. This object is available in API version 62.0 and later. - **[ExtlRecShrObject](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshrobject.htm)** Represents a shared object for Partner Connect. This object is available in API version 62.0 and later. - **[ExtlRecShrOpportunity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshropportunity.htm)** Represents the opportunity for Partner Connect in the vendor org if you’re a partner and the partner org if you’re the vendor. This object is available in API version 62.0 and later. - **[ExtlRecShrPcklstOptn](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshrpcklstoptn.htm)** Represents a picklist option of an external record share picklist field shared between a partner and vendor for Partner Connect. This object is available in API version 62.0 and later. - **[ExtlRecShrPicklistMap](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshrpicklistmap.htm)** Represents the external record share picklist field mapping between the partner and vendor system for Partner Connect. This object is available in API version 62.0 and later. - **[ExtlRecShrRecordMap](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_extlrecshrrecordmap.htm)** Represents the lead or opportunity being mapped between a partner and vendor for Partner Connect. This object is available in API version 62.0 and later. - **[FeedAttachment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedattachment.htm)** Represents an attachment to a feed item, such as a file attachment or a link. Use FeedAttachment to add various attachments to one feed item. This object is available in API version 36.0 and later. - **[FeedComment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedcomment.htm)** Represents a comment added to a feed by a user. This object is available in API version 18.0 and later. - **[FeedItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feeditem.htm)** FeedItem represents an entry in the feed, such as changes in a record feed, including text posts, link posts, and content posts. This object is available in API version 21.0 and later. This object replaces FeedPost. - **[FeedLike](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedlike.htm)** Indicates that a user has liked a feed item. This object is available in API version 21.0 and later. - **[FeedPollChoice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedpollchoice.htm)** Shows the choices for a poll posted in the feed. This object is available in API version 29.0 and later. - **[FeedPollVote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedpollvote.htm)** Shows how users voted on a poll posted in the feed. This object is available in API version 29.0 and later. - **[FeedPost](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedpost.htm)** FeedPost represents the following types of changes in a record feed, such as AccountFeed: text posts, link posts, and content posts. This object is available in API version 18.0 through 21.0. FeedPost is no longer available in later versions. Starting with API version 21.0, use FeedItem to represent text posts, link posts, and content posts in feeds. - **[FeedRevision](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedrevision.htm)** Holds the revision history of a specific feed item or comment, including a list of attributes that changed for each revision. This object is available in API version 34.0 and later. - **[feedSignal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedsignal.htm)** Attach feed signals, like UpDownVote, UserVerified, and Verified, to a feed post or comment. This object is available in API version 41.0 and later. - **[FeedTrackedChange](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedtrackedchange.htm)** Represents an individual field change or set of field changes. A FeedTrackedChange is a child object of a record feed, such as AccountFeed. This object is available in API version 18.0 and later. - **[FieldHistoryArchive](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fieldhistoryarchive.htm)** Represents field history values for all objects that retain field history. FieldHistoryArchive is a big object, available only to users with the “Retain Field History” permission. This object is available in API version 29.0 and later. - **[FieldChangeSnapshot](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fieldchangesnapshot.htm)** Use this virtual object to learn which opportunities' close dates changed during the specified time period. This object is available in API version 52.0 and later. - **[FieldPermissions](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fieldpermissions.htm)** Represents the enabled field permissions for the parent PermissionSet. This object is available in API version 24.0 and later. - **[FieldSecurityClassification](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fieldsecurityclassification.htm)** Represents a field’s data sensitivity value selected from the SecurityClassification picklist. This object is available in API version 46.0 and later. - **[FieldServiceMobileSettings](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fieldservicemobilesettings.htm)** Represents a configuration of settings that control the Field Service iOS and Android mobile app experience. This object is available in API version 38.0 and later. - **[FieldServiceOrgSettings](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fieldserviceorgsettings.htm)** Represents the org settings for Field Service, such as Appointment Assistant settings. If Field Service is enabled, the org contains one read-only record of this object. This object is available in API version 51.0 and later. - **[FileSearchActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_filesearchactivity.htm)** Represents search activity on a file. This object is available in API version 38.0 and later. - **[FiscalYearSettings](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fiscalyearsettings.htm)** Settings to define a custom or standard fiscal year for your organization. This object has a parent-child relationship with the Period object. - **[FldSvcObjChg](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fldsvcobjchg.htm)** Represents a change made to one of a service appointment’s tracked fields. This object is available in API version 63.0 and later. - **[FldSvcObjChgDtl](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fldsvcobjchgdtl.htm)** Represents the details of a change made to one of a service appointment’s tracked fields. This object is available in API version 63.0 and later. - **[FlexQueueItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flexqueueitem.htm)** Represents an asynchronous Apex job in the Apex flex queue. Provides information about the job type and flex queue position of the AsyncApexJob. This object is available in API version 36.0 and later. - **[FlowDefinitionView](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowdefinitionview.htm)** Represents the description of a flow definition. This object is available in API version 46.0 and later. - **[FlowInterview](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowinterview.htm)** Represents a flow interview. A flow interview is a running instance of a flow. This object is available in API version 32.0 and later. - **[FlowInterviewLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowinterviewlog.htm)** Represents the logs of a screen flow interview. An interview is an instance of a running or previously run flow.This object is available in API version 49.0 and later. - **[FlowInterviewLogEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowinterviewlogentry.htm)** Represents the log of a specific element that’s executed by a screen flow interview. An interview is an instance of a running or previously run flow. This object is available in API version 49.0 and later. - **[FlowInterviewLogOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowinterviewlogownersharingrule.htm)** Represents the rules for sharing a FlowInterviewLog with users other than the owner.This object is available in API version 49.0 and later. - **[FlowInterviewOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowinterviewownersharingrule.htm)** Represents the rules for sharing a FlowInterview with users other than the owner. This object is available in API version 33.0 and later. - **[FlowInterviewShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowinterviewshare.htm)** Represents a sharing entry on a FlowInterview. This object is available in API version 33.0 and later. - **[FlowNavMetricEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flownavmetriceventlog.htm)** Flow Navigation Metric event logs contain metric data for flow interviews such as total execution time, number of interviews, and number of errors. This object is available in API version 61.0 and later. - **[FlowOrchestration](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_floworchestration.htm)** Represents the details of an orchestration definition. This object is available in API version 62.0 and later. - **[FlowOrchestrationInstance](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_floworchestrationinstance.htm)** Represents a run-time instance of an orchestration. This object is available in API version 53.0 and later. - **[FlowOrchestrationLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_floworchestrationlog.htm)** Represents logging data for a FlowOrchestrationInstance. This object is available in API version 54.0 and later. - **[FlowOrchestrationStageInstance](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_floworchestrationstageinstance.htm)** Represents a run-time instance of a stage in a run-time instance of an orchestration. This read-only object is available in API version 53.0 and later. - **[FlowOrchestrationStepInstance](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_floworchestrationstepinstance.htm)** Represents a run-time instance of a step in a run-time instance of a stage of a run-time instance of an orchestration. This read-only object is available in API version 53.0 and later. - **[FlowOrchestrationVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_floworchestrationversion.htm)** Represents the version of an orchestration. This object is available in API version 62.0 and later. - **[FlowOrchestrationWorkItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_floworchestrationworkitem.htm)** Represents a work item associated with a run-time instance of an interactive step in a run-time instance of an orchestration. This object is available in API version 54.0 and later. - **[FlowRecord](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowrecord.htm)** Represents the details of a flow. This object is available in API version 58.0 and later. - **[FlowRecordElement](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowrecordelement.htm)** Represents a single element within a flow version. This object is available in API version 58.0 and later. - **[FlowRecordElementOccurrence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowrecordelementoccurrence.htm)** Represents the execution metrics for a single element within a flow version. This object is available in API version 62.0 and later. - **[FlowRecordRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowrecordrelation.htm)** Represents a relationship between a record and a flow interview. When a flow interview is paused, Salesforce uses the $Flow.CurrentRecord global variable in the flow to associate the interview with a record. Available in API version 42.0 and later. - **[FlowRecordVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowrecordversion.htm)** Represents the version of a flow. This object is available in API version 58.0 and later. - **[FlowRecordVersionOccurrence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowrecordversionoccurrence.htm)** Represents an instance of a recurring flow that runs on a schedule. For example, a flow that runs weekly on Wednesdays creates an occurrence each time it runs. This object is available in API version 60.0 and later. - **[FlowTestResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowtestresult.htm)** Represents the results for a flow test associated with a flow version. This object is available in API version 55.0 and later. - **[FlowTestView](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowtestview.htm)** Represents the description of a flow test associated with a flow definition. This object is available in API version 55.0 and later. - **[FlowStageRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowstagerelation.htm)** Represents a relationship between a paused flow interview and its stages. When a flow interview is paused, Salesforce creates a FlowStageRelation record for each stage that’s set to the $Flow.CurrentStage or $Flow.ActiveStages global variable. Available in API version 43.0 and later. - **[FlowVariableView](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowvariableview.htm)** Represents a variable within the flow version. This object is available in API version 46.0 and later. - **[FlowVersionView](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_flowversionview.htm)** Represents the version of a flow definition. This object is available in API version 46.0 and later. - **[Folder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_folder.htm)** Represents a repository for a Dashboard, Document, EmailTemplate, Macro, QuickText, or Report. Only one type of item can be contained in a folder. - **[FolderedContentDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_folderedcontentdocument.htm)** Represents the relationship between a parent and child ContentFolderItem in a ContentWorkspace. - **[ForecastingAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingadjustment.htm)** This object represents an individual forecast manager’s adjustment for a subordinate’s or child territory’s forecast via a ForecastingItem. Available in API versions 26.0 and later. This object is different from the ForecastingOwnerAdjustment object, which represents forecast users’ adjustments of their _own_ forecasts, including territory forecasts they own. - **[ForecastingColumnDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingcolumndefinition.htm)** Represents a custom calculated column or a custom reference data column in a forecast type. This object is available in API version 56.0 and later. - **[ForecastingColumnDefinitionLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingcolumndefinitionlocalization.htm)** Represents the translated value of a custom calculated column or custom reference data column label when the Translation Workbench is enabled for your organization. This object is available in API version 56.0 and later. - **[ForecastingCustomCategory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingcustomcategory.htm)** Represents a custom forecasting category used for forecast rollups. This object is available in API version 62.0 and later. - **[ForecastingCustomData](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingcustomdata.htm)** Represents forecast data from external sources to display in the forecasts page. For example, risk or last year’s revenue. This object is available in API version 58.0 and later. - **[ForecastingDisplayedFamily](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingdisplayedfamily.htm)** Represents the table in Forecasts Settings where an admin selects the product families that users can forecast on in Lightning Experience. This object is available in API version 40.0 and later. - **[ForecastingFact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingfact.htm)** This object is read-only and links a ForecastingItem with its opportunities, such as opportunities that share the same owner or forecast category and have a closing date within the period of the forecasting item. Available in API versions 26 and greater. - **[ForecastingFilter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingfilter.htm)** Represents the custom filter for including or excluding data from opportunity forecasts. This object is available in API version 54.0 and later. - **[ForecastingFilterCondition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingfiltercondition.htm)** Represents the custom filter condition logic for including or excluding data from opportunity forecasts. This object is available in API version 54.0 and later. - **[ForecastingGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastinggroup.htm)** Represents groups used to roll up forecast totals on the forecasts page. For example, group forecasts by industry or sales type. This object is available in API version 60.0 and later. - **[ForecastingGroupItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastinggroupitem.htm)** Represents the value within the picklist that is specified as the forecasting group for a forecast type. For example, if you have a forecasting group that identifies the industry an opportunity is part of, this object represents the value in the the industry picklist that’s chosen to be part of the group. This object is available in API version 60.0 and later. - **[ForecastingItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingitem.htm)** This object is read-only used for individual forecast amounts. Users see amounts based on their perspectives and forecast roles. The amounts users see include one of these values when forecasting in revenue: AmountWithoutAdjustments, AmountWithoutManagerAdjustment, ForecastAmount, OwnerOnlyAmount. The amounts users see include one of these values when forecasting in quantity: QuantityWithoutAdjustments, QuantityWithoutManagerAdjustment, ForecastQuantity, OwnerOnlyQuantity. Available in API version 26.0 and later. - **[ForecastingOwnerAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingowneradjustment.htm)** This object represents an individual forecast user’s adjustment of their _own_ forecast, including territory forecasts they own, via a ForecastingItem. Available in API versions 33.0 and later. This object is different from the ForecastingAdjustment object, which represents managers’ adjustments of _subordinates’_ and child territories’ forecasts. - **[ForecastingQuota](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingquota.htm)** This object represents an individual user’s or territory’s quota for a specified time period. The Managed Quotas user permission is required for creating, updating, or deleting quotas. (Users can only edit their subordinates’ or child territories’ quotas, not their own.) The View All Forecasts permission is required to view any user's forecast, regardless of the forecast hierarchy. Available in API versions 25.0 and later. Forecast managers can view the forecasts of subordinates and territories below them in the forecast hierarchy. - **[ForecastingShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingshare.htm)** Represents forecasts shared between a forecast manager and a user. Available in API version 44.0 and later. - **[ForecastingSourceDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingsourcedefinition.htm)** Represents the object, measure, date type, and hierarchy that a forecast uses to project sales. This object is available in API version 52.0 and later. - **[ForecastingSrcRecJudgment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingsrcrecjudgment.htm)** Represents forecast managers’ judgment of whether they consider an opportunity-related deal to be certain to close. This object is available in API version 59.0 and later. - **[ForecastingSubmission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingsubmission.htm)** Represents a submitted forecast. This object is available in API version 62.0 and later. - **[ForecastingSubmissionItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingsubmissionitem.htm)** Represents the values for each forecast category in a submitted forecast. This object is available in API version 62.0 and later. - **[ForecastingType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingtype.htm)** Used to identify the forecast type associated with ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingQuota, ForecastingFact, and ForecastingItem objects. Available in API version 30.0 and greater. - **[ForecastingTypeSource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastingtypesource.htm)** Maps a forecasting source definition to a forecast type. This object is available in API version 52.0 and later. - **[ForecastingUserPreference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_forecastinguserpreference.htm)** Represents the forecasting selections that a user has made, such as display options, date range, forecasting type, and currency. - **[FormulaFunction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_formulafunction.htm)** Represents a function used when building a formula, including examples and uses. This object is available in API version 47.0 and later. - **[FormulaFunctionAllowedType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_formulafunctionallowedtype.htm)** Represents the functions that are supported in the given formula context. This object is available in API version 48.0 and later. - **[FormulaFunctionCategory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_formulafunctioncategory.htm)** Represents the category to which a formula belongs when building a formula. This object is available in API version 47.0 and later. - **[FrcstCustmCatgRampRateSrc](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_frcstcustmcatgrampratesrc.htm)** Represents the total contract value used for custom bulk adjustments. This object is available in API version 63.0 and later. - **[FrcstCustmzAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_frcstcustmzadjustment.htm)** Represents an individual forecast manager’s adjustment of a subordinate’s consumption forecast. Available in API version 63.0 and later. This object is different from the ForecastingAdjustment object, which represents managers’ adjustments of subordinates’ pipeline forecasts. - **[FrcstCustmzOwnerAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_frcstcustmzowneradjustment.htm)** Represents an individual forecast user’s adjustment of their own consumption forecast. Available in API version 63.0 and later. This object is different from the ForecastingOwnerAdjustment object, which represents users’ adjustments of their pipeline forecasts. - **[FulfillmentOrder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorder.htm)** Represents a group of products, fees, and delivery charges on a single order that share the same fulfillment location, delivery method, and recipient. The FulfillmentOrderLineItems belonging to a FulfillmentOrder are associated with OrderItemSummary objects belonging to a single OrderSummary. This object is available in API version 48.0 and later. - **[FulfillmentOrderItemAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderitemadjustment.htm)** Represents a price adjustment on a FulfillmentOrderLineItem. Corresponds to an OrderItemAdjustmentLineSummary associated with the corresponding OrderItemSummary. This object is available in API version 48.0 and later. - **[FulfillmentOrderItemTax](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderitemtax.htm)** Represents the tax on a FulfillmentOrderLineItem or FulfillmentOrderItemAdjustment. Corresponds to an OrderItemTaxLineItemSummary. This object is available in API version 48.0 and later. - **[FulfillmentOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderlineitem.htm)** Represents a product or delivery charge belonging to a FulfillmentOrder. Corresponds to an OrderItemSummary. This object is available in API version 48.0 and later. - **[FunctionConnection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_functionconnection.htm)** Represents a connection between an org and Salesforce Functions. This object is available in API version 52.0 and later. - **[FunctionInvocationRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_functioninvocationrequest.htm)** Represents invocation information for a Salesforce Function. This object is available in API version 51.0 and later. - **[FunctionReference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_functionreference.htm)** Represents a deployed Salesforce Function associated with an org. This object is available in API version 52.0 and later. - **[FulfmtRoutgCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfmtroutgcriteria.htm)** Stores individual fulfillment criteria with their metadata, actions, and activation status within a fulfillment criteria group version. This object is available in API version 66.0 and later. - **[FulfmtRoutgCriteriaActnVar](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfmtroutgcriteriaactnvar.htm)** Maps variable identifiers used in fulfillment criteria action expressions to entity fields. Stores the binding between symbolic variable names (e.g., $availableCapacity, $location) in action expression and the actual entity and field paths (e.g., Location.availableCapacity) used at runtime. This object is available in API version 66.0 and later. - **[FulfmtRoutgCriteriaCond](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfmtroutgcriteriacond.htm)** Stores atomic conditions that make up fulfillment criteria logic, with globally unique identifiers. This object is available in API version 66.0 and later. - **[FulfmtRoutgCriteriaGrp](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfmtroutgcriteriagrp.htm)** Represents a logical grouping of rules for a specific business context, for example, Fulfillment routing and Delivery estimation. This object is available in API version 66.0 and later. - **[FulfmtRoutgCriteriaGrpVer](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfmtroutgcriteriagrpver.htm)** Manages versioning and lifecycle states for fulfillment criteria groups, providing stable external references while supporting versioning. This object is available in API version 66.0 and later. - **[GenAIConversationSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_genaiconversationsummary.htm)** Represents a generated summary of a voice or video call. This object is available in API version 60.0 and later. - **[GenAiFunctionDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_genaifunctiondefinition.htm)** Represents an agent action. This object is available in API version 60.0 and later. - **[GenAiPlannerDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_genaiplannerdefinition.htm)** Represents an agent planner service that uses a large language model (LLM) and a reasoning strategy to decompose a given task into smaller subtasks, identify the most suitable actions for each subtask, and invoke them. This object is available in API version 60.0 and later. - **[GenAiPlannerFunctionDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_genaiplannerfunctiondef.htm)** Represents a relationship between the agent planner service and agent actions. This object is available in API version 60.0 and later. - **[GenAiPluginDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_genaiplugindefinition.htm)** Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents. This object is available in API version 62.0 and later. - **[GenOpPlanRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_genopplanrequest.htm)** Represents a request to generate a service plan. This object is available in API version 67.0 and later. - **[GenOpPlanReferenceRecord](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_genopplanreferencerecord.htm)** Represents a reference record, such as a similar case, associated with a generated operation plan. This object is available in API version 65.0 and later. - **[GeoCountry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_geocountry.htm)** Represents a country. This object is available in API version 56.0 and later. - **[GeolocationBasedAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_geolocationbasedaction.htm)** Represents a geolocation-based action, which is an action that’s triggered when a user enters, exits, or is within the area of the associated object. Available in API version 61.0 and later. - **[GeoState](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_geostate.htm)** Represents a state. This object is available in API version 57.0 and later. - **[GtwyProvPaymentMethodType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_gtwyprovpaymentmethodtype.htm)** The gateway provider payment method type allows integrators and payment providers to choose an active payment to receive an order's payment data rather than allowing the Salesforce Order Management platform to select a default payment method. This object is available in API version 50.0 and later. - **[Goal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_goal.htm)** The Goal object represents the components of a goal such as its name, description, and status. - **[GoalLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_goallink.htm)** Represents the relationship between two goals. This is a many-to-many relationship, meaning that each goal can link to many other goals. - **[GoogleDoc](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_googledoc.htm)** Represents a link to a Google Document. This object is available in API version 14.0 and later. - **[GraphQlQueryEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_graphqlqueryeventlog.htm)** GraphQL Query events contain information about executed queries, including total execution time, the number of invocations, and any reported errors.. This object is available in API version 69.0 and later. - **[Group](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_group.htm)** A set of User records. - **[GroupMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_groupmember.htm)** Represents a User or Group that is a member of a public group. - **[GroupMembershipEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_groupmembershipeventlog.htm)** Group Membership events capture details about changes to public group and queue membership, such as when members are added to or removed from the public group or queue. This object is available in API version 64.0 and later. - **[GuestBuyerProfile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_guestbuyerprofile.htm)** Represents a store's guest buyer profile, which allows unauthenticated buyers to browse the store. This object is available in API version 51.0 and later. - **[HashtagDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_hashtagdefinition.htm)** HashtagDefinition represents hashtag (#) topics in public Chatter posts and comments. Public posts and comments include those on profiles and in public groups, but not those on records or in private groups. This object is available in API version 26.0 and later. - **[HealthCareDiagnosis](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_healthcarediagnosis.htm)** Represents information related to industry-standard healthcare diagnosis codes. Before the Spring ’21 release, the Healthcare Procedure and Healthcare Diagnosis objects stored codes specifically related to procedures and diagnoses. These codes were used for prior-authorization requests and approval processes. Since the Spring’21 release, Health Cloud uses the Code Set and Code Set Bundle objects for this purpose instead. - **[HealthCareProcedure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_healthcareprocedure.htm)** Represents information related to industry-standard healthcare procedure codes. Before the Spring ’21 release, the Healthcare Procedure and Healthcare Diagnosis objects stored codes specifically related to procedures and diagnoses. These codes were used for prior-authorization requests and approval processes. Since the Spring’21 release, Health Cloud uses the Code Set and Code Set Bundle objects for this purpose instead. - **[Holiday](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_holiday.htm)** Represents a period of time during which your customer support team is unavailable. Business hours and escalation rules associated with business hours are suspended during any holidays with which they are affiliated. - **[IconDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_icondefinition.htm)** Represents the icon-related metadata for a custom tab. This object is available in API version 43.0 and later. - **[Idea](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_idea.htm)** Represents an idea on which users are allowed to comment and vote, for example, a suggestion for an enhancement to an existing product or process. This object is available in API version 12 and later. - **[IdeaComment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ideacomment.htm)** Represents a comment that a user has submitted in response to an idea. - **[IdeaReputation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ideareputation.htm)** Represents a collection of statistics and scores derived from a user’s activity within an Ideas zone or internal organization. This object is available in API version 28.0 and later. - **[IdeaReputationLevel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ideareputationlevel.htm)** Represents a reputation level within an Ideas zone or internal organization and is used by the system to calculate reputation. You can create up to 25 levels per zone or internal organization. This object is available in API version 28.0 and later. - **[IdeaTheme](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ideatheme.htm)** Represents an invitation to zone members to submit ideas that are focused on a specific topic. This object is available in API version 26 and later. - **[IdpEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_idpeventlog.htm)** Represents the Identity Provider Event Log. This log records both problems and successes with inbound SAML or OpenID Connect authentication requests from another app provider. It also records outbound SAML responses when Salesforce is acting as an identity provider. This object is available in API version 39.0 and later. - **[IframeWhiteListUrl](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_iframewhitelisturl.htm)** Represents a list of trusted external domains that you allow to frame your Embedded Service, Surveys, and Visualforce pages. This object is available in API version 45.0 and later. - **[Image](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_image.htm)** Represents the details of an image. This object is available in API version 47.0 and later. - **[Incident](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_incident.htm)** An Incident is any unplanned business interruption that has wide-sweeping impacts and requires an urgent fix. This object contains the details of the incident, documenting the history of the incident from registration to closure. This object is available in API version 53.0 and later. - **[IncidentRelatedItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_incidentrelateditem.htm)** Represents a junction object that relates an Incident to an Asset or Product. This object is available in API version 53.0 and later. - **[Individual](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_individual.htm)** Represents a customer’s data privacy and protection preferences. Data privacy records based on the Individual object store your customers’ preferences. Data privacy records are associated with related leads, contacts, person accounts, and users. This object is available in API version 42.0 and later. - **[IndividualApplicationItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_individualapplicationitem.htm)** Captures individual application input data that is used during run-time. This object is available in API version 58.0 and later. - **[IndividualHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_individualhistory.htm)** Represents the history of changes to values in the fields of a data privacy record, based on the Individual object. This object is available in versions 42.0 and later. - **[IndividualShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_individualshare.htm)** Represents a list of access levels to a data privacy record along with an explanation of the access level. For example, if you have access to a record because you own it, the IndividualAccessLevel is All and RowCause is Owner. This object is available in API version 42.0 and later. - **[InsufficientAccessEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_insufficientaccesseventlog.htm)** Insufficient Access event logs contain details about errors relating to insufficient account, case, contact, and opportunity record access. This object is available in API version 61.0 and later. - **[InternalOrganizationUnit](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_internalorganizationunit.htm)** Represents an organization that an Employee belongs to. This object is available in API version 48.0 and later. In API version 49.0 and later, this object supports reports, criteria-based sharing rules, and history tracking, plus you can exclude individual fields from custom page layouts. - **[InventoryItemReservation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_inventoryitemreservation.htm)** Used to store inventory item reservation information for a specific product and location. This object is available in API version 60.0 and later. - **[InventoryReservation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_inventoryreservation.htm)** Stores information about the status of cart inventory reservations in B2B and D2C Commerce. This object is available in API version 60.0 and later. - **[InvocableActionEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_invocableactioneventlog.htm)** Invocable Action events capture the calls to Salesforce Invocable Actions. This is particularly useful to monitor actions invoked during Agentforce flows. This object is available in API version 64.0 and later. - **[Invoice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_invoice.htm)** Represents a financial document describing the total amount a buyer must pay for goods or services provided. This object is available in API version 48.0 and later. - **[InvoiceAddressGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_invoiceaddressgroup.htm)** Stores the buyer's address information. This object is available in API version 50.0 and later. - **[InvoiceBatchRun](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_invoicebatchrun.htm)** Represents a batch processing job in Subscription Management or Billing (Revenue Cloud). During an invoice batch run, all billing schedules that meet the specified criteria are processed, resulting in the generation of invoices. This object is available in API version 55.0 and later. - **[InvoiceBatchRunCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_invoicebatchruncriteria.htm)** Represents a batch processing job and its required criteria in Subscription Management. During an invoice batch run, all billing schedules that meet the specified criteria are processed, resulting in the generation of invoices. This object is available in API version 55.0 and later. - **[InvoiceBatchRunRecovery](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_invoicebatchrunrecovery.htm)** Provides information about an invoice batch run recovery procedure. This object is available in API version 57.0 and later. - **[InvoiceDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_invoicedocument.htm)** Tracks and displays the status of documents generated for invoices. Invoice documents are available in the related lists of invoice entity records. This object is available in API version 61.0 and later. - **[InvoiceLine](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_invoiceline.htm)** Represents the amount that a buyer must pay for a product, service, or fee. Invoice lines are created based on the amount of an order line. This object is available in API version 48.0 and later. - **[JobProfile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_jobprofile.htm)** Represents a job profile used for shift scheduling. This object is available in API versions 47.0 and later. - **[JobProfileQueueGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_jobprofilequeuegroup.htm)** JobProfileQueueGroup defines the mapping between Queue and JobProfile and configurations for capacity plans in Workforce Engagement. This object is available in API version 53.0 and later. - **[Knowledge\_\_Feed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledge__feed.htm)** Represents the feed for a knowledge article. This object is available in API version 39.0 and later. - **[Knowledge\_\_ka](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledge__ka.htm)** Provides access to the concrete object that represents a Knowledge article, the parent object for article versions. This object is available in API version 39.0 and later. - **[Knowledge\_\_kav](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledge__kav.htm)** Provides access to the concrete object that represents a Knowledge article version. This object is available in API version 39.0 and later. - **[Knowledge\_\_DataCategorySelection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledge__datacategoryselection.htm)** Represents a data category that classifies an article. This object is available in API version 39.0 and later. - **[KnowledgeableUser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgeableuser.htm)** Represents a user identified as knowledgeable about a specific topic, and ranks them relative to other knowledgeable users. This object is available in API version 31.0 and later. - **[KnowledgeArticle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticle.htm)** Provides read-only access to an article and the ability to delete the primary article. This object is available in API version 19.0 and later. - **[KnowledgeArticleEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleeventlog.htm)** Knowledge Article View event logs contain user activity with your knowledge base. This object is available in API version 61.0 and later. - **[KnowledgeArticleFeedback](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticlefeedback.htm)** Represents information about feedback from users on Knowledge articles and details about assignment of feedback to the article owner or team to take action. This object is available in API version 64.0 and later. - **[KnowledgeArticleVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleversion.htm)** Provides a global view of standard article fields across all types of articles depending on their version. This object is available in API version 18.0 and later. - **[KnwlgeBlockArticleRefField](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knwlgblockarticlereffield.htm)** Represents the association between a specific knowledge block version and its corresponding article version. This object is available in API version 68.0 and later. - **[KnowledgeArticleVersionHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleversionhistory.htm)** Enables read-only access to the full history of an article. This object is available in API version 25.0 and later. - **[KnowledgeArticleViewStat](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticleviewstat.htm)** Provides certain statistics related to the number of views for the specified article across all article types. The view count statistics are for published and archived articles only. View counts for draft articles aren’t tracked. This object is read-only and available in API version 20.0 and later. - **[KnowledgeArticleVoteStat](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticlevotestat.htm)** Provides the weighted rating for the specified article on a scale of 1 to 5 across all article types. This object is read-only and available in API version 20.0 and later. - **[LandingPage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_landingpage.htm)** Represents an Account Engagement landing page. A landing page is a web page that a visitor reaches after clicking a link or advertisement. Landing pages can be created in Account Engagement and synced to Salesforce or created on the Landing Page object in Account Engagement Lightning App. This object is available in API version 42.0 and later. - **[Lead](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lead.htm)** Represents a prospect or lead. - **[LeadCleanInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadcleaninfo.htm)** Stores the metadata Data.com Clean uses to determine a lead record’s clean status. Helps you automate the cleaning or related processing of lead records. - **[LeadDailyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leaddailymetric.htm)** Represents the daily engagement metrics for a lead. This object is available in API version 52.0 and later. - **[LeadMonthlyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadmonthlymetric.htm)** Represents the monthly engagement metrics for a lead. This object is available in API version 52.0 and later. - **[LeadOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadownersharingrule.htm)** Represents the rules for sharing a lead with users other than the owner. - **[LeadProspectingAgentResearch](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadprspagntrsrch.htm)** Represents research done by a prospecting agent on a lead record. - **[LeadShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadshare.htm)** Represents a sharing entry on a Lead. - **[LeadStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadstatus.htm)** Represents the status of a Lead record, such as Open, Qualified, or Converted. - **[LeadTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_leadtag.htm)** Associates a word or short phrase with a Lead. - **[LearningContent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_learningcontent.htm)** Represents a Trailhead or enablement site (myTrailhead) module assigned to a user in Workforce Engagement or Learning Paths. This object also represents a Trailhead module or video in an Enablement program exercise. This object is available in API version 54.0 and later. - **[LearningItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_learningitem.htm)** Represents an item that requires users to take action, including a Learning Paths entry, an Enablement program, or an exercise with linked content in an Enablement program. For Learning Paths, users are assigned a learning item to complete. For Enablement programs and exercises, users are assigned a program or can self-enroll in shared programs. This object is available in API version 58.0 and later. - **[LearningItemAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_learningitemassignment.htm)** Represents the assignment of a Learning Paths entry to users or groups or the enrollment of an Enablement program for a specific user. This object is available in API version 58.0 and later. - **[LearningItemProgress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_learningitemprogress.htm)** Represents the progress that a user has made towards completing an assigned learning item, such as a Learning Paths entry or Enablement program. This object is available in API version 60.0 and later. - **[LearningItemSubmission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_learningitemsubmission.htm)** Represents a link to a resource, such as a video recording, that a user submits as part of a Feedback Request exercise in an Enablement program. For peer and manager feedback, this resource can be a recording of a user’s sales patch. For Einstein Coach feedback, this resource can be a video call, and Einstein generates feedback from the call’s transcription. This object is available in API version 59.0 and later, but Einstein Coach is available only in API version 61.0 and later. - **[LearningItemType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_learningitemtype.htm)** Represents a custom exercise type that an Enablement user takes in an Enablement program in the Guidance Center. A custom exercise type also requires a corresponding LearningItem record for the Guidance Center and corresponding EnblProgramTaskDefinition and EnblProgramTaskSubCategory records for when admins create a program in Program Builder. This object is available in API version 62.0 and later. - **[LearningPractice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_learningpractice.htm)** Represents a Feedback Request exercise in an Enablement program. Users can submit a sample of their work and request feedback from their peers and managers. Or, users can submit a video call and Einstein Coach generates feedback from the call’s transcription. This object is available in API version 59.0 and later, but Einstein Coach feedback is available only in API version 61.0 and later. - **[LegalEntity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_legalentity.htm)** Represents the way an organization is structured. An organization can be a single legal entity or it can comprise more than one legal entity. This object is available in API version 48.0 and later. - **[LicenseDefinitionCustomPermission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_licensedefinitioncustompermission.htm)** Represents a licensed custom permission that controls access to a license's features when included in a custom permission set license definition. This object is available in API version 66.0 and later. - **[LightningErrorEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningerroreventlog.htm)** Lightning Error events represent errors that occurred during user interactions with Lightning Experience and the Salesforce mobile app. This object is available in API version 64.0 and later. - **[LightningExperienceTheme](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningexperiencetheme.htm)** Represents information for a theme in Lightning Experience. This object is available in API Version 42.0 and later. - **[LightningLoggerEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningloggereventlog.htm)** Lightning Logger Event Log provides information from observed Lightning component logs. This object is available in API version 61.0 and later. - **[LightningOnboardingConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningonboardingconfig.htm)** Represents the feedback provided when users switch from Lightning Experience to Salesforce Classic. Admins can customize the question, how frequently the form appears, and where the feedback is stored in Chatter from the Adoption Assistance page in Lightning Experience Setup. Available in API version 47.0 and later. - **[LightningPageViewEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningpagevieweventlog.htm)** Lightning Page View event logs represent information about the page on which the event occurred in Lightning Experience and the Salesforce mobile app. A Lightning Page View event log tracks the page a user visited, how long the user spent on the page, and the load time for the page. This object is available in API version 61.0 and later. - **[LightningPrfmEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningprfmeventlog.htm)** Lightning Performance events track trends in Lightning Experience and Salesforce mobile app performance. This object is available in API version 65.0 and later. - **[LightningToggleMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningtogglemetrics.htm)** Represents users who switched from Lightning Experience back to Salesforce Classic. This object is available in API version 43.0 and later. - **[LightningUsageByAppTypeMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningusagebyapptypemetrics.htm)** Represents number of users on Lightning Experience and Salesforce Mobile. This object is available in API version 43.0 and later. - **[LightningUsageByBrowserMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningusagebybrowsermetrics.htm)** Represents Lightning Experience usage grouped by user’s browser. This object is available in API version 43.0 and later. - **[LightningUsageByPageMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningusagebypagemetrics.htm)** Represents standard pages users viewed most frequently in Lightning Experience. This object is available in API version 43.0 and later. - **[LightningUsageByFlexiPageMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningusagebyflexipagemetrics.htm)** Represents custom pages users viewed most frequently in Lightning Experience. This object is available in API version 43.0 and later. - **[LightningExitByPageMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lightningexitbypagemetrics.htm)** Represents frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic. This object is available in API version 44.0 and later. - **[LinkedArticle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_linkedarticle.htm)** Represents a knowledge article that is attached to a work order, work order line item, or work type. This object is available in API version 37.0 and later. - **[LinkedArticleFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_linkedarticlefeed.htm)** Represents the comment feed on a linked article. This object is available in API version 39.0 and later. - **[LinkedArticleHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_linkedarticlehistory.htm)** Represents the history of changes made to tracked fields on a linked article. This object is available in API version 37.0 and later. - **[ListEmail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_listemail.htm)** Represents a list email sent from Salesforce, or sent from Account Engagement and synced to Salesforce. When the list email is sent, the recipients are generated by combining recipients in ListEmailIndividualRecipients and ListEmailRecipientSource. Duplicate and other invalid recipients are removed. The result is the recipients sent any given list email. ListEmail has a one-to-many relationship with ListEmailRecipientSource and ListEmailIndividualRecipient. This object is available in API version 41.0 and later. - **[ListEmailIndividualRecipient](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_listemail_individual_recipient.htm)** For a list email in Salesforce, represents a recipient. Each record represents a link from a list email to exactly one recipient for that list email. Recipients can be contacts, leads, or campaign members. Has a one-to-many relationship with ListEmail. This object is available in API version 44.0 and later. - **[ListEmailSentResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_listemailsentresult.htm)** Represents the results of a list email sent from Salesforce, or sent from Account Engagement and synced to Salesforce. It contains transport headers and information specific to the associated send action. This object is available in API version 67.0 and later. - **[ListEmailMonthlyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_listemailmonthlymetric.htm)** Represents the monthly engagement metrics for a single list email. This object is available in API version 49.0 and later. - **[ListEmailRecipientSource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_listemail_recipient_source.htm)** For a list email in Salesforce, represents the dynamically defined sources of recipient email addresses. Each record represents a link to a single list view or campaign that is examined when the list email is sent. Has a one-to-many relationship with ListEmail. This object is available in API version 41.0 and later. - **[ListView](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_listview.htm)** Represents a list view. A list view shows a set of records for an object, based on specific criteria. This object is available in API version 32.0 and later. - **[ListViewChart](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_listviewchart.htm)** Represents a graphical chart that’s displayed on Salesforce for Android, iOS, and mobile web list views. The chart aggregates data that is filtered based on the list view that’s currently displayed. This object is available in API version 33.0 and later and is accessible by portal users. - **[ListViewChartInstance](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_listviewchartinstance.htm)** Retrieves metadata for all standard and custom charts for a given entity in context of a given list view. This object is available in API versions 34.0 and later. - **[LiveAgentSession](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_liveagentsession.htm)** This object is automatically created for each Chat session and stores information about the session. This object is available in API versions 28.0 and later. - **[LiveAgentSessionHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_liveagentsessionhistory.htm)** This object is automatically created for each Chat session and stores information about changes made to the session. This object is available in API versions 28.0 and later. - **[LiveAgentSessionShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_liveagentsessionshare.htm)** This object is automatically created for each Chat session and stores information about the session. This object is available in API versions 28.0 and later. - **[LiveChatBlockingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatblockingrule.htm)** Represents a rule for blocking chat visitors’ IP addresses from starting new chats with agents. This object is available in API version 34.0 and later. - **[LiveChatObjectAccessConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatobjectaccessconfig.htm)** Represents the action you can perform on a specified object by the Chat API. This object is available in API version 53.0 and later. - **[LiveChatObjectAccessDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatobjectaccessdefinition.htm)** Represents the parent record for one or more LiveChatObjectAccessConfig objects. This object is available in API version 53.0 and later. - **[LiveChatButton](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatbutton.htm)** Represents a button that allows visitors to request chats with Chat users. This object is available in API version 24.0 and later. - **[LiveChatButtonDeployment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatbuttondeployment.htm)** Associates an automated chat invitation with a specific deployment. This object is available in API versions 28.0 and later. - **[LiveChatButtonSkill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatbuttonskill.htm)** Represents all the skills available to a LiveChatButton except the one currently assigned. To retrieve the skill currently assigned, query LiveChatButton. This object is available in API version 25.0 and later. - **[LiveChatDeployment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatdeployment.htm)** Represents the general settings for deploying Live Agent on a website. This object is available in API version 24.0 and later. - **[LiveChatSensitiveDataRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatsensitivedatarule.htm)** Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex). This object is available in API version 35.0 and later. - **[LiveChatTranscript](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechattranscript.htm)** This object is automatically created for each Live Agent chat session and stores information about the session. This object is available in API version 24.0 and later. - **[LiveChatTranscriptEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechattranscriptevent.htm)** Captures specific events that occur over the lifetime of a chat. This object is available in API version 24.0 and later. - **[LiveChatTranscriptShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechattranscriptshare.htm)** Represents a sharing entry on a LiveChatTranscript object. This object is available in API version 24.0 and later. - **[LiveChatTranscriptSkill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechattranscriptskill.htm)** Represents a join between LiveChatTranscript and Skill. This object is available in API version 25.0 and later. - **[LiveChatUserConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatuserconfig.htm)** Represents a setting that controls the console settings for Chat users. This object is available in API version 24.0 and later. - **[LiveChatUserConfigProfile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatuserconfigprofile.htm)** Represents a join between LiveChatUserConfig and Profile. This object is available in API version 24.0 and later. - **[LiveChatUserConfigUser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatuserconfiguser.htm)** Represents a join between Live Chat User Config and User. This object is available in API version 24.0 and later. - **[LiveChatVisitor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_livechatvisitor.htm)** Represents a website visitor who has started or tried to start a chat session. This object is available in API version 24.0 and later. - **[Location](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_location.htm)** Represents a warehouse, service vehicle, work site, or other element of the region where your team performs field service work. In API version 49.0 and later, you can associate activities with specific locations. Activities, such as the tasks and events related to a location, appear in the activities timeline when you view the location detail page. Also in API version 49.0 and later, Work.com users can view Employees as a related list on Location records. In API version 51.0 and later, this object is available for Omnichannel Inventory and represents physical locations where inventory is available for fulfilling orders. - **[LocationGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationgroup.htm)** Represents a group of Omnichannel Inventory locations, providing an aggregate view of inventory availability across those locations. Omnichannel Inventory can create an inventory reservation for an order at the location group level, then assign the reservation to one or more locations in the group as needed. This object is available in API version 51.0 and later. - **[LocationGroupAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationgroupassignment.htm)** Represents the assignment of a location to a location group. This object is available in API version 51.0 and later. - **[LocationShippingCarrierMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationshippingcarriermethod.htm)** The available shipping carrier services associated with a location or location group. Allows the assignment of different shipping methods to a specific location and enables flexibility and customization in the shipping process. This object is available in API version 61.0 and later. - **[LocationTrustMeasure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationtrustmeasure.htm)** Represents the COVID safety protocols that your business follows. For example, enforcement of masks, social distancing, cleanliness, and capacity limits. This object is available in API version 50.0 and later. - **[LocWaitlistMsgTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locwaitlistmsgtemplate.htm)** Represents a junction object connecting LocationWaitlist to MessagingTemplate. This object is available in API version 50.0 and later. - **[LocationWaitlist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationwaitlist.htm)** Represents a queue created for a specific location. Multiple queues can be created for a single location. For example, you can have a queue for each sales agent or a standard queue and a queue for vulnerable groups. The specific party of people in a queue is represented by LocationWaitlistedParty. This object is available in API version 50.0 and later. - **[LocationWaitlistedParty](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_locationwaitlistedparty.htm)** Represents a specific party of people waiting in a queue. This object is available in API version 50.0 and later. - **[LoginAsEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_loginaseventlog.htm)** LoginAsEventLog contains details about when a user logs in as another user in your org. This object is available in API version 61.0 and later. - **[LoginEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_loginevent.htm)** The documentation has moved to [LoginEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_loginevent.htm "HTML (New Window)") in the Platform Events Developer Guide. - **[LoginEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_logineventlog.htm)** Login event logs contain details about your Salesforce org's user login history. This object is available in API version 61.0 and later. - **[LoginGeo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_logingeo.htm)** Represents the geographic location of the user’s IP address for a login event. Due to the nature of geolocation technology, the accuracy of geolocation fields (for example, country, city, postal code) may vary. This object is available in API version 34.0 and later. - **[LoginHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_loginhistory.htm)** Represents the login history for all successful and failed login attempts for organizations and enabled portals. This object is available in API version 21.0 and later. - **[LoginIp](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_loginip.htm)** Represents a validated IP address. This object is available in version 28.0 and later. - **[LogoutEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_logouteventlog.htm)** Contains details of user sessions ending or being revoked. This object is available in API version 65.0 and later. - **[LogoutEventStream](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_logouteventstream.htm)** The documentation has moved to [LogoutEventStream](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_logouteventstream.htm "HTML (New Window)") in the Platform Events Developer Guide. - **[LookedUpFromActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lookedupfromactivity.htm)** This read-only object is displayed as a related list on an activity record (an event or a task); the list contains records that have custom lookup relationships from the activity to another object. This object is not queryable. - **[Macro](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_macro.htm)** Represents a macro, which is a set of instructions that tells the system to perform one or more tasks. This object is available in API version 32.0 and later. - **[MacroInstruction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_macroinstruction.htm)** Represents an instruction in a macro. An instruction can specify the object that the macro interacts with, the context or publisher that the macro works within, the operation or action that the macro performs, and the target of the macro’s actions. - **[MacroUsage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_macrousage.htm)** Represents macro usage on a record, including which macro was used, who used it, and how they used it. This object is available in API version 47.0 and later. - **[MailmergeTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mailmergetemplate.htm)** Represents a mail merge template (a Microsoft Word document) used for performing mail merges for your organization. - **[MaintenanceAsset](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_maintenanceasset.htm)** Represents an asset covered by a maintenance plan in field service. Assets can be associated with multiple maintenance plans. - **[MaintenancePlan](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_maintenanceplan.htm)** Represents a preventive maintenance schedule for one or more assets in field service. - **[MaintenanceWorkRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_maintenanceworkrule.htm)** Represents the recurrence pattern for a maintenance record. This object is available in API version 49.0 and later. - **[ManagedContent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_managedcontent.htm)** Represents managed content in a Salesforce CMS workspace for use in an Experience Cloud site or a channel. The ManagedContent object represents the complete instance of a managed content record. It provides a consistent identifier for the managed content so that variants of the content item can be created over time. This object is available in API version 56.0 and later. - **[ManagedContentChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_managedcontentchannel.htm)** Represents the details of a CMS channel. CMS channels correspond to managed content publishing endpoints. They deliver published content from your Salesforce CMS workspaces to an audience. This object is available in API version 55.0 and later. - **[ManagedContentInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_managedcontentinfo.htm)** Allows the creation of relationship to Product using ProductMedia. This object is available in API version 49.0 to 57.0. In API version 58.0 and later, use the ManagedContent object. - **[ManagedContentSpace](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_managedcontentspace.htm)** Represents the complete instance of a Salesforce CMS workspace that stores managed content. Users and groups with designated permissions can access and manage the content in a CMS workspace. This object is available in API version 56.0 and later. - **[ManagedContentVariant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_managedcontentvariant.htm)** Represents a variant of a managed content item. This object is available in API version 56.0 and later. - **[MarketingForm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_marketingform.htm)** Represents an Account Engagement marketing form that has been synched to Salesforce. Use forms on your website and landing pages to collect information about visitors and turn anonymous visitors into identified prospects. This object is available in API version 42.0 and later. - **[MarketingGoal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_marketinggoal.htm)** Represents a measurable target for a marketing program or a campaign, tracking target values, actual results, and assignments across different levels of the marketing hierarchy. This object is available in API version 68.0 and later. - **[MarketingLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_marketinglink.htm)** Represents an Account Engagement marketing link record, either a custom redirect or a file, that has been synced to Salesforce. This object is available in API version 42.0 and later. - **[MarketingProgram](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_marketingprogram.htm)** Represents a marketing program in a marketing hierarchy group that's tied to a specific node in the hierarchy. This object is available in API version 68.0 and later. - **[MarketingTactic](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_marketingtactic.htm)** Represents a single executable unit of work for a campaign or marketing program that combines marketing content with a specific delivery method, such as an email or a social post. This object is available in API version 68.0 and later. - **[MarketingTacticTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_marketingtactictemplate.htm)** Represents a repeatable template used to replicate successful marketing tactics across teams. This object is available in API version 68.0 and later. - **[MatchingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_matchingrule.htm)** Represents a matching rule that is used to identify duplicate records. This object is available in API version 33.0 and later. - **[MatchingRuleItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_matchingruleitem.htm)** Represents criteria used by a matching rule to identify duplicate records. This object is available in API version 33.0 and later. - **[MerchAccPaymentMethodSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_merchaccpaymentmethodset.htm)** Defines an ordered list of payment methods that are available to a merchant's cudstomer during checkout. You can configure multiple payment method sets, each designated for a specific locale, payment region, or sale channel. This object is available in API version 58.0 and later. - **[MerchAccPaymentMethodType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_merchaccpaymentmethodtype.htm)** Refers to a payment method that is in a payment method set, which is defined by the MerchAccPaymentMethodSet object. This object is available in API version 58.0 and later. - **[MerchantAccount](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_merchantaccount.htm)** A type of bank account that lets a merchant accept payments from a variety of payment methods, including credit or debit cards, or digital wallets. A Salesforce Payments merchant account is linked to an underlying payment gateway to process payments This object is available in API version 56.0 and later. - **[MerchantAccountEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_merchantaccountevent.htm)** Represents a merchant account platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later. - **[MessagingChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingchannel.htm)** Represents a communication channel that an end user can use to send a message to an agent. A communication channel can be an SMS number, a Facebook page, or another supported messaging channel. This object is available in API version 40.0 and later. - **[MessagingChannelSkill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingchannelskill.htm)** Junction object that represents an association between MessagingChannel and Skill. This object is available in API version 45.0 and later. - **[MessagingChannelUsage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingchannelusage.htm)** Represents the status of an enhanced Messaging channel or of an application in a Unified Messaging channel. This object is available in API version 60.0 and later. - **[MessagingConfiguration](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingconfiguration.htm)** Represents the details for a Messaging configuration. This object is available in API version 47.0 and later. - **[MessagingDeliveryError](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingdeliveryerror.htm)** Represents a log of triggered outbound failures to verify when a triggered outbound has failed. This object is available in API version 44.0 and later. - **[MessagingEndUser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingenduser.htm)** Represents a single address—such as a phone number or Facebook page—communicating with a single Messaging channel. This object is available in API version 40.0 and later. - **[MessagingLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messaginglink.htm)** Represents the link between a Messaging Channel and where it's shared. This object is available in API version 47.0 and later. - **[MessagingSession](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingsession.htm)** Represents a session on a Messaging channel. This object is available in API version 47.0 and later. - **[MessagingSessionMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingsessionmetrics.htm)** Represents a metric gathered about a specific enhanced messaging session, such as average agent response time. This object is available starting in October 2024 in API version 62.0 and later. - **[MessagingTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_messagingtemplate.htm)** Represents a Messaging template used to send pre-formatted messages. This object is available in API version 47.0 and later. - **[MetadataApiOpEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_metadataapiopeventlog.htm)** MetadataApiOpEventLog stores details of Metadata API retrieval and deployment requests. This object is available in API version 62.0 and later. - **[MetadataPackage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_metadatapackage.htm)** Represents a package that has been developed in the org you’re logged in to. Applies to unlocked, unmanaged, first-generation, and second-generation managed packages. - **[MetadataPackageVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_metadatapackageversion.htm)** Represents a package version (managed or unmanaged) that has been uploaded from the org you’re logged in to. - **[Metric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_metric.htm)** The Metric object represents the components of a goal metric such as its name, metric type, and current value. - **[MetricDataLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_metricdatalink.htm)** The link between the metric and the data source, such as a report. - **[MigratedEmail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_migratedemail.htm)** For internal use only. - **[MilestoneType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_milestonetype.htm)** Represents a milestone (required step in a customer support process). This object is available in API version 18.0 and later. - **[MktJourneyDcsnSetup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mktjourneydcsnsetup.htm)** Represents a collection of Marketing Cloud Engagement journeys that you can interact with by using Salesforce Flow in Marketing Cloud. This object is available in API version 65.0 and later. - **[MLField](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mlfield.htm)** Represents a single field in a data definition. This object is available in API version 50.0 and later. - **[MlIntentUtteranceSuggestion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mlintentutterancesuggestion.htm)** Represents a customer input, used for training purposes in the feedback loop process of a conversation. Admins can add these inputs to the intent training model. This object is available in API version 51.0 and later. - **[MLPredictionDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mlpredictiondefinition.htm)** Represents a prediction definition that specifies details about the prediction. This object is available in API version 50.0 and later. - **[MLModel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mlmodel.htm)** Represents an AI model that can be used in Einstein Prediction Builder, Einstein Recommendation Builder, and other Einstein features. This object is available in API version 53.0 and later. - **[MLModelFactor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mlmodelfactor.htm)** Represents a field value that has a positive or negative effect on the model’s score. This object is available in API version 53.0 and later. - **[MLModelFactorComponent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mlmodelfactorcomponent.htm)** Represents information about the related MLModelFactor. For example, this object can represent a field value or a field range such as “Title = CEO” or “Annual Revenue >10000000”. This object is available in API version 53.0 and later. - **[MLModelMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mlmodelmetric.htm)** Represents a metric or statistic about the related model, such as accuracy, precision, or RSquared. Use a model’s metrics to learn about its performance and to compare it with other models. This object is available in API version 53.0 and later. - **[MLRecommendationDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mlrecommendationdefinition.htm)** For internal use only. - **[MobileDeviceAppRegistration](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mobiledeviceappregistration.htm)** Represents the details provided in a mobile device registration event from an app that uses the Engagement Mobile SDK. This object is available in API version 65.0 and later. - **[MobileSecurityAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mobilesecurityassignment.htm)** Represents the assignment of mobile security policies to a profile. The policies apply to the Salesforce mobile app with Enhanced Mobile App Security enabled. This object is available in API version 54.0 and later. - **[MobileSecurityPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mobilesecuritypolicy.htm)** Enables mobile security policies on the Salesforce mobile app with Enhanced Mobile Security. This object is available in API version 50.0 and later. - **[MobileSecurityUserMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mobilesecurityusermetric.htm)** Represents the metrics for users who have Enhanced Mobile Security policies enforced. This object is available in API version 51.0 and later. - **[MobileSettingsAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mobilesettingsassignment.htm)** Represents the assignment of a particular field service mobile settings configuration to a user profile. This object is available in API version 41.0 and later. - **[MobSecurityCertPinConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mobsecuritycertpinconfig.htm)** Configuration of mobile security certificate pinning on the Salesforce mobile app with Enhanced Mobile Security. This object is available in API version 53.0 and later. - **[MobSecurityCertPinEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mobsecuritycertpinevent.htm)** The event of mobile security certificate pinning on the Salesforce mobile app with Enhanced Mobile Security. This object is available in API version 53.0 and later. - **[MsgChannelAvailability](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_msgchannelavailability.htm)** Represents the availability of a Messaging channel for a specific country. This object is available in API version 67.0 and later. - **[MsgChannelLanguageKeyword](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_msgchannellanguagekeyword.htm)** Represents the consent configuration for a Messaging channel. This object is available in API version 48.0 and later. - **[MsgChannelUsageExternalOrg](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_msgchannelusageexternalorg.htm)** Represents the Enterprise ID (EID) and Business Unit (MID) for Marketing Cloud connections in a Unified Messaging channel. This object is available in API version 60.0 and later. - **[MyDomainDiscoverableLogin](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mydomaindiscoverablelogin.htm)** Represents configuration settings when the My Domain login page type is Discovery. Login Discovery provides an identity-first login experience, where the login page contains the identifier field only. Based on the identifier entered, a handler determines how to authenticate the user. This object is available in API version 45.0 and later. - **[MutingPermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_mutingpermissionset.htm)** Represents a set of disabled permissions and is used in conjunction with PermissionSetGroup. This object is available in API version 46.0 and later. - **[Name](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_name.htm)** Non-queryable object that provides information about foreign key traversals when the foreign key has more than one parent. - **[NamedCredential](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_namedcredential.htm)** Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts. This object is available in API version 33.0 and later. - **[NamedCredentialEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_namedcredentialeventlog.htm)** The Named Credential event type captures information about Apex callouts that use named credentials as their endpoints. Use this event type to audit the installed managed packages that use named credentials. If you don’t recognize the package namespace in the named credential event log file, then you can investigate whether a security breach has occurred. This object is available in API version 65.0 and later. - **[NamespaceRegistry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_namespaceregistry.htm)** Represents a namespace that you can link to scratch orgs that were created from your org’s Dev Hub. You use the namespace when developing, packaging, and releasing an app. You can’t create this object with the API. Use the **Link Namespace** action in the Dev Hub graphical interface to insert a NamespaceRegistry record. This object is available in API version 41.0 and later. - **[NavigationLinkSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_navigationlinkset.htm)** Represents the navigation menu in an Experience Cloud site. A navigation menu consists of items that users can click to go to other parts of the site. This object is available in API version 35.0 and later. - **[NavigationMenuItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_navigationmenuitem.htm)** Represents a single menu item in a NavigationLinkSet. Use this object to create, delete, or update menu items in your Experience Cloud site’s navigation menu. This object is available in API version 35.0 and later. - **[NavigationMenuItemLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_navigationmenuitemlocalization.htm)** Represents the translated value of a navigation menu item in an Experience Cloud site. This object is available in API version 36.0 and later. - **[Network](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_network.htm)** Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. Experience Cloud sites let you share information, records, and files with coworkers and stakeholders all in one place. This object is available in API version 26.0 and later. - **[NetworkActivityAudit](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkactivityaudit.htm)** Represents an audit trail of moderation actions in Experience Cloud sites. This object is available in API version 30.0 and later. - **[NetworkAffinity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkaffinity.htm)** Represents a junction object that associates a user profile with a Network object, that is, with an Experience Cloud site. Use NetworkAffinity to assign a default Experience Cloud site to a user profile. This object is available in API version 41.0 and later. - **[NetworkAuthApiSettings](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkauthapisettings.htm)** Represents the settings that control enablement, access, and security for the Headless Registration Flow, Headless Forgot Password Flow, Headless Passwordless Login Flow, and their associated APIs. This object is available in API version 58.0 and later. - **[NetworkDataCategory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkdatacategory.htm)** Represents data categories in Lightning Web Runtime (LWR) Experience Cloud Sites. This object is available in API version 59.0 and later. - **[NetworkDiscoverableLogin](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkdiscoverablelogin.htm)** Represents the Login Discoverable page from where customers and partners log in to an Experience Cloud site. Customers and partners are users with an External Identity license or any communities license for Experience Cloud. This object is available in API version 44.0 and later. - **[NetworkEmailTmplAllowlist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkemailtmplallowlist.htm)** Represents an allowlist for the one-time password (OTP) email templates that are sent to end users during the Headless Registration Flow, the Headless Passwordless Login Flow, and the Headless Forgot Password Flow. This object is available in API version 60.0 and later. - **[NetworkFeedResponseMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkfeedresponsemetric.htm)** Represents an object that stores the date and time values of question posts. It captures information for question creation, answer creation, and when an answer is marked as best answer This object is available in API version 51.0 and later. - **[NetworkMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkmember.htm)** Represents a member of an Experience Cloud site. Members can be either users in your company or external users with portal profiles. This object is available in API version 26.0 and later. - **[NetworkMemberGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkmembergroup.htm)** Represents a group of members in an Experience Cloud site. Members can be either users in your internal org or external users assigned portal profiles. An administrator adds members to an Experience Cloud site by adding a profile or a permission set, and any user with the profile or permission set becomes a member of the site. This object is available in API version 26.0 and later. - **[NetworkModeration](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkmoderation.htm)** Represents a flag on an item in a community. This object is available in API version 30.0 and later. - **[NetworkPageOverride](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkpageoverride.htm)** Represents information about custom pages used to override the default pages in Experience Cloud sites. You can create Experience Builder or Visualforce pages and override the default pages in a site. Using custom pages allows you to create a more personalized experience for your users. This object is available in API version 34.0 and later. - **[NetworkSelfRegistration](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkselfregistration.htm)** Represents the account that self-registering Experience Cloud users are associated with by default. Self-registering users in an Experience Cloud site are required to be associated with an account, which the admin must specify while setting up self-registration for the site. If an account isn’t specified, Salesforce creates person accounts (when enabled) for self-registering users. This object is available in API version 34.0 and later. - **[NetworkUserHistoryRecent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_networkuserhistoryrecent.htm)** Represents an Experience Cloud site user’s history of accessed records. This object is available in API version 42.0 and later. - **[Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_note.htm)** Represents a note, which is text associated with a custom object or a standard object, such as a Contact, Contract, or Opportunity. - **[NoteAndAttachment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_noteandattachment.htm)** This read-only object contains all notes and attachments associated with an object. - **[NoteTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_notetag.htm)** Associates a word or short phrase with a Note. - **[OauthCustomScope](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_oauthcustomscope.htm)** Represents a permission defining the protected data that a connected app can access from an external entity when Salesforce is the OAuth authorization provider. - **[OauthCustomScopeApp](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_oauthcustomscopeapp.htm)** Represents the name of the connected app to which the custom scope is assigned. This object is available in API version 49.0 and later. - **[OauthToken](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_oauthtoken.htm)** Represents an OAuth access token for connected app authentication. Use this object to create a user interface for token management. This object is available in API version 32.0 and later. - **[OauthTokenExchangeHandler](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_oauthtokenexchangehandler.htm)** Represents a token exchange handler. The token exchange handler also consists of an Apex class. During the OAuth 2.0 token exchange flow, the token exchange handler is used to validate tokens from an external identity provider and to map users to Salesforce. This object is available in API version 60.0 and later. - **[OauthTokenExchHandlerApp](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_oauthtokenexchhandlerapp.htm)** Represents the enablement settings for a specific Salesforce connected app or external client app that’s enabled for the token exchange handler. A handler can be enabled for multiple apps. This object is available in API version 60.0 and later. - **[ObjectDataImport](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectdataimport.htm)** Represents the data import status of one or more object records. This object is available in API version 57.0 and later. - **[ObjectDataImportReference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectdataimportreference.htm)** Represents the relationships to the associated reference objects showing the source from which the data is imported. This object is available in API version 57.0 and later. - **[ObjectMetadataTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectmetadatatag.htm)** Represents a meta tag for a store page. Meta tags in HTML documents provide structured data used by search engines for ranking and to show content in search results. This object is available in API version 60.0 and later. - **[ObjectPermissions](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectpermissions.htm)** Represents the enabled object permissions for the parent PermissionSet. This object is available in API version 24.0 and later. - **[ObjectRelatedUrl](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectrelatedurl.htm)** Represents a URL slug for a Product or Category page on a B2B Commerce or D2C Commerce LWR site, or a custom object, account, or contact page on an enhanced LWR Experience Cloud site. This object is available in API version 57.0 and later. - **[ObjectTerritory2AssignmentRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectterritory2assignmentrule.htm)** Represents a territory assignment rule that’s associated with an object, such as Account. ObjectTerritory2AssignmentRuleItem can be created or deleted if the BooleanFilter field on its corresponding ObjectTerritory2AssignmentRule is null. Available if Sales Territories has been enabled. - **[ObjectTerritory2AssignmentRuleItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectterritory2assignmentruleitem.htm)** A single row of selection criteria for an ObjectTerritory2AssignmentRule object. ObjectTerritory2AssignmentRuleItem can only be created or deleted if the BooleanFilter field on its corresponding ObjectTerritory2AssignmentRule object is a null value. Available if Sales Territories has been enabled. - **[ObjectTerritory2Association](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectterritory2association.htm)** Represents an association (by assignment) between a territory and an object record such as an account or a lead. - **[ObjectUserTerritory2View](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_objectuserterritory2view.htm)** Represents a user and object, such as an account or lead, assigned to a territory. This object is available in API version 58.0 and later. - **[OmniSupervisorConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_omnisupervisorconfig.htm)** Represents the Command Center for Service configuration for an assigned group of supervisors. This object is available in API version 41.0 and later. - **[OmniSupervisorConfigAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_omnisupervisorconfigaction.htm)** Represents the actions available to the supervisors of a Command Center for Service configuration. This object is available in API version 56.0 and later. - **[OmniSupervisorConfigGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_omnisupervisorconfiggroup.htm)** Represents the group of reps who are visible to the supervisors of a Command Center for Service configuration. The group, if visible, appears in the Agents tab of Command Center for Service. This object is available in API version 41.0 and later. - **[OmniSupervisorConfigProfile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_omnisupervisorconfigprofile.htm)** Represents the supervisor profiles to which a Command Center for Service configuration applies. User-level configurations override profile-level configurations. This object is available in API version 41.0 and later. - **[OmniSupervisorConfigQueue](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_omnisupervisorconfigqueue.htm)** Represents the queues that are visible to the supervisors of a Command Center for Service configuration. The queue, if visible, appears in the Queues Backlog and Assigned Work tabs of Command Center for Service. This object is available in API version 53.0 and later. - **[OmniSupervisorConfigSkill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_omnisupervisorconfigskill.htm)** Represents the skills that are visible to the supervisors of a Command Center for Service configuration. These skills, if visible, appear in the Skills Backlog tab of Command Center for Service. This object is available in API version 53.0 and later. - **[OmniSupervisorConfigTab](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_omnisupervisorconfigtab.htm)** Represents the visible tabs specified in a Command Center for Service configuration. This object is available in API version 60.0 and later. - **[OmniSupervisorConfigUser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_omnisupervisorconfiguser.htm)** Represents the users to whom a Command Center for Service configuration applies. User-level configurations override profile-level configurations. This object is available in API version 41.0 and later. - **[OpenActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_openactivity.htm)** This read-only object is displayed in a related list of open activities—future events and open tasks—related to an object. It includes activities for all contacts related to the object. OpenActivity fields for phone calls are only available if your organization uses Salesforce CRM Call Center. - **[OperatingHours](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_operatinghours.htm)** Represents the hours in which a service territory, service resource, or account is available for work. OperatingHours is used by Field Service, Salesforce Scheduler, Salesforce Meetings, Sales Engagement, and Workforce Engagement. This object is available in API version 38.0 and later. - **[OperatingHoursHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_operatinghourshistory.htm)** Represents the history of changes made to tracked fields on an operating hours record. This object is available in API version 38.0 and later. - **[OperatingHoursHoliday](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_operatinghoursholiday.htm)** Represents the day or hours for which a service territory and service resources exclusive to the service territory are unavailable in Field Service, Salesforce Scheduler, Salesforce Meetings, Sales Engagement, or Workforce Engagement. This object is available in API version 54.0 and later. - **[Opportunity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm)** Represents an opportunity, which is a sale or pending deal. - **[OpportunityCompetitor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitycompetitor.htm)** Represents a competitor on an Opportunity. - **[OpportunityContactRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitycontactrole.htm)** Represents the role that a Contact plays on an Opportunity. - **[OpportunityContactRoleSuggestionInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitycontactrolesuggestioninsight.htm)** Represents a suggestion for a new opportunity contact role. Available in API versions 45.0 and later. - **[OpportunityFieldHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityfieldhistory.htm)** Represents the history of changes to the values in the fields of an opportunity. This object is available in versions 13.0 and later. - **[OpportunityHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityhistory.htm)** Represents the stage history of an opportunity. - **[OpportunityInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityinsight.htm)** Represents an individual insight (deal prediction, follow-up reminder, or key moment) related to an opportunity record. - **[OpportunityLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitylineitem.htm)** Represents an opportunity line item, which is a member of the list of Product2 products associated with an Opportunity. - **[OpportunityLineItemSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitylineitemschedule.htm)** Represents information about the quantity, revenue distribution, and delivery dates for a particular OpportunityLineItem. - **[OpportunityLineItemSplit](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitylineitemsplit.htm)** Represents information about an opportunity product split, including percentages, amounts, and owner. This object is available in API version 58.0 and later. - **[OpportunityOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityownersharingrule.htm)** Represents a rule for sharing an opportunity with users other than the owner. - **[OpportunityPartner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitypartner.htm)** This object represents a partner relationship between an Account and an Opportunity. An OpportunityPartner record is created automatically when a Partner record is created for a partner relationship between an account and an opportunity. - **[OpportunityRelatedDeleteLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityrelateddeletelog.htm)** Represents an audit log of the deletion of opportunity-related child records, such as opportunity team members, product splits, or opportunity splits. This object is available in API version 59.0 and later. - **[OpportunityShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityshare.htm)** Represents a sharing entry on an Opportunity. - **[OpportunitySplit](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitysplit.htm)** OpportunitySplit credits one or more opportunity team members with a portion of the opportunity amount. This object is available in API version 16.0 and later for pilot customers, and version 28.0 and later for others. - **[OpportunitySplitType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitysplittype.htm)** OpportunitySplitType provides unique labels and behavior for each split type. This object is available in API version 28.0 and later. - **[OpportunityStage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitystage.htm)** Represents the stage of an Opportunity in the sales pipeline, such as New Lead, Negotiating, Pending, Closed, and so on. - **[OpportunityTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitytag.htm)** Associates a word or short phrase with an Opportunity. - **[OpportunityTeamMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityteammember.htm)** Represents a User on the opportunity team of an Opportunity. - **[OppSalesMethodology](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_oppsalesmethodology.htm)** Represents the sales methodology record attached to an opportunity. This object is available in API version 67.0 and later. - **[OppSalesMethodologyItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_oppsalesmethodologyitem.htm)** Represents the scored criteria for an opportunity's associated sales methodology. This object is available in API version 67.0 and later. - **[OpptyLineItemSplitType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opptylineitemsplittype.htm)** Represents an opportunity product split type. This object is available in API version 58.0 and later. - **[Order](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_order.htm)** Represents an order associated with a contract or an account. - **[OrderAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderaction.htm)** Indicates the type of order, such as a new sale or a cancellation. This object is available in API version 55.0 and later. - **[OrderAdjustmentGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderadjustmentgroup.htm)** Group containing a set of adjustments applied to an order. This object is available in API version 48.0 and later. - **[OrderAdjustmentGroupSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderadjustmentgroupsummary.htm)** Represents the current properties and state of a group of related price adjustments. Associated with a set of OrderItemAdjustmentLineSummaries that apply to OrderItemSummaries belonging to one OrderSummary. Corresponds to one or more order adjustment group objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. - **[OrderChangeLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderchangelog.htm)** Represents a log record of all change requests made to an order post activation. A log record is always one-to-one to change an order request. This object is available in API version 48.0 and later. - **[OrderChgReasonCategMap](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderchgreasoncategmap.htm)** The mapping between an order change reason and a service flow category. This object is available in API version 65.0 and later. - **[OrderDeliveryGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderdeliverygroup.htm)** A group of order items that share a delivery method and address. The delivery method and address are used during the fulfillment process, such as shipping as a gift, downloading, picking up in store, or shipping to a standard address This object is available in API version 48.0 and later. - **[OrderDeliveryGroupSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderdeliverygroupsummary.htm)** Represents the current properties and state of a group of OrderItemSummaries, belonging to one OrderSummary, to be fulfilled using the same delivery method and delivered to the same address. A single shipment can include them all, but that isn’t guaranteed. Corresponds to one or more order delivery group objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. - **[OrderDeliveryMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderdeliverymethod.htm)** Shows the customizations and options that a buyer selected for their delivery method. This object is available in API version 48.0 and later. - **[OrderHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderhistory.htm)** Represents historical information about changes that have been made to the standard fields of the associated order, or to any custom fields with history tracking enabled. - **[OrderItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitem.htm)** Represents an order product that your organization sells. - **[OrderItemAdjustmentLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemadjustmentlineitem.htm)** An adjustment that has been made to an order item. This object is available in API version 48.0 and later. - **[OrderItemAdjustmentLineSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemadjustmentlinesummary.htm)** Represents the current properties and state of price adjustments on an OrderItemSummary. Corresponds to one or more order item adjustment line item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. - **[OrderItemGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemgroup.htm)** Stores the group information for line items in an order. It also stores the aggregated line field information (subtotal). It contains a parent-child relationship to order. This object is available in API version 62.0 and later. - **[OrderItemRecipient](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemrecipient.htm)** Represents a site, employee, or other entity for which services are being ordered. This includes essential details such as the recipient's name, contact information, and the specific site or location where the services will be provided. This object is available in API version 62.0 and later. - **[OrderItemRelationship](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemrelationship.htm)** Describes a relationship between order products. This object is available in API version 58.0 and later. - **[OrderItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm)** Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. - **[OrderItemSummaryChange](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummarychange.htm)** Represents a change to an OrderItemSummary, usually a reduction in quantity due to a cancel or return. Corresponds to a change order item. This object is available in API version 48.0 and later. - **[OrderItemSummaryRelationship](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummaryrelationship.htm)** Junction object used to track how an original order summary (created before any exchanges have occurred) relates to other order summary objects in a chain of exchange orders. This object is available in API version 60.0 and later. An exchange order is an OrderSummary object whose SourceProcess property is set to Exchange. An original order summary can have an exchange order, which in turn can have yet another exchange order, and so on. The OrderSummaryRelationship object maintains this relationship between OrderSummary objects. - **[OrderItemTaxLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemtaxlineitem.htm)** The tax amount that has been applied to an order item. This object is available in API version 48.0 and later. - **[OrderItemTaxLineItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemtaxlineitemsummary.htm)** Represents the current tax on an OrderItemSummary or OrderItemAdjustmentLineSummary. Corresponds to one or more order item tax line items, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. - **[OrderItemType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemtype.htm)** Shows whether the order product is a product line or charge line. This object is available in API version 48.0 and later. - **[OrderOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderownersharingrule.htm)** Represents a rule which determines order sharing access for the order’s owners. - **[OrderPaymentSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderpaymentsummary.htm)** Represents the current properties and state of payments using a single payment method that are applied to one OrderSummary. This object is available in API version 48.0 and later. - **[OrderPaymentSummaryReference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderpaymentsummaryreference.htm)** OrderPaymentSummaryReference is a junction object that allows an order payment summary to be shared with another order summary. This object is available in API version 60.0 and later. - **[OrderShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordershare.htm)** Represents a sharing entry on an Order. This object is available in API version 48.0 and later. - **[OrderStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderstatus.htm)** Represents the status of the order entity. This object is available in API version 48.0 and later. - **[OrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm)** Represents the current properties and state of an order. Corresponds to one or more order objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. - **[OrderSummaryAdditionalInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummaryadditionalinfo.htm)** Stores information related to OrderSummary including context around the order, such as inventory reservation details, order origination, and other values that Einstein uses to perform order analysis. Only reservation details can be stored in this object. This object is available in API version 58.0 and later. - **[OrderSummaryRelationship](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummaryrelationship.htm)** Junction object used to track how an original order summary (created before any exchanges have occurred) relates to other order summary objects in a chain of exchange orders. This object is available in API version 60.0 and later. - **[OrderSummaryRoutingSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummaryroutingschedule.htm)** Represents an attempt to route an order summary to one or more inventory locations for fulfillment. You can use it to schedule future attempts and to record completed attempts. This object is available in API version 51.0 and later. - **[Organization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_organization.htm)** Represents key configuration information for an organization. - **[OrgDeleteRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgdeleterequest.htm)** Represents a request to delete a developer edition (DE) org. This object is available in API version 42.0 and later. It is available only in Developer and Database.com editions. - **[OrgEmailAddressSecurity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgemailaddresssecurity.htm)** Defines the assignment of a user profile to an org-wide email address. This object is available in API version 58.0 and later. - **[OrgMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgmetric.htm)** Represents a feature or metric that Salesforce Optimizer evaluates. This object is available in API version 47.0 and later. - **[OrgMetricScanResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgmetricscanresult.htm)** Represents data or an item associated with a feature’s results in a Salesforce Optimizer evaluation. For example, for the Custom Field Limit feature, an OrgMetricScanResult object represents an object flagged for approaching the custom field limit. This object is available in API version 47.0 and later. - **[OrgMetricScanSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgmetricscansummary.htm)** Represents the results summary for a specific feature in a Salesforce Optimizer evaluation. This object is available in API version 47.0 and later. - **[OrgSnapshot](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgsnapshot.htm)** Represents a snapshot of a scratch org. Snapshots capture the state of a scratch org so that you can use it to quickly spin up new scratch orgs using its configuration. This object is available in API version 61.0 and later. - **[OrgWideEmailAddress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgwideemailaddress.htm)** Represents an organization-wide email address for user profiles. - **[OSAsyncChgCompletedEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_osasyncchgcompletedevent.htm)** An event that allows the processing of the credit memo, invoices, and other entities after a bulk action has successfully completed. The event provides all of the values that would exist on the synchronous APIs. This object is available in API version 63.0 and later. - **[OutOfOffice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_outofoffice.htm)** Represents a user-set value on a profile that shows when the user intends to be out of the office. This object is available in API version 41.0 and later. - **[OutgoingEmail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_outgoingemail.htm)** For internal use only. - **[OutgoingEmailRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_outgoingemailrelation.htm)** For internal use only. - **[OwnedContentDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ownedcontentdocument.htm)** Represents a file owned by a user. This object is available in version 30.0 and later. - **[OwnerChangeOptionInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ownerchangeoptioninfo.htm)** Represents default and optional actions that can be performed when a record’s owner is changed. Available in API version 35.0 and later, but to query for change owner metadata, use the OwnerChangeOptionInfo object in Tooling API instead. For more information, see [OwnerChangeOptionInfo](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_ownerchangeoptioninfo.htm) in the Tooling API. - **[PackageInstallEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_packageinstalleventlog.htm)** PackageInstallEventLog stores details about package installation in the organization. This object is available in API version 62.0 and later. - **[PackageLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_packagelicense.htm)** Represents a license for an installed managed package. This object is available in API version 31.0 and later. - **[PackagePushError](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_packagepusherror.htm)** Represents an error encountered during a push request. The number of PackagePushError records created depends on the number of push jobs in the request that result in an error. - **[PackagePushJob](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_packagepushjob.htm)** Represents an individual push job for upgrading a package in an org from one version to another version. There can be multiple push jobs created for one push request. For example, if you want to upgrade five orgs as part of one push, you have one PackagePushRequest record and five PackagePushJob records. - **[PackagePushRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_packagepushrequest.htm)** Represents the push request for upgrading a package in one or many orgs from one version to another version. - **[PackageSubscriber](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_packagesubscriber.htm)** Represents an installation of a package in an org. This object contains installation information for managed or unlocked packages developed in the org you’re logged in to. - **[Participant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_participant.htm)** Represents a participant in a ConversationParticipant. An existing or new Participant is referenced each time a new ConversationParticipant is created. This object is available in API version 57.0 and later. - **[Partner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partner.htm)** Represents a partner relationship between two Account records or between an Opportunity record and an Account record. - **[PartnerFundAllocation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnerfundallocation.htm)** Represents allocated funds from a partner marketing budget for channel partners. This object is available in API version 41.0 and later. - **[PartnerFundClaim](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnerfundclaim.htm)** Represents a claim of funds from the partner marketing budget by a channel partner. This object is available in API version 41.0 and later. - **[PartnerFundRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnerfundrequest.htm)** Represents a request for funds from the partner marketing budget by a channel partner. This object is available in API version 41.0 and later. - **[PartnerMarketingBudget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnermarketingbudget.htm)** Represents a budget that provides funds to channel partners for selling and marketing products and services. This object is available in API version 41.0 and later. - **[PartnerNetworkConnection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnernetworkconnection.htm)** Represents a Salesforce to Salesforce connection between Salesforce organizations. - **[PartnerNetworkRecordConnection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnernetworkrecordconnection.htm)** Represents a record shared between Salesforce organizations using Salesforce to Salesforce. - **[PartnerNetworkSyncLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnernetworksynclog.htm)** Represents the Org Sync Log tab in Salesforce, where Salesforce administrators can track the replication of record inserts and updates being performed in Organization Sync. The Connection Detail page for the replication connection also displays the Org Sync Log’s twenty most recent entries, and provides a link to the log. - **[PartnerRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partnerrole.htm)** Represents a role for an account Partner, such as consultant, supplier, and so on. - **[PartyConsent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_partyconsent.htm)** Represents consent preferences for an individual. This object is available in API version 48.0 and later. - **[Payment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_payment.htm)** Represents a single event when a shopper makes a payment. For credit cards, this event is a payment capture or payment sale, but it doesn't appear on the shopper's credit card statement. This object is available in API version 48.0 and later. - **[PaymentAuthAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentauthadjustment.htm)** Shows information about an adjustment made to an authorized transaction. This object is available in API version 51.0 and later. - **[PaymentAuthorization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentauthorization.htm)** Represents a single payment authorization event where users can capture or reverse a payment against a reserve of funds. This object is available in API version 48.0 and later. - **[PaymentCredit](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentcredit.htm)** Tracks the amount of money returned to the customer. The return can be a store credit, a gift card, or another type of credit. It's linked to the original payment record and includes the total credit amount issued. This object is available in API version 65.0 and later. - **[PaymentCreditLinePayment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentcreditlinepayment.htm)** A payment credit line payment. This object is available in API version 65.0 and later. - **[PaymentCreditTransaction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentcredittransaction.htm)** A payment credit transaction. This object is available in API version 65.0 and later. - **[PaymentGateway](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentgateway.htm)** Platform object that represents the connection to an external payment gateway. This object is available in API version 48.0 and later. - **[PaymentGatewayLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentgatewaylog.htm)** Stores information exchanged between the Salesforce payments platform and external payment gateways. Gateway logs can also record payloads from external payment entities. This object is available in API version 48.0 and later. - **[PaymentGatewayProvider](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentgatewayprovider.htm)** Setup entity for payment gateways. Defines the connection to a payment gateway Apex adapter. This object is available in API version 48.0 and later. - **[PaymentGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentgroup.htm)** Top-level object that groups all payment transactions that are processed for an order or invoice. PaymentGroup is a standalone object, so it isn’t required for users to execute payment transactions (authorizations, captures, refunds, and sales). This object is available in API version 48.0 and later. - **[PaymentInitiationSource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentinitiationsource.htm)** Represents the originating source of a payment. This information helps other Salesforce products integrate with Salesforce Payments. This object is available in API version 63.0 and later. - **[PaymentIntent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentintent.htm)** Represents data temporarily stored during a transaction’s lifecycle that can identify the buyer, the merchant, and the amount the buyer is sending to the merchant. Data such as timestamp and amount returned can also be stored in PaymentIntent. This object is available in API version 58.0 and later. - **[PaymentIntentEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentintentevent.htm)** Represents a payment intent platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later. - **[PaymentLineInvoice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentlineinvoice.htm)** Represents a payment allocated to or unallocated from an invoice. This object is available in API version 48.0 and later. - **[PaymentLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentlink.htm)** A link that a merchant can share with customers to collect payments for products and services. The payment link, which you can embed into a Salesforce app or send directly to a customer, directs the customer to a Pay Now payment page. The page can show a total amount owed or an itemized list or products, shipping and tax charges, and a total amount owed. The customer enters their contact and payment details, and submits their payment. The amounts are shown in the store's currency. This object is available in API version 58.0 and later. - **[PaymentLinkEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentlinkevent.htm)** Represents a payment link platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later. - **[PaymentMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentmethod.htm)** Represents the method that a buyer uses to compensate the seller of a good or service. Common payment methods include cash, checks, credit or debit cards, money orders, bank transfers, and online payment services. This object is available in API version 48.0 and later. - **[PymtSchdDistributionMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pymtschddistributionmethod.htm)** Indicates how the total payment is divided into partial payments. This object is available in API version 56.0 and later. - **[PaymentScheduleTreatmentDtl](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentscheduletreatmentdtl.htm)** Contains configuration information for the payment schedule treatment detail. This object is available in API version 56.0 and later. - **[PaymentTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentterm.htm)** Defines your company's method and expectations for receiving payment. This object is available in API version 55.0 and later. - **[PaymentTermItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymenttermitem.htm)** Defines the attributes of a payment term that your company uses. The PaymentTermItem is used to determine the due date on invoices. This object is available in API version 55.0 and later. - **[PaymentSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentschedule.htm)** The payment schedule represents a collection of payments that a customer wants to collect at different times for a certain record. A schedule contains one or more payment schedule items, where each item represents one payment to be processed. Each of a schedule’s items can have different payment configuration fields, such as payment methods, payment dates, and payment accounts. When a payment scheduler launches a payment run, the run evaluates active payment schedule items, and picks them up for payment processing if they align with the scheduler’s payment criteria. This object is available in API version 55.0 and later. - **[PaymentScheduleItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentscheduleitem.htm)** A payment schedule contains one or more payment schedule items, where each item represents one payment to be processed. Each of a schedule’s items can have different payment configuration fields, such as payment methods, payment dates, and payment accounts. When a payment scheduler launches a payment run, the run evaluates active payment schedule items, and picks them up for payment processing if they align with the scheduler’s payment criteria. This object is available in API version 55.0 and later. - **[PaymentSchedulePolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentschedulepolicy.htm)** Contains configuration information for the payment schedule policy. This object is available in API version 56.0 and later. - **[PaymentScheduleTreatment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentscheduletreatment.htm)** Contains configuration information for the payment schedule. This object is available in API version 56.0 and later. - **[PendingOrderSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pendingordersummary.htm)** Object representing a B2C Commerce order ingested via High Scale Orders before an OrderSummary is created for it. Optimized for online transaction processing (OLTP). This object is available in API version 55.0 and later. - **[PendingServiceRouting](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pendingservicerouting.htm)** Represents the routing details of a work item that’s waiting to be routed or assigned. This object is available in API version 40.0 and later. - **[PendingServiceRoutingInteractionInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pendingserviceroutinginteractioninfo.htm)** Represents PendingServiceRouting interaction information that’s used when work is routed to an agent. For a screen pop, it specifies which records to open when work is routed to an agent from a specific channel. PendingServiceRoutingInteractionInfo is read-only. This object is available in API version 53.0 and later. - **[Period](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_period.htm)** Represents a fiscal period defined in FiscalYearSettings. - **[PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm)** Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later. - **[PermissionSetAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetassignment.htm)** Represents a user’s assignment to a permission set or permission set group. This object is available in API version 22.0 and later. - **[PermissionSetGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetgroup.htm)** Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed. This object is available in API version 45.0 and later. - **[PermissionSetGroupComponent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetgroupcomponent.htm)** A junction object that relates the PermissionSetGroup and PermissionSet objects via their respective IDs; enables permission set group recalculation to determine the aggregated permissions for the group. This object is available in API version 45.0 and later. - **[PermissionSetLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetlicense.htm)** Represents a license that’s used to enable one or more users to receive a specified permission without changing their profile or reassigning profiles. You can use permission set licenses to grant access, but not to deny access. This object is available in API version 29.0 and later. - **[PermissionSetLicenseAssign](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetlicenseassign.htm)** Represents the association between a User and a PermissionSetLicense. This object is available in API version 29.0 and later. - **[PermissionSetLicenseDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetlicensedefinition.htm)** Represents the definition of a custom permission set license, which entitles specified features in a package. This object is available in API version 66.0 and later. - **[PermissionSetTabSetting](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsettabsetting.htm)** Represents a permission set tab setting. Requires the View Setup permission. Use this object to query all tab settings of the permission set. This object is available in API version 45.0 and later. - **[PersnlBatchDecision](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_PersnlBatchDecision.htm)** Represents a batch personalization that delivers personalization decisions (content or recommendations) to a customer segment. Available in API version 64.0 and later. - **[PersonAccountOwnerPowerUser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_personaccountownerpoweruser.htm)** Represents a user who can own more than 50,000 customer or partner portal accounts. Person account owner power users can own a large number of either customer or partner users. Their role can’t be changed and they must be at the root of the role hierarchy. Person account owner power user objects can't be created if deferred sharing is turned on for your org. Person account owner power user objects can be created while deferred sharing is turned off for an org. Deferred sharing can be turned back on after person account owner power user objects have been created. This object is available in API version 57.0 and later. - **[PersonalOrgInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_personalorginfo.htm)** Represents the information for a Tableau Next personal org. This object is available in API version 64.0 and later. - **[PersonalizationDecision](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_PersonalizationDecision.htm)** Represents a set of targeting rules within a personalization point that determine an individual's eligibility to receive personalized content and the content to deliver. Available in API version 62.0 and later. - **[PersonalizationObjective](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_PersonalizationObjective.htm)** Represents a specific business outcome that you want to achieve when creating a recommender. Available in API version 62.0 and later. - **[PersonalizationPoint](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_PersonalizationPoint.htm)** Represents a specific touch point in an experience where a personalization decision can be made. It connects a data space, profile data graph, personalization type, and response template to deliver personalized content at that time in a customer journey. Available in API version 62.0 and later. - **[PersonalizationSchema](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_PersonalizationSchema.htm)** Represents a personalization response template that’s used when you build a personalization decision. Available in API version 62.0 and later. - **[PersonalizationTargetInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_personalizationtargetinfo.htm)** Represents a target for an audience. This object is available in API version 47.0 and later. - **[PermissionUpdateEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionupdateeventlog.htm)** Permission update events represent changes to object, field, and user permissions and setup entity access that occur in profiles and permission sets. The event type also tracks if you clone profiles or change whether session activation is required in permission sets or permission set groups. This object is available in API version 65.0 and later. - **[PersonTraining](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_persontraining.htm)** Represents an assignment of a learning module in Workforce Engagement. This object is available in API version 54.0 and later. - **[PicklistValueInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_picklistvalueinfo.htm)** Represents the active picklist values for a given picklist field. This object is available in API version 40.0 and later. - **[PickTicket](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pickticket.htm)** A PickTicket represents quantities of one or more products to be picked for fulfillment at a location. It can include products belonging to one or more fulfillment orders. This object is available in API version 57.0 and later. - **[PickTicketAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pickticketassignment.htm)** Represents the association of a FulfillmentOrder with a PickTicket. A PickTicket has one PickTicketAssignment for each FulfillmentOrder containing products to be picked as part of that PickTicket. This object is available in API version 57.0 and later. - **[PickTicketProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pickticketproduct.htm)** Represents a quantity of a product to be picked as part of a PickTicket. It can include quantities for multiple FulfillmentOrders. This object is available in API version 57.0 and later. - **[PipelineInspectionListView](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pipelineinspectionlistview.htm)** Represents a pipeline view, an intelligence view, or a saved filter. A pipeline view shows a set of opportunity records, based on specific criteria. An intelligence view shows a set of account, lead, or contact records, based on specific criteria. This object is available in API version 53.0 and later. - **[PipelineInspectionSumField](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pipelineinspectionsumfield.htm)** Use this object to learn which field from the opportunity object is used to aggregate Pipeline Inspection metrics on a pipeline view. This object is available in API version 56.0 and later. - **[PipelineInspMetricConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pipelineinspmetricconfig.htm)** Represents the configuration of a forecast category metric that appears in the Pipeline Inspection view. This object is available in API version 55.0 and later. - **[PipelineInspMetricConfigLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pipelineinspmetricconfiglocalization.htm)** Represents the translated label of a Pipeline Inspection metric. This object is available in API version 55.0 and later. - **[PlatformAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_platformaction.htm)** PlatformAction is a virtual read-only object. It enables you to query for actions displayed in the UI, given a user, a context, device format, and a record ID. Examples include standard and custom buttons, quick actions, and productivity actions. - **[PlatformEventUsageMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_platformeventusagemetric.htm)** Contains usage data for event publishing and delivery to CometD and Pub/Sub API clients, empApi Lightning components, and event relays. If Enhanced Usage Metrics isn't enabled, usage data is available for the last 24 hours, ending at the last hour, and for historical daily usage. In API 58.0 and later, you can enable Enhanced Usage Metrics to get usage data by event name and client for granular time intervals. PlatformEventUsageMetric contains separate usage metrics for platform events and change data capture events. This object is available in API version 50.0 and later. - **[PlatformStatusAlertEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_platformstatusalertevent.htm)** The documentation has moved to [PlatformStatusAlertEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_platformstatusalertevent.htm "HTML (New Window)") in the Platform Events Developer Guide. - **[PortalDelegablePermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_portaldelegablepermissionset.htm)** PortalDelegablePermissionSet is a base platform object used to store permission sets that can be assigned by a delegated portal/external user admin (DPUA) to portal users. This object is available in API version 47.0 and later. - **[PplnInspListViewCalcClmn](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pplninsplistviewcalcclmn.htm)** Represents a column configuration for a pipeline inspection list view. Determines which calculated columns appear in a pipeline or intelligence view and their display order. This object is available in API version 66.0 and later. - **[PresenceConfigDeclineReason](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_presenceconfigdeclinereason.htm)** Represents the settings for a decline reason that a presence user provides when declining work. This object is available in API version 37.0 and later. - **[PresenceDeclineReason](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_presencedeclinereason.htm)** Represents an Omni-Channel decline reason that agents can select when declining work requests. This object is available in API version 37.0 and later. - **[PresenceUserConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_presenceuserconfig.htm)** Represents a configuration that determines a presence user’s settings. This object is available in API version 32.0 and later. - **[PresenceUserConfigProfile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_presenceuserconfigprofile.htm)** Represents a configuration that determines the settings that are assigned to presence users who are assigned to a specific profile. User-level configurations override profile-level configurations. This object is available in API version 32.0 and later. - **[PresenceUserConfigUser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_presenceuserconfiguser.htm)** Represents a configuration that determines the settings that are assigned to a presence user. These user-level configurations override profile-level configurations. This object is available in API version 32.0 and later. - **[PriceAdjustmentGroupShape](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceadjustmentgroupshape.htm)** Defines the business logic for a top-level price adjustment, for example, a discount applied to an entire order. This object is available in API version 57.0 and later. - **[PriceAdjustmentItemShape](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceadjustmentitemshape.htm)** Defines the business logic for an item-level price adjustment, for example, a discount on an order item. This object is available in API version 57.0 and later. - **[PriceAdjustmentSchedule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceadjustmentschedule.htm)** Represents a series of discounts offered depending on your product's configuration, quantity, and when they’re purchased in combination with other products. This object is available in API version 47.0 and later. - **[PriceAdjustmentTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceadjustmenttier.htm)** Represents a discount tier in a price adjustment schedule. This object is available in API version 47.0 and later. - **[Pricebook2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pricebook2.htm)** Represents a price book that contains the list of products that your org sells. - **[Pricebook2History](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pricebook2history.htm)** Represents historical information about changes that have been made to the standard fields of the associated Pricebook2, or to any custom fields with history tracking enabled. This object is available in API version 68.0 and later. - **[PricebookEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pricebookentry.htm)** Represents a product entry (an association between a Pricebook2 and Product2) in a price book. - **[PricebookEntryAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pricebookentryadjustment.htm)** Read-only junction object created when you associate a price adjustment schedule with a price book entry. This object is available in API version 47.0 and later. - **[PriceProtectionExecution](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceprotectionexecution.htm)** Represents an instance of running the price protection process, capturing execution time, status, and the effective date of price changes. This object is available in API version 63.0 and later. - **[PriceProtectExecLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceprotectexeclineitem.htm)** Represents a line item created as part of a Price Protection Execution. This object is available in API version 63.0 and later. - **[PriceProtectionTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_priceprotectionterm.htm)** Represents a configuration record that defines the rules, types, and eligible conditions for price protection. This object is available in API version 63.0 and later. - **[PrivacyHold](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacyhold.htm)** Represents a Privacy Hold that indicates that a record should be preserved from masking or deletion by Data Management policies in Privacy Center. This object is available in API version 59.0 and later. - **[PrivacyHoldReason](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacyholdreason.htm)** Represents the business or legal purpose for why a record has a Privacy Hold. This object is available in API version 59.0 and later. - **[PrivacyJobSession](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacyjobsession.htm)** Represents the status of past, ongoing, and scheduled policy jobs in Privacy Center. This object is available in API version 59.0 and later. - **[PrivacyObjectSession](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacyobjectsession.htm)** Represents the status of each object being processed in past, ongoing, and scheduled policy jobs in Privacy Center. This object is available in API version 59.0 and later. - **[PrivacyRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacyrequest.htm)** See details and monitor the status of Data Subject Access Requests made in Privacy Center. This object is available in API version 54.0 and later. - **[PrivacyRTBFRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacyrtbfrequest.htm)** Represents a Right to Be Forgotten Request made in Privacy Center. This object is available in API version 59.0 and later. - **[PrivacyRtntStoreDelStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacyrtntstoredelstatus.htm)** Represents the status of retention store deletion operations in Privacy Center. This object is available in API version 67.0 and later. - **[PrivacySessionRecordFailure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacysessionrecordfailure.htm)** Represents error messages encountered during policy job executions in Privacy Center. This object is available in API version 59.0 and later. - **[Problem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_problem.htm)** Problems represent the root cause data of one or more incidents. This object contains all the details of a problem, documenting the history of the problem from detection to closure. This object is available in API version 53.0 and later. - **[ProblemIncident](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_problemincident.htm)** Represents a junction object that relates a Problem to an Incident. This object is available in API version 53.0 and later. - **[ProblemRelatedItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_problemrelateditem.htm)** Represents a junction object that relates a Problem to an Asset. This object is available in API version 53.0 and later. - **[ProcessDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processdefinition.htm)** Represents the definition of a single approval process. - **[ProcessException](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processexception.htm)** Represents a business exception, such as a processing failure on an order summary. A separate process is required to resolve the failure that caused the process exception before processing can continue. This object is available in API version 50.0 and later. - **[ProcessFlowMigration](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processflowmigration.htm)** Represents a process's migrated criteria and the resulting migrated flow. This object is available in API version 58.0 and later. - **[ProcessInstance](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstance.htm)** Represents an instance of a single, end-to-end approval process. Use this and the node, step, and workitem process instance objects to create approval history reports. - **[ProcessInstanceHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancehistory.htm)** This read-only object shows all steps and pending approval requests associated with an approval process (ProcessInstance). - **[ProcessInstanceNode](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancenode.htm)** Represents a step in an instance of an approval process. Compare to ProcessNode, which describes the step in a process definition. Use this object to retrieve approval history. - **[ProcessInstanceStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstancestep.htm)** Represents one work item in an approval process (ProcessInstance). - **[ProcessInstanceWorkitem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processinstanceworkitem.htm)** Represents a user’s pending approval request. - **[ProcessNode](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_processnode.htm)** Describes a step in a process definition. Compare to ProcessInstanceNode, which describes a step in a running process. This object is available in API version 31.0 and later. - **[ProducerCommission](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_producercommission.htm)** Represents a producer's commission for an insurance policy. The commission can be calculated from the commissionable transactions or can be populated from an external system. This object is available in API version 51.0 and later. - **[Product2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_product2.htm)** Represents a product that your company sells. - **[Product2DataTranslation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_product2datatranslation.htm)** Represents the translated values of the data stored within a [Product2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_product2.htm "Represents a product that your company sells.") record’s fields. This object is available in API version 45.0 and later. - **[ProductAttribute](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productattribute.htm)** Represents the attributes that can be associated with a product. This object is available in API version 50.0 and later. - **[ProductAttributeSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productattributeset.htm)** Represents a group of attributes that can be associated with a product. This object is available in API version 50.0 and later. - **[ProductAttributeSetItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productattributesetitem.htm)** Represents a set of attributes that can be associated with a product. This object is available in API version 50.0 and later. - **[ProductAttributeSetProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productattributesetproduct.htm)** Represents the product associated with a set of attributes. This object is available in API version 50.0 and later. - **[ProductCatalog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productcatalog.htm)** The container that holds a Product Category hierarchy. This object is available in API version 55.0 and later. - **[ProductCategory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productcategory.htm)** Represents the category that products are organized in.This object is available in API version 49.0 and later. - **[ProductCategoryProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productcategoryproduct.htm)** Holds the relation between product and product category to assign products to a category. This object is available in API version 55.0 and later. - **[ProductCategoryDataTranslation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productcategorydatatranslation.htm)** Represents the translated values for the data stored within a [ProductCategory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productcategory.htm "Represents the category that products are organized in.This object is available in API version 49.0 and later.") record’s fields. This object is available in API version 46.0 and later. - **[ProductComponentGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productcomponentgroup.htm)** Represents the logical grouping of associated products in a bundle and the products’ arrangement policy (group cardinality). This object is available in API version 58.0 and later. - **[ProductConsumed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productconsumed.htm)** Represents an item from your inventory that was used to complete a work order or work order line item in field service. - **[ProductConsumedState](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productconsumedstate.htm)** Represents the status of an item from your inventory that was used to complete a work order or work order line item in Field Service. This object is available in API version 57.0 and later. - **[ProductDetectedPriceChange](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productdetectedpricechange.htm)** Represents a detected change in price for a product associated with a partner account. This object is available in API version 63.0 and later. - **[ProductEntitlementTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productentitlementtemplate.htm)** Represents predefined terms of customer support (Entitlement) that users can add to products (Product2). - **[ProductFeaturedProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productfeaturedproduct.htm)** Represents the user-defined collection of featured products that are meant to cross-sell or upsell with your product. This object is available in API version 64.0 and later. - **[ProductItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productitem.htm)** Represents the stock of a particular product at a particular location in field service, such as all bolts stored in your main warehouse. - **[ProductItemTransaction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productitemtransaction.htm)** Represents an action taken on a product item in field service. Product item transactions are auto-generated records that help you track when a product item is replenished, consumed, or adjusted. - **[ProductMedia](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productmedia.htm)** Represents the rich media, including images and attachments, that can be added to products.This object is available in API version 49.0 and later. - **[ProgramProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_programproduct.htm)** Represents a junction between Program and Product2. This will hold Product2 values related to a Program. This object is available in API version 58.0 and later. - **[ProductQuantityRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productquantityrule.htm)** Represents the relationship between a quantity rule and a product. This object assigns quantity rules to a product. This object is available in API version 51.0 and later. - **[ProductRelatedComponent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productrelatedcomponent.htm)** Represents a product that is included in a product bundle, a set, or a product and an add-on. This object is available in API version 57.0 and later. - **[ProductRelationshipType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productrelationshiptype.htm)** Defines the relationship between two sales transaction items. For example, defines a relationship between a bundle and a bundle component. This object is available in API version 57.0 and later. - **[ProductRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productrequest.htm)** Represents an order for a part or parts in field service. - **[ProductRequestLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productrequestlineitem.htm)** Represents a request for a part in field service. Product request line items are components of product requests. - **[ProductRequired](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productrequired.htm)** Represents a product that is needed to complete a work order or work order line item in field service. - **[ProductSellingModel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productsellingmodel.htm)** Defines one method by which a product can be sold; for example, as a one-time sale, an evergreen subscription, or a term-defined subscription. If the product is sold on subscription, this object defines the subscription’s term. A product can have multiple product selling models. This object is available in API version 55.0 and later. - **[ProductSellingModelOption](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productsellingmodeloption.htm)** A junction object between Product Selling Model and Product2. This object is available in API version 55.0 and later. - **[ProductServiceCampaign](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productservicecampaign.htm)** Represents a set of activities to be performed on a product service campaign asset, such as a product recall for safety issues or product defects. This object is available in API version 51.0 and later. - **[ProductServiceCampaignItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productservicecampaignitem.htm)** Represents a product service campaign's asset. This object is available in API version 51.0 and later. - **[ProductServiceCampaignItemStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productservicecampaignitemstatus.htm)** Represents a status for a product service campaign item in field service. This object is available in API version 51.0 and later. - **[ProductServiceCampaignStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productservicecampaignstatus.htm)** Represents a status for a product service campaign in field service. This object is available in API version 51.0 and later. - **[ProductTransfer](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_producttransfer.htm)** Represents the transfer of inventory between locations in field service. - **[ProductWarrantyTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productwarrantyterm.htm)** Defines the relationship between a product or product family and warranty term. This object is available in API version 50.0 and later. - **[Profile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profile.htm)** Represents a profile, which defines a set of permissions to perform different operations. Operations can include creating a custom profile or querying, adding, updating, or deleting information. - **[ProfileSkill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profileskill.htm)** Represents a profile skill, which describes a user’s professional knowledge. This is a global record for the organization, and users are associated through the ProfileSkillUser object. - **[ProfileSkillEndorsement](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profileskillendorsement.htm)** Represents a detail relationship of ProfileSkillUser. An endorsement of a profile skill shows approval and support of another user’s publicly declared skill. - **[ProfileSkillShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profileskillshare.htm)** Represents a sharing entry on a ProfileSkill. - **[ProfileSkillUser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profileskilluser.htm)** Represents a detail relationship of User. The object connects profile skills with users. - **[ProgramRebateType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_programrebatetype.htm)** Represents a rebate structure associated with a Rebate Program. This object is available in API version 63.0 and later. - **[Promotion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotion.htm)** Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later. - **[PromotionLineItemRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionlineitemrule.htm)** Lists compound conditions about a promotion. This object is available in API version 59.0 and later. - **[PromotionMarketSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionmarketsegment.htm)** Represents a market segment within B2B Commerce that promotions can be assigned to. This object is available in API version 52.0 and later. - **[PromotionQualifier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionqualifier.htm)** Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later. - **[PromotionSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegment.htm)** Represents a promotion segment, which you can assign to different stores or buyer groups, allowing them to access the promotion. This object is available in API version 52.0 and later. - **[PromotionSegmentBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentbuyergroup.htm)** Represents a promotion segment, associated with a buyer group, and used for B2B Commerce. This object is available in API version 52.0 and later. - **[PromotionSegmentSalesStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotionsegmentsalesstore.htm)** Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later. - **[PromotionTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontarget.htm)** Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store. This object is available in API version 52.0 and later. - **[PromotionTier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promotiontier.htm)** Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later. - **[Prompt](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prompt.htm)** Represents record details about an in-app guidance prompt or walkthrough. Available in API version 46.0 and later. - **[PromptAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promptaction.htm)** Represents how the user interacted with the in-app guidance prompt or walkthrough. Available in API version 46.0 and later. - **[PromptError](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prompterror.htm)** Represents the error or warning associated with the PromptAction. Available in API version 52.0 and later. - **[PromptActionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promptactionownersharingrule.htm)** Represents a rule which determines PromptAction sharing access for the owners. Available in API version 46.0 and later. - **[PromptActionShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promptactionshare.htm)** Represents a sharing entry on a prompt action record. Available in API version 46.0 and later. - **[PromptLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promptlocalization.htm)** Represents the translated value of a label for record details about in-app guidance when the Translation Workbench is enabled for your org. Available in API version 48.0 and later. - **[PromptVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promptversion.htm)** Represents an in-app guidance prompt or walkthrough. Available in API version 46.0 and later. - **[PromptVersionLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promptversionlocalization.htm)** Represents the translated value of a label for-app guidance when the Translation Workbench is enabled for your org. Available in API version 48.0 and later. - **[Prospect](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prospect.htm)** Represents a prospect. A prospect is an individual who has shared contact information, but isn't yet qualified. This object is available in API version 63.0 and later. - **[ProspectingAgentDataSource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prospectingagentdatasource.htm)** Represents a Prospecting Agent data source. - **[ProspectingAgentRcmdTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prospectingagentrcmdtarget.htm)** Represents prospecting information suggested by generative AI. This object is available in API version 66.0 and later. - **[ProspectingAgentSpec](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prospectingagentspec.htm)** Represents a Prospecting Agent specification. - **[ProspectingAgentSpecParm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prospectingagentspecparm.htm)** Stores runtime configuration parameters for a ProspectingAgentSpec. Each row represents one parameter keyed by type namespace and parameter name. - **[ProspectingAgentUserSpec](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prospectingagentuserspec.htm)** Represents a Prospecting Agent user specification. - **[ProrationPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prorationpolicy.htm)** Defines how the price of a subscription is divided into time periods and how the price is calculated for each time period. This object is available in API version 55.0 and later. - **[ProspectingAgentExternalCompanyResearch](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prspagntextlcorsrch.htm)** Represents research done by a prospecting agent on an external company. - **[ProspectingAgentExternalPersonResearch](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_prspagntextlpersrsrch.htm)** Represents research done by a prospecting agent on an external person. - **[PublicComplaint](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_std_publiccomplaint.htm)** Represents the complaints submitted by public users. This object is available in API version 49.0 and later. - **[PurchaseQuantityRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_purchasequantityrule.htm)** Represents a rule that restricts the quantity of a product that can be purchased. The rule can be an increment, minimum, or maximum rule. This object is available in API version 52.0 and later. - **[PushTopic](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pushtopic.htm)** Represents a query that is the basis for notifying Streaming API clients of changes to records in an org. This object is available in API version 21.0 and later. - **[PushUpgradeCustomization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pushupgradecustomization.htm)** Customized push upgrades allow a package subscriber to block push upgrades to their org. Package developers control which subscribers can opt into customized push upgrades. Each push upgrade customization maps to a specific package and to a specific subscriber org. This object is available in API version 60.0 and later. - **[QueuedExecutionEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_queuedexecutioneventlog.htm)** Queued Execution events contain details about queued executions—for example, batch Apex. This object is available in API version 65.0 and later. - **[QueueRoutingConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_queueroutingconfig.htm)** Represents the settings that determine how work items are routed to agents. This object is available in API version 32.0 and later. - **[Question](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_question.htm)** Represents a question in a zone that users can view and reply to. - **[QuestionDataCategorySelection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_questiondatacategoryselection.htm)** A data category selection represents a data category that classifies a question. - **[QuestionReportAbuse](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_questionreportabuse.htm)** Represents a user-reported abuse on a Question in a Chatter Answers zone. This object is available in API version 24.0 and later. - **[QuestionSubscription](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_questionsubscription.htm)** Represents a subscription for a user following a Question. This object is available in API version 24.0 and later. - **[QueueSobject](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_queuesobject.htm)** Represents the mapping between a queue Group and the types associated with the queue, including custom objects. - **[QuickText](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quicktext.htm)** This object stores a snippet of text that allows users to send a quick response to a customer. Use quick text to create greetings, answers to common questions, short notes, and more. This object is available in API version 24.0 and later. - **[QuickTextUsage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quicktextusage.htm)** Represents the usage of quick text on a record, including which quick text was used, who used it, and how they used it. Quick text is a snippet of text that allows users to send a quick response to a customer. This object is available in API version 47.0 and later. - **[Quote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quote.htm)** Represents a quote, which is a record showing proposed prices for products and services. Available in API version 18.0 and later. - **[QuoteAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quoteaction.htm)** Indicates the type of sales transaction that’s being quoted; for example, a renewal sale. This object is available in API version 59.0 and later. - **[QuoteAdjustmentGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quoteadjustmentgroup.htm)** Group containing a set of adjustments applied to a quote. This object is available in API version 58.0 and later. - **[QuoteDocument](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotedocument.htm)** Represents a quote in document format. Available in API version 18.0 and later. - **[QuoteLineGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelinegroup.htm)** Stores the group information for line items in a quote. It also stores the aggregated line field information (subtotal). It contains a parent-child relationship to quote. This object is available in API version 61.0 and later. - **[QuoteLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelineitem.htm)** Represents a quote line item, which is a member of the list of Product2 products associated with a quote, along with other information about those line items on that quote. Available in API version 18.0 and later. - **[QuoteLineItemRecipient](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelineitemrecipient.htm)** Represents a site, employee, or other entity for which services are being quoted. This could include details such as the recipient's name, contact information, associated site or location, and any specific requirements or preferences for the quoted services. This object is available in API version 62.0 and later. - **[QuoteLinePriceAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelinepriceadjustment.htm)** Indicates the calculated price adjustment that is applied to the quote line, for example, a calculated volume discount or the prorated value of a manual discount. Use the quote line price adjustment to inform potential customers about the type, value, and total amount of their discounts. This object is available in API version 56.0 and later. - **[QuoteLineRelationship](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelinerelationship.htm)** Describes the relationship between quote line items, such as items in a bundle. When you create a QuoteLineRelationship object, it’s immutable: it can’t be edited or removed. This object is available in API version 58.0 and later. - **[QuoteItemTaxItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quoteitemtaxitem.htm)** The tax that is applied to a quote line item. This object is available in API version 55.0 and later. - **[QuoteLineWorkSource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quotelineworksource.htm)** Represents an association between a quote and work sources, such as assets, quote line items, order products, or work type groups. This object is available in API version 63.0 and later. - **[QuoteRecipientGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quoterecipientgroup.htm)** Represents a recipient group for which offers or products with the same configuration are being added. This also includes reusing these groups to add or remove recipients. This object is available in API version 64.0 and later. - **[QuoteRecipientGroupMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_quoterecipientgroupmember.htm)** Represents a junction between a quote line item recipient and a quote recipient group. This object is available in API version 64.0 and later. - **[RecentFieldChange](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recentfieldchange.htm)** Use this virtual object to see how an opportunity has changed in the past seven days. Learn the previous value of a field, who made the change, and when the change was made. This object is available in API version 52.0 and later. - **[RecentlyViewed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recentlyviewed.htm)** Represents records or list views that the current user has recently viewed or referenced (by viewing a related record). List views are available in API version 29.0 and later. - **[Recommendation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recommendation.htm)** Represents the recommendations surfaced as offers and actions for Einstein Next Best Action. This object is available in API version 45.0 and later. - **[RecommendationResponse](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recommendationresponse.htm)** Represents the user responses to a presented offer or recommendation for Einstein Next Best Action. This object is available in API version 51.0 and later. - **[RecordAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordaction.htm)** Represents a relationship between a record and an action, such as a flow. Create a RecordAction for every action that you want to associate with a particular record. Available in API version 42.0 and later. - **[RecordActionHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordactionhistory.htm)** Represents the lifecycle of a RecordAction as it goes through different states. Available in API version 44.0 and later. - **[RecordsetFilterCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordsetfiltercriteria.htm)** Represents a set of filters that can be used to match service appointments or assets based on your criteria fields. For example, you can create recordset filter criteria so that only service appointments that satisfy the filter criteria are matched to the filtered shifts, and likewise only maintenance work rules that satisfy your criteria are matched to assets. This object is available in API version 50.0 and later. Assets and maintenance work rules are available in API version 52.0 and later. - **[RecordsetFilterCriteriaRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordsetfiltercriteriarule.htm)** Represents a rule using fields from the designated source object to create filters on the filtered, or target, object. RecordsetFilterCriteriaRule is associated with the RecordsetFilterCriteria object. This object is available in API version 50.0 and later. - **[RecordsetFltrCritMonitor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordsetfltrcritmonitor.htm)** Monitors whether the value of an asset attribute is within the threshold of a recordset filter criteria (RFC). You can monitor one or more RFCs for an Asset. This object is available in API version 57.0 and later. - **[RecordType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordtype.htm)** Represents a record type. - **[RecordTypeLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordtypelocalization.htm)** Represents the translated value of a label for a record type when the Translation Workbench is enabled for your organization. - **[RecordVisibility (Pilot)](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordvisibility.htm)** Represents the visibility attributes that determine a record’s read access. This object is read only and is available in API version 46.0 and later. - **[RedirectWhitelistUrl](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_redirectwhitelisturl.htm)** Represents a trusted URL for external user redirections. Redirections to a different Salesforce org, including its publicly served pages and content, are allowed from your Salesforce org only when the URL is a RedirectWhitelistUrl. For non-Salesforce URLs, a session setting controls whether redirections from pages and components built in Salesforce Classic are restricted to RedirectWhitelistUrl objects. Except for cross-org redirections, you can’t restrict redirections that originate from pages and components built with Lightning Experience. This object is available in API version 48.0 and later. - **[Refund](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_refund.htm)** Represents a refund made against a payment. This object is available in API version 48.0 and later. - **[RefundLinePayment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_refundlinepayment.htm)** A refund line that has been applied to a payment. This object is available in API version 48.0 and later. - **[RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_registeredexternalservice.htm)** Represents a registered external service used for checkout integrations by data integrators. This object is available in API version 49.0 and later. - **[RelatedListColumnDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_relatedlistcolumndefinition.htm)** Represents information about a column in a related list. A related list specifies a set of records for a related object, based on specific criteria. This object is available in API version 55.0 and later. - **[RelatedListDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_relatedlistdefinition.htm)** Represents information about a related list. A related list specifies a set of records for a related object, based on specific criteria. This object is available in API version 55.0 and later. - **[RemoteKeyCalloutEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_remotekeycalloutevent.htm)** The documentation has moved to [RemoteKeyCalloutEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_remotekeycalloutevent.htm "HTML (New Window)") in the Platform Events Developer Guide. - **[Reply](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reply.htm)** Represents a reply that a user has submitted to a question in an answers zone. - **[ReplyEmailSettings](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_replyemailsettings.htm)** Represents a reply mail management configuration, which is used to configure emails that are received by an email sending domain. This object is available in API version 62.0 and later. - **[ReplyReportAbuse](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_replyreportabuse.htm)** Represents a user-reported abuse on a Reply in a Chatter Answers zone. This object is available in API version 24.0 and later. - **[ReplyText](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_replytext.htm)** A text reply generated by Einstein Reply Recommendations that is based on closed chat transcripts. Admins review replies and publish them to quick text, editing them as needed. Einstein recommends relevant published replies to support agents in the Lightning Service Console, and agents can insert replies into chats or messaging sessions. This object is available in API version 49.0 and later. - **[Report](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_report.htm)** Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only. This object is available in API version 20.0 and later. - **[ReportEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reporteventlog.htm)** Report event logs contain information about what happened when a user ran a report. This event type includes all activity that's in the Report Export event type, and additional information. For example, it has user activity for reports exported as both Formatted Report and Details Only output. This object is available in API version 61.0 and later. - **[ReportExportEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reportexporteventlog.htm)** Report Export events contain details about reports that a user exported. For example, this event type captures when a user exports a report as Details Only output. But it doesn’t capture reports that users export as Formatted Report or XLSX Detail output. For that data, see the Report event type. This object is available in API version 65.0 and later. - **[ReportTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reporttag.htm)** Associates a word or short phrase with a Report. This object is available in API version 20.0 and later. - **[ReputationLevel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reputationlevel.htm)** Represents a reputation level defined for an Experience Cloud site. This object is available in API version 32.0 and later. - **[ReputationLevelLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reputationlevellocalization.htm)** Represents the translated value of a reputation level. Reputation level localization only applies for reputation levels in Experience Cloud sites. This object is available in API version 35.0 and later. - **[ReputationPointsRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reputationpointsrule.htm)** Represents the reputation point rules for an Experience Cloud site. Each rule specifies an action that members can earn points from and the points associated with those actions in a particular site. This object is available in API version 32.0 and later. - **[ResourceAbsence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_resourceabsence.htm)** Represents a time period in which a service resource is unavailable to work in Field Service, Salesforce Scheduler, or Workforce Engagement. This object is available in API version 38.0 and later. - **[ResourcePreference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_resourcepreference.htm)** Represents an account’s preference for a specified service resource on field service work. - **[RestApiEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_restapieventlog.htm)** REST API event logs contain details about REST-specific requests. This object is available in API version 61.0 and later. - **[RetentionStoreUsage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_retentionstoreusage.htm)** Represents the total usage of the org's retention store measured at specific points in time. This object is available in API version 66.0 and later. - **[ReturnOrder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_returnorder.htm)** Represents the return or repair of inventory or products in Field Service, or the return of order products in Order Management. This object is available in API version 42.0 and later. - **[ReturnOrderItemAdjustment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_returnorderitemadjustment.htm)** Represents a price adjustment on a return order line item. This object is available in API version 50.0 and later. - **[ReturnOrderItemTax](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_returnorderitemtax.htm)** Represents the tax on a return order line item or return order item adjustment. This object is available in API version 50.0 and later. - **[ReturnOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_returnorderlineitem.htm)** Represents a specific product that is returned or repaired as part of a return order in Field service, or a specific order item that is returned as part of a return order in Order Management. This object is available in API version 42.0 and later. - **[ReturnOrderOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_returnorderownersharingrule.htm)** Represents the rules for sharing a return order with user records other than the owner or anyone above the owner in the role hierarchy. This object is available in API version 42.0 and later. - **[RevenueAsyncOperation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_revenueasyncoperation.htm)** Represents the status of an asynchronous process initiated by a REST request in Subscription Management. This object is available in API versions 57.0 to 59.0. Use AsyncOperationTracker instead of RevenueSyncOperation in API version 59.0 and later. - **[RevenueTransactionErrorLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_revenuetransactionerrorlog.htm)** Contains information about errors that occurred while processing a request. The error record persists until another error with the same category, primary record, and (optionally) related record occurs. This object is available in API version 55.0 and later. - **[Review](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_review.htm)** Represents a standing review of a specific business record against a defined reference standard. When a review is conducted, it automatically reflects the date and outcome of the most recently completed review execution. This object is available in API version 68.0 and later. - **[ReviewExecution](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_reviewexecution.htm)** Represents a single review event conducted by an assigned user or group to fulfill a review, capturing the outcome at a specific point in time. This object is available in API version 68.0 and later. - **[RpaFlowResultEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rpaflowresultevent.htm)** Reserved for future use. - **[RpaRobot](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobot.htm)** Reserved for future use. - **[RpaRobotAsgnMaintWindow](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotasgnmaintwindow.htm)** Reserved for future use. - **[RpaRobotAsgnSessionInf](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotasgnsessioninf.htm)** Reserved for future use. - **[RpaRobotDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotdefinition.htm)** Reserved for future use. - **[RpaRobotMaintWindow](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotmaintwindow.htm)** Reserved for future use. - **[RpaRobotMaintWindowDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotmaintwindowdef.htm)** Reserved for future use. - **[RpaRobotPool](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotpool.htm)** Reserved for future use. - **[RpaRobotPoolAsgnRobot](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotpoolasgnrobot.htm)** Reserved for future use. - **[RpaRobotPoolDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotpooldefinition.htm)** Reserved for future use. - **[RpaRobotPoolFlowAsgn](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotpoolflowasgn.htm)** Reserved for future use. - **[RpaRobotSessionInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotsessioninfo.htm)** Reserved for future use. - **[RpaRobotSessionInfoDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_rparobotsessioninfodef.htm)** Reserved for future use. - **[RuleTerritory2Association](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ruleterritory2association.htm)** Represents a record-assignment rule and its association to an object, such as Account. Available if Sales Territories has been enabled. - **[SalesAIScoreCycle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesaiscorecycle.htm)** Represents the cycle type and ID used to score records. This object is available in API version 47.0 and later. - **[SalesAIScoreModelFactor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesaiscoremodelfactor.htm)** Represents the factors that Sales Cloud Einstein uses to build a scoring model. Scoring models are used by features, such as Opportunity Scoring, to score individual records. This object is available in API version 47.0 and later. - **[SalesforceLoginAsEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforceloginaseventlog.htm)** Salesforce LoginAs Event provides details about the Salesforce User's login into Customer Org as Customer's authorized user. This object is available in API version 65.0 and later. - **[SalesChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_saleschannel.htm)** Represents the origin of an order. For example, a web storefront, physical store, marketplace, or mobile app. If you integrate Salesforce Order Management with Salesforce B2C Commerce, set up a SalesChannel corresponding to each Site in your B2C Commerce implementation. This object is available in API version 48.0 and later. - **[SalesforceContract](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcecontract.htm)** Read-only virtual object used in the Your Account App. Represents contract information related to your organization’s Salesforce subscription. - **[SalesforceInvoice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforceinvoice.htm)** Read-only virtual object used in the Your Account App. Represents information about your organization’s invoices with Salesforce. - **[SalesforcePayment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcepayment.htm)** Read-only virtual object used in the Your Account App. Represents information about payments related to your organization’s Salesforce invoice. - **[SalesforceQuote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforcequote.htm)** Read-only virtual object used in the Your Account App. Represents information about your organization’s quotes with Salesforce. - **[SalesMethodologyDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesmethodologydef.htm)** Represents the template of criteria for a sales methodology. This object is available in API version 67.0 and later. - **[SalesMethodologyDefItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesmethodologydefitem.htm)** Represents the individual criteria for each stage of a sales methodology. This object is available in API version 67.0 and later. - **[SalesStoreCatalog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesstorecatalog.htm)** Represents the catalog associated with a store. This object is available in API version 49.0 and later. - **[SalesTransactionItemShape](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salestransactionitemshape.htm)** Defines the business logic for a sales transaction shape item, for example, an item in an order. This object is available in API version 57.0 and later. - **[SalesTransactionShape](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salestransactionshape.htm)** Defines the business logic for a sales transaction; for example, an order, a quote, or a cart. This object is available in API version 57.0 and later. - **[SalesTransactionType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salestransactiontype.htm)** Represents the type of sales transaction, such as an initial, renewal, or amendment sale, and its related pricing configuration.. This object is available in API version 61.0 and later. - **[SalesTrxnItemRelationShape](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salestrxnitemrelationshape.htm)** Describes the relationship between sales transaction shape items; for example, a bundle or set. This object is available in API version 57.0 and later. - **[SalesWorkQueueSettings](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesworkqueuesettings.htm)** Represents settings used to customize work queue options for third-party scoring. Third-party scoring enables custom number fields on person accounts, contacts, and leads. You must be a Sales Engagement customer to update this object. Previously, you could only use the Einstein Intelligence Score for third-party scoring. Available starting in Version 47.0. - **[SandboxStatusEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sandboxstatuseventlog.htm)** SandboxStatusEventLog stores details about Sandbox copies. This object is available in API version 62.0 and later. - **[SamlSsoConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_samlssoconfig.htm)** Represents a SAML Single Sign-On configuration.This object is available in API version 32.0 and later. - **[SavedPaymentMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_savedpaymentmethod.htm)** Represents a payment method saved by an authenticated customer. This object is available in API version 58.0 and later - **[SavedPaymentMethodEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_savedpaymentmethodevent.htm)** Represents a saved payment method platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later. - **[SchedulingAdherenceDetail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_schedulingadherencedetail.htm)** Represents the breakdown of daily shift adherence data by agent status. This object is available in API version 54.0 and later. - **[SchedulingAdherenceSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_schedulingadherencesummary.htm)** Represents daily shift adherence data for a service resource in a service territory and job profile on a specific date. This object is available in API version 54.0 and later. - **[SchedulingConstraint](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_schedulingconstraint.htm)** Represents scheduling constraints on each service resource. This object is available in API version 50.0 and later. - **[SchedulingObjective](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_schedulingobjective.htm)** Represents business goals that the scheduling tools consider. This object is available in API version 53.0 and later. - **[SchedulingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_schedulingrule.htm)** Represents scheduling rules that are hard constraints in the scheduling logic engine. This object is available in API version 52.0 and later. - **[SchedulingRuleParameter](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_schedulingruleparameter.htm)** Represents scheduling rule parameters associated with a scheduling rule. This object is available in API version 52.0 and later. - **[Scontrol](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scontrol.htm)** A custom s-control, which is custom content that is hosted by the system but executed by the client application. - **[ScontrolLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scontrollocalization.htm)** The translated value of the field label for an s-control. - **[Scorecard](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scorecard.htm)** Use scorecards to measure partner performance and establish benchmarks for channel programs within Experience Cloud. Display any report summary results that your channel account manager or executive team wants to see. This object is available in API version 40.0 and later. - **[ScorecardAssociation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scorecardassociation.htm)** Represents a connection between a specific scorecard and the associated account, channel program, or channel program level. This object is available in API version 41.0 and later. - **[ScorecardMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scorecardmetric.htm)** Stores information about a Salesforce report that is run and summarized to get a single value. The stored value is added as a metric to the related Scorecard object. This object is available in API version 40.0 and later. - **[ScoreIntelligence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scoreintelligence.htm)** For internal use only. - **[ScratchOrgInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scratchorginfo.htm)** Represents a scratch org and its audit log. Use this object to create a scratch org and keep a log of its creation and deletion. This object is available in API version 41.0 and later. - **[SearchActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_searchactivity.htm)** Represents search activity on a Knowledge article. Also known as KnowledgeSearchActivity. This object is available in API version 38.0 and later. - **[SearchClickEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_searchclickeventlog.htm)** Search Click Event Log contains details about the user’s interaction with the search results. This object is available in API version 61.0 and later. - **[SearchEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_searcheventlog.htm)** Search Event Log provides details about the user’s search query. This object is available in API version 61.0 and later. - **[SearchLayout](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_searchlayout.htm)** Represents a search layout defined for an object. This object is available in API version 35.0 and later. - **[SearchPromotionRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_searchpromotionrule.htm)** Represents a promoted search term, which is one or more keywords that you associate with a Salesforce Knowledge article. When a user’s search query includes these keywords, the associated article is returned first in search results. This object is available in API version 31.0 and later. - **[SecurityCustomBaseline](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_securitycustombaseline.htm)** Provides the ability to read, create, and delete user-defined custom security baselines, which define an org’s security standards. This object is available in API version 39.0 and later. - **[SecurityHealthCheckAlertRecipient](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_securityhealthcheckalertrecipient.htm)** Represents a recipient configuration for Security Health Check alerts. Use this object to manage who receives Security Health Check notifications and how they are delivered. - **[SecurityHealthCheckResult](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_securityhealthcheckresult.htm)** Stores Security Health Check results, including the baseline used and the score calculated. - **[SelfServiceUser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_selfserviceuser.htm)** Represents a Contact who has been enabled to use your organization’s Self-Service portal, where he or she can obtain online support. - **[Seller](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_seller.htm)** Represents the seller role of an individual with respect to a particular company or organization. This object is available in API version 53.0 and later. - **[SenderEmailAddress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_senderemailaddress.htm)** Represents a From address in a marketing email. This object is available in API version 63.0 and later. - **[SerializedProductTransaction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serializedproducttransaction.htm)** Represents transactions performed on a serialized product. This object is available in API version 57.0 and later. - **[ServiceAppointment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceappointment.htm)** Represents an appointment to complete work for a customer in Field Service, Lightning Scheduler,Intelligent Appointment Management, and Virtual Care.This object is available in API version 38.0 and later. - **[ServiceAppointmentStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceappointmentstatus.htm)** Represents a possible status of a service appointment in field service. - **[ServiceChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicechannel.htm)** Represents a channel of work items that are received from your organization—for example, cases, chats, or leads. This object is available in API version 32.0 and later. - **[ServiceChannelFieldPriority](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicechannelfieldpriority.htm)** Represents a secondary routing priority field-value mapping. This object is available in API version 47.0 and later. - **[ServiceChannelStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicechannelstatus.htm)** Represents the status that’s associated with a specific service channel. This object is available in API version 32.0 and later. - **[ServiceChannelStatusField](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicechannelstatusfield.htm)** Represents the values that you use to indicate completed and in-progress work item status for the status field in the Status-Based Capacity routing model. This object is available in API version 49.0 and later. - **[ServiceContract](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicecontract.htm)** Represents a customer support contract (business agreement). This object is available in API version 18.0 and later. - **[ServiceContractOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicecontractownersharingrule.htm)** Represents the rules for sharing a ServiceContract (customer service agreement) with users other than the owner. This object is available in API version 18.0 and later. - **[ServiceCrew](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicecrew.htm)** Represents a group of service resources who can be assigned to service appointments as a unit. - **[ServiceCrewMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicecrewmember.htm)** Represents a technician service resource that belongs to a service crew. - **[ServiceCrewOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicecrewownersharingrule.htm)** Represents the rules for sharing a service crew with user records other than the owner or anyone above the owner in the role hierarchy. - **[ServicePresenceStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicepresencestatus.htm)** Represents a presence status that can be assigned to a service channel. This object is available in API version 32.0 and later. - **[ServiceReport](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicereport.htm)** Represents a report that summarizes a work order, work order line item, or service appointment. - **[ServiceReportLayout](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicereportlayout.htm)** Represents a service report template in field service. - **[ServiceRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicerequest.htm)** Represents a formal request from a user for something to be provided, such as access, information, hardware, or software. This object manages the lifecycle of these tasks, which are typically low-risk, and can be fulfilled through a defined, repeatable process. For example, a Service Request can be created for an employee requesting a new laptop or a student needing a transcript. This object is available in API version 66.0 and later. - **[ServiceResource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceresource.htm)** Represents a service technician or service crew in Field Service and Salesforce Scheduler, or an agent in Workforce Engagement. This object is available in API version 38.0 and later. - **[ServiceResourceCapacity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceresourcecapacity.htm)** Represents the maximum number of scheduled hours or number of service appointments that a capacity-based service resource can complete within a specific time period. This object is available in API version 38.0 and later. - **[ServiceResourceCapacityHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceresourcecapacityhistory.htm)** Represents the history of changes made to tracked fields on a service resource capacity record. This object is available in API version 38.0 and later. - **[ServiceResourceDataTranslation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceresourcedatatranslation.htm)** Represents the translated values of the data stored within a [ServiceResource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceresource.htm "Represents a service technician or service crew in Field Service and Salesforce Scheduler, or an agent in Workforce Engagement. This object is available in API version 38.0 and later.") record’s fields. This object is available in API version 54.0 and later. - **[ServiceResourceOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceresourceownersharingrule.htm)** Represents the rules for sharing a service resource with user records other than the owner or anyone above the owner in the role hierarchy. This object is available in API version 38.0 and later. - **[ServiceResourcePreference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceresourcepreference.htm)** Represents the service resource scheduling preferences that are considered as a business objective in the scheduling logic engine. This object is available in API version 52.0 and later. - **[ServiceResourceSkill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceresourceskill.htm)** Represents a skill that a service resource possesses in Field Service and Lightning Scheduler. This object is available in API version 38.0 and later. - **[ServiceSetupProvisioning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicesetupprovisioning.htm)** Represents a task completed by the Service Setup Assistant. This object is available in API version 52.0 and later. - **[ServiceTerritory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceterritory.htm)** Represents a geographic or functional region in which work can be performed in Field Service, Salesforce Scheduler, or Workforce Engagement. This object is available in API version 38.0 and later. - **[ServiceTerritoryDataTranslation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceterritorydatatranslation.htm)** Represents the translated values of the data stored within a [ServiceTerritory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceterritory.htm "Represents a geographic or functional region in which work can be performed in Field Service, Salesforce Scheduler, or Workforce Engagement. This object is available in API version 38.0 and later.") record’s fields. This object is available in API version 54.0 and later. - **[ServiceTerritoryLocation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceterritorylocation.htm)** Represents a location associated with a particular service territory in field service. - **[ServiceTerritoryMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceterritorymember.htm)** Represents a service resource who can be assigned in a service territory in Field Service, Salesforce Scheduler, or Workforce Engagement. This object is available in API version 38.0 and later. - **[ServiceTerritoryWorkType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceterritoryworktype.htm)** Represents the relationship between a ServiceTerritory object and a WorkType object for Salesforce Scheduler appointments. This object is available in API version 45.0 and later. - **[SessionPermSetActivation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sessionpermsetactivations.htm)** The SessionPermSetActivation object represents a permission set assignment activated during an individual user session. When a SessionPermSetActivation object is inserted into a permission set, an activation event fires, allowing the permission settings to apply to the user’s specific session. This object is available in API versions 37.0 and later. - **[SetupAssistantStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_setupassistantstep.htm)** For internal use only. - **[SetupAuditTrail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_setupaudittrail.htm)** Represents changes you or other admins made in your org’s Setup area for at least the last 180 days. This object is available in API version 15.0 and later. - **[SetupEntityAccess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_setupentityaccess.htm)** Represents the enabled setup entity access settings (such as for Apex classes) for the parent PermissionSet. This object is available in API version 25.0 and later. - **[SfdcCustomerForPartner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdccustomerforpartner.htm)** Represents a customer associated with a Salesforce partner. Records appear in the Partner Business Org (PBO) and represent a partner's customer for the purpose of storing billing information. This object is available in API version 66.0 and later. - **[SfdcPartnerOffer](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartneroffer.htm)** Represents a private offer that an ISV partner creates and sends to a customer. This object includes information about the offer, and is parent to multiple Partner Offer line items, and includes information used in the Partner Business Org (BPO) transaction. This object is available in API version 66.0 and later. - **[SfdcPartnerOfferItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerofferitem.htm)** Represents a line item within a partner offer. Line items map to defined products or SKUs that are sold as part of the offer. Includes quantity. This object is available in API version 66.0 and later. - **[SfdcPartnerOrder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerorder.htm)** Represents the order record generated after a customer accepts an offer and initiates a purchase. Orders are viewable from the Go-To-Market App in the Partner Business Org (PBO). This object is available in API version 64.0 and later. - **[SfdcPartnerOrderBillingTrxn](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerorderbillingtrxn.htm)** Represents the junction between SfdcPartnerOrder and SfdcPartnerBillingTrxn in a Partner Business Org (PBO). This allows for a many-to-many relationship between the two objects and is used as the customer facing link between Orders and Stripe invoice data. This object is available in API version 66.0 and later. - **[SfdcPartnerOrderItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerorderitem.htm)** Represents a line item within a partner order, including provisioning information and billing details from a customer's purchase, in a Partner Business Org (PBO). This object is available in API version 64.0 and later. - **[SfdcPartnerPackage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerpackage.htm)** Represents a managed package owned by a partner in a Partner Business Org (PBO). This object is available in API version 64.0 and later. - **[SfdcPartnerPackageVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerpackageversion.htm)** Represents a released version of a first generation (1GP) or second generation (2GP) package in a Partner Business Org (PBO) with the Go-To-Market app enabled. This object is available in API version 66.0 and later. - **[SfdcPartnerPayout](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerpayout.htm)** Represents an invoice payout from Stripe to a partner in a Partner Business Org (PBO). This object is available in API version 66.0 and later. - **[SfdcPartnerPermSetLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerpermsetlicense.htm)** Represents a Permission Set License Definition (PSLD) from a released managed package in a Partner Business Org (PBO) with the Go-To-Market app enabled. This object is available in API version 66X.0 and later. - **[SfdcPartnerProductLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerproductlicense.htm)** Represents the mapping between a provisionable product and a package license or permission set licenses (PSL) in a Partner Business Org (PBO). This object is available in API version 64.0 and later. - **[SfdcPartnerProvisionProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnerprovisionproduct.htm)** Represents a product used to map licenses for customer provisioning in a Partner Business Org (PBO). This object is available in API version 64.0 and later. - **[SfdcPartnerSbscrOffer](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnersbscroffer.htm)** Represents a partner offer as seen by the customer in their subscriber org. Synced from Partner Business Org SfdcPartnerOffer record. This object is available in API version 66.0 and later. - **[SfdcPartnerSbscrOfferItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnersbscrofferitem.htm)** Represents a line item within a partner subscriber offer. Includes all necessary information about the line-item being sold, including quantity and cost. This object is available in API version 66.0 and later. - **[SfdcPartnerTenant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnertenant.htm)** Represents a Salesforce org that contains information about a partner's customer's tenants and is stored in a Partner Business Org (PBO). This object is available in API version 64.0 and later. - **[SfdcPartnerTenantPackage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnertenantpackage.htm)** Represents a package installed in a tenant org and tracked in a Partner Business Org (PBO). This object is available in API version 66.0 and later. - **[SfdcPartnerTermSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnertermset.htm)** Represents a set of contractual terms for a partner relationship. SfdcPartnerTermSet is a Partner Business Org (PBO) standard object storing partner contract terms that are propagated from the Channel Orders Application (COA). This object is available in API version 66.0 and later. - **[SfdcPartnerTermSetProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnertermsetproduct.htm)** Represents a product within a partner term set. SfdcPartnerTermSetProduct is a Partner Business Org (PBO) standard object storing Partner Product Catalogue that are propagated from the Channel Orders Application (COA). This object is available in API version 66.0 and later. - **[SfdcPartnerTntPermSetLic](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnertntpermsetlic.htm)** Represents Permission Set License (PSL) tracking for a tenant package in a Partner Business Org (PBO). Used to track seats, expiration dates, and license statuses from both the management and subscriber org for PSLs. This object is available in API version 66.0 and later. - **[SfdcPartnerTntPkgLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sfdcpartnertntpkglicense.htm)** Represents package license tracking for a tenant package in a Partner Business Org (PBO). Used to track seats, expiration dates, and license statuses from both the Management and Subscriber org for package licenses. This object is available in API version 66.0 and later. - **[ShapeRepresentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shaperepresentation.htm)** Contains information about the shape of an org. The shape of an org includes licenses and limits information. You can easily create scratch orgs based on a source org’s shape. This object is available in API version 50.0 and later. - **[SharingRecordCollection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sharingrecordcollection.htm)** Represents a collection of records. This object is available in API version 51.0 and later. - **[SharingRecordCollectionItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sharingrecordcollectionitem.htm)** Represents a single record in a collection of records. This object is available in API version 51.0 and later. - **[SharingRecordCollectionMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sharingrecordcollectionmember.htm)** Represents a user with access to a collection of records. This object is available in API version 51.0 and later. - **[Shift](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shift.htm)** Represents a shift for service resource scheduling. Available in API versions 46.0 and later. - **[ShiftHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shifthistory.htm)** Represents the history of changes made to tracked fields on a time sheet. Available in API versions 46.0 and later. - **[ShiftOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftownersharingrule.htm)** Represents the rules for sharing a shift with user records other than the owner or anyone above the owner in the role hierarchy. Available in API versions 46.0 and later. - **[ShiftPattern](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftpattern.htm)** Represents a pattern of templates for creating shifts. This object is available in API version 51.0 and later. - **[ShiftPatternEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftpatternentry.htm)** ShiftPatternEntry links a shift template to a shift pattern. This object is available in API version 51.0 and later. - **[ShiftSegment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftsegment.htm)** Represents a scheduled activity within a shift. This object is available in API version 55.0 and later. - **[ShiftSegmentType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftsegmenttype.htm)** Represents a type of activity scheduled within a shift. This object is available in API version 55.0 and later. - **[ShiftShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftshare.htm)** Represents a sharing entry on a field service shift. Available in API versions 46.0 and later. - **[ShiftStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftstatus.htm)** Represents a shift, such as Tentative, Published, or Confirmed. Available in API versions 46.0 and later. - **[ShiftTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shifttemplate.htm)** Represents a template for creating shifts. This object is available in API version 51.0 and later. - **[Shipment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shipment.htm)** Represents the transport of inventory in field service or a shipment of order items in Order Management. - **[ShipmentItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shipmentitem.htm)** Represents an order item included in a shipment. This object is available in API version 51.0 and later. - **[ShippingCarrier](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shippingcarrier.htm)** Shipping company or carrier responsible for transporting goods or packages. Examples include UPS, FedEx, and USPS. This object is available in API version 61.0 and later. - **[ShippingCarrierMethod](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shippingcarriermethod.htm)** Shipping service provided by a shipping carrier. Examples include Ground, 2Day, and NextDay. Service depends on the range of transit times available for each carrier. This object is available in API version 61.0 and later. - **[ShippingConfigurationSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shippingconfigurationset.htm)** Shipping configuration for a set of products in a store. This object is available in API version 59.0 and later. - **[ShippingConfigSetProduct](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shippingconfigsetproduct.htm)** Represents a product associated with a shipping configuration. This object is available in API version 64.0 and later. - **[ShippingRateArea](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shippingratearea.htm)** A designated geographical area that’s available for shipping. This object is available in API version 59.0 and later. - **[ShippingRateGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shippingrategroup.htm)** Available shipping rates based on shipping destination. This object is available in API version 59.0 and later. - **[SignupRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_signuprequest.htm)** Represents a request for a new sign-up. SignupRequest isn’t supported in sandbox instances and will result in an error. This object is available in API version 27.0 and later. - **[Site](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_site.htm)** Represents a public website that is integrated with an org. This object is available in API version 16.0 and later. - **[SiteDetail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sitedetail.htm)** Represents the details of a Salesforce site or Experience Cloud site. Available in API Version 38.0 and later. - **[SiteDomain](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sitedomain.htm)** SiteDomain is a read-only object, and a one-to-many replacement for the Site.TopLevelDomain field. This object is available in API version 21.0, and has been deprecated as of API version 26.0. In API version 26.0 and later, use the [Domain](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domain.htm "Read-only object that represents a custom Web address assigned to a site in your organization. This object is available in API version 26.0 and later.") and [DomainSite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_domainsite.htm "Read-only junction object that joins the Site and Domain objects. This object is available in API version 26.0 and later.") objects instead. - **[SiteEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_siteeventlog.htm)** SiteEventLog stores details of Site.com requests. Requests can originate from the browser (UI). This object is available in API version 62.0 and later. - **[SiteHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sitehistory.htm)** Represents the history of changes to the values in the fields of a site. This object is generally available in API version 18.0 and later. - **[SiteIframeWhitelistUrl](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_siteiframewhitelisturl.htm)** Represents a list of external domains that you allow to frame your Salesforce site or Experience Cloud site pages. This object is available in API version 44.0 and later. - **[SiteRedirectMapping](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_siteredirectmapping.htm)** Represents a site redirect from an external site to an Experience Cloud site. This object is available in API version 52.0 and later. - **[Skill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_skill.htm)** Represents a category or group of Chat users or service resources in Field Service or Workforce Engagement. This object is available in API version 24.0 and later. - **[SkillLevelDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_skillleveldefinition.htm)** Represents a skill which can be acquired by completing enablement site (myTrailhead) modules. This object is available in API version 51.0 and later. - **[SkillLevelProgress](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_skilllevelprogress.htm)** Represents training progress for a given user. This object is available in API version 51.0 and later. - **[SkillProfile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_skillprofile.htm)** Represents a join between Skill and Profile. This object is available in API version 24.0 and later. - **[SkillRequirement](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_skillrequirement.htm)** Represents a skill that is required to complete a particular task in Field Service, Omni-Channel, Salesforce Scheduler, or Workforce Engagement. Skill requirements can be added to pending service routing objects in Omni-Channel. They can be added to work types, work orders, and work order line items in Field Service and Lightning Scheduler. And they can be added to job profiles in Workforce Engagement. This object is available in API version 38.0 and later. You also can add skill requirements to work items in Omni-Channel skills-based routing using API version 42.0 and later. - **[SkillUser](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_skilluser.htm)** Represents a join between Skill and User. This object is available in API version 24.0 and later. - **[SlackChannelRelatedRecord](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_slackchannelrelatedrecord.htm)** Represents the related record mapping between a Slack channel and a Salesforce record that’s made when you create a Salesforce channel. This object is available in API version 65.0 and later. - **[SlaProcess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_slaprocess.htm)** Represents an entitlement process associated with an Entitlement. This object is available in API version 19.0 and later. - **[Snippet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_snippet.htm)** Represents a snippet, which is a container for rich text that can be reused across Account Engagement emails and email templates. This object is available in API version 47.0 and later. - **[SnippetAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_snippetassignment.htm)** Represents a relationship between a snippet and a campaign. Assignments are required to use snippet content in Account Engagement emails and email templates. A snippet can be assigned to more than one campaign. This object is available in API version 47.0 and later. - **[SoapApiEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_soapapieventlog.htm)** SOAP API events contain details about your org's SOAP API request activity. This object is available in API version 61.0 and later. - **[SocialPersona](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_socialpersona.htm)** Represents a snapshot of a contact's profile on a social network such as Facebook or Twitter. This object is available in API version 22.0 and later. - **[SocialPost](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_socialpost.htm)** Represents a snapshot of a post on a social network such as a Facebook or Twitter. This object is available in API version 23.0 and later. - **[Solution](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_solution.htm)** Represents a detailed description of a customer issue and the resolution of that issue. - **[SolutionStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_solutionstatus.htm)** Represents the status of a Solution, such as Draft, Reviewed, and so on. - **[SolutionTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_solutiontag.htm)** Associates a word or short phrase with a Solution. - **[SOSDeployment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sosdeployment.htm)** Represents the general settings for deploying SOS video call capability in a native mobile application. This object is available in API version 34.0 and later. - **[SOSSession](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sossession.htm)** This object is automatically created for each SOS session and stores information about the session. This object is available in API versions 34.0 and later. - **[SOSSessionActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sossessionactivity.htm)** Captures information about specific events that occur during an SOS video call, such as when an SOS call begins or ends. This object is available in API version 34.0 and later. - **[SourceCodeRepoProvider](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sourcecoderepoprovider.htm)** Represents a supported source (version) control system like GitHub or Bitbucket. This object is available in API version 66.0 and later. - **[SourceCodeRepository](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sourcecoderepository.htm)** Represents a specific version control repository hosted by a provider, such as GitHub, that stores the metadata and configuration data for a DevOps Center project. Multiple projects can reference the same repository. This object is available in API version 66.0 and later. - **[SourceCodeRepositoryBranch](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sourcecoderepositorybranch.htm)** Represents a specific branch within a source control repository, such as a feature branch for a work item or a release branch for a pipeline stage. Work Item and Pipeline Stage records refer to this object. This object is available in API version 66.0 and later. - **[StagedEmail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_stagedemail.htm)** For internal use only. - **[StagedInviteeEmail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_stagedinviteeemail.htm)** Represents an email address that is included on a calendar event but that doesn’t match an existing user, contact, or lead record. This object is available in API version 66.0 and later. - **[StagedUnmtchdEmailAddr](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_stagedunmtchdemailaddr.htm)** Represents data about an email address identified by Einstein Activity Capture that doesn’t match to an existing user, contact, or lead record. These addresses are only stored temporarily. Related to StagedUnmtchdEmailAddrRela, which represents data about the email message or calendar event activity associated with an unmatched email. This object is available in API version 66.0 and later. - **[StagedUnmtchdEmailAddrRela](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_stagedunmtchdemailaddrrela.htm)** Represents data about the message or event activity associated with an email address that Einstein Activity Capture can’t match with an existing user, contact, or lead record. Related to StagedUnmtchdEmailAddr, which represents data about the unmatched email address. This object is available in API version 66.0 and later. - **[Stamp](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_stamp.htm)** Represents a User Specialty. This object is available in API version 39.0 and later. - **[StampAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_stampassignment.htm)** Represents assignment of a User Specialty to a user. This object is available in API version 39.0 and later. - **[StandardInvocableActionType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_standardinvocableactiontype.htm)** Represents a collection of fields to set up granular user permissions for access to a standard invocable action in Flow Builder. This object is available in API versions 60.0 to 68.0. - **[StandardShippingRate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_standardshippingrate.htm)** Standard shipping rate for a store. This object is available in API version 59.0 and later. - **[StaticResource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_staticresource.htm)** Represents a static resource that can be used in Visualforce markup. - **[StoreIntegratedService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_storeintegratedservice.htm)** Represents an association between an integration and a store. This object is available in API version 49.0 and later. - **[StreamingChannel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_streamingchannel.htm)** Represents a channel that is the basis for notifying listeners of generic Streaming API events. This object is available in API version 29.0 and later. - **[Salesforce Surveys Object Model](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_salesforce_surveys_object_model.htm)** Learn about how Salesforce Surveys objects relate to one another in Salesforce. - **[Survey](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_survey.htm)** Represents a survey. - **[SurveyEmailBranding](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyemailbranding.htm)** Represents the configuration settings for invitation emails sent to survey participants for a particular survey. - **[SurveyEngagementContext](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyengagementcontext.htm)** Represents the context based on which a survey invitation was sent or a survey response was received. This object is available in API version 49.0 and later. - **[SurveyInvitation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyinvitation.htm)** Represents the invitation sent to a participant to complete the survey. - **[SurveyPage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveypage.htm)** Represents a page, such as the title page or a question page, in a survey. - **[SurveyQuestion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyquestion.htm)** Represents a question in a survey. - **[SurveyQuestionChoice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyquestionchoice.htm)** Represents an answer choice that a participant can select for a survey question. - **[SurveyQuestionResponse](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyquestionresponse.htm)** Represents a participant’s answer to a specific question. - **[SurveyQuestionScore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyquestionscore.htm)** Represents the aggregate of responses for the following question types: date, multiple choice, picklist, radio, ranking, rating, scoring, slider, and [Net Promoter Score® (NPS®)](https://www.salesforce.com/content/dam/web/en_us/www/documents/legal/Agreements/product-specific-terms/net-promoter-and-nps.pdf). - **[SurveyResponse](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyresponse.htm)** Represents information about a participant’s response to a survey, such as the status of the response, the participant’s location, and when the survey was completed. - **[SurveySubject](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveysubject.htm)** Represents a relationship between a survey and another object, such as an account or a case. - **[SurveyVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyversion.htm)** Represents a version of a survey. - **[SurveyVersionAddlInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_surveyversionaddlinfo.htm)** Represents additional information about a survey version. This information defines the default settings of a survey version. This object is available in API version 49.0 and later. - **[SvcCatalogCategory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_svccatalogcategory.htm)** Represents a group of Service Catalog items by functional area. This object is available in API version 58.0 and later. - **[SvcCatalogCategoryItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_svccatalogcategoryitem.htm)** Represents an association between a Service Catalog item and category. Service catalog items can be grouped into categories. This object is available in API version 58.0 and later. - **[SvcCatalogFilterCriteria](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_svccatalogfiltercriteria.htm)** Represents an eligibility rule that determines if a Service Catalog user has access to a catalog item. This object is available in API version 60.0 and later. - **[SvcCatalogItemDef](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_svccatalogitemdef.htm)** Represents a service catalog item that can be requested by a service catalog user. This object is available in API version 53.0 and later. - **[SvcCatalogRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_svccatalogrequest.htm)** Represents a request made by a user using the Service Catalog. Catalog builders use this object to report on Service Catalog activity. This object is available in API version 53.0 and later. - **[SvcCatalogReqRelatedItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_svccatalogreqrelateditem.htm)** Represents an item related to a Service Catalog Request. This object is available in API version 53.0 and later. - **[Swarm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_swarm.htm)** 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. - **[SwarmMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_swarmmember.htm)** Represents a Salesforce member, such as an agent, of a swarm. This object is available in API version 55.0 and later. - **[TabDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tabdefinition.htm)** Represents a custom tab. Returns only the tabs that the current user has access to. This object is available in API version 43.0 and later. - **[TagDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tagdefinition.htm)** Defines the attributes of child Tag objects. - **[Task](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm)** Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities. - **[TaskPriority](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taskpriority.htm)** Represents the importance or urgency of a task, such as High, Normal, or Low. - **[TaskRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taskrelation.htm)** Represents the relationship between a task and a lead, contacts, and other objects related to the task. If Shared Activities is enabled, this object doesn’t support triggers, workflow, or data validation rules. This object is available in API version 24.0 and later. - **[TaskStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taskstatus.htm)** Represents the status of a task, such as Not Started, Completed, or Closed. - **[TaskTag](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tasktag.htm)** Associates a word or short phrase with a task . - **[TaskWhoRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taskwhorelation.htm)** Represents the relationship between a task and a lead or contacts. This object is available in API version 29.0 and later. - **[TaxEngine](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taxengine.htm)** A tax engine represents both an instance of a tax engine provider as well as the merchant credentials for that specific instance. When Subscription Management calculates tax on an order item, it sends a request through Subscription Management Tax Calculation API to an external tax engine. The Salesforce tax engine record contains information passed to the external tax engine, such as This object is available in API version 55.0 and later. - **[TaxEngineInteractionLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taxengineinteractionlog.htm)** A record of a communication with an external tax engine following a tax calculation request. This object is available in API version 55.0 and later. - **[TaxEngineProvider](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taxengineprovider.htm)** Represents general information about a service that manages a tax engine, such as the ID of the tax adapter Apex class in Salesforce, and the engine’s namespace prefix. Tax engine providers have a one-to-many relationship with tax engines, where the tax engine record represents a specific configuration of a tax engine that can be assigned to multiple order items. This object is available in API version 55.0 and later. - **[TaxGeoConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taxgeoconfig.htm)** Represents a tax configuration associated with a GeoCountry. This object is available in API version 57.0 and later. - **[TaxPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taxpolicy.htm)** A tax policy contains a group of tax treatments, where each treatment represents parameters to determine how a particular product is taxed for a transaction line item. Tax policies are related to products, which pass the policy on to the resulting order items. When you activate an order, Subscription Management assigns a tax treatment to each order item based on the tax policy's DefaultTaxTreatmentId, then uses the tax treatment to calculate tax. This object is available in API version 55.0 and later. - **[TaxRate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taxrate.htm)** Represents a tax rate for a tax code and country. This object is available in API version 56.0 and later. - **[TaxTreatment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taxtreatment.htm)** A tax treatment contains details about how Salesforce and external engines calculate taxes, and the tax engine to use for tax calculation. The IsTaxable field determines whether tax is calculated for the product in the transaction. The tax code, tax engine, and product code are sent via API to the external tax calculation service. When you invoice an order item that has a tax treatment, the invoice line inherits the tax treatment from the order item’s related billing schedule. The invoice line’s TaxCode field is populated based on the code that the tax engine used for calculation. This object is available in API version 55.0 and later. - **[TenantConsumptionAlert](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantconsumptionalert.htm)** Stores a record each time a utilization signal is reached for your org's consumption-based products. Each record captures the signal type, the resource that triggered it, and the condition that was met. This object is available in API version 67.0 and later. - **[TenantScrAIPrmptInjection](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantscraiprmptinjection.htm)** Stores generative AI prompt injection data. This object is available in API version 65.0 and later. - **[TenantSecret](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecret.htm)** This object stores an encrypted organization-specific key fragment that’s used with the primary secret (KDF seed) to produce org-specific data encryption keys. This object is available in API version 34.0 and later. - **[TenantSecurityAIGtwyUsage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityaigtwyusage.htm)** Stores Einstein generative AI gateway usage data. This object is available in API version 65.0 and later. - **[TenantSecurityAlertRuleSelectedTenant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityalertruleselectedtenant.htm)** Stores information about a Security Center alert rule for tenants. This object is available for Security Center subscribers in API version 55.0 and later. - **[TenantSecurityAnomaly](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityanomaly.htm)** Stores detected anomalies. This object is available in API version 64.0 and later. - **[TenantSecurityApiAnomaly](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityapianomaly.htm)** Stores detected anomalies in how users typically make API calls. Fore more information, see [Threat Detection](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.real_time_em_threat_detection.htm). This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityCertificate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritycertificate.htm)** Stores metric details related to public key certificate information. The certificate binds the public key to the identity of an entity. This object is available in API version 63.0 and later. - **[TenantSecurityClientApp](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityclientapp.htm)** Stores details about the connected apps and external client apps authorized in a tenant that Security Center monitors. This object is available to Security Center subscribers in API version 68.0 and later. - **[TenantSecurityConnectedApp](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityconnectedapp.htm)** Stores the details for a connected app that was added to or removed from a Security Center tenant. This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityConfigAgent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityconfigagent.htm)** Stores metric details related to implemented Agentforce Agents This object is available in API version 65.0 and later. - **[TenantSecurityCredentialStuffing](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritycredentialstuffing.htm)** Stores when a user successfully logs in to Salesforce during an identified credential stuffing attack. For more information, see [Threat Detection](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.real_time_em_threat_detection.htm). This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityCustomMetricSetup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritycustommetricsetup.htm)** Represents the configuration for a custom metric within Security Center. This object is available in API version 61.0 and later. - **[TenantSecurityCustomMetricDetail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritycustommetricdetail.htm)** Stores TenantSecurityCustomMetricStat drill down details. This object is available in API version 62.0 and later. - **[TenantSecurityCustomMetricStat](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritycustommetricstat.htm)** Represents custom metric data within Security Center. This object is available in API version 61.0 and later. - **[TenantSecurityEncryptedField](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityencryptedfield.htm)** Represents fields encrypted under your Shield Platform Encryption policy. This object is available in API version 61.0 and later. - **[TenantSecurityGuestUserAnomaly](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityguestuseranomaly.htm)** Represents metric details for guest user anomaly events detected by Threat Detection. This object is available in API version 60.0 and later. - **[TenantSecurityEncryptionPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityencryptionpolicy.htm)** Stores tenant encryption policy status. This object is available in API version 58.0 and later. - **[TenantSecurityFeature](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityfeature.htm)** Stores org features across all tenants in Security Center. This object is available in API version 57.0 and later. - **[TenantSecurityHealthCheckBaselineTrend](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityhealthcheckbaselinetrend.htm)** Stores metric details related to Health Check baseline settings. The Health Check detail page in Security Center displays scores and settings for all your tenants in one place. Use this object to get details about which metrics are collected and for which tenants, and changes made to the Health Check baseline. This object is available to Security Center subscribers in API version 54.0 and later. - **[TenantSecurityHealthCheckDetail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityhealthcheckdetail.htm)** Stores the details of Health Check scores for a connected tenant. The Health Check detail page in Security Center displays scores and settings for all your tenants in one place. Use this object to get settings and risks per tenant on a selected date. This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityHealthCheckTrend](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityhealthchecktrend.htm)** Stores the history of Security Health Check scores for a connected tenant within Security Center. Health Check in Security Center displays Health Check scores and the average risk settings for all your tenants in one place. This object belongs to the parent tenant and stores Health Check data pushed from child tenants. This object is available for Security Center subscribers in API version 53.0 and later. - **[TenantSecurityLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritylicense.htm)** Stores license usage information within Security Center. This object is available in API version 59.0 and later. - **[TenantSecurityLogin](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritylogin.htm)** Stores the login details of a single user to a tenant, grouped by date and type. You can query this object to find out how many times the user logged in to a specific tenant using a specific login type (for example, username/password or SSO). This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityLoginIpRangeTrend](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityloginiprangetrend.htm)** Stores details of changes related to login IP ranges in Security Center. This object is available in API version 59.0 and later. - **[TenantSecurityMcpServer](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritymcpserver.htm)** Stores configuration snapshots and risk scores for third-party MCP (Model Context Protocol) servers connected to a tenant that Security Center monitors. This object is available to Security Center subscribers in API version 68.0 and later. - **[TenantSecurityMobilePolicyTrend](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritymobilepolicytrend.htm)** Stores metrics related to changes in mobile security policies across all tenants in Security Center. This object is available to Security Center subscribers in API version 54.0 and later. - **[TenantSecurityMonitorMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritymonitormetric.htm)** Stores the daily count and daily count change for a metric within Security Center. This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityNotification](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritynotification.htm)** Stores information about notifications that were triggered in Security Center as a function of the Alerts feature. For more information, see [Create Alerts for Security Changes](https://help.salesforce.com/s/articleView?id=xcloud.security_center_create_alerts.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 54.0 and later. - **[TenantSecurityNotificationRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritynotificationrule.htm)** Stores an alert configured in the Security Center Alerts feature to notify recipients of changes made to security settings. For more information, see [Create Alerts for Security Changes](https://help.salesforce.com/s/articleView?id=xcloud.security_center_create_alerts.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityMetricDetail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritymetricdetail.htm)** Stores detailed drill-down data for Security Center Health Check metrics. Each record contains dimension values and metric data for a specific metric type. - **[TenantSecurityMetricDetailLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritymetricdetaillink.htm)** Represents the link between the metric count and metric drill down. This object is available in API version 48.0 and later. - **[TenantSecurityPackage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritypackage.htm)** Stores details about managed and unmanaged packages that are added, updated, or removed from a tenant in Security Center. Use this object to identify whether new packages are installed, upgraded, or uninstalled from your connected tenants. This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritypolicy.htm)** Stores security policies created and deployed in Security Center. For more information, see [Define and Deploy Security Policies](https://help.salesforce.com/s/articleView?id=xcloud.security_center_deploy_policies.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 54.0 and later. - **[TenantSecurityPolicyChange](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritypolicychange.htm)** Captures policy lifecycle events, such as creation, modification, and deletion, for the tenants that Security Center monitors. This object is available to Security Center subscribers in API version 68.0 and later. - **[TenantSecurityPolicyChangeLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritypolicychangelog.htm)** Tracks changes to Security Center policy fields. Each record represents a single field change on a policy. - **[TenantSecurityPolicyDeployment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritypolicydeployment.htm)** Stores the status of deployments of a Security Center policy on a tenant. For more information, see [Define and Deploy Security Policies](https://help.salesforce.com/s/articleView?id=xcloud.security_center_deploy_policies.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 54.0 and later. - **[TenantSecurityPolicySelectedTenant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritypolicyselectedtenant.htm)** Stores the list of tenants selected for a Security Center policy. For more information, see [Define and Deploy Security Policies](https://help.salesforce.com/s/articleView?id=xcloud.security_center_deploy_policies.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 54.0 and later. - **[TenantSecurityReportAnomaly](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityreportanomaly.htm)** Stores anomalies in how users run or export reports, including unsaved reports, as detected by Threat Detection. For more information, see [Threat Detection](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.real_time_em_threat_detection.htm). This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityRiskSpec](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityriskspec.htm)** Represents the configuration of a monitored risk type for a tenant in Security Center, including the risk level and the measurement scope. This object is available to Security Center subscribers in API version 68.0 and later. - **[TenantSecuritySessionHijacking](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritysessionhijacking.htm)** Stores information about session hijacking events as detected by Threat Detection within connected tenants in Security Center. For more information, see [Threat Detection](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.real_time_em_threat_detection.htm). This object is available for Security Center subscribers in API version 53.0 and later. - **[TenantSecurityTenantChangeLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritytenantchangelog.htm)** Tracks changes to Security Center tenant fields. Each record represents a single field change on a tenant. - **[TenantSecurityTenantInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritytenantinfo.htm)** Stores information on changes related to the tenant history. This object is available in API version 56.0 and later. - **[TenantSecurityTransactionPolicyTrend](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritytransactionpolicytrend.htm)** Stores changes to the count of Transaction Security Policies for a connected tenant within Security Center. This object is available for Security Center subscribers in API version 55.0 and later. - **[TenantSecurityTrigTransactionSecurityPol](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritytrigtransactionsecuritypol.htm)** Stores metric details related to Transaction Security Policy triggering events. This object is available in API version 63.0 and later. - **[TenantSecurityTrustedIpRangeTrend](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritytrustediprangetrend.htm)** Stores details of changes related to trusted IP ranges in Security Center.This object is available for Security Center subscribers in API version 54.0 and later. - **[TenantSecurityUserActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityuseractivity.htm)** Stores details related to how a user interacts with a tenant. Use this object to determine whether to reevaluate a user’s access to your org for security purposes. You can check whether a user has never logged in, hasn’t been active for 90 days, has a frozen account, or isn’t using multi-factor authentication. This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantSecurityUserPerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecurityuserperm.htm)** Stores information on permissions assigned to a user. Use this object to see which tenants a user is assigned to. This object is available to Security Center subscribers in API version 53.0 and later. - **[TenantUsageEntitlement](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantusageentitlement.htm)** Represents a data structure that contains information about the features or functionalities that a Salesforce org has access to. This object is available in API version 28.0 and later. - **[Territory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory.htm)** Represents a flexible collection of accounts and users where the users have at least read access to the accounts, regardless of who owns the accounts. Available if Sales Territories has been enabled. This object is available in API versions 7.0 to 52.0. Use Territory2 instead of Territory in API version 52.0 and later. - **[TerritoryMgmtObjectConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territorymgmtobjectconfig.htm)** Represents territory management settings and defaults for a particular object. This object is available in API version 56.0 and later. - **[Territory2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory2.htm)** Represents a sales territory. Available if Sales Territories has been enabled. - **[Territory2AlignmentLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory2alignmentlog.htm)** Represents the start and end status of a territory assignment rule run job. This object is available in API version 54.0 and later. - **[Territory2Model](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory2model.htm)** Represents a territory model. Available if Sales Territories has been enabled. - **[Territory2ModelHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory2modelhistory.htm)** Represents the history of changes to the values in the fields on a territory model. Available if Sales Territories has been enabled. - **[Territory2ObjectExclusion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory2objectexclusion.htm)** Represents the objects that aren’t included in territory assignment rule runs, even when they meet assignment rule criteria. This object is available in API version 54.0 and later. - **[Territory2ObjSharingConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory2objsharingconfig.htm)** Represents the sharing access level of objects assigned to a particular territory. This object is available in API version 56.0 and later. - **[Territory2Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory2type.htm)** Represents a category for territories (Territory2). Every Territory2 must have a Territory2Type. Available only if Sales Territories has been enabled for your organization. - **[TerritoryAdminAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territoryadminassignment.htm)** Represents designated team members who can administer specific territories and their descendants. This object is available in API version 63.0 and later. - **[TestSuiteMembership](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_testsuitemembership.htm)** Associates an Apex class with an ApexTestSuite. This object is available in API version 36.0 and later. - **[ThirdPartyAccountLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_thirdpartyaccountlink.htm)** Represents the list of external users who authenticated using an authentication provider. This object is available in API version 32.0 and later. - **[ThreatDetectionFeedback](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_threatdetectionfeedback.htm)** Represents feedback provided by a user about a Threat Detection event that occurred in your org. The feedback specifies whether the event was malicious, suspicious, not a threat, or unknown. Each ThreatDetectionFeedback object is associated with one of these Threat Detection storage events: ApiAnomalyEventStore, CredentialStuffingEventStore, ReportAnomalyEventStore, or SessionHijackingEventStore. This object is available in API version 49.0 and later. - **[TimeSheet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_timesheet.htm)** Represents a schedule of a service resource’s time in Field Service or Workforce Engagement. This object is available in API v47.0 and later. - **[TimeSheetEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_timesheetentry.htm)** Represents a span of time that a service resource spends on a field service task. This object is available in API version 47.0 and later. - **[TimeSlot](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_timeslot.htm)** Represents a period of time on a specified day of the week during which work can be performed in Field Service, Salesforce Scheduler, or Workforce Engagement. Operating hours consist of one or more time slots. This object is available in API version 38.0 and later. - **[TimeSlotHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_timeslothistory.htm)** Represents the history of changes made to tracked fields on a time slot. This object is available in API version 38.0 and later. - **[TodayGoal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_todaygoal.htm)** Sets the quarterly sales goal on the performance chart. This object is available in API version 35.0 and later. - **[Topic](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_topic.htm)** Represents a topic on a Chatter post or record. This object is available in API version 28.0 and later. - **[TopicAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_topicassignment.htm)** Represents the assignment of a topic to a specific feed item, record, or file. This object is available in API version 28.0 and later. - **[TopicLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_topiclocalization.htm)** Represents the translated version of a topic name. Topic localization applies only to navigational and featured topics in Experience Cloud sites. This object is available in API version 33.0 and later. - **[TopicUserEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_topicuserevent.htm)** Represents an action (such as comment, post, like, or share) made by a user on a topic. This object is available in API version 42.0 and later. - **[TopInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_topinsight.htm)** For internal use only. - **[TransactionSecurityPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_transactionsecurity.htm)** Represents a transaction security policy definition. - **[TransactionSecurityEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_transactionsecurityeventlog.htm)** Transaction Security event logs contain details about policy execution. Legacy transaction security policy details are supported in API version 38.0 and later. Enhanced transaction security policy details are supported in API version 61.0 and later. - **[Translation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_translation.htm)** The Translation object represents the languages enabled for translation in your Salesforce org. This object is available in API version 47.0 and later. - **[TravelMode](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_travelmode.htm)** Represents a travel mode used for travel time calculations. The records include information about the type of transportation (such as Car or Walking), whether a vehicle can take toll roads, and whether a vehicle is transporting hazardous materials. This object is available in API version 54.0 and later. - **[TwoFactorInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_twofactorinfo.htm)** Stores a user’s secret for multi-factor operations. Use this object when customizing multi-factor authentication in your organization. (Note that multi-factor authentication was formerly called two-factor authentication.) This object is available in API version 32.0 and later. - **[TwoFactorMethodsInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_twofactormethodsinfo.htm)** Stores information about which identity verification methods a user has registered. This object is available in API version 37.0 and later. - **[TwoFactorTempCode](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_twofactortempcode.htm)** Stores information about a user’s temporary verification code for confirming their identity when logging in. This object is available in API version 37.0 and later. - **[UiAgentInteractionEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_uiagentinteractioneventlog.htm)** This log tracks client side interactions and events with the Agentforce panel. It is limited to Salesforce Lightning Experience, Salesforce Mobile, and Conversation Preview within Agentforce Builder. This object is available in API version 65.0 and later. - **[UiFormulaCriterion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_uiformulacriterion.htm)** Represents a filter that helps define component visibility on a Lightning page. This object is available in API version 47.0 and later. - **[UiFormulaRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_uiformularule.htm)** Represents a set of one or more filters that define the conditions under which a component displays on a Lightning page. This object is available in API version 47.0 and later. - **[UiTelemetryNavTmEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_uitelemetrynavtmeventlog.htm)** UI Telemetry Navigation Timing events capture network performance metrics related to page navigation. The event extends from the UI Telemetry Resource Timing Event and includes requests initiated with either the [Fetch API](https://fetch.spec.whatwg.org/) or the [XMLHttpRequest API](https://xhr.spec.whatwg.org/). This object is available in API version 64.0 and later. - **[UiTelemetryRsrcTmEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_uitelemetryrsrctmeventlog.htm)** UI Telemetry Resource Timing events capture network performance metrics related to loading an application’s resources. The event includes requests initiated with either the [Fetch API](https://fetch.spec.whatwg.org/) or the [XMLHttpRequest API](https://xhr.spec.whatwg.org/). This object is available in API version 64.0 and later. - **[UndecidedEventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_undecidedeventrelation.htm)** Represents event participants (invitees or attendees) with the status Not Responded for a given event. This object is available in API versions 29.0 and later. - **[UnifiedActivity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedactivity.htm)** Represents an activity that is automatically captured from Einstein Activity Capture (EAC) or other activity data, such as calls, manually logged tasks, and emails. This object consists of fields common to all types of activity-related objects such as Event, Task, EmailMessage, VoiceCall, VideoCall, and so on. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedActivityInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedactivityinsight.htm)** Represents an insight related to a unified activity. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedActivityParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedactivityparticipant.htm)** Represents a participant in an activity. For example, a participant in a voice call is someone who initiated the call or someone who received the call. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedActivityRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedactivityrelation.htm)** Represents a relationship between an activity and a related record that’s a target or topic of the activity. For example, a related record can be an opportunity, account, and so on. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedActvtyInsightKeyword](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedactvtyinsightkeyword.htm)** Represents a keyword in a communication that triggered the activity insight. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedEmail](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedemail.htm)** Represents an email that was captured or synced from an EmailMessage or Task record. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedEmailParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedemailparticipant.htm)** Represents a participant in an email. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedMeeting](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedmeeting.htm)** Represents a meeting that was captured or synced from an Event record. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedMeetingParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedmeetingparticipant.htm)** Represents a participant in a meeting. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedTask](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedtask.htm)** Represents a business activity such as a to-do item. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedTaskParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedtaskparticipant.htm)** Represents a participant in a task. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedVideoCall](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedvideocall.htm)** Represents a video call that is captured or synced from the VideoCall or Task record. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedVideoCallParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedvideocallparticipant.htm)** Represents a participant in a video call. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedVoiceCall](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedvoicecall.htm)** Represents a voice call that is captured or synced from a VoiceCall or Task record. Available for reports and dashboards in API version 59.0 and later. - **[UnifiedVoiceCallParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unifiedvoicecallparticipant.htm)** Represents a participant in a voice call. Available for reports and dashboards in API version 59.0 and later. - **[UnitOfMeasure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_unitofmeasure.htm)** Defines the units and systems of units used to express and account for quantities. This object is available in API version 61.0 and later. - **[UriEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_urieventlog.htm)** URI events contain details about user interaction with the web browser UI. This object is available in API version 61.0 and later. - **[UsageImpactFactor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usageimpactfactor.htm)** Represents a collection of fields to set up the Usage Impact Factors used across jurisdictions and programs.This object is available in API version 58.0 and later. - **[UsageImpactGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usageimpactgroup.htm)** Represents a collection of fields to set up the Usage Impact Groups used across jurisdictions and programs. This object is available in API version 58.0 and later. - **[UsageImpactGroupFactor](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usageimpactgroupfactor.htm)** Represents a junction between an Usage Impact Group version and Usage Impact Factor. This object is available in API version 58.0 and later. - **[UsageImpactGroupPgmMeasure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usageimpactgrouppgmmeasure.htm)** Represents a junction between the program, product, and Usage Impact Group version. This object is available in API version 58.0 and later. - **[UsageImpactGroupVersion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usageimpactgroupversion.htm)** Represents a collection of fields to set up the versions of Usage Impact Groups. This object is available in API version 58.0 and later. - **[User](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_user.htm)** Represents a user in your organization. - **[UserAccessChange](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_useraccesschange.htm)** Represents a change related to user access. This object is available in API version 57.0 and later. - **[UserAccessPolicy](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_useraccesspolicy.htm)** Represents a user access policy. This object is available in API version 57.0 and later. - **[UserAccountTeamMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_useraccountteammember.htm)** Represents a User on the default account team of another User. - **[UserAppInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userappinfo.htm)** Stores the last Lightning app logged in to. If the user hasn’t logged into Salesforce or if the user lost access to the last accessed app, the UserAppInfo object stores a Null value. This object is available in API version 38.0 and later. - **[UserAppMenuCustomization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userappmenucustomization.htm)** Represents an individual user’s settings for items in the app menu or App Launcher. This object is available in API version 35.0 and later. - **[UserAppMenuItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userappmenuitem.htm)** Represents the organization-wide settings for items in the app menu or App Launcher that the requesting user has access to in Setup. This object is available in API version 35.0 and later. - **[UserAuthCertificate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userauthcertificate.htm)** Represents a user authentication certificate in your org. A user certificate is a unique PEM-encoded X.509 digital certificate to authenticate individual users to your org. This object is available in API version 45.0 and later. - **[UserConfigTransferButton](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userconfigtransferbutton.htm)** Represents the association between a Chat configuration and a live chat button. This association allows users associated with a specific configuration to transfer chats to a button queue. - **[UserConfigTransferSkill](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userconfigtransferskill.htm)** Represents the association between a Chat configuration and a skill. This association allows users associated with a specific configuration to transfer chats to agents who have that skill. - **[UserCustomBadge](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usercustombadge.htm)** Represents a custom badge for a user. This object is available in API version 38.0 and later. - **[UserCustomBadgeLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usercustombadgelocalization.htm)** Represents the translated version of a custom badge for a user. This object is available in API version 38.0 and later. - **[UserDailyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userdailymetric.htm)** Represents the daily engagement metrics for a user. This object is available in API version 52.0 and later. - **[UserDailyMetricOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userdailymetricownersharingrule.htm)** Represents the rules for sharing the user daily metric with users other than the owner. - **[UserDefinedLabel](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userdefinedlabel.htm)** Represents a label created by a user to help organize, track, and find records. This object is available in API version 61.0 and later. - **[UserDefinedLabelAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userdefinedlabelassignment.htm)** Represents a relationship between a record label and the item the user assigned it to. This object is available in API version 61.0 and later. - **[UserDevice](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userdevice.htm)** Represents information unique to a device. Available in API version 43.0 and later. - **[UserDeviceApplication](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userdeviceapplication.htm)** Represents information on applications installed on a device that is accessing Salesforce. Available in API version 43.0 and later. - **[UserDeviceHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userdevicehistory.htm)** Represents tracking information on the UserDevice sObject. This object is available in API version 50.0 and later. - **[UserEmailCalendarSync](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_useremailcalendarsync.htm)** Represents the user assignments of an Einstein Activity Capture configuration. This object is available in API version 49.0 and later. - **[UserEmailPreferredPerson](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_useremailpreferredperson.htm)** Represents a mapping for a user’s preferred record for an email address when multiple records match an email field.This object is available in API version 44.0 and later. - **[UserEmailPreferredPersonShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_useremailpreferredpersonshare.htm)** Represents a sharing entry on a UserEmailPreferredPerson object. Sharing is not customizable for UserEmailPreferredPerson records.This object is available in API version 44.0 and later. - **[UserLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlicense.htm)** Represents a user license in your organization. A user license entitles a user to specific functionality and determines the profiles and permission sets available to the user. - **[UserListView](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlistview.htm)** Represents the customizations a user made to a list view. This object is available in API version 32.0 and later. - **[UserListViewCriterion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlistviewcriterion.htm)** Represents the criterion for a user’s customized list view. The criterion consists of the filters or sort order a user added to a list view for the Salesforce Mobile app. This object is available in API version 32.0 and later. - **[UserLocationAssignment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlocationassignment.htm)** Represents the assignment between a location and a user. This object is available in API version 57.0 and later. - **[UserLogin](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlogin.htm)** Represents the settings that affect a user’s ability to log into an organization. To access this object, you need the UserPermissions.ManageUsers permission. This object is available in API version 29.0 and later. - **[UserMembershipSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usermembershiprule.htm)** Represents the rules for sharing user records from a source group to a target group. A user record contains details about a user. Users who are members of the source group can be shared with members of the target group. The source and target groups can be based on roles, portal roles, public groups, or territories. This object is available in API version 26.0 and later. - **[UserMonthlyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usermonthlymetric.htm)** Represents the monthly engagement metrics for a user. This object is available in API version 52.0 and later. - **[UserMonthlyMetricOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usermonthlymetricownersharingrule.htm)** Represents the rules for sharing the user monthly metric with users other than the owner. - **[UserPackageLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userpackagelicense.htm)** Represents a license for an installed managed package, assigned to a specific user. This object is available in API version 31.0 and later. - **[UserPermissionAccess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userpermissionaccess.htm)** Represents the permissions accessibility for a current user. Available in API version 41.0 and later. - **[UserPrioritizedRecord](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userprioritizedrecord.htm)** Represents records that Pipeline Inspection, Account Intelligence, Contact Intelligence, and Lead Intelligence users flag as important for tracking in pipeline and intelligence views and filters. This object is available in API version 53.0 and later. - **[UserPreference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userpreference.htm)** Represents a functional preference for a specific user in your organization. - **[UserProfile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userprofile.htm)** Represents a Chatter user profile. - **[UserProvAccount](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userprovaccount.htm)** Represents information that links a Salesforce user account with an account in a third-party (target) system, such as Google, for users of connected apps with Salesforce user provisioning enabled. This object is available in API version 33.0 and later. - **[UserProvAccountStaging](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userprovaccountstaging.htm)** Temporarily stores user account information while a user completes the User Provisioning Wizard. This information that is stored in the UserProvAccount object when you click the button to collect and analyze accounts on the target system. - **[UserProvMockTarget](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userprovmocktarget.htm)** Represents an entity for testing user data before committing the data to a third-party system for user provisioning. - **[UserProvisioningConfig](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userprovisioningconfig.htm)** Represents information for a flow to use during a user provisioning request process, such as the attributes for an update. This object is available in API version 34.0 and later. - **[UserProvisioningLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userprovisioninglog.htm)** Represents messages generated during the process of provisioning users for third-party applications. This object is available in API version 33.0 and later. - **[UserProvisioningRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userprovisioningrequest.htm)** Represents an individual provisioning request to create, update, or delete a single user account in a third-party service system (or another Salesforce organization). This object is available in API version 33.0 and later. - **[UserRecordAccess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userrecordaccess.htm)** Represents a user’s access to a set of records. This object is read only and is available in API version 24.0 and later. This object doesn’t consider whether a user’s access is blocked by a restriction rule. - **[UserRelatedRecordContent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userrelatedrecordcontent.htm)** Represents the link between a managed content record, an account, event, or opportunity record, and a user record. This object is reserved for future use. - **[UserRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_role.htm)** Represents a user role in your organization. - **[UserServicePresence](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userservicepresence.htm)** Represents a presence user’s real-time presence status. This object is available in API version 32.0 and later. - **[UserSetupEntityAccess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usersetupentityaccess.htm)** Represents the enabled custom permissions of the running user. This object is available in API version 48.0 and later. - **[UserShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usershare.htm)** Represents a sharing entry on a user record. This object is available in API version 26.0 and later. - **[UserSharedFeature](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usersharedfeature.htm)** For internal use only. - **[UserTeamMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userteammember.htm)** Represents a single User on the default opportunity team of another User. - **[UserTerritory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userterritory.htm)** Represents a User who has been assigned to a Territory. - **[UniqueQueryEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_uniquequeryeventlog.htm)** Unique Query events capture specific search queries (SOQL), filter IDs, and report IDs that are processed, along with the underlying database queries (SQL). This object is available in API version 65.0 and later. - **[UserTerritory2Association](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userterritory2association.htm)** Represents an association (by assignment) between a territory and a user record. Available only if Sales Territories has been enabled. - **[UserTerritory2AssocLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userterritory2assoclog.htm)** Represents a log of when a user is assigned and unassigned from a territory. This object is available in API version 57.0 and later. - **[UserUIPreference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_useruipreference.htm)** Represents user preferences for Salesforce components. This object is available in API version 63.0 and later. - **[UserWorkList](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userworklist.htm)** Represents a list of work items in the My List tab for Sales Engagement users. - **[UserWorkListItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userworklistitem.htm)** Represents an individual work item in the My List tab for Sales Engagement users. - **[VendorCallCenterStatusMap](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_vendorcallcenterstatusmap.htm)** Stores a mapping between a call center vendor agent status and a Salesforce presence status for an associated call center. This object is available in API version 54.0 and later. - **[VerificationHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_verificationhistory.htm)** Represents the past six months of your org users’ attempts to verify their identity. This object is available in API version 36.0 and later. - **[VisualforceAccessMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_visualforceaccessmetrics.htm)** Represents summary statistics for Visualforce pages. - **[VisualforceRequestEventLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_visualforcerequesteventlog.htm)** Visualforce Request events contain details of Visualforce requests. Requests can originate from the browser (UI). This object is available in API version 61.0 and later. - **[VideoCall](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocall.htm)** Represents a video call. One VideoCall record can be related to several VideoCallRecording records — for example, a video call can have several video recordings and a transcript. As well, one video call record can be associated with several video call participant records. This object is available in API version 51.0 and later. - **[VideoCallInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallinsight.htm)** Represents the video call insight data associated with a video call. Each record represents the call insight of a specific recording or transcript within a call. This object is available in API version 66.0 and later. - **[VideoCallInsightAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallinsightaction.htm)** Represents a suggested follow-up action derived from a video call insight. VideoCallInsightAction manages recommended steps—such as sending an email, creating a task, or scheduling a meeting—that address specific moments, including competitor mentions, pricing discussions, or objections. This object is available in API version 66.0 and later. - **[VideoCallInsightReason](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallinsightreason.htm)** Represents the video call insight reason that contains the insight keyword, insight moments associated with a keyword, and the number of keyword occurrences. This object is available in API version 66.0 and later. - **[VideoCallParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallparticipant.htm)** Represents a participant in a video call. Participant information can come from the video call provider (for example, Zoom), or Salesforce. This object is available in API version 51.0 and later. - **[VideoCallRecording](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallrecording.htm)** Represents a recording from a video call, such as a video recording, a voice recording, or a transcript. Video call recordings aren’t saved in Salesforce. This object is available in API version 51.0 and later. - **[VideoCallRecordingStructure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallrecordingstructure.htm)** Represents the structure of a video call recording, having relation to a video call participant, speaking order, start offset, and end offset. This object is available in API version 66.0 and later. - **[VideoCallTranscript](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocalltranscript.htm)** Represents the complete transcript text and metadata of a recorded video call. This object is available in API version 66.0 and later. - **[VoiceCall](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecall.htm)** Represents a call in Salesforce Voice, Sales Dialer, or other supported voice connectors. For Salesforce Voice, this can be a phone or Voice over Internet Protocol (VoIP) call. This object is available in API version 40.0 and later. - **[VoiceCallInsight](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecallinsight.htm)** Represents the voice call insight data associated with a voice call. Each record represents the call insight of a specific recording or transcript within a call. This object is available in API version 66.0 and later. - **[VoiceCallInsightAction](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecallinsightaction.htm)** Represents a suggested follow-up action derived from a voice call insight. VoiceCallInsightAction manages recommended steps—such as sending an email, creating a task, or scheduling a meeting—that address specific moments, including competitor mentions, pricing discussions, or objections. This object is available in API version 66.0 and later. - **[VoiceCallInsightReason](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecallinsightreason.htm)** Represents the voice call insight reason that contains the insight keyword, insight moments associated with a keyword, and the number of keyword occurrences. This object is available in API version 66.0 and later. - **[VoiceCallMetrics](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecallmetrics.htm)** Represents metrics for a VoiceCall lifecycle event, aggregated daily. This object is available in API version 56.0 and later. - **[VoiceCallList](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecalllist.htm)** Represents a prioritized list of numbers to call. - **[VoiceCallListItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecalllistitem.htm)** Represents a single phone number in a prioritized call list. - **[VoiceCallQualityFeedback](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecallqualityfeedback.htm)** Represents feedback given by a Sales Dialer user about the quality of a [VoiceCall](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecall.htm "Represents a call in Salesforce Voice, Sales Dialer, or other supported voice connectors. For Salesforce Voice, this can be a phone or Voice over Internet Protocol (VoIP) call. This object is available in API version 40.0 and later.") . - **[VoiceCallRecording](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecallrecording.htm)** Represents a call recording in Salesforce Voice and Sales Dialer. Call recordings for Salesforce Voice with Amazon Connect and for Salesforce Voice with Partner Telephony from Amazon Connect are stored in S3 buckets on your Amazon Web Services (AWS) account and can be accessed via AWS. Call recordings for Sales Dialer are saved as files in Salesforce. - **[VoiceCallRecordingStructure](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecallrecordingstructure.htm)** Represents the structure of a voice call recording, which includes voice call participants, speaking order, start offset, and end offset. This object is available in API version 66.0 and later. - **[VoiceCallSessionData](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecallsessiondata.htm)** Represents a record that stores SIP session metadata for a voice call. Use this object to access SIP header values from inbound calls in flows for Agentforce Voice and to configure disconnect behavior for escalations and call terminations. This object is available in API version 67.0 and later. - **[VoiceCoaching](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecoaching.htm)** Represents a call that is using call monitoring. - **[VoiceLocalPresenceNumber](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicelocalpresencenumber.htm)** Represents a phone number with the same area code as the person who’s being called. - **[VoiceMailContent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicemailcontent.htm)** Represents a voicemail message left by a caller to the context user. - **[VoiceMailGreeting](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicemailgreeting.htm)** Represents a custom greeting message that plays upon reaching a user’s voicemail. This object is available in API version 41.0 and later. - **[VoiceMailGreeting2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicemailgreeting2.htm)** Represents information about a voicemail message that reps can drop during outbound customer calls, or set to play when they're unable to take calls from customers. This object is available in API version 67.0 and later. - **[VoiceMailGreeting2Rep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicemailgreeting2rep.htm)** Represents information about the voicemail message and its associated service rep. This object is available in API version 67.0 and later. - **[VoiceMailMessage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicemailmessage.htm)** Represents a prerecorded voicemail message. - **[VoiceOrgSetting](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voiceorgsetting.htm)** Represents the org's customized voice settings. This object is available in API version 46.0 and later. - **[VoiceUserLine](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voiceuserline.htm)** Represents a user’s forwarding phone number. - **[VoiceUserPreferences](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voiceuserpreferences.htm)** Represents the number the user displays when making outbound calls. This object is available in API version 41.0 and later. - **[VoiceVendorInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicevendorinfo.htm)** Represents information about the Salesforce Voice or Sales Dialer provider’s vendor. - **[VoiceVendorLine](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicevendorline.htm)** Represents a user’s phone number reserved with the vendor. - **[Vote](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_vote.htm)** Represents a vote that a user has made on a Knowledge Article, Idea, or Reply. - **[WarrantyTerm](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_warrantyterm.htm)** Represents warranty terms defining the labor, parts, and expenses covered, along with any exchange options, provided to rectify issues with products. This object is available in API version 50.0 and later. - **[WaveAutoInstallRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_waveautoinstallrequest.htm)** Provides access to the concrete object that represents a CRM Analytics auto-install request. The auto-install request tracks the progress of CRM Analytics applications created from CRM Analytics templates by the automated process user. This object is available in API version 38.0 and later. - **[WebCart](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcart.htm)** Represents an online shopping cart for a store built with B2B Commerce or D2C Commerce, with total amounts for products, shipping and handling, and taxes. This object is available in API version 49.0 and later. - **[WebCartAdjustmentBasis](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcartadjustmentbasis.htm)** Coupons that trigger promotions for the cart. When a customer tries to add a coupon to the cart, the store looks for promotions associated with the coupon. If a promotion results in a price adjustment, a WebCartAdjusmentBasis record is created. This object is available in API version 54.0 and later. - **[WebCartAdjustmentGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcartadjustmentgroup.htm)** Group of price adjustments for a cart. This object is available in API version 52.0 and later. - **[WebCartHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcarthistory.htm)** WebCartHistory represents the history of changes to the values in the fields of the WebCart object. - **[WebLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_weblink.htm)** Represents a custom link to a URL or Scontrol. - **[WebLinkLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_weblinklocalization.htm)** Represents the translated value of the field label for a custom link to a URL or s-control when the Translation Workbench is enabled for your organization. - **[WebStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstore.htm)** Represents a B2B or D2C store. This object is available in API version 49.0 and later. - **[WebstoreBuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstorebuyergroup.htm)** Associates a webstore with a buyer group. Supports dynamically changing locales when buyers shop in orgs that are enabled for multiple languages and currencies. This object is available in API version 58.0 and later. - **[WebStoreCatalog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstorecatalog.htm)** Represents the collection of products associated with a store. This object is available in API version 49.0 and later. - **[WebStoreInventorySource](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstoreinventorysource.htm)** Used to configure the inventory source for a webstore. This object is available in API version 57.0 and later. - **[WebStoreMessageContent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstoremessagecontent.htm)** Represents the assocation of a managed content message record in CMS to a web store, along with other attributes that specify the application and intent of the message content. This object is available in API version 61.0 and later. - **[WebStoreNetwork](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstorenetwork.htm)** Represents the relationship between a web store and an experience site. This object is available in API version 49.0 and later. - **[WebStorePricebook](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstorepricebook.htm)** Represents a store price book used in Lightning B2B Commerce. This object is available in API version 48.0 and later. - **[WebStoreSearchProdSettings](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstoresearchprodsettings.htm)** Search settings for a WebStore product search. This object is available in API version 47.0 and later. - **[WebStoreShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstoreshare.htm)** Represents a sharing entry on a B2B or D2C store. This object is available in API version 45.0 and later. - **[Wishlist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_wishlist.htm)** Represents a buyer-created list of [WishlistItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_wishlistitem.htm "Represents an item on a Wishlist in a store built with B2B Commerce for Lightning. Available in API version 49.0 and later.")s in a store that’s built with B2B Commerce on Lightning. Available in API version 49.0 and later. - **[WishlistItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_wishlistitem.htm)** Represents an item on a Wishlist in a store built with B2B Commerce for Lightning. Available in API version 49.0 and later. - **[WorkAccess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workaccess.htm)** Used to grant or restrict user access to give badge definitions. Each badge definition record must have one WorkAccess record. - **[WorkAccessShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workaccessshare.htm)** Used to control Givers of WorkBadgeDefinition records. - **[WorkBadge](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workbadge.htm)** Represents information about who the badge was given to and which badge was given. A WorkBadge record is created for each recipient of a WorkBadgeDefinition. - **[WorkBadgeDefinition](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workbadgedefinition.htm)** Represents the attributes of a badge including the badge name, description, and image. Each WorkBadge record must have a lookup to a WorkBadgeDefinition since badge attributes (like badge name) are derived from the WorkBadgeDefinition object. - **[WorkCapacityAvailability](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workcapacityavailability.htm)** Represents the available work capacity for a specific time and service territory. This object is available in API version 59.0 and later. - **[WorkCapacityLimit](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workcapacitylimit.htm)** Represents the capacity limit in a specific service territory for a workstream or for the whole service territory in a given period. This object is available in API version 59.0 and later. - **[WorkCapacityUsage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workcapacityusage.htm)** Represents the capacity usage in a specific service territory for a workstream or for the whole service territory in a given period. This object is available in API version 59.0 and later. - **[WorkCoaching](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workcoaching.htm)** Represents a single coaching relationship between two users. One of the users is defined as the coach and the other is defined as a coachee. WorkCoaching is feed-enabled so there is a private feed available to the coach and coachee. - **[WorkDemographic](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workdemographic.htm)** Represents the field values used to specify slices in the workload forecasting and capacity planning. This object is available in API version 49.0 and later. - **[WorkFeedback](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workfeedback.htm)** Represents the answer to a question that a person was asked via a feedback request. Also used to store offered feedback without linking it to a particular question. - **[WorkFeedbackQuestion](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workfeedbackquestion.htm)** Represents a free-form text type or multiple choice question within a set of questions. - **[WorkFeedbackQuestionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workfeedbackquestionset.htm)** Represents a set of questions being asked. The question set is used to link all the individual requests where different recipients were asked the same set of questions on the same subject. - **[WorkFeedbackRequest](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workfeedbackrequest.htm)** Represents a single feedback request on a subject or topic (question) to a single recipient in the feedback application. In the case of offered feedback, WorkFeedbackRequest represents feedback that is offered about a subject. In the performance application, WorkFeedbackRequest represents a request for feedback on a set of questions from a question set, on a subject—for the recipient to complete and submit. - **[WorkforceCapacity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workforcecapacity.htm)** Represents the time series for actual or forecasted workforce allocation. This object is available in API version 51.0 and later. - **[WorkforceCapacityUnit](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workforcecapacityunit.htm)** Represents the number of resources allocated or needed for a specific set of work items at a timestamp within a specific duration. This object is available in API version 51.0 and later. - **[WorkGoal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workgoal.htm)** Represents the components of a goal, such as its description and associated metrics. This object has been deprecated as of API version 35.0. Use the [Goal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_goal.htm#sforce_api_objects_Goal "The Goal object represents the components of a goal such as its name, description, and status.") object to query information about WDC goals. - **[WorkGoalCollaborator](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workgoalcollaborator.htm)** Represents collaborators on a WorkGoal object. This doesn’t include WorkGoal followers, which is handled by Chatter Feed Follow functionality. This object has been deprecated as of API version 35.0. Use the [Goal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_goal.htm#sforce_api_objects_Goal "The Goal object represents the components of a goal such as its name, description, and status.") object to query information about WDC goals. - **[WorkGoalCollaboratorHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workgoalcollaboratorhistory.htm)** Represents the history of changes to the values in the fields in a WorkGoalCollaborator object. Access is read-only. - **[WorkGoalHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workgoalhistory.htm)** Represents the history of changes to the values in the fields of a WorkGoal. Access is read-only. This object has been deprecated as of API version 35.0. Use the GoalHistory object to query historical information for WDC goals. - **[WorkGoalLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workgoallink.htm)** Represents the relationship between two goals (many to many relationship). This object has been deprecated as of API version 35.0. Use the [GoalLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_goallink.htm#sforce_api_objects_GoalLink "Represents the relationship between two goals. This is a many-to-many relationship, meaning that each goal can link to many other goals.") object to query information about the relationship between two WDC goals. - **[WorkGoalShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workgoalshare.htm)** Represents a sharing entry on a WorkGoal object. This object has been deprecated as of API version 35.0. Use the GoalShare object to query information about sharing for WDC goals. - **[WorkItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workitem.htm)** Represents a logical unit of work, such as a user story, task, or bug, used to track the progress of metadata and configuration data changes within a Lifecycle Center project. A work item moves through multiple development lifecycle stages until all development work is complete and the work item is part of the release pipeline. This object is available in API version 67.0 and later. - **[WorkItemComponent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workitemcomponent.htm)** Represents a metadata component or configuration data record that’s linked to a WorkItemComponentList record in a Lifecycle Center project. The record includes details such as the change type, metadata member, and change tracking information. This object is available in API version 67.0 and later. - **[WorkItemEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workitemevent.htm)** Represents real-time notifications for work item status changes in a Lifecycle Center project. This object is available in API version 66.0 and later. - **[Workload](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workload.htm)** Represents the time series for work item volume and average handle time from aggregation and forecasting processes. This object is available in API version 49.0 and later. - **[WorkloadUnit](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workloadunit.htm)** Represents the number of work items and average handle time in a specific time interval. This object is available in API version 49.0 and later. - **[WorkOrder](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workorder.htm)** Represents field service work to be performed for a customer. This object is available in API version 36.0 and later. - **[WorkOrderHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workorderhistory.htm)** Represents the history of changes made to tracked fields on a work order. This object is available in API version 36.0 and later. - **[WorkOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workorderlineitem.htm)** Represents a subtask on a work order in field service. This object is available in API version 36.0 and later. - **[WorkOrderLineItemHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workorderlineitemhistory.htm)** Represents the history of changes made to tracked fields on a work order line item. This object is available in API version 36.0 and later. - **[WorkOrderLineItemStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workorderlineitemstatus.htm)** Represents a possible status of a work order line item in field service. - **[WorkOrderShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workordershare.htm)** Represents a sharing entry on a work order. This object is available in API version 36.0 and later. - **[WorkOrderStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workorderstatus.htm)** Represents a possible status of a work order in field service. - **[WorkPerformanceCycle](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workperformancecycle.htm)** Represents feedback that is gathered to assess the performance of a specific set of employees. - **[WorkPlan](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workplan.htm)** Represents a work plan for a work order or work order line item. This object is available in API version 52.0 and later. - **[WorkPlanSelectionRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workplanselectionrule.htm)** Represents a rule that selects a work plan for a work order or work order line item. This object is available in API version 52.0 and later. - **[WorkPlanTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workplantemplate.htm)** Represents a template for a work plan. This object is available in API version 52.0 and later. - **[WorkPlanTemplateEntry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workplantemplateentry.htm)** Represents an object that associates a work step template with a work plan template. This object is available in API version 52.0 and later. - **[WorkReward](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workreward.htm)** Used to store reward codes tied to a Reward Fund. Reward Funds must have at least one WorkReward record. - **[WorkRewardFund](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workrewardfund.htm)** Represents a Reward Fund and describes the Reward Fund attributes. - **[WorkRewardFundType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workrewardfundtype.htm)** Represents the type of WorkRewardFund object. - **[WorkStep](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workstep.htm)** Represents a work step in a work plan. This object is available in API version 52.0 and later. - **[WorkStepStatus](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workstepstatus.htm)** Represents a picklist for a status category on a work step. This object is available in API version 52.0 and later. - **[WorkStepTemplate](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_worksteptemplate.htm)** Represents a template for a work step. This object is available in API version 52.0 and later. - **[WorkThanks](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workthanks.htm)** Represents the source and message of a thanks post. - **[WorkType](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_worktype.htm)** Represents a type of work to be performed in Field Service and Lightning Scheduler. Work types are templates that can be applied to work order or work order line items. This object is available in API version 38.0 and later. - **[WorkTypeGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_worktypegroup.htm)** Represents a grouping of work types used to categorize types of appointments available in Lightning Scheduler, or to define scheduling limits in Field Service. This object is available in API version 45.0 and later. - **[WorkTypeGroupMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_worktypegroupmember.htm)** Represents the relationship between a work type and the work type group it belongs to. This object is available in API version 45.0 and later. # StandardInvocableActionType Represents a collection of fields to set up granular user permissions for access to a standard invocable action in Flow Builder. This object is available in API versions 60.0 to 68.0. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Marketing Cloud Growth edition and the Manage Flow user permission or View Flows user permission are required. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The developer name and namespace combination of the invocable action. This combination must be unique. | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language code of the invocable action. For a full list of supported languages and their codes, see [Supported Languages](https://help.salesforce.com/s/articleView?id=xcloud.faq_getstart_what_languages_does.htm&type=5&language=en_US). This field is available in API version 60.0 and later. | | MasterLabel | Type string Properties Filter, Group, Sort Description The label for the invocable action. This display value is the internal label that doesn’t get translated. This field is available in API version 60.0 and later. | | Namespace | Type string Properties Filter, Group, Nillable, Sort Description The namespace of the invocable action. Enter a value only if you’re using the invocable action in Flow Builder or with Apex. | # StandardObjectName ChangeEvent A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events. ## Supported Calls describeSObjects() ## Special Access Rules - All objects may not be available in your org. Some objects require specific feature settings and permissions to be enabled. - For more special access rules, if any, see the documentation for the standard object. For example, for AccountChangeEvent, see the special access rules for Account. ## Change Event Support Change events are available for all custom objects and a subset of standard objects. Change events that correspond to custom settings are partially supported. They aren't supported in Apex triggers but are supported in other types of subscribers. For more information about standard object support, see the Objects That Support Change Events section below. ## Change Event Name The name of a change event is based on the name of the corresponding object for which it captures the changes. - **Standard Object Change Event Name**: ChangeEvent Example: AccountChangeEvent - **Custom Object Change Event Name**: \_\_ChangeEvent Example: MyCustomObject\_\_ChangeEvent ## Change Event Fields The fields that a change event can include correspond to the fields on the associated parent Salesforce object, with a few exceptions. For example, AccountChangeEvent fields correspond to the fields on Account. The fields that a change event doesn’t include are: - The IsDeleted system field. - The SystemModStamp system field. - Any field whose value isn’t on the record and is derived from another record or from a formula, except roll-up summary fields, which are included. Examples are formula fields. Examples of fields with derived values include LastActivityDate and PhotoUrl. Each change event also contains header fields. The header fields are included inside the ChangeEventHeader field. They contain information about the event, such as whether the change was an update or delete and the name of the object, like Account. In addition to the event payload, the event schema ID is included in the schema field. Also included is the event-specific field, replayId, which is used for retrieving past events. ## Event Message Example This example is an event message in JSON format for a new account record creation. { "schema": "IeRuaY6cbI\_HsV8Rv1Mc5g", "payload": { "ChangeEventHeader": { "entityName": "Account", "recordIds": \[ "" \], "changeType": "CREATE", "changeOrigin": "com/salesforce/api/soap/51.0;client=SfdcInternalAPI/", "transactionKey": "0002343d-9d90-e395-ed20-cf416ba652ad", "sequenceNumber": 1, "commitTimestamp": 1612912679000, "commitNumber": 10716283339728, "commitUser": "" }, "Name": "Acme", "Description": "Everyone is talking about the cloud. But what does it mean?", "OwnerId": "", "CreatedDate": "2021-02-09T23:17:59Z", "CreatedById": "", "LastModifiedDate": "2021-02-09T23:17:59Z", "LastModifiedById": "" }, "event": { "replayId": 6 } } ## API Version and Schema When you subscribe to change events, the subscription uses the latest API version and the event messages received reflect the latest field definitions. For more information, see [API Version and Event Schema](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_message_structure.htm#cdc_event_schema.htm) in the Change Data Capture Developer Guide. ## Usage For more information about Change Data Capture, see [Change Data Capture Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_intro.htm). ## Objects That Support Change Events These objects have associated ChangeEvent objects. - Account (including Person Account) - AccountCleanInfo - AccountContactRelation - AccountContactRole - AccountPlan - AccountTeamMember - ActionCadence - ActionCadenceStep - ActionCadenceStepTracker - ActionCadenceTracker - AdOrderLineAdTarget - AdProductTargetCategory - AdQuoteLineAdTarget - AdTargetCategory - AdTargetCategorySegment - AgentWork - AgentWorkSkill - AppExtension - Asset - AssetWarranty - AssetRelationship - AssignedResource - AssociatedLocation - AuthorizationForm - AuthorizationFormConsent - AuthorizationFormDataUse - AuthorizationFormText - Automotive Cloud. Some objects are supported. See [StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.automotive_cloud.meta/automotive_cloud/sforce_api_associated_objects_change_event.htm) in the Automotive Cloud Developer Guide. - BriefcaseAssignment - BriefcaseDefinition - BroadcastTopicNetwork - BusinessBrand - CalendarView - CallTemplate - Campaign - CampaignMember - CampaignMemberStatus - CartDeliveryGroup - CartItem - CartItemPriceAdjustment - CartTax - CartValidationOutput - Case - CaseRelatedIssue - ChangeRequest - ChangeRequestRelatedIssue - ChangeRequestRelatedItem - CollaborationGroupRecord - CollabTemplateMetric - CommerceEntitlementBuyerGroup - CommerceEntitlementPolicy - CommerceEntitlementProduct - CommSubscription - CommSubscriptionChannelType - CommSubscriptionConsent - CommSubscriptionTiming - ConferenceNumber - Consumer Goods Cloud. Some objects are supported. See [StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_associated_objects_change_event.htm) in the Consumer Goods Cloud Developer Guide. - Contact - ContactCleanInfo - ContentDocument - ContentDocumentLink - ContentFolder - ContactPointAddress - ContactPointConsent - ContactPointEmail - ContactPointPhone - ContactPointTypeConsent - ContentVersion - Contract - ContractLineItem - Conversation Reason objects: ConversationContextEntry, ConversationReason, ConversationReasonExcerpt, and ConversationReasonGroup. See [Einstein Conversation Insights](https://help.salesforce.com/s/articleView?id=sales.call_coaching.htm&type=5&language=en_US) in Salesforce Help. - Coupon - CustomFieldDisplayValue - DataUseLegalBasis - DataUsePurpose - DigitalSignature - DocProcReview - DynamicDataCapture - EmailMessage - EmailTemplate - EngagementAttendee - EngagementChannelType - EngagementInteraction - EngagementTopic - Entitlement - Event - EventRelation - Expense - ExternalClientAppSettings - ExternalEvent - FieldServiceMobileSettings - Financial Services Cloud. Some objects are supported. See [StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_change_event.htm) in the Financial Services Cloud Developer Guide. - FlowRecord - FlowRecordElement - FlowRecordVersion - FlowOrchestration - FlowOrchestrationVersion - ForecastingOwnerAdjustment - FulfillmentOrderItemTax - Health Cloud. Some objects are supported. See [StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm) in the Salesforce Health Cloud Developer Guide. - Incident Related Item - Individual - LandingPage - Lead - LinkedArticle - ListEmail - LiveAgentSession - LiveChatTranscript - LiveChatTranscriptEvent - LiveChatVisitor - Location - LocationGroup - LocationGroupAssignment - Loyalty Management. Some objects are supported. See [StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.loyalty.meta/loyalty/sforce_api_associated_objects_change_event.htm) in the Loyalty Management Developer Guide. - Macro - MacroInstruction - MaintenanceAsset - MaintenancePlan - ManagedContent - Manufacturing Cloud. Some objects are supported. See [StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm) in the Manufacturing Cloud Developer Guide. - MarketingForm - MarketingLink - MarketSegmentActivation - MerchantAccount - MessagingEndUser - MessagingSession - Mortgage loan applicant and application objects. See [Mortgage Lending Objects Supported by Out-of-the-Box Components and Pages in Experience Builder Templates](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_admin_guide.meta/financial_services_cloud_admin_guide/fsc_admin_mort_community_supported_objects.htm "HTML (New Window)") in the Financial Services Cloud Administrator Guide. - Net Zero Cloud. Some objects are supported. See [StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.netzero_cloud_dev_guide.meta/netzero_cloud_dev_guide/sforce_api_associated_objects_change_event.htm) in the Net Zero Cloud Developer Guide. - Nonprofit Cloud. Some objects are supported. See [StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_associated_objects_change_event.htm) in the Nonprofit Cloud Developer Guide. - ObjectDataImport - ObjectRelatedUrl - OperatingHours - Opportunity - OpportunityContactRole - OpportunityLineItem - OpportunitySplit - Order - OrderAdjustmentGroupSummary - OrderDeliveryGroupSummary - OrderDeliveryMethod - OrderItem - OrderItemSummary - OrderItemSummaryChange - OrderItemTaxLineItemSummary - OrderPaymentSummary - OrderSummary - PartyConsent - PaymentPage - PendingServiceRouting - Pricebook2 - PricebookEntry - ProblemIncident - ProblemRelatedItem - ProcessException - ProcessInstance - ProcessInstanceStep - Product2 - ProductCategory - ProductConsumed - ProductFeaturedProduct - ProductItem - ProductMedia - ProductRequest - ProductRequestLineItem - ProductTransfer - ProductWarrantyTerm - ProfileSkillEndorsement - Public Sector Solutions. Some objects are supported. See [StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.psc_api.meta/psc_api/sforce_api_associated_objects_change_event.htm "HTML (New Window)") in the Public Sector Solutions Developer Guide. - QuickText - QuickTextUsage - Quote - QuoteLineItem - Recommendation - RecordAggregationResult - RecordSetFilterCriteria - RecordSetFilterCriteriaRule - ResourceAbsence - ResourcePreference - ReturnOrder - ReturnOrderItemAdjustment - ReturnOrderItemTax - ReturnOrderLineItem - SalesChannel - ServiceAppointment - ServiceContract - ServiceCrew - ServiceCrewMember - ServiceResource - ServiceResourceCapacity - ServiceResourceSkill - ServiceReport - ServiceReportLayout - ServiceTerritory - ServiceTerritoryLocation - ServiceTerritoryMember - Shift - ShiftPattern - ShiftPatternEntry - Shipment - SkillRequirement - SocialPost - Survey - SurveyInvitation - SurveyPage - SurveyQuestion - SurveyQuestionChoice - SurveyQuestionResponse - SurveyResponse - SurveySubject - SurveyVersion - TenantEntitlementTransaction - TenantSecurityAlertRuleSelectedTenant - TenantSecurityApiAnomaly - TenantSecurityConnectedApp - TenantSecurityCredentialStuffing - TenantSecurityFeature - TenantSecurityHealthCheckBaselineTrend - TenantSecurityHealthCheckData - TenantSecurityHealthCheckTrend - TenantSecurityTenantInfo - TenantSecurityLicense - TenantSecurityLogin - TenantSecurityLoginIpRangeTrend - TenantSecurityMobilePolicyTrend - TenantSecurityMonitorMetric - TenantSecurityNotification - TenantSecurityNotificationRule - TenantSecurityPackage - TenantSecurityPolicy - TenantSecurityPolicyDeployment - TenantSecurityPolicySelectedTenant - TenantSecurityReportAnomaly - TenantSecuritySessionHijacking - TenantSecurityTransactionPolicyTrend - TenantSecurityTrustedIpRangeTrend - TenantSecurityUserAcitivity - TenantSecurityUserPerm - TenantUsageTypeMultiplier - Territory2AlignmentLog - Territory2Model - TimeSheet - TimeSheetEntry - TimeSlot - Task - TodayGoal - TaskRelation - User (including partner users) - UserAppInfo - UserEmailPreferredPerson - UserServicePresence - VideoCall - VideoCallParticipant - VideoCallRecording - VoiceCall - VoiceCallRecording - WarrantyTerm - WaveAutoInstallRequest - WebCart - WebCartAdjustmentBasis - WebCartAdjustmentGroup - WorkAccess - WorkBadge - WorkBadgeDefinition - WorkCapacityLimit - WorkPlan - WebStore - WebStoreBuyerGroup - WebStoreSearchProdSettings - WorkOrder - WorkOrderLineItem - WorkThanks - WorkType # StandardObjectName Feed _StandardObjectName_Feed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object. The object name is variable and uses _StandardObjectName_Feed syntax. For example, AccountFeed represents the posts and feed-tracked changes on an account record. We list the available associated feed objects at the end of this topic. For specific version information, see the documentation for the standard object. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules In the internal org, users can delete all feed items they created. This rule varies in Experience Cloud sites where threaded discussions and delete-blocking are enabled. Site members can delete all feed items they created, provided the feed items don’t have content nested under them—like a comment, answer, or reply. Where the feed item has nested content, only feed moderators and users with the Modify All Data permission can delete threads. To delete feed items they didn’t create, users must have one of these permissions: - Modify All Data - Modify All Records on the parent object, like Account for AccountFeed - Moderate Chatter Users with the Moderate Chatter permission can delete only the feed items and comments they can see. Only users with this permission can delete items in unlisted groups. For more special access rules, if any, see the documentation for the standard object. For example, for AccountFeed, see the special access rules for Account. ## Fields ### BestCommentId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the comment marked as best answer on a question post. This field is available in API version 44.0 and later. ### Body - **Type**: textarea - **Properties**: Nillable, Sort - **Description**: The body of the post. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. ### CommentCount - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The number of comments associated with this feed item. In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say that you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, comments aren’t counted until approved by an admin or someone with Can Approve Feed Post and Comment or Modify All Data. Feed moderation has implications on how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until the end of comments is returned. ### ConnectionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization. ### ContentData - **Type**: base64 - **Properties**: Nillable - **Description**: Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost. Only visible when Type is set to ContentPost. ### ContentDescription - **Type**: textarea - **Properties**: Nillable, Sort - **Description**: Available in API version 36.0 and earlier only. The description of the file specified in ContentData. Only visible when Type is set to ContentPost. ### ContentFileName - **Type**: string - **Properties**: Group, Nillable, Sort - **Description**: Available in API version 36.0 and earlier only. This field is required if Type is ContentPost.The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost. Only visible when Type is set to ContentPost. ### ContentSize - **Type**: int - **Properties**: Group, Nillable, Sort - **Description**: Available in API version 36.0 and earlier. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert. Only visible when Type is set to ContentPost. ### ContentType - **Type**: string - **Properties**: Group, Nillable, Sort - **Description**: Available in API version 36.0 and earlier. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert. Only visible when Type is set to ContentPost. ### FeedPostId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only. ID of the associated FeedPost. A FeedPost represents the following types of changes in a feed item: changes to tracked fields, text posts, link posts, and content posts. ### InsertedById - **Type**: reference - **Properties**: Group, Nillable, Sort - **Description**: ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user. ### IsRichText - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the feed item Body contains rich text. If you post a rich text feed comment using SOAP API, set IsRichText to true and escape HTML entities from the body. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: -

Though the
tag isn’t supported, you can use

 

to create lines. - - - - - - -
    -
      -
    1. - The tag is accessible only through the API and must reference files in Salesforce similar to this example: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. ### LikeCount - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The number of likes associated with this feed item. ### LinkUrl - **Type**: url - **Properties**: Nillable, Sort - **Description**: The URL of a LinkPost. ### NetworkScope - **Type**: picklist - **Properties**: Group, Nillable, Restricted picklist, Sort - **Description**: Specifies whether this feed item is available in the default Experience Cloud site, a specific Experience Cloud site, or all sites. This field is available in API version 26.0 and later, if digital experiences is enabled for your org. NetworkScope can have the following values: - NetworkId—The ID of the Experience Cloud site in which the FeedItem is available. If left empty, the feed item is only available in the default Experience Cloud site. - AllNetworks—The feed item is available in all Experience Cloud sites. Note the following exceptions for NetworkScope: - Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. - For feed items with a record parent, users can set NetworkScope only to AllNetworks. - You can’t filter a feed item on the NetworkScope field. ### ParentId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the record that is tracked in the feed. The detail page for the record displays the feed. ### RelatedRecordId - **Type**: reference - **Properties**: Group, Nillable, Sort - **Description**: ID of the ContentVersion record associated with a ContentPost. This field is null for all posts except ContentPost. ### Title - **Type**: string - **Properties**: Group, Nillable, Sort - **Description**: The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name. ### Type - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The type of feed item: - ActivityEvent—indirectly generated event when a user or the API adds a [Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_task.htm) associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or [Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_event.htm) associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. - AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. - AnnouncementPost—Not used. - ApprovalPost—generated when a user submits an approval. - BasicTemplateFeedItem—Not used. - CanvasPost—a post made by a canvas app posted on a feed. - CollaborationGroupCreated—generated when a user creates a public group. - CollaborationGroupUnarchived—Not used. - ContentPost—a post with an attached file. - CreatedRecordEvent—generated when a user creates a record from the publisher. - DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. - DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. - LinkPost—a post with an attached URL. - PollPost—a poll posted on a feed. - ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. - QuestionPost—generated when a user posts a question. - ReplyPost—generated when Chatter Answers posts a reply. - RypplePost—generated when a user creates a Thanks badge in WDC. - TextPost—a direct text entry on a feed. - TrackedChange—a change or group of changes to a tracked field. - UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: - CaseCommentPost—generated event when a user adds a case comment for a case object - EmailMessageEvent—generated event when an email related to a case object is sent or received - CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. - ChangeStatusPost—generated event when a user changes the status of a case - AttachArticleEvent—generated event when a user attaches an article to a case If you set Type to ContentPost, also specify ContentData and ContentFileName. ### Visibility - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if digitial experiences is enabled for your organization. Visibility can have the following values: - AllUsers—The feed item is available to all users who have permission to see the feed item. - InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: - For record posts, Visibility is set to InternalUsers for all internal users by default. - External users can set Visibility only to AllUsers. - On user and group posts, only internal users can set Visibility to InternalUsers. ## Usage A feed for an object is automatically created when a user enables feed tracking for the object. Use feeds to track changes to records. For example, AccountFeed tracks changes to an account record. Use feed objects to retrieve the content of feed fields, such as type of feed or feed ID. - NewsFeed and UserProfileFeed are available in API version 18.0 through API version 26.0. In API version 27.0 and later, NewsFeed and UserProfileFeed are no longer available in SOAP API. Use Connect REST API to access NewsFeed and UserProfileFeed. Use the NewsFeed object to query and retrieve lead feed items associated with a converted lead record. - For NewsFeed and UserProfileFeed, users who don’t have the View All Data permission have the following limitations when querying records: Must specify a LIMIT clause and the limit must be less than or equal to 1000. Can include a WHERE clause that references object fields, but can‘t include references to fields in related objects. For example, you can filter by CreatedDate or ParentId, but not by Parent.Name. Can include an ORDER BY clause that references object fields, but can’t include references to fields in related objects. For example, ORDER BY CreatedDate or ParentId, but not by Parent.Name. To query for the most recent feed items, ORDER BY CreatedDate DESC, Id DESC. Note the following SOQL restrictions. No SOQL limit if logged-in user has View All Data permission. If not, specify a LIMIT clause of 1,000 records or fewer. SOQL ORDER BY on fields using relationships isn’t available. Use ORDER BY on fields on the root object in the SOQL query. - The name Article Type\_\_Feed is variable, where _Article Type_ is the object name for the article type associated with the article. For example, Offer\_\_Feed represents a feed on an article of type _Offer_. - Field Service must be enabled in your organization for ServiceAppointmentFeed, ServiceCrewFeed, ServiceMemberFeed, ServiceResourceCapacityFeed, ServiceResourceFeed, ServiceResourceSkillFeed, ServiceTerritoryFeed, ServiceTerritoryMemberFeed, and SkillRequirementFeed. - For WorkOrderFeed, Work Orders or Field Service must be enabled in your organization. - On UserFeed, if you use the FeedComment object to comment on a user record, the user can delete the comment. For example, if John Smith adds a comment to the feed on Sasha Jones’ user record, Sasha can delete the comment. # StandardObjectName History _StandardObjectName_History 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. The object name is variable and uses _StandardObjectName_History syntax. For example, AccountHistory represents the history of changes to the values of an account record’s fields. We list the available associated history objects at the end of this topic. For specific version information, see the documentation for the standard object. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules For specific special access rules, if any, see the documentation for the standard object. For example, for AccountHistory, see the special access rules for Account. ## Fields ### _StandardObjectName_Id - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the standard object. ### DataType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Data type of the field that was changed. ### Field - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Name of the field that was changed. ### NewValue - **Type**: anyType - **Properties**: Nillable, Sort - **Description**: New value of the field that was changed. ### OldValue - **Type**: anyType - **Properties**: Nillable, Sort - **Description**: Old value of the field that was changed. # StandardObjectName OwnerSharingRule _StandardObjectName_OwnerSharingRule 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. The object name is variable and uses _StandardObjectName_OwnerSharingRule syntax. For example, ChannelProgramOwnerSharingRule is a rule for sharing a channel program with users other than the channel program owner. The available associated owner sharing rule objects are listed at the end of this topic. For specific version information, see the standard object documentation. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object, contact Salesforce customer support. But we recommend that you use Metadata API to programmatically update owner sharing rules instead because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules For specific special access rules, if any, see the documentation for the standard object. For example, for ChannelProgramOwnerSharingRule, see the special access rules for ChannelProgram. ## Fields ### AccessLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Determines the level of access users have to records. - **Possible values**: - Read (read only) - Edit (read/write) ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of the sharing rule. Maximum length is 1,000 characters. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance can slow while Salesforce generates one for each record. ### GroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the source group. Records that are owned by users in the source group trigger the rule to give access. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Label of the sharing rule as it appears in the UI. Maximum length is 80 characters. ### UserOrGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the user or group that you're granting access to. # StandardObjectName Share _StandardObjectName_Share is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object. The object name is variable and uses _StandardObjectName_Share syntax. For example, AccountBrandShare is a sharing entry on an account brand. For specific version information, see the standard object documentation. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules For specific special access rules, if any, see the documentation for the standard object. For example, for AccountBrandShare, see the special access rules for AccountBrand. ## Fields ### AccessLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The level of access allowed. - **Possible values**: - All (owner) - Edit (read/write) - Read (read only) ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the parent record. ### RowCause - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Reason that the sharing entry exists. ### UserOrGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the user or group that has been given access to the object. # StandardShippingRate Standard shipping rate for a store. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The StandardShippingRate object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | ConditionFactor | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Conditions that affect the shipping rate. Possible values are: - OrderPriceFactor—Condition based on the order price value. - OrderWeightFactor—Condition based on delivery weight. This value is available in API version 62.0 and later. | | ConditionRangeMax | Type double Properties Create, Filter, Nillable, Sort, Update Description Maximum value of the shipping rate condition. | | ConditionRangeMin | Type double Properties Create, Filter, Nillable, Sort, Update Description Minimum value of the shipping rate condition. This value can't be negative. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Currency ISO code of the cart. Possible values are: - EUR—Euro - USD—U.S. Dollar The default value is USD. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the standard shipping rate. | | Price | Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Price of standard shipping. | | ShippingCarrierMethodId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the shipping service carrier method. This field is available in API version 61.0 and later. This field is a relationship field. Relationship Name ShippingCarrierMethod Relationship Type Lookup Refers To ShippingCarrierMethod | | ShippingZoneId | Type reference Properties Create, Filter, Group, Sort Description ID of the shipping zone. This field is a relationship field. Relationship Name ShippingZone Relationship Type Parent-detail Refers To ShippingRateArea (the master object) | | TransitTimeMax | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Maximum value of the shipping transit time. This field is available in API version 61.0 and later. | | TransitTimeMin | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Minimum value of the shipping transit time. This value can't be negative. This field is available in API version 61.0 and later. | | TransitTimeUnit | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Unit of value for shipping transit time. This field is available in API version 61.0 and later. Possible values are: - Days - Hours - Weeks | | WeightUnit | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Unit of measurement for the weight of the cart items. This field is available in API version 62.0 and later. Possible values are: - Grams - Kilograms - Ounces - Pounds | # StaticResource Represents a static resource that can be used in Visualforce markup. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Body | Type base64 Properties Create, Nillable, Update Description Required. Encoded file data. | | BodyLength | Type int Properties Filter, Group, Sort Description Size of the file (in bytes). | | CacheControl | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The sharing policy for the static resource when cached. The cache control can have one of these values: - Private specifies that the static resource is accessible to all authenticated users. The static resource is stored on the Salesforce server in a user’s individual cache for the duration of the session. - Public specifies that the static resource is accessible after caching to all internet traffic, including unauthenticated users. The resource is stored on the Salesforce server in a shared cache, which results in faster load times. | | ContentType | Type string Properties Create, Filter, Group, Sort, Update Description Type of content. Label is **Mime Type**. Limit: 120 characters. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the static resource. Limit: 255 characters. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the static resource. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. This field can’t be accessed unless the logged-in user has the Customize Application permission. | ## Usage Use static resources to upload content that you can reference in Visualforce markup, including archives (such as .zip and .jar files), images, stylesheets, JavaScript, and other files. Using a static resource is preferable to uploading a file to the Documents tab because: - You can package a collection of related files into a directory hierarchy and upload that hierarchy as a .zip or .jar archive. - You can reference a static resource in page markup by name using the $Resource global variable instead of hard-coding document IDs. ## Encoded Data The API sends and receives the binary file data encoded as a base64 data type. Prior to creating a record, clients must encode the binary file data as base64. Upon receiving an API response, clients must decode the base64 data to binary. The SOAP client usually handles this conversion. ## Maximum Static Resource Size You can create or update static resources to a maximum size of 5 MB. An organization can have up to 250 MB of static resources, total. #### See Also - [ApexComponent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexcomponent.htm "Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as and .") - [ApexPage](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexpage.htm "Represents a single Visualforce page.") - [_Developer Guide_: Visualforce Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.pages.meta/pages/ " Developer Guide: Visualforce Developer Guide - html (New Window)") # StoreIntegratedService Represents an association between an integration and a store. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The StoreIntegratedService object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | Integration | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The integration ID. Possible values are: - If the integration is a RegisteredExternalService: - The ID of the RegisteredExternalService OR - \[ServiceProviderType\]\_\_\[DeveloperName\] - ServiceProviderType: Price, Inventory, Tax, or Shipment - DeveloperName of RegisteredExternalService - If the integration is a PaymentGateway: - The ID of the PaymentGateway - If the integration is a Flow: - \[ServiceProviderType\]\_\_\[NamespacePrefix\]\_\_\[ApiName\] - If NamespacePrefix is null, it’s \[ServiceProviderType\]\_\_\[ApiName\] - ServiceProviderType: Flow - ApiName and NamespacePrefix of FlowDefinitionView - If the integration is the Salesforce Standard pricing: - \[ServiceProviderType\]\_\_B2B\_STOREFRONT\_\_StandardPricing - ServiceProviderType: Price | | ServiceProviderType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The type of integration service provider. Possible values are: - Flow - Inventory - Payment - Price - Promotions (this value is available in API version 53.0 and later) - Shipment - Tax | | StoreId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The unique ID for the store. | # StreamingChannel Represents a channel that is the basis for notifying listeners of generic Streaming API events. This object is available in API version 29.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules - This object is available only if Streaming API is enabled for your org. - Users with the Create permission can create this record. - You can create a permission set and grant users read and create access to all streaming channels in the org. This access isn’t for a specific channel, like with user sharing. - You can apply user sharing to StreamingChannel. You can restrict access to receiving or sending events on a channel by sharing channels with specific users or groups. Channels shared with public read-only or read-write access send events only to clients subscribed to the channel that also are using a user session associated with the set of shared users or groups. Only users with read-write access to a shared channel can generate events on the channel, or modify the actual StreamingChannel record. ## Fields | Field | Details | | --- | --- | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the StreamingChannel. Limit: 255 characters. **Label:** Description | | IsDynamic | Type boolean Properties Defaulted on create, Filter, Group, Sort Description true if the channel gets dynamically created on subscribe if necessary, false otherwise. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Descriptive name of the streaming channel. Limit: 80 characters, alphanumeric and “\_”, “/” characters only. Must start with “/u/”. This value identifies the channel and must be unique. **Label:** Streaming Channel Name | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the streaming channel. **Label:** Owner Name This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Dynamic Streaming Channel Streaming API generic streaming supports dynamic streaming channel creation, which creates a StreamingChannel when a client first subscribes to the channel. To enable dynamic streaming channels in your org, from Setup, enter User Interface in the Quick Find box, then select **User Interface**. Enable **Enable Dynamic Streaming Channel Creation**. You can also enable dynamic channel creation in Metadata API using EventSettings. #### See Also - [_Streaming API Developer Guide_](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_streaming.meta/api_streaming/intro_stream.htm " Streaming API Developer Guide - HTML (New Window)") # Survey Represents a survey. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the Survey object using the Object Manager. ## Fields | Field Name | Details | | --- | --- | | ActiveVersionID | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the survey version currently activated. | | Description | Type string Properties Nillable Description The description of the survey. This field isn’t visible in the UI. | | DeveloperName | Type string Properties Filter, Group, Sort Description The survey’s unique API name. | | IsPartialSaveEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether to save the partial responses for the survey (true) or not (false). The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the current user last viewed a record related to the survey. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed the survey. | | LatestVersionId | Type reference Properties Filter, Group, Sort Description The ID of the most recent version of this survey. | | Name | Type string Properties Filter, Group, Sort Description The name of the survey that appears in the UI. This field is read-only from API version 50.0. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user who created the survey. | | SurveyType | Type string Properties Filter, Group, Nillable, Sort Description Type of the survey. The default value is Survey. Possible values are: - ASSESSMENT — Survey type for sales enablement teams. Available from API version 58.0 and later. - BASIC — Survey with a question page with like or dislike, long text, multiple selection, NPS, rating, short text, and single selection questions, and without inserted participant responses, display logic, and page branching logic. - SURVEY — Survey with all the available features. | | TotalVersionsCount | Type int Properties Filter, Group, Nillable, Sort Description The number of versions of the survey. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [SurveyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [SurveyFeed](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.") (API version 42.0) Feed tracking is available for the object. [SurveyOwnerSharingRule](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. [SurveyShare](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. # SurveyEmailBranding Represents the configuration settings for invitation emails sent to survey participants for a particular survey. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the SurveyEmailBranding object using the Object Manager. ## Fields | Field Name | Details | | --- | --- | | Body | Type textarea Properties Create, Update Description The body text of the invitation email. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique API name of the email branding configuration. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | FooterImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the content asset that appears in the footer of the invitation email. | | FromEmailAddress | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address that appears in the “From” field when the invitation is sent to participants. | | HeaderImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the content asset that appears in the header of the invitation email. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the emails. Available languages include: - Chinese (Simplified) - Chinese (Traditional) - Danish - Dutch - English - Finnish - French - German - Italian - Japanese - Korean - Norwegian - Portuguese (Brazilian) - Russian - Spanish - Spanish (Mexican) - Swedish - Thai | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for these email configuration settings. | | Subject | Type string Properties Create, Filter, Group, Sort, Update Description The subject of the invitation email. | # SurveyEngagementContext Represents the context based on which a survey invitation was sent or a survey response was received. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the SurveyEngagementContext object using the Object Manager. ## Fields | Field | Details | | --- | --- | | ContextType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Context type based on which the survey invitation was sent or the response was received. | | ContextValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Context based on which the survey invitation was sent or the response was received. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the record's owner. | | SurveyInvitationId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the survey invitation. | | SurveyResponseId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the survey response. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [SurveyEngagementContextShare](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. # SurveyInvitation Represents the invitation sent to a participant to complete the survey. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | CommunityId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the Experience Cloud site that you want to send the survey to. | | ContactId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the contact who received the invitation. This field is available in API v49.0 and later. | | EmailBrandingId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the survey email branding object that’s associated with this invitation. | | InvitationLink | Type url Properties Group, Nillable Description The URL to the survey that is sent to participants. To query on this field, you need access to the associated Survey record. | | InviteExpiryDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that the survey invitation expires. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether this is the default survey invitation to use when the survey is sent to participants. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this survey invitation. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this survey invitation. | | LeadId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the lead who received the invitation. This field is available in API v49.0 and later. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the survey invitation that appears in the UI. | | OptionsAllowGuestUserResponse | Type boolean Properties Create, Filter, Update Description Determines whether participants who don’t have a Salesforce account can complete the survey. | | OptionsAllowParticipantAccessTheirResponse | Type boolean Properties Create, Filter, Update Description Determines whether participants can access a copy of their responses after they complete the survey. | | OptionsCollectAnonymousResponse | Type boolean Properties Create, Filter, Update Description Determines whether participants can complete the survey anonymously. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who created the survey invitation. | | ParticipantId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the participant if the participant is a Salesforce contact, user, or lead. | | ResponseStatus | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of a participant’s response to the survey that’s associated with the survey invitation. Possible values include: - NotStarted — For an invitation with a ParticipantID, it means that the recipient hasn’t opened the survey. For an invitation without the ParticipantID, it means that none of the recipients have opened the survey. - Started — For an invitation with a ParticipantID, it means that the recipient opened the survey. For an invitation without the ParticipantID, it means that the survey has been opened by at least one recipient. - Paused — For an invitation with a ParticipantID, it means that the recipient has paused the survey. For an invitation without the ParticipantID, it means that the survey has been paused by any one of the recipients. Paused isn't available for invitations in which either OptionsAllowParticipantAccessTheirResponse or OptionsCollectAnonymousResponse is true. - PartiallyCompleted— For an invitation with a ParticipantID field, it means that the recipient has partially completed the survey. For an invitation without the ParticipantID field, it means that at least one recipient has partially completed the survey. Available in API version 63.0 and later. - Completed — For an invitation with a ParticipantID, it means that the recipient has submitted the survey. For an invitation without the ParticipantID, it means that the invitation has been submitted by at least one recipient. | | SurveyId | Type reference Properties Create, Filter, Group, Sort Description ID of the survey that’s sent in the invitation. | | UUID | Type string Properties Filter, Group, Nillable, Sort Description A unique user ID that's added to a survey invitation generated for a contact, lead,or user. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user who received the invitation. This field is available in API v49.0 and later. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [SurveyInvitationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [SurveyInvitationOwnerSharingRule](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. [SurveyInvitationShare](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. # SurveyPage Represents a page, such as the title page or a question page, in a survey. ## Supported Calls getDeleted(), getUpdated(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the SurveyPage object using the Object Manager. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique API name of this SurveyPage object. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the survey page that appears in the UI. | | SurveyVersionId | Type reference Properties Filter, Group, Sort Description The version of the survey that the page belongs to. | ## 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. [SurveyPageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # SurveyQuestion Represents a question in a survey. ## Supported Calls describeLayout()describeSObjects()getDeleted(), getUpdated(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the SurveyQuestion object using the Object Manager. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The API name of the SurveyQuestion. The API name must be unique within a particular version of the survey. | | IsDeprecated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the question was deleted from the survey. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Up to the first 250 characters of the label for the question. | | PageDisplayOrder | Type int Properties Filter, Group, Nillable, Sort Description The order in which the page is displayed. This field is available in API version 54.0 and later. | | PageName | Type string Properties Filter, Group, Nillable, Sort Description The label for the page. This field is available in API version 52.0 and later. | | QuestionChoiceCount | Type int Properties Filter, Group, Nillable, Sort Description The number of choices for the question. This field is available in API version 62.0 and later. | | QuestionName | Type textarea Properties Nillable Description The label for the question. | | QuestionOrder | Type int Properties Filter, Group, Nillable, Sort Description The order in which the question is displayed. The label for the page. This field is available in API version 52.0 and later. | | QuestionType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of question. Possible values include: - Boolean—This value is available in API v49.0 and later. - CSAT - Currency - Date - DateTime - FreeText - Image - Matrix—This value is available in API v55.0 and later. - MultipleChoice - MultiSelectPicklist - NPS - Number - Picklist - RadioButton - StackRank - Rating - ShortText—This value is available in API v49.0 and later. - Slider - Toggle | | RelatedQuestionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the parent question. This field is blank when the question itself is the parent question. This field is available in API v55.0 and later, with Feedback Management - Starter and Feedback Management - Growth licenses. | | SubQuestionDisplayOrder | Type int Properties Filter, Group, Nillable, Sort Description The order in which the question is displayed within the parent question. This field is available in API v55.0 and later, with Feedback Management - Starter and Feedback Management - Growth licenses. | | SurveyPageId | Type reference Properties Filter, Group, Sort Description Lookup to the SurveyPage that contains the question. | | SurveyVersionId | Type reference Properties Filter, Group, Sort Description The ID of the SurveyVersion that the question belongs to. | | ValidationType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The validations available for the short-text question. Possible values include: - Custom - Cu - Number - Nu | ## 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. [SurveyQuestionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # SurveyQuestionChoice Represents an answer choice that a participant can select for a survey question. ## Supported Calls describeLayout(), getDeleted(), getUpdated(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the SurveyQuestionChoice object using the Object Manager. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique API name of the SurveyQuestionChoice object. | | DisplayOrder | Type int Properties Filter, Group, Nillable, Sort Description The order in which the question choice is displayed within the parent question. This field is available in API v55.0 and later, with Feedback Management - Starter and Feedback Management - Growth licenses. | | IsDeprecated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a question choice was deleted from the survey. | | Name | Type string Properties Filter, Group, idLookup, Sort Description A label for the question choice that appears in the UI. | | QuestionId | Type reference Properties Filter, Group, Sort Description The ID of the SurveyQuestion object that this choice belongs to. | | SurveyVersionId | Type reference Properties Filter, Group, Nillable, Sort Description The version of the survey that this question choice belongs to. | ## 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. [SurveyQuestionChoiceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # SurveyQuestionResponse Represents a participant’s answer to a specific question. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the SurveyQuestionResponse object using the Object Manager. ## Fields | Field | Details | | --- | --- | | ChoiceValue | Type textarea Properties Filter, Nillable, Sort Description Response provided by a participant for the following question types: - Multiple choice - Picklist - Radio - Ranking | | Datatype | Type Properties Filter, Group, Nillable, Restricted picklist, Sort Description The data type of the question response. Possible values are: - Boolean This value is available in API v49.0 and later. - Date - Double - Int - Number - String | | DateTimeValue | Type dateTime Properties Filter, Nillable, Sort Description Response provided by a participant for a question of the type date time. | | DateValue | Type date Properties Filter, Group, Nillable, Sort Description Response provided by a participant for a question of the type date. | | InvitationId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the SurveyInvitation that was sent to the survey participant. | | IsTrueOrFalse | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Response provided by a participant for a question type which has only two possible values: True and False. | | NumberValue | Type int Properties Filter, Group, Nillable, Sort Description Response provided by a participant for the following question types: - Net Promoter Score (NPS) - Rating - Score - Slider | | QuestionChoiceId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of SurveyQuestionChoice that a participant chose in response to a question. | | QuestionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the SurveyQuestion that a participant provided an answer for. | | Rank | Type int Properties Filter, Group, Nillable, Sort Description Rank provided by a participant for an answer choice for the ranking question type. | | ResponseId | Type reference Properties Filter, Group, Sort Description The ID of the SurveyResponse that is the parent of this SurveyQuestionResponse. | | ResponseShortText | Type string Properties Filter, Group, idLookup, Sort Description Up to the first 250 characters of the response provided by a participant for a text type question. | | ResponseValue | Type textarea Properties Nillable Description Response provided by a participant for a question. | | SurveyVersionId | Type reference Properties Filter, Group, Sort Description The ID of the SurveyVersion that the response belongs to. | ## 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. [SurveyQuestionResponseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # SurveyQuestionScore Represents the aggregate of responses for the following question types: date, multiple choice, picklist, radio, ranking, rating, scoring, slider, and [Net Promoter Score® (NPS®)](https://www.salesforce.com/content/dam/web/en_us/www/documents/legal/Agreements/product-specific-terms/net-promoter-and-nps.pdf). ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the SurveyQuestionScore object using the Object Manager. ## Fields
      Field Details
      CumulativeScore
      Type
      double
      Properties
      Filter, Nillable, Sort
      Description
      Sum of the responses provided by all the participants for a question of the following types: rating, scoring, and slider. For a question of the type ranking, sum of the weights provided by all the participants for each item.
      Note

      Note

      This field is only applicable for the overall score type.
      DateResponse
      Type
      date
      Properties
      Filter, Group, Nillable, Sort
      Description
      The date selected by one or more participants for a question of the type date.
      Note

      Note

      This field is only applicable for the individual score type.
      Name
      Type
      string
      Properties
      Filter, Group, idLookup, Sort
      Description
      For an overall score type record:
      • Name of a question.
      • Name of an item in a question of the type ranking.
      For an individual score type record:
      • Name of an item in a question of the type ranking.
      • Name of a question of the type date.
      • Response provided by one or more participants for questions of the following types: picklist, multiple choice, rating, ranking, score, slider, NPS.
      QuestionChoiceId
      Type
      reference
      Properties
      Filter, Group, Nillable, Sort
      Description
      Unique identifier of the answer choice selected by one or more participants. For an individual score type record, this field is applicable for questions of the following types: picklist, radio, multi choice, ranking and rating. For an overall score type record, this field is applicable for questions of the type ranking.
      QuestionDeveloperName
      Type
      string
      Properties
      Filter, Group, Nillable, Sort
      Description
      The API name of the question for which response is recorded. The API name must be unique within a particular version of the survey.
      QuestionId
      Type
      reference
      Properties
      Filter, Group, Nillable, Sort
      Description
      Unique identifier of the question for which response is recorded.
      QuestionName
      Type
      textarea
      Properties
      Nillable
      Description
      Name of the question for which response is recorded.
      QuestionSkippedCount
      Type
      int
      Properties
      Filter, Group, Nillable, Sort
      Description
      Number of participants who didn’t respond to the question.
      Note

      Note

      This field is only applicable for the overall score type.
      ResponseCount
      Type
      int
      Properties
      Filter, Group, Nillable, Sort
      Description
      For an overall score type record, number of participants who responded to the question. For an individual score type record, number of participants who selected a particular answer choice.
      ResponseValue
      Type
      double
      Properties
      Filter, Nillable, Sort
      Description
      Answer choice selected by one or more participants for a question of the following types: rating, slider, score, NPS. Rank provided by the participant for an item in a question of the type ranking.
      Note

      Note

      This field is only applicable for the individual score type.
      Score
      Type
      double
      Properties
      Filter, Nillable, Sort
      Description
      For an individual score type record, percentage of participants who selected a particular answer choice.
      Note

      Note

      For questions of the type ranking, the percentage of participants who have provided the same rank to an item.

      For overall score type record:
      • Average score of questions of the following question types: rating, scoring, and slider.
      • Score of an NPS type question.
      • Average weight provided by all participants for each item in question of the type ranking.
      • Number of participants who responded to the question for the following question types: date, radio, multi choice, and picklist.
      ScoreType
      Type
      picklist
      Properties
      Filter, Group, Nillable, Restricted picklist, Sort
      Description
      Type of the score calculated for a record. Possible values are:
      • Individual
      • Overall
      SurveyId
      Type
      reference
      Properties
      Filter, Group, Sort
      Description
      Unique identifier of the survey that contains the question for which scores are calculated.
      SurveyInvitationId
      Type
      reference
      Properties
      Filter, Group, Nillable, Sort
      Description
      Unique identifier of the survey invitation for which scores are calculated.
      SurveyVersionId
      Type
      reference
      Properties
      Filter, Group, Sort
      Description
      Unique identifier of the survey version for which scores are calculated.
      # SurveyResponse Represents information about a participant’s response to a survey, such as the status of the response, the participant’s location, and when the survey was completed. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the SurveyResponse object using the Object Manager. ## Fields | Field Name | Details | | --- | --- | | CompletionDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the participant completed the survey. | | DataMapperExecutionStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Status of all the survey data maps after a response is received. This field is available in API v49.0 and later, with Feedback Management - Starter and Feedback Management - Growth licenses. Possible values are: - Pending - InProgress - Success - Error | | InterviewGuid | Type string Properties Filter, Group, idLookup, Nillable Description An automatically-generated, unique ID for a saved survey response. | | InterviewId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the FlowInterview object that’s associated with this response. | | InvitationId | Type reference Properties Filter, Group, Sort Description The ID of the SurveyInvitation object that’s associated with this response. | | IpAddress | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the device the participant used to take the survey. | | Language | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The language that the participant used to complete the survey. Possible values are: - af—Afrikaans - ar—Arabic - ar\_AE—Arabic (United Arab Emirates) - ar\_BH—Arabic (Bahrain) - ar\_DZ—Arabic (Algeria) - ar\_EG—Arabic (Egypt) - ar\_IQ—Arabic (Iraq) - ar\_JO—Arabic (Jordan) - ar\_KW—Arabic (Kuwait) - ar\_LB—Arabic (Lebanon) - ar\_LY—Arabic (Libya) - ar\_MA—Arabic (Morocco) - ar\_OM—Arabic (Oman) - ar\_QA—Arabic (Qatar) - ar\_SA—Arabic (Saudi Arabia) - ar\_SD—Arabic (Sudan) - ar\_SY—Arabic (Syria) - ar\_TN—Arabic (Tunisia) - ar\_YE—Arabic (Yemen) - bg—Bulgarian - bn—Bengali - bs—Bosnian - ca—Catalan - cs—Czech - cy—Welsh - da—Danish - de—German - de\_AT—German (Austria) - de\_BE—German (Belgium) - de\_CH—German (Switzerland) - de\_LU—German (Luxembourg) - el—Greek - en\_AU—English (Australian) - en\_CA—English (Canadian) - en\_GB—English (UK) - en\_HK—English (Hong Kong) - en\_IE—English (Ireland) - en\_IN—English (Indian) - en\_MY—English (Malaysian) - en\_NZ—English (New Zealand) - en\_PH—English (Philippines) - en\_SG—English (Singapore) - en\_US—English - en\_ZA—English (South Africa) - es—Spanish - es\_AR—Spanish (Argentina) - es\_BO—Spanish (Bolivia) - es\_CL—Spanish (Chile) - es\_CO—Spanish (Colombia) - es\_CR—Spanish (Costa Rica) - es\_DO—Spanish (Dominican Republic) - es\_EC—Spanish (Ecuador) - es\_GT—Spanish (Guatemala) - es\_HN—Spanish (Honduras) - es\_MX—Spanish (Mexico) - es\_NI—Spanish (Nicaragua) - es\_PA—Spanish (Panama) - es\_PE—Spanish (Peru) - es\_PR—Spanish (Puerto Rico) - es\_PY—Spanish (Paraguay) - es\_SV—Spanish (El Salvador) - es\_US—Spanish (United States) - es\_UY—Spanish (Uruguay) - es\_VE—Spanish (Venezuela) - et—Estonian - eu—Basque - fa—Farsi - fi—Finnish - fr—French - fr\_BE—French (Belgium) - fr\_CA—French (Canadian) - fr\_CH—French (Switzerland) - fr\_LU—French (Luxembourg) - ga—Irish - gu—Gujarati - hi—Hindi - hr—Croatian - hu—Hungarian - hy—Armenian - in—Indonesian - is—Icelandic - it—Italian - it\_CH—Italian (Switzerland) - iw—Hebrew - ja—Japanese - ka—Georgian - kn—Kannada - ko—Korean - lb—Luxembourgish - lt—Lithuanian - lv—Latvian - mi—Te reo - mk—Macedonian - ml—Malayalam - mr—Marathi - ms—Malay - mt—Maltese - my—Burmese - nl\_BE—Dutch (Belgium) - nl\_NL—Dutch - no—Norwegian - pl—Polish - pt\_BR—Portuguese (Brazil) - pt\_PT—Portuguese (European) - rm—Romansh - ro—Romanian - ro\_MD—Romanian (Moldova) - ru—Russian - sh—Serbian (Latin) - sh\_ME—Montenegrin - sk—Slovak - sl—Slovene - sq—Albanian - sr—Serbian (Cyrillic) - sv—Swedish - sw—Swahili - ta—Tamil - te—Telugu - th—Thai - tl—Tagalog - tr—Turkish - uk—Ukrainian - ur—Urdu - vi—Vietnamese - xh—Xhosa - zh\_CN—Chinese (Simplified) - zh\_HK—Chinese (Hong Kong) - zh\_SG—Chinese (Singapore) - zh\_TW—Chinese (Traditional) - zu—Zulu | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that another Salesforce object last referenced this SurveyResponse object. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that someone last viewed this SurveyResponse object. | | Latitude | Type double Properties Filter, Nillable, Sort Description The latitude of the participant’s location. | | Location | Type location Properties Nillable Description The latitude and longitude coordinates of the participant’s location. | | Longitude | Type double Properties Filter, Nillable, Sort Description The longitude of the participant’s location. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the participant. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the survey. Possible values include: - NotStarted — The participant hasn't opened the survey. - Started — The participant has opened the survey. - Paused — The participant has paused the survey. Paused isn't available for invitations in which either OptionsAllowParticipantAccessTheirResponse or OptionsCollectAnonymousResponse is true. - PartiallyCompleted — The participant has partially completed the survey. Available in API version 63.0 and later. - Completed — The participant has completed the survey. | | SubmitterId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Salesforce user, contact, or lead who completed the survey. Relationship Name Submitter Relationship Type Lookup Refers To Contact, Lead, User | | SurveyId | Type reference Properties Filter, Group, Sort Description The ID of the survey that the participant completed. | | SurveyVersionId | Type reference Properties Filter, Group, Sort Description The ID of the version of the survey that the participant completed. | ## 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. [SurveyResponseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # SurveySubject Represents a relationship between a survey and another object, such as an account or a case. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the SurveySubject record was last referenced by another object. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed the SurveySubject record. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the SurveySubject record. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description Unique identifier of the SurveyInvitation object or SurveyResponse object that is associated with this survey-object relationship. Relationship Name Parent Relationship Type Lookup Refers To SurveyInvitation, SurveyResponse | | SubjectEntityType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Object that the survey is associated with. Possible values include: - Account - Asset - Banker - BranchUnit - BranchUnitBusinessMember - BranchUnitCustomer - BusinessLicenseApplication - BusinessMilestone - Campaign - CareProgram - Case - Claim - ClaimParticipant - Contact - Employee - Event - Incident - IndividualApplication - InsurancePolicy - InsurancePolicyParticipant - Lead - LearningItemSubmission—Available in API version 58.0 and later. - LiveChatTranscript - LoyaltyProgram - LoyaltyProgramMember - LoyaltyProgramPartner - MaterialityStakeholder - MessagingSession - Opportunity - Order - PersonalLifeEvent - Producer - Product2 - Promotion - RebateProgram - RetailStore - ServiceAppointment - ServiceResource - Solution - Task - TransactionJournal - User - VideoCall - Visit - VoiceCall - VolunteerProject - WorkOrder - Custom Objects | | SubjectId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the object that’s associated with the survey. | | SurveyId | Type reference Properties Filter, Group, Sort Description Unique identifier of the survey that’s associated with the record that’s represented by SubjectId. | | SurveyInvitationId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier of the survey invitation that's associated with another object. | | SurveyResponseId | Type reference Properties Filter, Group, Nillable, Sort Description Unique identifier of the survey response that's associated with another object. | ## 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. [SurveySubjectChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # SurveyVersion Represents a version of a survey. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t define custom fields for the SurveyVersion object using the Object Manager. ## Fields | Field Name | Details | | --- | --- | | BrandingSetId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the branding set associated with the survey version. | | Description | Type textarea Properties Nillable Description The description of this survey version. | | IsTemplate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the survey version is a template. Template surveys are automatically shared with all users in your Salesforce org. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the current user last viewed a record related to the survey version. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed the survey version. | | Name | Type string Properties Filter, Group, Sort Filter, Group, Sort Filter, Group, idLookup, Sort Description The name of the survey that appears in the UI. | | SurveyId | Type reference Properties Filter, Group, Sort Description The ID of the survey associated with the survey version. | | SurveyStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the survey. Possible values include: - Active - Draft - Obsolete - InvalidDraft | | VersionNumber | Type int Properties Filter, Group, Sort Description The version number of the survey. | ## 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. [SurveyVersionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # SurveyVersionAddlInfo Represents additional information about a survey version. This information defines the default settings of a survey version. This object is available in API version 49.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | EmailSender | Type textarea Properties Filter, Nillable, Sort Description The organization-wide email address used to send a survey invitation. | | EmailTemplateId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the email template that's used to send an automated survey invitation. | | EngagementContextMetadata | Type string Properties Filter, Group, Nillable, Sort Description The custom metadata created to get the engagement context from the participants. | | InvitationSharingRole | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the users that share edit access to a survey invitation. Possible values are: - InvitationRecordCreator— Owner of the record that's associated with a survey invitation. - SurveyOwner | | Language | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Language used to create the survey. Possible values are: - af—Afrikaans - ar—Arabic - ar\_AE—Arabic (United Arab Emirates) - ar\_BH—Arabic (Bahrain) - ar\_DZ—Arabic (Algeria) - ar\_EG—Arabic (Egypt) - ar\_IQ—Arabic (Iraq) - ar\_JO—Arabic (Jordan) - ar\_KW—Arabic (Kuwait) - ar\_LB—Arabic (Lebanon) - ar\_LY—Arabic (Libya) - ar\_MA—Arabic (Morocco) - ar\_OM—Arabic (Oman) - ar\_QA—Arabic (Qatar) - ar\_SA—Arabic (Saudi Arabia) - ar\_SD—Arabic (Sudan) - ar\_SY—Arabic (Syria) - ar\_TN—Arabic (Tunisia) - ar\_YE—Arabic (Yemen) - bg—Bulgarian - bn—Bengali - bs—Bosnian - ca—Catalan - cs—Czech - cy—Welsh - da—Danish - de—German - de\_AT—German (Austria) - de\_BE—German (Belgium) - de\_CH—German (Switzerland) - de\_LU—German (Luxembourg) - el—Greek - en\_AU—English (Australian) - en\_CA—English (Canadian) - en\_GB—English (UK) - en\_HK—English (Hong Kong) - en\_IE—English (Ireland) - en\_IN—English (Indian) - en\_MY—English (Malaysian) - en\_NZ—English (New Zealand) - en\_PH—English (Philippines) - en\_SG—English (Singapore) - en\_US—English - en\_ZA—English (South Africa) - es—Spanish - es\_AR—Spanish (Argentina) - es\_BO—Spanish (Bolivia) - es\_CL—Spanish (Chile) - es\_CO—Spanish (Colombia) - es\_CR—Spanish (Costa Rica) - es\_DO—Spanish (Dominican Republic) - es\_EC—Spanish (Ecuador) - es\_GT—Spanish (Guatemala) - es\_HN—Spanish (Honduras) - es\_MX—Spanish (Mexico) - es\_NI—Spanish (Nicaragua) - es\_PA—Spanish (Panama) - es\_PE—Spanish (Peru) - es\_PR—Spanish (Puerto Rico) - es\_PY—Spanish (Paraguay) - es\_SV—Spanish (El Salvador) - es\_US—Spanish (United States) - es\_UY—Spanish (Uruguay) - es\_VE—Spanish (Venezuela) - et—Estonian - eu—Basque - fa—Farsi - fi—Finnish - fr—French - fr\_BE—French (Belgium) - fr\_CA—French (Canadian) - fr\_CH—French (Switzerland) - fr\_LU—French (Luxembourg) - ga—Irish - gu—Gujarati - hi—Hindi - hr—Croatian - hu—Hungarian - hy—Armenian - in—Indonesian - is—Icelandic - it—Italian - it\_CH—Italian (Switzerland) - iw—Hebrew - ja—Japanese - ka—Georgian - kn—Kannada - ko—Korean - lb—Luxembourgish - lt—Lithuanian - lv—Latvian - mi—Te reo - mk—Macedonian - ml—Malayalam - mr—Marathi - ms—Malay - mt—Maltese - my—Burmese - nl\_BE—Dutch (Belgium) - nl\_NL—Dutch - no—Norwegian - pl—Polish - pt\_BR—Portuguese (Brazil) - pt\_PT—Portuguese (European) - rm—Romansh - ro—Romanian - ro\_MD—Romanian (Moldova) - ru—Russian - sh—Serbian (Latin) - sh\_ME—Montenegrin - sk—Slovak - sl—Slovene - sq—Albanian - sr—Serbian (Cyrillic) - sv—Swedish - sw—Swahili - ta—Tamil - te—Telugu - th—Thai - tl—Tagalog - tr—Turkish - uk—Ukrainian - ur—Urdu - vi—Vietnamese - xh—Xhosa - zh\_CN—Chinese (Simplified) - zh\_HK—Chinese (Hong Kong) - zh\_SG—Chinese (Singapore) - zh\_TW—Chinese (Traditional) - zu—Zulu | | Name | Type string Properties Filter, Group, idLookup, Sort Description Name of the record. | | SurveyQuestionId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the survey question embedded in the email template used to send automated survey invitations. | | SurveyVersionId | Type reference Properties Filter, Group, Sort Description ID of the survey version. This field is unique within your organization | # SvcCatalogCategory Represents a group of Service Catalog items by functional area. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, get the Service Catalog Access permission set license , Employee Productivity Starter license, or Employee Productivity Plus add-on license. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Unique developer name for the catalog item category. | | ImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Allows a builder to pick an image displayed in the catalog. This field is a relationship field. Relationship Name Image Relationship Type Lookup Refers To ContentAsset | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Allows service catalog builders to deprecate categories or create in-draft categories. The default value is false. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | ParentCategoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Parent category of this category. Allows categories to be grouped up to a max depth of 3. This field is a relationship field. Relationship Name ParentCategory Relationship Type Lookup Refers To SvcCatalogCategory | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Determines the order that the category is displayed to the end user. | # SvcCatalogCategoryItem Represents an association between a Service Catalog item and category. Service catalog items can be grouped into categories. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, get the Service Catalog Access permission set license, Employee Productivity Starter license, or Employee Productivity Plus add-on license. ## Fields | Field | Details | | --- | --- | | IsPrimaryCategory | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the category is the primary category for a catalog item. The default value is false. | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Controls the order in which catalog items appear by default when you're viewing all items in a single category. | | SvcCatalogCategoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the category for which the service category item belongs. This field is a relationship field. Relationship Name SvcCatalogCategory Relationship Type Lookup Refers To SvcCatalogCategory | | SvcCatalogItemDefId | Type reference Properties Create, Filter, Group, Sort Description ID of the service category item definition. This field is a relationship field. Relationship Name SvcCatalogItemDef Relationship Type Lookup Refers To SvcCatalogItemDef | # SvcCatalogFilterCriteria Represents an eligibility rule that determines if a Service Catalog user has access to a catalog item. This object is available in API version 60.0 and later. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Special Access Rules To access this object, get the Service Catalog Access permission set license. ## Fields | Field | Details | | --- | --- | | CriteriaRelation | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Possible values are: - AllConditionsAreMet - AnyConditionIsMet | | Description | Type textarea Properties Nillable Description A description that states the restriction placed on a user’s access to a catalog items eligibility. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 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. | | FullName | Type string Properties Create, Group, Nillable | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies if the eligibility rule is active. The default value is false. | | Language | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Supported languages for eligibility rules Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | ManageableState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Describes the manageable state of a catalog item that is contained in a package. Possible values are: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged | | MasterLabel | Type string Properties Filter, Group, Sort Description The label of the eligibility rule record. | | Metadata | Type complexvalue Properties Create, Nillable, Update Description The metadata type associated with the SvcCatalogFilterCriteria object. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort | | NumOfRelatedItems | Type int Properties Filter, Group, Nillable, Sort Description The number of catalog items that has the eligibility rule. | # SvcCatalogItemDef Represents a service catalog item that can be requested by a service catalog user. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules To access this object, get the Service Catalog Access permission set license, Employee Productivity Starter license, or Employee Productivity Plus add-on license. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The definition of the catalog item. This field is visible on the Service Catalog page. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique developer name for the catalog item. | | FlowName | Type string Properties Filter, Group, Nillable, Sort Description The flow called when the user navigates to the request page for the catalog item. Available in API version 55.0 and later. | | FulfillmentFlowId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the fulfillment flow. Available in API version 56.0 and later. This field is a relationship field. Relationship Name FulfillmentFlow Relationship Type Lookup Refers To SvcCatalogFulfillmentFlow | | ImageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The image ID used for the catalog item. This field is a relationship field. Relationship Name Image Relationship Type Lookup Refers To ContentAsset | | ImageReference | Type string Properties Filter, Group, Nillable, Sort Description Derived field from ImageId to expose ContentAssetId on item definitions. Available in API version 61.0 and later. | | InternalNotes | Type textarea Properties Create, Nillable, Update Description A place for the Service Catalog Builder to leave internal notes about the catalog item. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Derived field from Status to indicate whether the service catalog item is active. The default value is false. Available in API version 59.0 and later. | | IsAvailableToAllCustomers | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Udpate Description Indicates whether the Service Catalog item is available to all customers. The default value is false. Available in API version 61.0 and later. | | IsFeatured | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether a catalog item is marked as a favorite for the org. Favorites display as a featured item on the Service Catalog home page. The default value is false. | | IsGuestAccessible | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Service Catalog item can be accessed by guest users. The default value is false. Available in API version 61.0 and later. | | IsOutOfSync | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the fulfillment flow that the Service Catalog item is based on has been updated. Available in API version 58.0 and later. The default value is false. If value is true, try updating and saving the service catalog item again. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Supported languages for catalog items. | | Product | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The product associated with the Service Catalog item. The value is derived from UsageType. Available in API version 59.0 and later. Possible values are: - FinancialServices - ServiceCatalog—Default | | ShortDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The short description of the catalog item. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Allows the Service Catalog Builder to control whether the flow is displayed to users within the Service Catalog. Possible values are: - Deprecated - Draft—Default - PendingChanges - Published | | UsageType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The business type for which the Service Catalog is used. Available in API version 57.0 and later. Possible values are: - CustomerService - Employee—Default - FinancialServices - Industry | # SvcCatalogReqRelatedItem Represents an item related to a Service Catalog Request. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules To access this object, get the Service Catalog permission set license, Employee Productivity Starter license, or Employee Productivity Plus add-on license. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the related item. | | RelatedExternalId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text containing an ID from any external system. | | RelatedInternalRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Salesforce record related to this request. This reference must be for an object that has the following characteristics. - It's a standard object. - It must allow custom fields. - It's referencable (that is, it can be the target of a lookup). - It can be the target of a custom lookup field. - It contains a Name field. - It isn't dependent on a junction object. - It isn't a virtual object or a setup object. This is a polymorphic relationship field. Relationship Name RelatedInternalRecord Relationship Type Lookup Refers To Account, Address, Asset, AssociatedLocation, AuthorizationForm, AuthorizationFormConsent, AuthorizationFormDataUse, AuthorizationFormText, BusinessBrand, Case, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, Contact, ContactPointAddress, ContactPointConsent, ContactPointEmail, ContactPointPhone, ContactPointTypeConsent, Contract, ContractLineItem, Customer, DataUseLegalBasis, DataUsePurpose, Employee, EngagementChannelType, Entitlement, Idea, Individual, InternalOrganizationUnit, Lead, Location, MessagingEndUser, Opportunity, Order, OrderItem, PartyConsent, Pricebook2, ProcessException, Product2, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, QuickText, Recommendation, Seller, ServiceContract, SocialPersona, SocialPost, Solution, SurveyInvitation, SurveySubject, UserProvisioningRequest, VoiceCall | | SvcCatalogRequestId | Type reference Properties Create, Filter, Group, Sort Description The SvcCatalogRequest record. This is a relationship field. Relationship Name SvcCatalogRequest Relationship Type Lookup Refers To SvcCatalogRequest | # SvcCatalogRequest Represents a request made by a user using the Service Catalog. Catalog builders use this object to report on Service Catalog activity. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To access this object, get the Service Catalog Access permission set license, Employee Productivity Starter license, or Employee Productivity Plus add-on license. ## Fields | Field | Details | | --- | --- | | CatalogItemDescription | Type textarea Properties Create, Nillable, Update Description Description for the catalog item. | | CatalogItemName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the catalog item. | | CatalogItemVersion | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Version for the catalog item. This is a calculated field. Available in API version 58.0 and later. | | ClosedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the request was closed. This field is automatically populated when IsClosed is 'true'. | | CurrencyIsoCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description ISO code of the currency. Must be one of the valid alphabetic, three-letter currency ISO codes defined by the ISO 4217 standard, such as USD, GBP, or JPY. Must be unique within your organization. Default value is USD\-U.S. Dollar. | | FlowInterviewGuid | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique GUID associated with the automation that was executed as part of the catalog item. Available in API version 60.0 and later. | | IsClosed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the request has been resolved. This field is automatically checked when ClosedDate is populated. The default value is false. | | ItemFlowVersion | Type string Properties Filter, Group, Nillable, Sort Description Version for the item flow. This is a calculated field. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The Service Catalog request number. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID for the owner record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the service catalog request. Available in API version 60.0 and later. Possible values are: - CompletedExecution—Default - CreatedRequest - StartedExecution | | SubmitterId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID for the submitter record. This is a relationship field. Relationship Name Submitter Relationship Type Lookup Refers To User | | SvcCatalogItemDefinitionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The catalog item that was used to create this request. This is a relationship field. Relationship Name SvcCatalogItemDefinition Relationship Type Lookup Refers To SvcCatalogItemDef | | TargetCustomerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The customer ID that the request was submitted for. For example, when an agent runs a catalog item for a given contact, the contact is represented by the TargetCustomerId. Available in API version 61.0 and later. This is a polymorphic relationship field. Relationship Name TargetCustomer Relationship Type Lookup Refers To Contact, User | # 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. # SwarmMember Represents a Salesforce member, such as an agent, of a swarm. 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 | | --- | --- | | AssignedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time the member is added to the swarm. | | CompletedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time the member exits the swarm or the swarm closes. | | HelpNeeded | Type textarea Properties Create, Nillable, Update Description Short description of the problem that the swarm is trying to solve. | | 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the swarm or record number. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the Salesforce user assigned to a swarm. 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 | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Status of the swarm member or swarm. Possible values are: - Closed - In Progress - New The default value is New. | | SwarmId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the swarm the member belongs to. This field is a relationship field. Relationship Name Swarm Relationship Type Lookup Refers To Swarm | ## 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. [SwarmMemberFeed](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. [SwarmMemberHistory](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. [SwarmMemberOwnerSharingRule](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. [SwarmMemberShare](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. # System Fields System fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example, the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies a record. ## Basic System Fields
      Field Field Type Description
      Id ID Globally unique string that identifies a record. For information on IDs, see ID Field Type. Because this field exists in every object, it is not listed in the field table for each object. Id fields have Defaulted on create and Filter access.
      IsDeleted boolean Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
      LastReferencedDate dateTime Date and time when the current user last viewed or modified this record, a record related to this record, or a list view. If this value is null, the current user has never viewed or modified a record related to this object.

      This field doesn’t exist on records for a custom object unless a custom object tab is created for that object. See Use LastReferencedDate and LastViewedDate fields in a SOQL query.
      LastViewedDate dateTime Date and time when the current user last viewed or modified this record. If this value is null, the current user has never viewed or modified this record.

      This field doesn’t exist on records for a custom object unless a custom object tab is created for that object. See Use LastReferencedDate and LastViewedDate fields in a SOQL query.
      ## Audit System Fields
      Field Field Type Description
      CreatedById reference ID of the User who created this record. CreatedById fields have Defaulted on create and Filter access.
      CreatedDate dateTime Date and time when this record was created. CreatedDate fields have Defaulted on create and Filter access.
      LastModifiedById reference ID of the User who last updated this record. LastModifiedById fields have Defaulted on create and Filter access.
      LastModifiedDate dateTime Date and time when a user last modified this record. LastModifiedDate fields have Defaulted on create and Filter access.
      SystemModstamp dateTime Date and time when a user or automated process (such as a trigger) last modified this record. In this context, "trigger" refers to Salesforce code that runs to implement standard functionality, and not an Apex trigger. SystemModstamp fields have Defaulted on create and Filter access.

      In general, SystemModstamp shows the date and time when a user or automated process last modified the record. However, in certain cases, SystemModstamp doesn’t capture every field change. For example, if object A retrieves values from object B, then the changes to field values in records on object B are reflected in the SystemModstamp field for records on object B, but not on object A.

      ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Audit Fields with the dateTime field type have a certain range of valid dates. Unlike other dateTime fields, the earliest valid date is 1970-01-01T00:00:00Z GMT, or just after midnight on January 1, 1970. The latest valid date is 4000-12-31T00:00:00Z GMT, or just after midnight on December 31, 4000. These values are offset by your time zone. For example, in the Pacific time zone, the earliest valid date is 1969-12-31T16:00:00, or 4:00 PM on December 31, 1969. If you import data into Salesforce and want to retain the audit field values of the source system, you can set the values for audit fields on the following objects: Account, ArticleVersion, Attachment, CampaignMember, Case, CaseComment, Contact, ContentVersion, Contract, Event, Idea, IdeaComment, Lead, Opportunity, Question, Task, Vote, and custom objects. The only audit field you cannot set a value for is systemModstamp. ## Create Audit Fields 1. From Setup, enter User Interface in the Quick Find box, then select **User Interface** under Customize. 2. Under Setup, select **Enable “Set Audit Fields upon Record Creation” and “Update Records with Inactive Owners” User Permissions**. 3. In the permission set or profile that you want to set audit fields with, enable the permission **Set Audit Fields upon Record Creation**. 4. Using the API, create a record and set its audit fields. Not all standard objects have all audit fields. Check the Enterprise WSDL to verify which audit fields are available for a given object. ## Parent Reference Fields If an object has a relationship to a parent object, two fields are added. - Parent\_Name contains the object name of the parent. For example, Case has a Contact field that contains a reference to the contact parent of the case. - Parent\_NameId contains the ID of the parent. For example, Case has a ContactId field that refers to the contact parent of the case. This field is used in SOQL relationship queries such as the following: SELECT Case.ContactId, Case.Contact.Name FROM Case Even if the object can parent itself, these fields occur. For example, the Campaign object has a CampaignName and CampaignId field for referencing the parent Campaign. # TabDefinition Represents a custom tab. Returns only the tabs that the current user has access to. This object is available in API version 43.0 and later. ## Supported Calls describeSObjects(), query(), search() ## Fields | Field Name | Details | | --- | --- | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description Unique identifier for the tab. Always retrieve this value before using it, because the value isn’t guaranteed to stay the same from one release to the next. Simplify queries by using this field instead of making multiple queries. | | IsAvailableInAloha | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the tab is available in Salesforce Classic. | | IsAvailableInDesktop | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the tab is available on desktop. | | IsAvailableInLightning | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the tab is available in Lightning Experience. | | IsAvailableInMobile | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the tab is available in the Salesforce mobile app. | | IsCustom | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the tab is a custom tab created by admins in the org. | | Label | Type string Properties Filter, Group, Nillable, Sort Description The localized label corresponding to the MasterLabel field in the Tooling API object. | | MobileUrl | Type string Properties Filter, Group, Nillable, Sort Description The URL that can be used to launch this tab in the Salesforce mobile app. | | Name | Type string Properties Filter, Group, Nillable, Sort Description The developer name of the tab. | | SobjectName | Type string Properties Filter, Group, Nillable, Sort Description The name of the sObject corresponding to the tab. | | Url | Type string Properties Filter, Group, Nillable, Sort Description The URL that can be used to launch this tab on desktop. | # TagDefinition Defines the attributes of child Tag objects. ## Supported Calls delete(), describeSObjects(), query(), retrieve(), search(), undelete(), update() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Detail | | --- | --- | | Name | Type string Properties Filter, Nillable, Update Description Identifies the tag word or phrase. | | Type | Type picklist Properties Filter, Nillable, Restricted picklist Description Defines the visibility of a tag. Possible value are: - **Public**: The tag can be viewed and manipulated between all users in an organization. - **Personal**: The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage When you create a tag for a record, an association is created with to a corresponding TagDefinition: - If the value in the tag's Name field is new, a new TagDefinition record is automatically created and becomes the parent of the tag. - If the value in the tag's Name field already exists in a TagDefinition, that TagDefinition automatically becomes the parent of the tag. Each TagDefinition record has a one-to-many relationship with its child tag records. The following standard objects represent tags for records: - AccountTag - AssetTag - CampaignTag - CaseTag - ContactTag - ContractTag - DocumentTag - EventTag - LeadTag - NoteTag - OpportunityTag - SolutionTag - TaskTag Custom objects may also be tagged. Tags for custom objects are identified by a suffix of two underscores immediately followed by the word tag. For example, a custom object named Meeting has a corresponding tag named Meeting\_\_tag in that organization’s WSDL. Meeting\_\_tag is only valid for Meeting objects. TagDefinition is useful for mass operations on any tag record. For instance, if you want to rename existing tags, you can search for the appropriate TagDefinition object, update it, and the child tag's Name values are also changed. The following Java example replaces all WC tags with the phrase West Coast: public void tagDefinitionSample() { String soqlQuery = "SELECT Id, Name FROM TagDefinition " + "WHERE Name = 'WC'"; QueryResult qResult = null; try { qResult = connection.query(soqlQuery); TagDefinition tagDef = (TagDefinition) qResult.getRecords()\[0\]; tagDef.setName("West Coast"); connection.update(new SObject\[\]{tagDef}); } catch (ConnectionException ce) { ce.printStackTrace(); } } When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. # Task Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Task fields related to calls are exclusive to Salesforce CRM Call Center. Also, query(), delete(), and update() aren't allowed with tasks related to more than one contact in API versions 23.0 and earlier. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Field Type | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description Represents the ID of the related Account. The AccountId is determined as follows. If the value of WhatId is any of these objects, Salesforce uses that object's AccountId. - Account - Opportunity - Contract - Custom object that is a child of Account If the value of the WhatIdfield is any other object, and the value of the WhoId field is a Contact object, then Salesforce uses that contact’s AccountId. (If your organization uses Shared Activities, then Salesforce uses the AccountId of the primary contact.) Otherwise, Salesforce sets the value of the AccountId field to null. For information on IDs, see [ID Field Type.](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm#i1435616) This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | ActivityDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the due date of the task. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant; do not attempt to alter it to accommodate time zone differences. Label is **Due Date**. This field can’t be set or updated for a recurring task (IsRecurrence is true). | | CallDisposition | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center. | | CallDurationInSeconds | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Duration of the call in seconds. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center. | | CallObject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of a call center. Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center. | | CallType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of call being answered. Possible values are: - Inbound - Internal - Outbound When working with PushTopic, the CallType values display as 1 for Inbound, 0 for Internal, and 2 for Outbound. | | CompletedDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time the task was saved with a Closed status. - For insert, if the task is saved with a Closed status the field is set. If the task is saved with an Open status the field is set to NULL. - For update, if the task is saved with a new Closed status, the field is reset. If the task is saved with a new non-closed status, the field is reset to NULL. If the task is saved with the same closed status (that is, unchanged) there is no change to the field. The status is a dynamic enum. If the Closed mapping is changed it won’t cause an update of existing tasks. Only new insert/update operations are affected. | | ConnectionReceivedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce. | | ConnectionSentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is available if Salesforce to Salesforce is enabled. This field is supported in API versions 14.0 and earlier. In API version 15.0 and later, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections. | | Description | Type textarea Properties Create, Nillable, Update Description Contains a text description of the task. The text provided in the Description field shows in the Comments field on the task record detail page. | | IsArchived | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event has been archived. The default value of this field is false. | | IsClosed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the task has been completed (true) or not (false). The default value of this field is false. Is only set indirectly via the Status picklist. Label is **Closed**. | | IsHighPriority | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates a high-priority task. This field is derived from the Priority field. The default value of this field is false. | | IsRecurrence | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the task is scheduled to repeat itself (true) or only occurs once (false). The default value of this field is false. This field is read-only on update, but not on create. If this field value is true, then RecurrenceStartDateOnly, RecurrenceEndDateOnly, RecurrenceType, and any recurrence fields associated with the given recurrence type must be populated. See Usage section. | | IsReminderSet | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a popup reminder has been set for the task (true) or not (false). The default value of this field is false. | | IsVisibleInSelfService | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a task associated with an object can be viewed in the Customer Portal (true) or not (false). If your organization has digital experiences enabled, tasks marked IsVisibleInSelfService are visible to any external user in the Experience Cloud site, as long as the user has access to the record the task was created on. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User or Group who owns the record. Label is **Assigned To ID**. This field accepts Groups of type Queue only. In the user interface, Group IDs correspond with the queue’s list view names. To create or update tasks assigned to Group, use v48.0 or later. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates the importance or urgency of a task, such as high or low. The default value of this field is Normal. | | RecurrenceActivityId | Type reference Properties Filter, Group, Nillable, Sort Description Read-only. Not required on create. ID of the main record of the recurring task. Subsequent occurrences have the same value in this field. | | RecurrenceDayOfMonth | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day of the month in which the task repeats. | | RecurrenceDayOfWeekMask | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day or days of the week on which the task repeats. This field contains a bitmask. The values are as follows: - Sunday = 1 - Monday = 2 - Tuesday = 4 - Wednesday = 8 - Thursday = 16 - Friday = 32 - Saturday = 64 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20. | | RecurrenceEndDateOnly | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The last date on which the task repeats. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant; do not attempt to alter it to accommodate time zone differences. | | RecurrenceInstance | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The frequency of the recurring task. Possible values are: - First—1st - Fourth—4th - Last—last - Second—2nd - Third—3rd | | RecurrenceInterval | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The interval between recurring tasks. | | RecurrenceMonthOfYear | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The month of the year in which the task repeats. | | RecurrenceRegeneratedType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents what triggers a repeating task to repeat. Add this field to a page layout together with the RecurrenceInterval field, which determines the number of days between the triggering date (due date or close date) and the due date of the next repeating task in the series. Label is **Repeat This Task**. This field has the following picklist values: - **None**: The task doesn’t repeat. - **After due date**: The next repeating task will be due the specified number of days after the current task’s due date. - **After the task is closed**: The next repeating task will be due the specified number of days after the current task is closed. - **(Task closed)**: This task, now closed, was opened as part of a repeating series. When tasks in a series are set to repeat after their due date, Salesforce doesn’t create recurrences that would have been due in the past. Instead, Salesforce keeps adding the interval until a repeated task has a due date in the future. For example, suppose that someone sets a task to repeat three days after it’s due. But, that person doesn’t complete the task (mark it Closed) until five days after it’s due. Instead of creating a task that’s already overdue, Salesforce gives the new task a due date of tomorrow. This due date is equivalent to 6 days after the due date; two intervals of three days each. If that person completes the repeating task (marks it Closed) before the due date, the next task is still due three days after the due date. | | RecurrenceStartDateOnly | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the recurring task begins. Must be a date and time before RecurrenceEndDateOnly. | | RecurrenceTimeZoneSidKey | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time zone associated with the recurring task. For example, “UTC-8:00” for Pacific Standard Time. | | RecurrenceType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how often the task repeats. For example, daily, weekly, or every nth month (where “nth” is defined in RecurrenceInstance). | | ReminderDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Represents the time when the reminder is scheduled to fire, if IsReminderSet is set to true. If IsReminderSet is set to false, then the user may have deselected the reminder checkbox in the Salesforce user interface, or the reminder has already fired at the time indicated by the value. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates the status of the task. The default value of this field is Not Started. Each predefined Status field implies a value for the IsClosed flag. To obtain picklist values, query the TaskStatus object. Possible values are: - Completed - Deferred - In Progress - Not Started - Waiting on someone else This field can’t be updated for recurring tasks (IsRecurrence is true). | | Subject | Type combobox Properties Create, Filter, Nillable, Sort, Update Description The subject line of the task, such as “Call” or “Send Quote.” Limit: 255 characters. | | TaskSubtype | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Provides standard subtypes to facilitate creating and searching for specific task subtypes. This field can't be updated. TaskSubtype values: - Task - Email - LinkedIn —Available in API version 56.0 and later. - ListEmail - Cadence - Call The Cadence subtype is an internal value used by Sales Engagement, and can’t be set manually. | | TaskWhoIds | Type JunctionIdList Properties Create, Update Description A string array of contact or lead IDs related to this task. This JunctionIdList field is linked to the TaskWhoRelations child relationship. TaskWhoIds is only available when the shared activities setting is enabled. The first contact or lead ID in the list becomes the primary WhoId if you don’t specify a primary WhoId. If you set the EventWhoIds field to null, all entries in the list are deleted and the value of WhoId is added as the first entry. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning Adding a JunctionIdList field name to the fieldsToNull property deletes all related junction records. This action can’t be undone. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of task, such as Call or Meeting. | | WhatCount | Type int Properties Filter, Group, Nillable, Sort Description Available to organizations that have Shared Activities enabled. Count of related TaskRelations pertaining to WhatId. Count of the WhatId must be 1 or less. | | WhatId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The WhatId represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. WhatIds are polymorphic. Polymorphic means a WhatId is equivalent to the ID of a related object. The label is Related To ID. This is a polymorphic relationship field. Relationship Name What Relationship Type Lookup Refers To Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CommSubscriptionConsent, ContactEncounter, ContactEncounterParticipant, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem, CreditMemo, DelegatedAccount, DocumentChecklistItem, EnrollmentEligibilityCriteria, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, ListEmail, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PartyConsent, PersonLifeEvent, PlanBenefit, PlanBenefitItem, ProcessException, Product2, ProductItem, ProductRequest, ProductRequestLineItem, ProductTransfer, PurchaserPlan, ReceivedDocument, ResourceAbsence, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, Shift, Shipment, ShipmentItem, Solution, Visit, VisitedParty, VolunteerProject, WorkOrder, WorkOrderLineItem | | WhoCount | Type int Properties Filter, Group, Nillable, Sort Description Available to organizations that have Shared Activities enabled. Count of related TaskRelations pertaining to WhoId. | | WhoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is Name ID. If Shared Activities is enabled, the value of this field is the ID of the related lead or primary contact. If you add, update, or remove the WhoId field, you might encounter problems with triggers, workflows, and data validation rules that are associated with the record. The label is Name ID. Beginning in API version 37.0, if the contact or lead ID in the WhoId field is not in the TaskWhoIds list, no error occurs and the ID is added to the TaskWhoIds as the primary WhoId. If WhoId is set to null, an arbitrary ID from the existing TaskWhoIds list is promoted to the primary position. This is a polymorphic relationship field. Relationship Name Who Relationship Type Lookup Refers To Contact, Lead | ## Usage **Recurring Tasks** - Recurring tasks are available in API version 16.0 and later. - After a task is created, it can’t be changed from recurring to nonrecurring or vice versa. - When a user creates a series of recurring tasks, Salesforce creates a main record and subsequent occurrences. For the main record, IsRecurrence is set to true and other fields that define the recurrence pattern are populated. The ID of the main record of the recurring task is saved in the subsequent occurrences, in the RecurrenceActivityId field. - When you delete a recurring task series through the API, all open and closed task occurrences in the series are removed. However, when you delete a recurring task series through the user interface, only open tasks occurrences (IsClosed is false) in the series are removed. - If IsRecurrence is true, then RecurrenceStartDateOnly, RecurrenceEndDateOnly, RecurrenceType, and any properties associated with the given recurrence type (see the following table) must be populated. - When you change the RecurrenceStartDateOnly field or the recurrence pattern, all open tasks occurrences in the series are deleted and new open task occurrences are created based on the new recurrence pattern. The following fields determine the recurrence pattern: RecurrenceType, RecurrenceTimeZoneSidKey, RecurrenceInterval, RecurrenceDayOfWeekMask, RecurrenceDayOfMonth, RecurrenceInstance, and RecurrenceMonthOfYear. - When you change the value of RecurrenceEndDateOnly to an earlier date (for example, from January 20 to January 10), all open task occurrences in the series with the ActivityDate value greater than the new end date value are deleted. Other open and closed task occurrences in the series are not affected. - When you change the value of RecurrenceEndDateOnly to a later date (for example, from January 10 to January 20), new task occurrences are created up to the new end date. Existing open and closed tasks in the series are not affected. This table describes the usage of recurrence fields for Salesforce Classic recurring events. Each recurrence type must have all of its properties set. All unused properties must be set to null. | RecurrenceType Value | Properties | Example Pattern | | --- | --- | --- | | RecursDaily | RecurrenceInterval | Every second day | | RecursEveryWeekday | RecurrenceDayOfWeekMask | Every weekday - can’t be Saturday or Sunday | | RecursMonthly | RecurrenceDayOfMonth RecurrenceInterval | Every second month, on the third day of the month | | RecursMonthlyNth | RecurrenceInterval RecurrenceInstance RecurrenceDayOfWeekMask | Every second month, on the last Friday of the month | | RecursWeekly | RecurrenceInterval RecurrenceDayOfWeekMask | Every three weeks on Wednesday and Friday | | RecursYearly | RecurrenceDayOfMonth RecurrenceMonthOfYear | Every March on the 26th day of the month | | RecursYearlyNth | RecurrenceDayOfWeekMask RecurrenceInstanceRecurrenceMonthOfYear | The first Saturday in every October | JunctionIdList The JunctionIdList field is now implemented in the Event and Task objects. With a single API call, it’s easy to create many-to-many relationships between the Event or Task object with contacts, leads, or users. To create a Task with related Contacts without JunctionIdList, you first have to create the task, then use the returned task ID to create the TaskRelation records. If the TaskRelation save call fails, error handling is your responsibility because the task has already been committed to the database. public void createTasksOld(Contact\[\] contacts) { Task task = new Task(); task.setSubject("New Task"); SaveResult\[\] results = null; try { results = connection.create(new Task\[\] { task }); if (results\[0\].isSuccess()) { TaskRelation\[\] relations = new TaskRelation\[contacts.size()\]; for (int i = 0; i < contacts.length; i++) { relations\[i\] = new TaskRelation(); relations\[i\].setTaskId(results\[0\].getID()); relations\[i\].setRelationId(contacts\[i\].getID()); } results = connection.create(relations); } } catch (ConnectionException ce) { ce.printStackTrace(); } } To create a task using JuncionIdList, IDs are pulled from the related contacts and both the task and the TaskRelation records are created in one API call. If the TaskRelation fails, the task is rolled back because it’s all done in a single API call. public void createTaskNew(Contact\[\] contacts) { String\[\] contactIds = new String\[contacts.size()\]; for (int i = 0; i < contacts.size(); i++) { contactIds\[i\] = contacts\[i\].getID(); } Task task = new Task(); task.setSubject("New Task"); task.setTaskWhoIds(contactIds); SaveResult\[\] results = null; try { results = connection.create(new Task\[\] { task }); } catch (ConnectionException ce) { ce.printStackTrace(); } } **Shared Field-Level Security for Event and Task Objects** Metadata deployments for the Task object should always include the field-level security for the Event object. Shared field-level security prevents each object from changing the field-level security of the associated object. Metadata deployments that include field-level security for only one of either the Event or Task objects can cause field-level security changes to the other object that aren't reflected in the metadata. - If field-level security is enabled for one object, then field-level security is enabled for both objects. - If field-level security is disabled for one object, then it's disabled for both objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note A missing entry in the metadata is treated as field-level security being disabled. ## 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. [TaskChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [TaskFeed](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.") (API version 20.0) Feed tracking is available for the object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # TaskPriority Represents the importance or urgency of a task, such as High, Normal, or Low. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Customer and Partner Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an ID or master label. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the status is the default task priority value (true) or not (false) in the picklist. Only one value in the picklist can be the default value. | | IsHighPriority | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this task priority value represents a high priority task (true) or not (false). Multiple task priority values can represent a high-priority task. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Master label for this task priority value. This display value is the internal label that doesn’t get translated. Limit: 255 characters. | | SortOrder | Type int Properties Filter, Nillable, Group, Sort Description Number used to sort this value in the task priority picklist. These numbers aren’t guaranteed to be sequential, as some previous task priority values might have been deleted. | ## Usage This object represents a value in the task priority picklist. The task priority picklist provides additional information about the importance of a task , such as whether a given priority value represents a high priority. Your client application can query on this object to retrieve the set of values in the task priority picklist, and then use that information while processing task objects to determine more information about a given task. For example, the application could test whether a given task is high priority based on its Priority value and the value of the IsHighPriority field in the associated TaskPriority object. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # TaskRelation Represents the relationship between a task and a lead, contacts, and other objects related to the task. If Shared Activities is enabled, this object doesn’t support triggers, workflow, or data validation rules. This object is available in API version 24.0 and later. TaskRelation is only available if you’ve enabled Shared Activities in your organization. TaskRelation allows the following relationships: - A task can be related to one lead or up to 50 contacts. - A task can also be related to one account, asset, campaign, case, contract, opportunity, product, solution, or custom object. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), queryAll(), retrieve() ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the Account ID of the relation. For information on IDs, see [ID Field Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm#i1435616). | | IsWhat | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the relation is an Account, Opportunity, Campaign, Case, other standard object, or a custom object. Value is false if RelationId is a contact or lead and true otherwise. | | RelationId | Type reference Properties Create, Filter, Group, Sort Description Indicates the WhatId or WhoId in the relationship. For more information, see Task. For information on IDs, see [ID Field Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm#i1435616). | | TaskId | Type reference Properties Create, Filter, Group, Sort Description Represents the ID of the associated Task. For information on IDs, see [ID Field Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm#i1435616). | ## Usage See contacts associated with a task public void queryWhosOfTaskSample() { String soqlQuery = "SELECT Id, Subject, (SELECT RelationId, Relation.Name, IsWhat from TaskRelations WHERE isWhat = false) FROM Task WHERE Id = '00T x0000005OKEN'"; QueryResult qResult = null; try { qResult = connection.query(soqlQuery); TaskRelation relation1 = (TaskRelation)qResult.getRecords()\[0\].getTaskRelations().getRecords()\[0\]; }catch (ConnectionException ce) { ce.printStackTrace(); } } ## 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. [TaskRelationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. #### See Also - [Task](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm "Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities.") - [TaskWhoRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taskwhorelation.htm "Represents the relationship between a task and a lead or contacts. This object is available in API version 29.0 and later.") # TaskStatus Represents the status of a task, such as Not Started, Completed, or Closed. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Customer Portal users can't access this object. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Uniquely identifies a picklist value so it can be retrieved without using an ID or master label. | | IsClosed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this task status value represents a closed task (true) or not (false). Multiple task status values can represent a closed task. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the status is the default task status value (true) or not (false) in the picklist. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Master label for this task status value. This display value is the internal label that doesn’t get translated. Limit: 255 characters. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the task status picklist. These numbers aren’t guaranteed to be sequential, as some previous task status values might have been deleted. | ## Usage This object represents a value in the task status picklist. The task status picklist provides additional information about the status of a task , such as whether a given status value represents an open or closed task. Your client application can query this object to retrieve the set of values in the task status picklist, and then use that information while processing task records to determine more information about a given task. For example, the application could test whether a given task is open or closed based on the task Status value and the value of the IsClosed property in the associated TaskStatus record. #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # TaskTag Associates a word or short phrase with a task . ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | ItemId | Type reference Properties Create, Filter Description ID of the tagged item. | | Name | Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically. | | TagDefinitionId | Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag. | | Type | Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: - Public—The tag can be viewed and manipulated by all users in an organization. - Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId. | ## Usage TaskTag stores the relationship between its parent TagDefinition and the task being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. # TaskWhoRelation Represents the relationship between a task and a lead or contacts. This object is available in API version 29.0 and later. TaskWhoRelation allows a variable number of relationships: one lead or up to 50 contacts. Available only if you’ve enabled Shared Activities for your organization. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the Account ID of the relation. For information on IDs, see [ID Field Type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm#i1435616). | | RelationId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the contacts or lead related to the task. | | TaskId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the task. | | Type | Type string Properties Filter, Group, Nillable, Sort Description Indicates whether the person related to the task is a lead or contact. | ## Usage Here's a Java example that queries contacts associated with a task. public void queryWhosOfTaskSample() { String soqlQuery = "SELECT Id, Subject, (SELECT RelationId, Relation.Name, IsWhat from TaskWhoRelations) FROM Task WHERE Id = '00Tx0000005OKEN'"; QueryResult qResult = null; try { qResult = connection.query(soqlQuery); TaskWhoRelation relation1 = (TaskWhoRelation)qResult.getRecords()\[0\].getTaskWhoRelations().getRecords()\[0\]; } catch (ConnectionException ce) { ce.printStackTrace(); } } #### See Also - [Task](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm "Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities.") - [TaskRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_taskrelation.htm "Represents the relationship between a task and a lead, contacts, and other objects related to the task. If Shared Activities is enabled, this object doesn’t support triggers, workflow, or data validation rules. This object is available in API version 24.0 and later.") # TaxEngine A tax engine represents both an instance of a tax engine provider as well as the merchant credentials for that specific instance. When Subscription Management calculates tax on an order item, it sends a request through Subscription Management Tax Calculation API to an external tax engine. The Salesforce tax engine record contains information passed to the external tax engine, such as This object is available in API version 55.0 and later. The merchant credentials are stored in a named credential record in Salesforce. The named credential record is referenced in the tax engine object’s Merchant Credentials field. The tax adapter Apex class ID is stored in the tax engine provider. When a user calls Calculate Tax API, Subscription Management interacts with the external tax provider using the adapter class and the named credentials. The tax engine address and seller code from the TaxEngine record are also used in the interaction. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available when Subscription Management or Commerce Subscriptions is enabled. If your org has Subscription Management and Commerce Subscriptions enabled, then Subscription Management takes precedence. ## Special Access Rules This object is available with Subscription Management, Commerce Subscriptions, and Billing (Revenue Cloud). If your org has Subscription Management and Commerce Subscriptions enabled, then Subscription Management takes precedence. For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_taxengine.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the tax engine provider and merchant credential. | | ExternalReference | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Shows information about the external platform used for the tax engine. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | MerchantCredentialId | Type reference Properties Create, Filter, Group, Sort, Update Description Looks up to the merchant credential setup entity in Salesforce. CommerceTax Tax Calculation API sends this information to the external tax engine for use in the tax calculation process. This field is a relationship field. Relationship Name MerchantCredential Relationship Type Lookup Refers To NamedCredential | | SellerCode | Type string Properties Create, Filter, Group, Sort, Update Description Seller code of the transaction for which the tax engine integration log was captured. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Shows the status of the tax engine. Possible values are: - Active—This tax engine is available for use. - Inactive—This tax engine isn't available for use. | | TaxEngineAddress | Type address Properties Filter Description The compound form of the tax engine address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/compound_fields_address.htm) for details on compound address fields. | | TaxEngineCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the tax engine address. Maximum size is 40 characters. | | TaxEngineCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the tax engine address. Maximum size is 80 characters. | | TaxEngineGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the tax engine address. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/compound_fields_limitations.htm#compound_fields_limitations) for details on geolocation compound fields. | | TaxEngineLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with TaxEngineLongitude to specify the precise geolocation of a tax engine address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/compound_fields_limitations.htm#compound_fields_limitations) for details on geolocation compound fields. | | TaxEngineLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with TaxEngineLatitude to specify the precise geolocation of a tax engine address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/compound_fields_limitations.htm#compound_fields_limitations) for details on geolocation compound fields. | | TaxEngineName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the tax engine. | | TaxEnginePostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the tax engine address. Postal code maximum size is 20 characters. | | TaxEngineProviderId | Type reference Properties Create, Filter, Group, Sort, Update Description The Id of the tax engine provider. This field is a relationship field. Relationship Name TaxEngineProvider Relationship Type Lookup Refers To TaxEngineProvider | | TaxEngineState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the tax engine address. State maximum size is 80 characters. | | TaxEngineStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the tax engine address. Maximum of 255 characters. | | TaxPrvdAccountIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier of the external tax provider’s account. This field is only available if Commerce Subscriptions is enabled for your org. Available in API version 63.0 and later. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the tax engine used to calculate tax. This field is only available if Commerce Subscriptions is enabled for your org. Available in API version 63.0 and later. Possible values are: - CommerceTaxExtension—Commerce Tax Extension - RevenueCloudTaxExtension—Revenue Cloud Tax Extension - StandardTaxEngine—Standard Tax Extension - StripeNative—Stripe Native | # TaxEngineInteractionLog A record of a communication with an external tax engine following a tax calculation request. This object is available in API version 55.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_taxengineinteractionlog.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Filter, Nillable, Sort Description Optional user-defined description for providing more information about the tax engine interaction log. | | DocumentCode | Type string Properties Filter, Group, Nillable, Sort Description Document code of the transaction for which the tax engine integration log was captured. | | EffectiveDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the tax engine request takes effect. This date is available for reference and bookkeeping only and doesn’t have any impact on tax calculation. | | InteractionHttpStatusCode | Type int Properties Filter, Group, Nillable, Sort Description The HHTP result code of the external callout made to a third-party tax engine provider. Refer to your third-party tax engine provider’s documentation for details about the specific codes returned. | | InteractionType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Shows the type of request made to the tax engine. In Subscription Management Summer ‘22, only CalculateTax is supported. Possible values are: - CalculateTax | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Description The 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 The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | ReferenceEntity | Type string Properties Filter, Group, Nillable, Sort Description The record on which tax was calculated. | | RequestBody | Type base64 Properties Nillable Description Contains the content of the tax calculation API request. | | RequestContentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Shows the type of data passed in the request. For example, application/html or text/csv. | | RequestLength | Type int Properties Filter, Group, Nillable, Sort Description The character length of text within the request body. | | RequestName | Type string Properties Filter, Group, Nillable, Sort Description The name of the request. | | ResponseBody | Type base64 Properties Nillable Description Contains the content of the tax calculation API response. | | ResponseContentType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Shows the method used to deliver the tax calculation API response, such as application/html or text/vnd.salesforce.quip-template. | | ResponseLength | Type int Properties Filter, Group, Nillable, Sort Description The character length of text within the response body. | | ResponseName | Type string Properties Filter, Group, Nillable, Sort Description Name of the response from the tax engine. | | ResultCode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The code describing the result of the request. Possible values are: - AdapterException—The Apex adapter interface for the tax provider threw an exception. - Success—The request was successful. - TaxEngineError—An error occurred while processing the request. See the log for details. - ValidationError—A validation error occurred. Check that the request is complete and valid. | | TaxEngineId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the tax engine used in the tax calculation process. This field is a relationship field. Relationship Name TaxEngine Relationship Type Lookup Refers To TaxEngine | | TaxEngineInteractionLogNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A system-generated number for a log entry. | # TaxEngineProvider Represents general information about a service that manages a tax engine, such as the ID of the tax adapter Apex class in Salesforce, and the engine’s namespace prefix. Tax engine providers have a one-to-many relationship with tax engines, where the tax engine record represents a specific configuration of a tax engine that can be assigned to multiple order items. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_taxengineprovider.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ApexAdapterId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Id of the Apex adapter used by this tax provider. This field is unique within your organization. This field is a relationship field. Relationship Name ApexAdapter Relationship Type Lookup Refers To ApexClass | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the tax engine provider. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API name for the record. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language used by this tax engine provider. Values appear based on their language codes in Salesforce, such as da for Danish or th for Thai. | | MasterLabel | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label used for the tax engine’s API in Salesforce. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Apex namespace prefix of the API used for the tax engine. In a packaging context, a namespace prefix is a one to 15-character alphanumeric identifier that distinguishes your package and its contents from packages of other developers on AppExchange. | # TaxGeoConfig Represents a tax configuration associated with a GeoCountry. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The TaxGeoConfig object is available if B2B Commerce or D2C Commerce is enabled. ## Fields | Field | Details | | --- | --- | | GeoCountryId | Type reference Properties Create, Filter, Group, Sort Description The GeoCountry associated with the TaxGeoConfig. This field is a relationship field. Relationship Name GeoCountry Relationship Type Lookup Refers To GeoCountry | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed data in this record, a record related to this record, or a list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user accessed data in this record or list view but didn't view it directly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the TaxGeoConfig. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the TaxGeoConfig record. By default, the asset owner is the user who created the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RoundingStrategyType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the tax rounding strategy associated with the TaxGeoConfig. Possible values are: - Rounding Down - Rounding Off - Rounding Up The default value is Rounding Off. | ## 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. [TaxGeoConfigShare](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. #### See Also - [GeoCountry](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_geocountry.htm "Represents a country. This object is available in API version 56.0 and later.") # TaxPolicy A tax policy contains a group of tax treatments, where each treatment represents parameters to determine how a particular product is taxed for a transaction line item. Tax policies are related to products, which pass the policy on to the resulting order items. When you activate an order, Subscription Management assigns a tax treatment to each order item based on the tax policy's DefaultTaxTreatmentId, then uses the tax treatment to calculate tax. This object is available in API version 55.0 and later. Each tax policy requires at least one tax treatment. We recommend determining the taxation needs for each of your products and creating policies and treatments for each product accordingly. You can then assign your tax policies to the relevant products on your own or through automation. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_taxpolicy.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | DefaultTaxTreatmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description When you order a product, the order product receives this tax treatment. This field is a relationship field. Relationship Name DefaultTaxTreatment Relationship Type Lookup Refers To TaxTreatment | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Optional user-defined description for providing more information about the tax policy. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Optional user-defined name for the tax policy. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description To calculate tax for order products, products must have an active tax policy. Tax policies are created with a Draft status before being assigned to a product or order product. After activating a tax policy, you can't edit certain policy fields. Possible values are: - Active - Draft - Inactive | | TreatmentSelection | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines how Subscription Management chooses a tax treatment to assign to order products related to this tax policy. In API version 55.0, only Default is supported. Possible values are: - Default—The order product receives the tax treatment defined in the tax policy's DefaultTreatmentId field. - LegalEntity—Assigns a tax treatment based on matching legal entities between the order product and tax treatment. - Manual—Order products don't receive tax treatments based on the tax policy; users must provide the treatment on their own instead. | # TaxRate Represents a tax rate for a tax code and country. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The TaxRate object is available if B2B Commerce or D2C Commerce is enabled. ## Fields | Field | Details | | --- | --- | | ApplicationBasis | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether the tax rate is applied on the net or gross amount. Possible values are: - Gross - Net The default value is Gross. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city to which the tax rate applies. | | Country | Type string Properties Filter, Group, Nillable, Sort Description The country name that’s derived from the GeoCountry field value. This field is a calculated field. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency ISO code that’s applicable to the tax rate. Possible values are: - AUD—Australian Dollar - EUR—Euro - GBP—British Pound - USD—U.S. Dollar The default value is USD. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date until when the tax rate is valid. | | FlatTaxAmount | Type double Properties Create, Filter, Nillable, Sort, Update Description The flat tax amount that’s applied to the transaction. | | GeoCountryId | Type reference Properties Create, Filter, Group, Sort Description The ID of the GeoCountry for which the tax rate applies. You can define only one tax rate per GeoCountry and tax code combination. This field is a relationship field. Relationship Name GeoCountry Relationship Type Lookup Refers To GeoCountry | | GeoStateId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the GeoState for which the tax rate applies. This field is a relationship field. Relationship Name GeoState Refers To GeoState | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user accessed data in this record or list view but didn't viewed it directly. | | LegalEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The legal entity to which the tax rate applies. This field is a relationship field. Relationship Name LegalEntity Refers To LegalEntity | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique ID of the tax rate. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The TaxRate record owner. By default, the record owner is the user who created the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | Priority | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Reserved for future use. | | ProductCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The code of the product for which the tax rate applies. | | Rate | Type double Properties Create, Filter, Sort, Update Description The tax percentage rate that will be applied to orders. | | RateUsageType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Specifies whether the tax rate is created for Commerce or Revenue Cloud. Possible values are: - Commerce - RevCloud—Revenue Cloud The default value is Commerce. | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date from when the tax rate is valid. | | State | Type string Properties Filter, Group, Nillable, Sort Description The state name that’s derived from the GeoState field value. This field is a calculated field. | | TaxCode | Type string Properties Create, Filter, Group, Sort Description The code used to calculate the tax rate for the invoice line. | | ZipCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal or ZIP code to which the tax rate applies. | ## 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. [TaxRateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TaxRateFeed](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. [TaxRateHistory](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. [TaxRateOwnerSharingRule](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. [TaxRateShare](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. # TaxTreatment A tax treatment contains details about how Salesforce and external engines calculate taxes, and the tax engine to use for tax calculation. The IsTaxable field determines whether tax is calculated for the product in the transaction. The tax code, tax engine, and product code are sent via API to the external tax calculation service. When you invoice an order item that has a tax treatment, the invoice line inherits the tax treatment from the order item’s related billing schedule. The invoice line’s TaxCode field is populated based on the code that the tax engine used for calculation. This object is available in API version 55.0 and later. Each product requires a tax policy to determine whether to apply tax. The tax treatments determine how taxable products are taxed. Each tax policy requires at least one tax treatment. We recommend determining the taxation needs for each of your products and creating policies and treatments for each product accordingly. You can then assign your tax policies to the relevant products on your own or through automation. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the [Revenue Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_taxtreatment.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Optional user-defined description for providing more information about the tax treatment. | | IsTaxable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether Subscription Management calculates tax for order items covered by the tax treatment. When this value is True, Subscription Management calls the CalculateTax API for the order item during order item creation. The default value is 'False'. This field is available when Subscription Management is enabled. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Optional user-defined name for the tax treatment. | | ProductCode | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Code of the product that the tax treatment applies to. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Status of the tax treatment. Possible values are: - Active - Draft - Inactive | | TaxCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reference code used when tax is calculated in an external tax engine. | | TaxEngineId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The tax engine for the tax treatment. A tax engine represents both an instance of a tax engine provider as well as the merchant credentials for that specific instance. When Subscription Management begins the tax calculation process for an order item, it uses the tax engine from the order item’s tax treatment. If the tax treatment’s IsTaxable value is True, the treatment requires a tax engine. This field is a relationship field. This field is available when Subscription Management is enabled. Relationship Name TaxEngine Relationship Type Lookup Refers To TaxEngine | | TaxPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The tax treatment’s parent tax policy. A tax policy is a group of tax treatments, where each treatment represents a rule for how to invoice a customer for an order item. Tax policies are related to products, which pass the policy on to the resulting order items. When you activate an order, Subscription Management assigns a tax treatment to each order item based on the tax policy's DefaultTaxTreatmentId, then uses the tax treatment to calculate tax. This field is a relationship field. Relationship Name TaxPolicy Relationship Type Lookup Refers To TaxPolicy | # TenantConsumptionAlert Stores a record each time a utilization signal is reached for your org's consumption-based products. Each record captures the signal type, the resource that triggered it, and the condition that was met. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Fields | Field | Details | | --- | --- | | AlertScope | Type string Properties Filter, Group, Sort Description Required. Identifies the top-level resource or component that the alert applies to. AlertScope, AlertSubScope1, and AlertSubScope2 together identify the exact target of the alert, from broadest to most specific. | | AlertStatus | Type picklist Properties Filter, Group, Sort Description Required. Indicates whether the alert condition is still active or has resolved (Active or Cleared). Active suppresses duplicate alerts while the condition persists. Cleared resets the alert so it can fire again. | | AlertSubScope1 | Type string Properties Filter, Group, Sort, Nillable Description Identifies a sub-resource or sub-component beneath the alert scope. Can be empty if no further refinement is required. | | AlertSubScope2 | Type string Properties Filter, Group, Sort, Nillable Description Identifies a sub-resource or sub-component that further refines AlertSubScope1. Can be empty if no further refinement is required. However, if you set AlertSubScope2, we recommend that you also set AlertSubScope1. | | AlertTimestamp | Type dateTime Properties Filter, Group, Sort Description Required. The date and time the alert was triggered. | | AlertType | Type string Properties Filter, Group, Sort Description Required. Identifies the type of signal that triggered the alert. Salesforce-managed alert types are prefixed with sf\_\_. | | IsNotificationSent | Type boolean Properties Filter, Group, Sort Description Required. Indicates whether a platform notification has been sent for this alert record (true) or not (false). | | TriggerType | Type string Properties Filter, Group, Sort Description Required. The unit or measurement type of the value that triggered the alert, such as a percentage or unit count. Use this field to interpret the numeric value in TriggerValue. Values are: ThresholdPercent or ThresholdUnits. | | TriggerValue | Type int Properties Filter, Group, Sort Description Required. The numeric value that triggered the alert, which is interpreted in the context of TriggerType. | ## Usage TenantConsumptionAlert stores a record each time a utilization signal is reached for your org's consumption-based products or license utilization. Each record represents a single triggered signal and is structured hierarchically: AlertType identifies the high-level signal category. - AlertScope (and its sub-scopes) identifies the specific resource that triggered the signal. - TriggerType and TriggerValue define the condition that was met. There are two types of alerts: Salesforce-managed and user-defined. - Salesforce-managed alerts are created by Salesforce processes via invocable actions. Alert types for these alerts are prefixed with sf\_\_. Salesforce validates that the triggering condition is correct on creation and provides out-of-the-box features, including flow templates and invocable actions, to manage the alert lifecycle. Lifecycle fields such as AlertStatus and IsNotificationSent are updated automatically. - User-defined alerts offer the flexibility to define any signal that meets your use case. However, all fields must be set manually. Lifecycle fields like AlertStatus and IsNotificationSent aren’t updated automatically. ## About Salesforce-Managed Alert Types Consumption Threshold alerts are triggered when consumption of a Digital Wallet consumption card reaches a specified threshold. For setup information, see Salesforce Help: [Get Digital Wallet Notifications about Your Usage](https://help.salesforce.com/s/articleView?id=xcloud.wallet_get_notified.htm&language=en_US&type=5). This table illustrates an alert for when the Data Services Credits consumption card exceeds 70% of its credits consumption based on its entitlements. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note For this object, consumption cards are identified by their card definition developer name, which often differs from their display name in Digital Wallet. To determine the developer name for a consumption card, see “Find the Card Definition Developer Name” in Salesforce Help: [Change a Consumption Threshold for a Specific Card](https://help.salesforce.com/s/articleView?id=xcloud.wallet_change_threshold_specific_card.htm&language=en_US). | Field | Value | | --- | --- | | AlertType | sf\_\_ConsumptionThreshold | | AlertStatus | Active | | AlertScope | The developer name for the consumption card, for example, PlatformServicesCard. | | AlertSubScope1 | Business environment (always Production) | | AlertSubScope2 | PrePurchased. Buying models include PrePurchased, PreCommitted, or PayGo, but not all consumption cards support all buying models. | | TriggerType | ThresholdPercent | | TriggerValue | 70 | | AlertTimestamp | Date and time alert was triggered. | | IsNotificationSent | true | ## 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. [TenantConsumptionAlertOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [TenantConsumptionAlertShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. #### See Also - [_Salesforce Help_: Get Digital Wallet Notifications about Your Usage](https://help.salesforce.com/s/articleView?id=xcloud.wallet_get_notified.htm&language=en_US) # TenantScrAIPrmptInjection Stores generative AI prompt injection data. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available for Security Center subscribers. This object is read-only. ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique across all tenants. | | InputSource | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The origin of this prompt. | | Language | Type string Properties Filter, Group, Nillable, Sort Description Language of the prompt. | | MaskedPrompt | Type textarea Properties Nillable Description Masked prompt or input text. | | MaskedResponse | Type textarea Properties Nillable Description The generated response from the LLM. If masking is enabled, this may contain placeholder text. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | PlannerLlm | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The LLM being used by the Planner. | | Prompt | Type textarea Properties Nillable Description The hydrated version of prompt text before data masking is applied. The actual prompt sent to the LLM will mask sensitive data if data masking is enabled. | | PromptTimestamp | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when this prompt injection happened. | | PromptTokens | Type int Properties Filter, Group, Nillable, Sort Description The number of tokens used in the prompt. | | Response | Type textarea Properties Nillable Description The generated response after unmasking. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant with this triggered Transaction Security Policy event. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant where this triggered Transaction Security Policy happened. | # TenantSecret This object stores an encrypted organization-specific key fragment that’s used with the primary secret (KDF seed) to produce org-specific data encryption keys. This object is available in API version 34.0 and later. You can rotate tenant secrets of the Data type once every four hours in a sandbox org or every 24 hours in production orgs. You can rotate tenant secrets of the SearchIndex type one time every seven days. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This information is about Shield Platform Encryption and not Classic Encryption. ## Supported Calls create(), query(), retrieve(), update() ## Fields
      Field Name Details
      Description
      Type
      textarea
      Properties
      Create, Nillable, Update
      Description

      The description of the tenant secret.
      KeyDerivationMode
      Type
      picklist
      Properties
      Create, Filter, Group, Restricted picklist, Sort
      Description
      The key derivation mode applied to customer-supplied key material. Modes are:
      PBKDF2
      The customer-supplied key material is used by the Shield KMS to create a derived data encryption key.
      NONE
      The customer-supplied key material is used by the Shield KMS as the final data encryption key to directly encrypt and decrypt data.

      Available in API version 43.0 and later.
      RemoteKeyCertificate
      Type
      string
      Properties
      Create, Filter, Group, Nillable, Sort, Update
      Description
      The name of the certificate whose public key is used to encrypt the SecretValue during a remote key callout.

      Available in API version 45.0 and later.
      RemoteKeyIdentifier
      Type
      string
      Properties
      Create, Filter, Group, Nillable, Sort
      Description
      A unique key identifier for key material fetched from a remote key service.

      Available in API version 45.0 and later.
      RemoteKeyServiceID
      Type
      reference
      Properties
      Create, Filter, Group, Nillable, Sort, Update
      Description
      The named credential used to fetch remote key material from a remote key service.

      Available in API version 45.0 and later.
      SecretValue
      Type
      base64
      Properties
      Create, Nillable, Update
      Description

      The encrypted 256-bit secret value encoded in base64.
      SecretValueCertificate
      Type
      string
      Properties
      Create, Filter, Group, Nillable, Sort, Update
      Description

      The certificate needed to upload a customer-supplied tenant secret. Each certificate has a unique name.
      SecretValueHash
      Type
      base64
      Properties
      Create
      Description

      The matching tenant secret hash for an uploaded customer-supplied tenant secret.
      Source
      Type
      picklist
      Properties
      Create, Default on create, Filter, Group, Restricted picklist, Sort
      Description
      The source of the encryption key material. Values are:
      HSM
      A Salesforce-generated tenant secret.
      Uploaded
      A customer-supplied tenant secret or data encryption key.
      Remote
      A tenant secret or data encryption key fetched from a key service outside of Salesforce. Available in API version 44.0 and later.Tenant secrets with a Source value of Remote are listed as Fetched on the Key Management page in Setup.

      Available in API version 43.0 and later.
      Status
      Type
      picklist
      Properties
      Filter, Group, Nillable, Restricted picklist, Sort, Update
      Description
      The status of the tenant secret. Values are:
      Active
      Can be used to encrypt and decrypt new or existing data.
      Archived
      Can’t encrypt new data. Can be used to decrypt data previously encrypted with this key when it was active.
      Destroyed
      Can’t encrypt or decrypt data. Data encrypted with this key when it was active can no longer be decrypted. Files and attachments encrypted with this key can no longer be downloaded.

      You can update the Status field through the API in versions 44.0 or later.
      Type
      Type
      picklist
      Properties
      Create, Default on create, Filter, Group, Restricted picklist, Sort
      Description
      The type of tenant secret. The Type field is available in API version 39.0 and later. The following values appear in the Type picklist:
      • Analytics—CRM Analytics data (available in API version 39.0 and later).
      • Data—data stored in the Salesforce database. Includes data in encrypted fields, files, and attachments but not search index files. Tenant secrets created in API version 34.0 and later default to the Data type.
      • Database—transactional database including standard and custom fields, metadata, and Apex (available in API version 62.0 and later).
      • DeterministicData—data stored in the Salesforce database. Includes data in encrypted fields, files, and attachments, but not search index files (available in API version 39.0 and later).
      • EventBus—Change Data Capture event data (available in API version 43.0 and later).
      • SearchIndex—search index files (available in API version 39.0 and later).

        For Hyperforce orgs on API version 63.0 and later, create secrets of type SearchIndex with the DataEncryptionKey object. For Hyperforce orgs on API version 62.0 and earlier, and for all non-Hyperforce orgs, create secrets of type SearchIndex with the TenantSecret object.

      Version
      Type
      int
      Properties
      Filter, Group, idLookup, Sort
      Description

      The version number of this secret. The version number is unique within your org.
      ## Usage Use this object to create or update an org-specific tenant secret or customer-supplied key material. Use your preferred developer environment to run the examples. Use the Salesforce developer [Introduction to REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/intro_rest.htm) for basic information on making REST calls into Salesforce. Also, the video [How To Use Salesforce APIs Collection With Postman](https://www.youtube.com/watch?v=DJ7_iW2B5tA) by Sudipta Deb provides step by step instructions on getting started using REST with Salesforce. ## Example 1: Build an automated tenant secret creation and activation solution similar to the following. 1. Start by creating an Apex class to create the tenant secret. Specify the value of the tenant secret to encrypt data of a particular type. global class CreateNewSecret implements Schedulable { global void execute(SchedulableContext SC) { TenantSecret secret = new TenantSecret (); secret.description = 'Created new secret from scheduled job'; secret.type= 'Database'; insert secret; } } ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Type is available in API version 39.0 and later. Type is optional; all tenant secrets default to the Data type. 2. Schedule the Apex class to run at the specified interval. This Apex code only needs to be run a single time to schedule the job. This code runs the job every 90 days. CreateNewSecret secret = new CreateNewSecret(); String schedule = '0 0 0 1 JAN,APR,JUL,OCT ?'; String jobID = system.schedule('Automated secret creation and activation', schedule, secret); 3. Validate that the job is scheduled. 4. Validate that tenant secrets are created after the job is run. ## Example 2 Upload a customer-supplied tenant secret. 1. Create a certificate that’s compatible with customer-supplied key material. See [Generate a BYOK-Compatible Certificate](https://help.salesforce.com/articleView?id=security_pe_byok_generate_cert.htm&language=en_US) in Salesforce Help. 2. Then upload your matching key material and key material hash. Include the unique name of the compatible certificate. The key material is uploaded in encrypted form. TenantSecret secret = new TenantSecret (); secret.description = 'New uploaded secret'; secret.type= 'Data'; secret.SecretValue = ... EncodingUtil.base64Decode('...');; secret.SecretValueCertificate = ...; secret.SecretValueHash = ... EncodingUtil.base64Decode('...'); insert secret; You can use this [script to generate a customer-supplied tenant secret](https://help.salesforce.com/s/articleView?id=xcloud.security_pe_byok_script.htm&type=5&language=en_US) and tenant secret hash. 3. Validate that the key material is uploaded. ## Example 3 Opt out of key derivation on a key-by-key basis when you upload key material. When you upload your key material, specify 'Source':Uploaded and 'KeyDerivationMode':'NONE', and set non-null values for the SecretValueCertificate, SecretValue, and SecretValueHash. ## Example 4 Import a tenant secret of the Data type. TenantSecret secret = \[SELECT Id FROM TenantSecret WHERE Type = 'Data' AND Version = 2\]; secret.SecretValue = ""; update secret; ## Example 5 Export a tenant secret by writing the secret.SecretValue to a file. Here’s an example that uses a tenant secret of the Data type. TenantSecret secret = \[SELECT SecretValue FROM TenantSecret WHERE Type = 'Data' AND Version = 2\]; secret.SecretValue =...; update secret; ## Example 6 Destroy a tenant secret of the Data type. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_warning.png) #### Warning Your tenant secret is unique to your organization and to the specific data to which it applies. When you destroy a tenant secret, related data isn’t accessible unless you previously exported the key and then import the key back into Salesforce. TenantSecret secret = \[SELECT Id FROM TenantSecret WHERE Type = 'Data' AND Version = 2\]; secret.SecretValue = NULL; secret.Status = Destroyed; update secret; ## Example 7 Change the Status of a tenant secret from Archived to Destroyed. Include the SecretValue and new tenant secret Status. TenantSecret secret = \[SELECT Id FROM TenantSecret WHERE Type = 'Data' AND Version = 2\]; secret.Status = Destroyed; update secret; Cache-Only Key Service customers can change the Status of cache-only key tenant secrets. For example, reactivate a cache-only key by changing its Status from Destroyed to Active. ## Example 8 Create a callout connection that fetches a cache-only key tenant secret from a key service outside of Salesforce. 1. Make sure that your org has at least one active Data in Salesforce key, either Salesforce-generated or customer-supplied. Then turn on Allow Cache-Only Keys with BYOK from the Advanced Settings page in Setup. 2. Create a certificate that’s compatible with customer-supplied key material. See [Generate a BYOK-Compatible Certificate](https://help.salesforce.com/articleView?id=security_pe_byok_generate_cert.htm&language=en_US) in Salesforce Help. 3. [Create and assemble your key material](https://help.salesforce.com/articleView?id=security_pe_byok_cache_create.htm&language=en_US). 4. Create a named credential to serve as your authenticated callout mechanism. You can define your named credential through Setup or [directly with Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_callouts_named_credentials.htm). Specify a BYOK-compatible certificate and an HTTPS endpoint. 5. Configure the connection to your remote key service. This connection uses a named credential and its associated certificate to fetch a specified cache-only key tenant secret. remote\_params = { 'Source': 'Remote', 'RemoteKeyIdentifier': ..., 'RemoteKeyServiceId': ..., 'RemoteKeyCertificate': ...} sf.TenantSecret.create(remote\_params) #### See Also - [System Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/system_fields.htm "System fields are read-only fields found on most objects. These fields are automatically updated during API operations. For example, the ID field is automatically generated during a create operation and the LastModifiedDate is automatically updated when a user modifies a record.") # TenantSecurityAIGtwyUsage Stores Einstein generative AI gateway usage data. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available for Security Center subscribers. This object is read-only. ## Fields | Field | Details | | --- | --- | | Cloud | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Cost cloud ID. | | DetailIdentifier | Type string Properties Filter, Group, Sort Description The ID of the individual detail record. This field is unique across all tenants. | | Feature | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The AI feature for which the gateway request was made. | | MaskedPrompt | Type textarea Properties Nillable Description Masked prompt or input text. | | MaskedResponse | Type textarea Properties Nillable Description The generated response from the LLM. If masking is enabled, this may contain placeholder text. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. This field is unique within your organization. | | MetricsType | Type string Properties Filter, Group, Nillable, Sort Description The type of data collected. | | Model | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the model to which the request was sent. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | ObjectName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Name of the Salesforce object is referenced in the prompt. | | Prompt | Type textarea Properties Nillable Description The hydrated version of prompt text before data masking is applied. The actual prompt sent to the LLM will mask sensitive data if data masking is enabled. | | PromptTemplateDevName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the prompt template. | | PromptTemplateVersionNo | Type string Properties Filter, Group, Nillable, Sort Description The version of the prompt template. | | PromptTokens | Type int Properties Filter, Group, idLookup, Nillable, Sort Description The number of tokens used in the prompt. | | Response | Type textarea Properties Nillable Description The generated response after unmasking. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant of this AI gateway usage event. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant of this AI gateway usage event. | # TenantSecurityAlertRuleSelectedTenant Stores information about a Security Center alert rule for tenants. This object is available for Security Center subscribers in API version 55.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the metric for the data collected. | | NotificationRuleIdentifier | Type string Properties Create, Filter, Group, Sort, Update Description The ID of the corresponding TenantSecurityNotificationRule. | | Tenant | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The ID of the tenant (org) that this record is for. | ## 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. [TenantSecurityAlertRuleSelectedTenantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityAlertRuleSelectedTenantFeed](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. [TenantSecurityAlertRuleSelectedTenantHistory](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. [TenantSecurityAlertRuleSelectedTenantOwnerSharingRule](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. [TenantSecurityAlertRuleSelectedTenantShare](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. # TenantSecurityAnomaly Stores detected anomalies. This object is available in API version 64.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique across all tenants. | | EventDate | Type dateTime Properties Filter, Nillable, Sort Description The time when the anomaly was reported. For example, 2020-01-20T19:12:26.965Z. The most granular setting is milliseconds. | | EventDetails | Type textarea Properties Create Description JSON text that contains the details for the unsubscribe all event, such as the timestamp for when the event happened. | | EventIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique ID of the event, which is shared with the corresponding storage object. | | EventName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the event, which is Api Anomaly. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of feature collected by this metric. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the feature for which data is being collected. | | Score | Type double Properties Filter, idLookup, Nillable, Sort Description A number from 0 through 100 that represents the anomaly score for the API execution or export tracked by this event. The anomaly score shows how the current API activity differs from the user’s typical activity. A low score indicates that the user’s current API activity is similar to the usual activity, and a high score indicates that it’s different. | | Summary | Type textarea Properties Nillable Description A text summary of the API anomaly that caused this event. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant where the feature was applied. | | TenantName | Type string Properties Filter, Group, Nillable, Sort Description The name of the connected tenant where the feature was enabled or disabled. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The origin user’s unique ID. | | Username | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The origin username in the format of user@company.com at the time that the event was created. | ## 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. [TenantSecurityFeatureChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityFeatureFeed](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. [TenantSecurityFeatureHistory](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. [TenantSecurityFeatureOwnerSharingRule](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. [TenantSecurityFeatureShare](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. # TenantSecurityApiAnomaly Stores detected anomalies in how users typically make API calls. Fore more information, see [Threat Detection](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.real_time_em_threat_detection.htm). This object is available to Security Center subscribers in API version 53.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Threat Detection is available only for Event Monitoring subscribers. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique within your org. | | EventDate | Type dateTime Properties Filter, Nillable, Sort Description The time when the anomaly was reported. For example, 2020-01-20T19:12:26.965Z. The most granular setting is milliseconds. | | EventIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique ID of the event, which is shared with the corresponding storage object. | | EventName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the event, which is Api Anomaly. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for the data collected. | | Operation | Type string Properties Filter, Group, Nillable, Sort Description The API call that generated the event. For example, Query. | | QueriedEntities | Type textarea Properties Nillable Description The type of entities associated with the event. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. | | RowsProcessed | Type double Properties Filter, Nillable, Sort Description Total row count for the current operation. | | Score | Type double Properties Filter, idLookup, Nillable, Sort Description A number from 0 through 100 that represents the anomaly score for the API execution or export tracked by this event. The anomaly score shows how the current API activity differs from the user’s typical activity. A low score indicates that the user’s current API activity is similar to the usual activity, and a high score indicates that it’s different. | | SecurityEventData | Type textarea Properties Nillable Description The set of features about the API activity that triggered this anomaly event. For example, a user typically downloads 10 accounts at a time but then deviates from that pattern and downloads 1,000 accounts. This event is triggered, and the contributing features are captured in this field. Potential features include row count, column count, average row size, day of week, and the browser’s user agent used for the report activity. The data captured also shows how much as a percentage that the feature contributed to triggering this anomaly event. The data is in JSON format. | | Summary | Type textarea Properties Nillable Description A text summary of the API anomaly that caused this event. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant that was targeted in the event. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant that was targeted in the event. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserAgent | Type textarea Properties Nillable Description UserAgent used in the HTTP request, post-processed by the server. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The origin user’s unique ID. | | Username | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The origin username in the format of user@company.com at the time that the event was created. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityApiAnomalyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityApiAnomalyFeed](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. [TenantSecurityApiAnomalyHistory](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. [TenantSecurityApiAnomalyOwnerSharingRule](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. [TenantSecurityApiAnomalyShare](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. # TenantSecurityCertificate Stores metric details related to public key certificate information. The certificate binds the public key to the identity of an entity. This object is available in API version 63.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read only. ## Fields | Field | Details | | --- | --- | | Action | Type String Properties Filter, Group, idLookup, Nillable, Sort Description The action taken on this certificate. Possible values are: - Added - Removed - Updated | | ActionBy | Type String Properties Filter, Group, idLookup, Nillable, Sort Description The user who made this change. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date this action was taken. | | CertCreatedDate | Type dateTime Properties Filter, Nillable, Sort Description When this certificate was created. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the individual detail record. This field is unique within your organization. | | ExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description When this certificate expires. | | IsActive | Type boolean Properties Filter, Group, Sort Description Indicates whether this certificate is active. | | IsCaSigned | Type boolean Properties Filter, Group, Sort Description Indicates whether this certificate is signed by the issuer (true) or not (false). | | IsPlatformEncrypted | Type boolean Properties Filter, Group, Sort Description Whether this certificate is encrypted with Platform Encryption. | | IsPrivateKeyExportable | Type boolean Properties Filter, Group, Sort Description Indicates whether this certificate’s private key is exportable. | | KeySize | Type string Properties Filter, Group, Nillable, Sort Description The length of the public key. | | MetricIdentfier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the type of metric that was counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Sort Description The type of data being collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description A user-friendly name for the certificate. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant with this certificate. | | TenantName | Type string Properties Filter, Group, idLookup, Sort Description The name of the tenant with this certificate. | # TenantSecurityClientApp Stores details about the connected apps and external client apps authorized in a tenant that Security Center monitors. This object is available to Security Center subscribers in API version 68.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The action performed on the app. Possible values are Added, Removed, and Updated. | | ActionBy | Type string Properties Filter, Group, Nillable, Sort Description The user who performed the action. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the action was performed. | | AppName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the app. | | AuthorizedBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user who authorized the app. | | AuthorizedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the app was authorized. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The unique identifier for this detail record. This field is unique within your organization. | | IsEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the app is enabled. The default value is false. | | LastUsedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the app was last used. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of metric that the record represents. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the client app record. | | Policy | Type textarea Properties Nillable Description The configurable policies associated with the app. | | Publisher | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The publisher of the app. | | Scopes | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The scope or scopes assigned to the connected app. A scope defines the type of protected resource that the connected app accesses. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant org where the data was captured. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant org. | | Version | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The version of the app. | # TenantSecurityConfigAgent Stores metric details related to implemented Agentforce Agents This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available for Security Center subscribers. This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, Nillable, Sort Description The action taken on the configured agent within a tenant. | | ActionBy | Type string Properties Filter, Group, Nillable, Sort Description The user who made this change. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date this action was taken. | | AgentName | Type string Properties Filter, Group, Nillable, Sort Description The name of the configured agent. | | AgentType | Type string Properties Filter, Group, Nillable, Sort Description The type of agent. | | AssignedTopics | Type textarea Properties Nillable Description The list of agent topics. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique across all tenants. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The API name of the agent. | | Status | Type string Properties Filter, Group, Nillable, Sort Description The status, active or inactive, of the agent version. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant. | | TenantName | Type string Properties Filter, Group, Nillable, Sort Description The name of the tenant. | | Version | Type int Properties Filter, Group, Nillable, Sort Description The version number. | # TenantSecurityConnectedApp Stores the details for a connected app that was added to or removed from a Security Center tenant. This object is available to Security Center subscribers in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object can only be read and queried. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The action taken on the connected app within a tenant. Possible values are: - ADDED - REMOVED - UPDATED | | ActionBy | Type string Properties Filter, Group, Nillable, Sort Description The user who performed the action on the connected app. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the action was taken. | | AppName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the connected app. | | AuthorizedBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user who authorized the connected app to be installed. | | AuthorizedDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the connected app was authorized for installation. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique within your org. | | LastUsedDate | Type dateTime Properties Filter, Nillable, Sort Description The last date that the connected app was used for authentication. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data being collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | Publisher | Type string Properties Filter, Group, Nillable, Sort Description Represents if the relevant tenant is the original publisher of the connected app for all connected tenants in the org. | | Scope | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The scope or scopes assigned to the connected app. A scope defines the type of protected resource that the connected app can access. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the relevant tenant. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant that the connected app is connected to. | | Version | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The current version of the connected app. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityConnectedAppChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityConnectedAppFeed](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. [TenantSecurityConnectedAppHistory](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. [TenantSecurityConnectedAppOwnerSharingRule](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. [TenantSecurityConnectedAppShare](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. # TenantSecurityCredentialStuffing Stores when a user successfully logs in to Salesforce during an identified credential stuffing attack. For more information, see [Threat Detection](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.real_time_em_threat_detection.htm). This object is available to Security Center subscribers in API version 53.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Threat Detection is available only for Event Monitoring subscribers. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | AcceptLanguage | Type string Properties Filter, Group, Nillable, Sort Description List of HTTP headers that specify the natural language, such as English, that the client understands. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique within your org. | | EventDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the hijacking event was reported. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | EventIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique ID of the event. | | EventName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the event, which is Credential Stuffing. | | LoginType | Type string Properties Filter, Group, Nillable, Sort Description The type of login used to access the session. For the list of possible values, see the LoginType field of [LoginHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_loginhistory.htm) in the Object Reference. | | LoginUrl | Type string Properties Filter, Group, Nillable, Sort Description The URL of the login page. For example, login.salesforce.com. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for the data collected. | | Score | Type double Properties Filter, idLookup, Nillable, Sort Description Indicates that a user successfully logged in to Salesforce during an identified credential stuffing attack. The value of this field is always 1. | | Summary | Type textarea Properties Nillable Description A summary of the threat that caused this event to be created. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant that was targeted in the event. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant that was targeted in the event. | | UserAgent | Type textarea Properties Nillable Description UserAgent used in the HTTP request, post-processed by the server. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The origin user’s unique ID. | | Username | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The origin username in the format of user@company.com at the time the event was created. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityCredentialStuffingChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityCredentialStuffingFeed](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. [TenantSecurityCredentialStuffingHistory](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. [TenantSecurityCredentialStuffingOwnerSharingRule](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. [TenantSecurityCredentialStuffingShare](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. # TenantSecurityCustomMetricDetail Stores TenantSecurityCustomMetricStat drill down details. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Whether the metric detail record was added, updated, or removed. | | ActionBy | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The user who performs the action. | | ActionDate | Type dateTime Properties Create, Filter, Group, idLookup, Sort, Update Description When this change was made. | | CustomObjectIdentifier | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description A virtual foreign key reference to a Custom Object in which the metric details are stored. | | DiffFieldValueListHash | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The hash of custom metric diff fields value. | | FieldValueListHash | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The hash of custom metric fields value. | | MetricStatIdentifier | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description A virtual foreign key reference to TenantSecurityCustomMetricStat. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The Custom Object Api Name associates to the custom metric. | # TenantSecurityCustomMetricSetup Represents the configuration for a custom metric within Security Center. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CustomMetricIdentifier | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique identifier for the custom metric. | | CustomObjectIdentifier | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier for the custom object for this custom metric. | | CustomObjectName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique name of the custom object for this custom metric. | | DiffFieldIdentifierList | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The list of fields that were selected for Diff display. | | DisplayFieldIdentifierList | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The list of fields that were selected for display. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the custom metric. | | MetricDisplayType | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The display type for this metric. For example, diff or non-diff. | | MetricGroup | Type string Properties Create, Filter, Group, Sort, Update Description The category of the custom metric. Some category examples include Authenticationand Configuration. | | MetricName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the custom metric. The MetricName and Name fields have the same value. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the custom metric. The MetricName and Name fields have the same value. | # TenantSecurityCustomMetricStat Represents custom metric data within Security Center. This object is available in API version 61.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | ChangeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times this metric was changed. | | CustomMetricIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the custom metric. | | EndProcessTime | Type dateTime Properties Filter, Sort Description The end time of the metric being processed. | | MetricCount | Type int Properties Filter, Group, Sort Description The number of times this metric was recorded. | | MetricIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The unique identifier of the metric. | | MetricName | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the custom metric. | | PreviousMetricIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The previous unique identifier of this metric. | | StartProcessTime | Type dateTime Properties Filter, Sort Description The start time of the metric being processed. | | Tenant | Type string Properties Filter, Group, Sort Description The ID of the tenant with the custom metric. | # TenantSecurityEncryptedField Represents fields encrypted under your Shield Platform Encryption policy. This object is available in API version 61.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The action taken on the encryption policy within a tenant. Possible values are: - Added - Removed - Updated | | ActionBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description This field is reserved for future use. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the change to the tenant encryption policy status was made. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description Unique identifier for this detail record. | | EncryptionType | Type string Properties Filter, Group, Nillable, Sort Description The type of encryption for the field. | | FieldName | Type string Properties Filter, Group, Nillable, Sort Description The name of the encrypted field. | | FieldType | Type string Properties Filter, Group, Nillable, Sort Description The type of field being encrypted. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of encryption policy collected by this metric. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for the data collected. | | ObjectName | Type string Properties Filter, Group, Nillable, Sort Description The name of the object for this encrypted field. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant with Shield Encryption. | | TenantName | Type string Properties Filter, Group, Nillable, Sort Description The name of the tenant that this record is for. | # TenantSecurityEncryptionPolicy Stores tenant encryption policy status. This object is available in API version 58.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The action taken on the encryption policy within a tenant. Possible values are: - Added - Removed - Updated | | ActionBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description This field is reserved for future use. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description When the change to the tenant encryption policy status was made. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description Unique identifier for this detail record. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of encryption policy collected by this metric. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for the data collected. | | PolicyName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the policy. | | PolicyStatus | Type int Properties Filter, Group, idLookup, Nillable, Sort Description Status of the policy. Possible values are: - \-1—No license. - 0—Not Enabled. - \-1—Enabled | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant with Shield Encryption. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant that this record is for. | # TenantSecurityFeature Stores org features across all tenants in Security Center. This object is available in API version 57.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique across all tenants. | | FeatureDescription | Type string Properties Filter, Group, Nillable, Sort Description The description of the feature. | | FeatureName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the feature. | | IsEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feature is enabled or disabled. The default value is false. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of feature collected by this metric. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the feature for which data is being collected. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant where the feature was applied. | | TenantName | Type string Properties Filter, Group, Nillable, Sort Description The name of the connected tenant where the feature was enabled or disabled. | ## 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. [TenantSecurityFeatureChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityFeatureFeed](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. [TenantSecurityFeatureHistory](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. [TenantSecurityFeatureOwnerSharingRule](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. [TenantSecurityFeatureShare](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. # TenantSecurityGuestUserAnomaly Represents metric details for guest user anomaly events detected by Threat Detection. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique identifier for this detail record. | | EventDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time when the anomaly was reported. For example, 2020-01-20T19:12:26.965Z. The most granular setting is milliseconds. | | EventIdentifier | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique ID of the event, which is shared with the corresponding storage object. | | EventName | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The name of the event. | | MetricIdentifier | Type string Properties Create, Filter, Group, Sort, Update Description The ID of the type of metric counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of data collected. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the metric for the data collected. | | RequestedObjects | Type textarea Properties Create, Nillable, Update Description The objects requested by the customers. | | Score | Type double Properties Create, Filter, idLookup, Nillable, Sort, Update Description Specifies how significantly the guest user behavior deviates from the other guest users. It is formatted as a number between 0 and 1. | | SoqlCommands | Type textarea Properties Create, Nillable, Update Description SOQL commands run by the guest user. | | Summary | Type textarea Properties Create, Nillable, Update Description A text summary of the anomaly that caused this event. | | Tenant | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The ID of the tenant that was targeted in the event. | | TenantName | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The name of the tenant that was targeted in the event. | | TotalControllerEvents | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The number of times controllers were triggered. | | UserAgent | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description User Agent for this event. | | UserIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The origin user’s unique ID. | | UserType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Type of user of this event. For example, a guest user. | | Username | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The origin username in the format of user@company.com at the time the event was created. | ## 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. [TenantSecurityGuestUserAnomalyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityGuestUserAnomalyFeed](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. [TenantSecurityGuestUserAnomalyHistory](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. [TenantSecurityGuestUserAnomalyOwnerSharingRule](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. [TenantSecurityGuestUserAnomalyShare](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. # TenantSecurityHealthCheckBaselineTrend Stores metric details related to Health Check baseline settings. The Health Check detail page in Security Center displays scores and settings for all your tenants in one place. Use this object to get details about which metrics are collected and for which tenants, and changes made to the Health Check baseline. This object is available to Security Center subscribers in API version 54.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, Nillable, Sort, idLookup Description The type of action. For example, added, updated, or removed. | | ActionBy | Type string Properties Filter, Group, Nillable, Sort Description The user or admin that made the change. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time of the change. | | ApiName | Type string Properties Filter, Group, Nillable, Sort, idLookup Description The name of the metric used by the API and managed packages. | | BaselineDescription | Type string Properties Filter, Group, Nillable, Sort Description For custom baselines, the name of the custom baseline file. | | BaselineIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the baseline. | | BaselineName | Type string Properties Filter, Group, Nillable, Sort, idLookup Description The name of the baseline. | | DetailIdentifier | Type string Properties Filter, Group, Sort Description The identifier for the tenant security health check baseline trend detail record. This field is unique within your org. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the baseline is default or custom. The default is false. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric collected. | | MetricsType | Type string Properties Filter, Group, Sort Description The type of data collected. For example, SecurityHealthCheckBaselineMetric. | | Name | Type string Properties Filter, Group, Sort, idLookup Description The name of the metric for the data collected. | | Tenant | Type string Properties Filter, Group, Sort, idLookup Description The ID of the tenant that was scored by the Security Health Check. | | TenantName | Type string Properties Filter, Group, Nillable, Sort, idLookup Description The name of the tenant that was scored by the Security Health Check. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityHealthCheckBaselineTrendChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityHealthCheckBaselineTrendFeed](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. [TenantSecurityHealthCheckBaselineTrendHistory](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. [TenantSecurityHealthCheckBaselineTrendOwnerSharingRule](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. [TenantSecurityHealthCheckBaselineTrendShare](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. # TenantSecurityHealthCheckDetail Stores the details of Health Check scores for a connected tenant. The Health Check detail page in Security Center displays scores and settings for all your tenants in one place. Use this object to get settings and risks per tenant on a selected date. This object is available to Security Center subscribers in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | HealthCheckSettingIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of the Health Check setting within your organization. | | HealthCheckTrendKey | Type string Properties Filter, Group, Nillable, Sort Description The ID of the Health Check trend related to the Health Check detail records. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the tenant that was scored. | | OrgValue | Type string Properties Filter, Group, Nillable, Sort Description The org’s value for the security setting. | | RiskType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The level of risk of the org’s security setting value. Possible values are: - HIGH\_RISK - MEDIUM\_RISK - MEETS\_STANDARD | | Setting | Type string Properties Filter, Group, Nillable, Sort Description The name of the security setting. For example, Minimum Password Length. | | SettingGroup | Type string Properties Filter, Group, Nillable, Sort Description The name of the security setting group in Setup that this setting is in. For example, Password Policies. | | SettingRiskCategory | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The level of risk of the org’s security settings. Possible values are: - HIGH\_RISK - INFORMATIONAL - LOW\_RISK - MEDIUM\_RISK | | StandardValue | Type string Properties Filter, Group, Nillable, Sort Description The recommended standard value for the security setting. | | Tenant | Type string Properties Filter, Group, Sort Description The ID of the tenant that was scored. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityHealthCheckDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityHealthCheckDetailFeed](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. [TenantSecurityHealthCheckDetailHistory](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. [TenantSecurityHealthCheckDetailOwnerSharingRule](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. [TenantSecurityHealthCheckDetailShare](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. # TenantSecurityHealthCheckTrend Stores the history of Security Health Check scores for a connected tenant within Security Center. Health Check in Security Center displays Health Check scores and the average risk settings for all your tenants in one place. This object belongs to the parent tenant and stores Health Check data pushed from child tenants. This object is available for Security Center subscribers in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Baseline | Type string Properties Filter, Group, Nillable, Sort Description The definition of an org’s security settings standards. | | HighRisk | Type int Properties Filter, Group, Sort Description Indicates that fields with this picklist value contain data highly sensitive to your company. | | Informational | Type int Properties Filter, Group, Sort Description Indicates that fields with this picklist value contain data that isn't sensitive for your company. | | LowRisk | Type int Properties Filter, Group, Sort Description Indicates that fields with this picklist value contain data with low sensitivity for your company. | | MediumRisk | Type int Properties Filter, Group, Sort Description Indicates that fields with this picklist value contain data with moderate sensitivity for your company. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the tenant that was scored. | | ProcessedTime | Type dateTime Properties Filter, Nillable, Sort Description The time when the Health Check score was calculated. | | Score | Type double Properties Filter, Sort Description The summary score that shows how your org measures against a security baseline. | | ScoreDelta | Type double Properties Filter, Nillable, Sort Description The percentage amount that the Health Check score changed. | | Tenant | Type string Properties Filter, Group, Sort, idLookup Description The ID of the tenant that was scored. | | TenantOriginalIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The original identifier for the tenant's Health Check Trend record. This field is unique within your org. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityHealthCheckTrendChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityHealthCheckTrendFeed](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. [TenantSecurityHealthCheckTrendHistory](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. [TenantSecurityHealthCheckTrendOwnerSharingRule](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. [TenantSecurityHealthCheckTrendShare](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. # TenantSecurityLicense Stores license usage information within Security Center. This object is available in API version 59.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available only for Security Center subscribers. This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The type of change made to the license. Possible values are: - ADDED - REMOVED - UPDATED | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when this change was made. | | DetailIdentifier | Type string Properties Filter, Group, Sort Description The identifier for the tenant security license detail record. This field is unique within your org. | | ExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description The date on which this license expires. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the corresponding TenantSecurityMonitorMetric. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of license collected by this metric. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the license. | | Status | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The status of the license. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant with this license. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant with this license. | | TotalLicenses | Type int Properties Filter, Group, idLookup, Nillable, Sort Description The total number of licenses. | | UsedLicenses | Type int Properties Filter, Group, idLookup, Nillable, Sort Description The number of used licenses. | | UsedLicensesLastUpdated | Type dateTime Properties Filter, Nillable, Sort Description The date that the used licenses were last updated for this tenant. | ## 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. [TenantSecurityLicenseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityLicenseFeed](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. [TenantSecurityLicenseHistory](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. [TenantSecurityLicenseOwnerSharingRule](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. [TenantSecurityLicenseShare](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. # TenantSecurityLogin Stores the login details of a single user to a tenant, grouped by date and type. You can query this object to find out how many times the user logged in to a specific tenant using a specific login type (for example, username/password or SSO). This object is available to Security Center subscribers in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Filter, Group, Sort Description The identifier for the tenant security login detail record. This field is unique within your org. | | LastLoginDate | Type dateTime Properties Filter, Nillable, Sort Description The last time the user logged in. | | LoginCount | Type int Properties Filter, Group, idLookup, Nillable, Sort Description The number of times the user has logged in to the tenant. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data collected. The supported metric types are: - LOGIN\_PWLESS - LOGIN\_PWLESS2FA - LOGIN\_UNPW - LOGIN\_UNPW2FA - LOGIN\_SSO - LOGIN\_SSO2FA - LOGIN\_OAUTH - LOGIN\_OAUTH2FA | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant that was scored. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant that was scored. | | UserEmail | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The email address of the user. | | Username | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user’s org username. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityLoginChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityLoginFeed](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. [TenantSecurityLoginHistory](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. [TenantSecurityLoginOwnerSharingRule](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. [TenantSecurityLoginShare](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. # TenantSecurityLoginIpRangeTrend Stores details of changes related to login IP ranges in Security Center. This object is available in API version 59.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is available only for Security Center subscribers. This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The type of change made to the login IP range. Possible values are: - ADDED - REMOVED - UPDATED | | ActionBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the person who made this change. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when this change was made. | | Description | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The description of the login IP range record. | | DetailIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The identifier for the tenant security login IP range trend detail record. This field is unique within your org. | | IpEndAddress | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The end IP address of the login IP range. For example, 10.0.0.0 – 10.255.255.255. | | IpRangeIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Unique identifier of the IP range. | | IpStartAddress | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The start IP address of the login IP range. For example, 10.0.0.0 – 10.255.255.255. | | MetricIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the corresponding TenantSecurityMonitorMetric. | | MetricsType | Type string Properties Filter, Group, Nillable, Sort Description The type of metric for the data collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for the data collected. | | ProfileIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the profile that is assigned to this login IP range. | | ProfileName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the profile that is assigned to this login IP range. | | Tenant | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the tenant (org) that this record is for. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant (org) that this record is for. | ## 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. [TenantSecurityLoginIpRangeTrendChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityLoginIpRangeTrendFeed](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. [TenantSecurityLoginIpRangeTrendHistory](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. [TenantSecurityLoginIpRangeTrendOwnerSharingRule](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. [TenantSecurityLoginIpRangeTrendShare](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. # TenantSecurityMcpServer Stores configuration snapshots and risk scores for third-party MCP (Model Context Protocol) servers connected to a tenant that Security Center monitors. This object is available to Security Center subscribers in API version 68.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The event that produced this record. Possible values are Added, Removed, and Updated. | | ActionBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user who performed the action. This field is null for automated risk score events. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time of the configuration change or risk score event. | | AddedBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user who first added the MCP server. | | AddedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the MCP server was first added. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The unique identifier for this detail record. This field is unique within your organization. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of metric that the record represents. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the MCP server record. | | PreviousRiskScore | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The risk score for this MCP server before the most recent risk score update. | | RiskScore | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The calculated risk score for this MCP server when the record was written. | | ServerName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The API developer name of the third-party MCP server. | | ServerUrl | Type url Properties Filter, Nillable, Sort Description The endpoint URL of the third-party MCP server. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant org where the data was captured. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant org. | | ToolCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of tools on this server when the record was written. | | Tools | Type textarea Properties Nillable Description A JSON array of the tools on this server when the record was written. | # TenantSecurityMetricDetail Stores detailed drill-down data for Security Center Health Check metrics. Each record contains dimension values and metric data for a specific metric type. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field Name | Details | | --- | --- | | DateTimeValue1 | Type dateTime Properties Filter, Nillable, Sort Description Generic datetime storage field. Meaning depends on MetricIdentifier. | | DateTimeValue2 | Type dateTime Properties Filter, Nillable, Sort Description Generic datetime storage field. Meaning depends on MetricIdentifier. | | DetailIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier for this detail record. | | IntValue1 | Type int Properties Filter, Group, Nillable, Sort Description Generic integer storage field. Meaning depends on MetricIdentifier. | | IntValue2 | Type int Properties Filter, Group, Nillable, Sort Description Generic integer storage field. Meaning depends on MetricIdentifier. | | MetricIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the type of metric counted. This field is unique within your organization. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which the data is being collected. | | Tenant | Type string Properties Filter, Group, Nillable, Sort Description The ID of the tenant. | | TextValue1 | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Generic text storage field. Meaning depends on MetricIdentifier. | | TextValue2 | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Generic text storage field. Meaning depends on MetricIdentifier. | | TextValue3 | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Generic text storage field. Meaning depends on MetricIdentifier. | | TextValue4 | Type string Properties Filter, Group, Nillable, Sort Description Generic text storage field. Meaning depends on MetricIdentifier. | | TextValue5 | Type string Properties Filter, Group, Nillable, Sort Description Generic text storage field. Meaning depends on MetricIdentifier. | | TextValue6 | Type string Properties Filter, Group, Nillable, Sort Description Generic text storage field. Meaning depends on MetricIdentifier. | | TextValue7 | Type string Properties Filter, Group, Nillable, Sort Description Generic text storage field. Meaning depends on MetricIdentifier. | ## Associated Objects This object has these associated objects. If the API version isn't specified, it's available in the same API versions as this object. Otherwise, it's available in the specified API version and later. TenantSecurityMetricDetailLink Represents the many-to-many join object between TenantSecurityMetricDetail and TenantSecurityMonitorMetric. # TenantSecurityMetricDetailLink Represents the link between the metric count and metric drill down. This object is available in API version 48.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The unique identifier for this detail record. | | MetricIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the type of metric counted. This field is unique within your organization. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for the data collected. | | Tenant | Type string Properties Filter, Group, Nillable, Sort Description The ID of the tenant that was targeted in the event. | # TenantSecurityMobilePolicyTrend Stores metrics related to changes in mobile security policies across all tenants in Security Center. This object is available to Security Center subscribers in API version 54.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object can only be read and queried. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The change made to the mobile security policy. For example, a new policy was added, updated, or removed. | | ActionBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user who made the change. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time of the mobile security policy change. | | ConnectedApp | Type string Properties Filter, Group, Nillable, Sort Description The app that is associated with the mobile security policy. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique across all tenants. | | EffectiveDate | Type dateTime Properties Filter, Nillable, Sort Description The date a mobile security policy is enforced. | | IsEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description A value indicating whether the mobile security policy is enabled. The default is false, which means policies are disabled. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The foreign key of the metric. | | MetricsType | Type string Properties Filter, Group, Sort Description The type of mobile security policy data collected. | | MobilePlatform | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The mobile operating system of the mobile security policy. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is collected. | | PolicyType | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The type of mobile security policy. For example, Block Calendar. | | RuleValue | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The value of the security notification rule. | | RuleValueType | Type string Properties Filter, Group, Nillable, Sort Description The type of rule value. For example, boolean or text. | | SeverityLevel | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The severity level of the security threat. For example, CRITICAL. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityPackageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityPackageFeed](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. [TenantSecurityPackageHistory](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. [TenantSecurityPackageOwnerSharingRule](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. [TenantSecurityPackageShare](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. # TenantSecurityMonitorMetric Stores the daily count and daily count change for a metric within Security Center. This object is available to Security Center subscribers in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | ChangeCount | Type int Properties Filter, Group, Nillable, Sort Description How much the relevant metric changed. | | Count | Type int Properties Filter, Group, Sort Description The current metric count. | | EndProcessTime | Type dateTime Properties Filter, Sort Description The date and time that the metric count process ended. | | MetricIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the type of metric counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the tenant. | | PreviousMetricIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The previous ID of the type of metric that was counted. This field is unique within your organization. | | ReferencedMetricIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of a related metric that is referenced by this metric. | | StartProcessTime | Type dateTime Properties Filter, Sort Description The date and time that the metric count process started. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant that was scored. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityMonitorMetricChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityMonitorMetricFeed](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. [TenantSecurityMonitorMetricHistory](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. [TenantSecurityMonitorMetricOwnerSharingRule](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. [TenantSecurityMonitorMetricShare](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. # TenantSecurityNotification Stores information about notifications that were triggered in Security Center as a function of the Alerts feature. For more information, see [Create Alerts for Security Changes](https://help.salesforce.com/s/articleView?id=xcloud.security_center_create_alerts.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 54.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | MetricCount | Type int Properties Filter, Group, Sort Description The metric count that triggered the notification. | | MetricIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type string Properties Filter, Group, idLookup, Sort Description The metric for which the notification was sent. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the triggered notification rule. | | NotificationDate | Type dateTime Properties Filter, Sort Description The date and time that the notification was sent. | | NotificationType | Type string Properties Filter, Group, idLookup, Sort Description The type of notification sent. For example, a Chatter feed or push notification. | | Operator | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The quantity of metrics used to measure. | | RecipientEmails | Type textarea Properties Nillable Description The email addresses of the recipients who receive security notifications. | | RuleName | Type string Properties Filter, Group, Sort Description The name of the notification rule. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant for which the notification was triggered. | | TenantName | Type string Properties Filter, Group, idLookup, Sort Description The org name of the tenant for which the notification was triggered. | | Threshold | Type int Properties Filter, Group, idLookup, Nillable, Sort Description The threshold value that triggered the notification. | | TriggerType | Type string Properties Filter, Group, Nillable, Sort Description The type of trigger that set off the notification. For example, a security change was made. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityNotificationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityNotificationFeed](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. [TenantSecurityNotificationHistory](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. [TenantSecurityNotificationOwnerSharingRule](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. [TenantSecurityNotificationShare](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. # TenantSecurityNotificationRule Stores an alert configured in the Security Center Alerts feature to notify recipients of changes made to security settings. For more information, see [Create Alerts for Security Changes](https://help.salesforce.com/s/articleView?id=xcloud.security_center_create_alerts.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is read/write. ## Fields | Field | Details | | --- | --- | | MetricsType | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The type of data being collected. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the metric for which data is being collected. | | NotificationRuleIdentifier | Type string Properties Create, Filter, Group, Sort, Update Description The ID of the alert that was triggered. This field is unique within your organization. | | NotificationType | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The type of notification used for the alert. The options are: - Email - In-App | | Operator | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The operator for the change that triggered the alert. For example, greater than. | | RecipientEmails | Type textarea Properties Create, Nillable, Update Description The email addresses for the recipients of the alert details. | | RuleName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the custom alert that triggered the notification. This field is unique within your organization. | | Status | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The status of the alert setting. The options are: - Active - Draft - Inactive | | Threshold | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The threshold value that triggered the alert. | | TriggerType | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The type of trigger used for the alert. The values are: - Always - On Change | | Version | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The version number of the custom alert. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityNotificationRuleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityNotificationRuleFeed](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. [TenantSecurityNotificationRuleHistory](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. [TenantSecurityNotificationRuleOwnerSharingRule](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. [TenantSecurityNotificationRuleShare](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. # TenantSecurityPackage Stores details about managed and unmanaged packages that are added, updated, or removed from a tenant in Security Center. Use this object to identify whether new packages are installed, upgraded, or uninstalled from your connected tenants. This object is available to Security Center subscribers in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object can only be read and queried. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The action taken on a package within a tenant. The options are: - Added - Removed | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date the action was taken. | | AppExchangeReady | Type int Properties Filter, Group, Nillable, Sort Description Indicates whether the package has passed AppExchange review. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique within your org. | | InstalledBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user that installed the package. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data being collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with the package. | | PackageIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the package. | | PackageName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the package being added to or removed from the tenant. | | Publisher | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the publisher that created the package. | | ReleaseStatus | Type string Properties Filter, Group, Nillable, Sort Description The release status of the package. The options are: - Beta - Released | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant that the package was added to or removed from. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant that the package was added to or removed from. | | UninstalledBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user that uninstalled the package. | | Version | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The current version of the package. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityPackageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityPackageFeed](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. [TenantSecurityPackageHistory](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. [TenantSecurityPackageOwnerSharingRule](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. [TenantSecurityPackageShare](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. # TenantSecurityPolicy Stores security policies created and deployed in Security Center. For more information, see [Define and Deploy Security Policies](https://help.salesforce.com/s/articleView?id=xcloud.security_center_deploy_policies.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is read/write. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The API name of the policy. This field is unique within your organization. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the policy. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the policy. | | PolicyData | Type textarea Properties Create, Update Description The policy details contained in JSON format. | | PolicyIdentifier | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The ID of this policy. Contains a unique virtual key from child to parent. | | PolicyType | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The type of policy. For example, Health Check Baseline. | | SourceRowIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the policy that is applied to the tenant. This value is specific to the org that owns this record. | | Status | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The status of the policy. For example, the policy is active or inactive. | | Version | Type int Properties Create, Filter, Group, idLookup, Sort, Update Description The version of the policy. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityPolicyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityPolicyFeed](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. [TenantSecurityPolicyHistory](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. [TenantSecurityPolicyOwnerSharingRule](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. [TenantSecurityPolicyShare](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. # TenantSecurityPolicyChange Captures policy lifecycle events, such as creation, modification, and deletion, for the tenants that Security Center monitors. This object is available to Security Center subscribers in API version 68.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The action performed on the policy. Possible values are Added, Removed, and Updated. | | ActionBy | Type string Properties Filter, Group, Nillable, Sort Description The user who performed the action. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the action was performed. | | Category | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The category of the policy rule, such as Access, Governance, or Trannsform. | | Consumer | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The consumer of the policy rule, such as Datacloud. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The unique identifier for this detail record. This field is unique within your organization. | | Effect | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The effect of the policy rule, such as Permit, Deny, or Transform. | | EventDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the policy change event occurred. For example, 2020-01-20T19:12:26.965Z. | | EventIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique identifier for the platform event that triggered collection of this record. | | IsMultiOrg | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the policy is replicated across multiple orgs. If false, the policy is local to a single org. The default value is false. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric counted. This field is unique within your organization. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of metric that the record represents. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the policy change record. | | PolicyJson | Type textarea Properties Nillable Description The full policy definition in JSON format. | | PolicyName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the policy. | | PolicyRef | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The Salesforce ID of the policy. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant org where the data was captured. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant org. | # TenantSecurityPolicyChangeLog Tracks changes to Security Center policy fields. Each record represents a single field change on a policy. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is read/write. ## Fields | Field Name | Details | | --- | --- | | Field | Type string Properties Create, Filter, Group, Sort, Update Description The name of the field that was changed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique identifier for the change log record. | | NewValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The new value of the field that was changed. | | OldValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The latest value of the field before it was changed. | | PolicyIdentifier | Type string Properties Create, Filter, Group, Sort, Update Description The ID of this policy. Contains a unique virtual key from child to parent. | ## Associated Objects This object doesn't have associated objects. # TenantSecurityPolicyDeployment Stores the status of deployments of a Security Center policy on a tenant. For more information, see [Define and Deploy Security Policies](https://help.salesforce.com/s/articleView?id=xcloud.security_center_deploy_policies.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is read/write. ## Fields | Field | Details | | --- | --- | | DeploymentDate | Type dateTime Properties Create, Filter, Sort, Update Description The date the deployment was triggered. | | DeploymentStatus | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The status of the deployment. For example, Not Deployed, Processing, Deployed, or Failed. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the deployment status. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the deployment. | | PolicyIdentifier | Type string Properties Create, Filter, Group, Sort, Update Description The ID of the TenantSecurityPolicy entity. | | StatusDate | Type dateTime Properties Create, Filter, Sort, Update Description The date that the status of the deployment was provided. | | Tenant | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The ID of the tenant for which the policy was deployed. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityPolicyDeploymentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityPolicyDeploymentFeed](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. [TenantSecurityPolicyDeploymentHistory](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. [TenantSecurityPolicyDeploymentOwnerSharingRule](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. [TenantSecurityPolicyDeploymentShare](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. # TenantSecurityPolicySelectedTenant Stores the list of tenants selected for a Security Center policy. For more information, see [Define and Deploy Security Policies](https://help.salesforce.com/s/articleView?id=xcloud.security_center_deploy_policies.htm&type=5&language=en_US). This object is available to Security Center subscribers in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is read/write. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the policy for the selected tenant. | | PolicyIdentifier | Type string Properties Create, Filter, Group, Sort, Update Description The ID of the security policy. | | Tenant | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The ID of the tenant. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityPolicySelectedTenantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityPolicySelectedTenantFeed](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. [TenantSecurityPolicySelectedTenantHistory](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. [TenantSecurityPolicySelectedTenantOwnerSharingRule](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. [TenantSecurityPolicySelectedTenantShare](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. # TenantSecurityReportAnomaly Stores anomalies in how users run or export reports, including unsaved reports, as detected by Threat Detection. For more information, see [Threat Detection](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.real_time_em_threat_detection.htm). This object is available to Security Center subscribers in API version 53.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Threat Detection is available only for Event Monitoring subscribers. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Filter, Group, Sort Description The identifier for the tenant security report anomaly detail record. This field is unique within your org. | | EventDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the hijacking event was reported. For example, 2020-01-20T19:12:26.965Z. The most granular setting is milliseconds. | | EventIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique ID of the event. | | EventName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the event, which is Report Anomaly. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data being collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | Report | Type string Properties Filter, Group, Nillable, Sort Description The ID for the report for which this anomaly event was detected. If the anomaly resulted from a user executing an unsaved report, the value of this field is null. | | Score | Type double Properties Filter, idLookup, Nillable, Sort Description A number from 0 through 100 that represents the anomaly score for the report execution or export tracked by this event. The anomaly score indicates how the user’s current report activity differs from their typical activity. A low score indicates that the current report activity is similar to the user’s usual activity. A high score indicates that it’s different. | | SecurityEventData | Type textarea Properties Nillable Description The set of features about the report activity that triggered this anomaly event. For example, a user typically downloads 10 accounts at a time, but then deviates from that pattern and downloads 1,000 accounts. This event is triggered, and the contributing features are captured in this field. Potential features include row count, column count, average row size, day of week, and the browser’s user agent used for the report activity. The data captured also shows as a percentage how much a particular feature contributed to this anomaly event. The data is in JSON format. | | Summary | Type textarea Properties Nillable Description A text summary of the report anomaly that caused this event. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant that was targeted in the event. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant that was targeted in the event. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The origin user’s unique ID. | | Username | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The origin username in the format of user@company.com at the time the event was created. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityReportAnomalyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityReportAnomalyFeed](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. [TenantSecurityReportAnomalyHistory](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. [TenantSecurityReportAnomalyOwnerSharingRule](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. [TenantSecurityReportAnomalyShare](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. # TenantSecurityRiskSpec Represents the configuration of a monitored risk type for a tenant in Security Center, including the risk level and the measurement scope. This object is available to Security Center subscribers in API version 68.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the risk specification. | | RiskDescription | Type string Properties Filter, Group, Nillable, Sort Description The description of the risk configuration. | | RiskLevel | Type string Properties Filter, Group, Nillable, Sort Description The level of risk, such as High, Medium, or Low. | | RiskSpecConfig | Type textarea Properties Nillable Description A JSON representation that stores the risk specification configuration. | | RiskType | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The type of risk being configured. | | Scope | Type string Properties Filter, Group, Nillable, Sort Description An explanation of what the risk specification measures, based on the selected risk type. | | Tenant | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the configured tenant. | | TenantName | Type string Properties Filter, Group, Nillable, Sort Description The name of the configured tenant. | # TenantSecuritySessionHijacking Stores information about session hijacking events as detected by Threat Detection within connected tenants in Security Center. For more information, see [Threat Detection](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.real_time_em_threat_detection.htm). This object is available for Security Center subscribers in API version 53.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Threat Detection is available only for Event Monitoring subscribers. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | CurrentIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the observed fingerprint that deviates from the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. If the IP address didn’t contribute to the observed fingerprint deviation, the value of this field is the same as the PreviousIp field. | | CurrentPlatform | Type string Properties Filter, Group, Nillable, Sort Description The platform of the observed fingerprint that deviates from the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. If the platform didn’t contribute to the observed fingerprint deviation, the value of this field is the same as the PreviousPlatform field. | | CurrentScreen | Type string Properties Filter, Group, Nillable, Sort Description The screen of the observed fingerprint that deviates from the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. If the screen didn’t contribute to the observed fingerprint deviation, the value of this field is the same as the PreviousScreen field. | | CurrentUserAgent | Type textarea Properties Nillable Description The user agent of the observed fingerprint that deviates from the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. If the user agent didn’t contribute to the observed fingerprint deviation, the value of this field is the same as the PreviousUserAgent field. | | CurrentWindow | Type string Properties Filter, Group, Nillable, Sort Description The browser window of the observed fingerprint that deviates from the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. If the window didn’t contribute to the observed fingerprint deviation, the value of this field is the same as the PreviousWindow field. | | DetailIdentifier | Type string Properties Filter, Group, Sort Description The identifier for the tenant security session hijacking detail record. This field is unique within your org. | | EventDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the hijacking event was reported. For example, 2020-01-20T19:12:26.965Z. The most granular setting is milliseconds. | | EventIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique ID of the event. | | EventName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the event, which is Session Hijacking. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data being collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | PreviousIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. See the CurrentIp field for the newly observed IP address. | | PreviousPlatform | Type string Properties Filter, Group, Nillable, Sort Description The platform of the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. See the CurrentPlatform field for the newly observed platform. | | PreviousScreen | Type string Properties Filter, Group, Nillable, Sort Description The screen of the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. See the CurrentScreen field for the newly observed screen. | | PreviousUserAgent | Type textarea Properties Nillable Description The user agent of the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. See the CurrentUserAgent field for the newly observed user agent. | | PreviousWindow | Type string Properties Filter, Group, Nillable, Sort Description The browser window of the previous fingerprint. The difference between the current and previous values is one indicator that a session hijacking attack has occurred. See the CurrentWindow field for the newly observed window. | | Score | Type double Properties Filter, idLookup, Nillable, Sort Description Specifies how much the new fingerprint deviates from the previous one. The score is from 6.0 through 21.0. The event exposes five field pairs (such as CurrentIp and PreviousIp) to view the before and after data for browser features that contributed to this anomaly. See the SecurityEventData field for all contributing features in JSON format. A large deviation score (6.0 or more) between two intra-session fingerprints indicates that two different browsers are active in the same session. The presence of two active browsers usually means that session hijacking has occurred. | | SecurityEventData | Type textarea Properties Nillable Description The set of browser fingerprint features that triggered this event. See the [Threat Detection documentation](https://help.salesforce.com/articleView?id=real_time_em_threat_session.htm&type=5&language=en_US) for the possible features. For example, a user’s current browser fingerprint diverges from the previously known fingerprint. If Salesforce concludes the user’s session was hijacked, it fires this event, and the contributing features are captured in this field in JSON format. Each feature describes a browser fingerprint property, such as the browser user agent, window, or platform. The data includes the current and previous values for each feature. | | Summary | Type textarea Properties Nillable Description A text summary of the threat that caused this event. The summary lists the browser fingerprint features that most contributed to the threat detection, along with their contribution to the total score. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant that was targeted in the event. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant that was targeted in the event. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The origin user’s unique ID. | | Username | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The origin username in the format of user@company.com at the time that the event was created. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecuritySessionHijackingChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecuritySessionHijackingFeed](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. [TenantSecuritySessionHijackingHistory](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. [TenantSecuritySessionHijackingOwnerSharingRule](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. [TenantSecuritySessionHijackingShare](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. # TenantSecurityTenantChangeLog Tracks changes to Security Center tenant fields. Each record represents a single field change on a tenant. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Field | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the field that was changed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique identifier for the change log record. | | NewValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The new value of the field that was changed. | | OldValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The latest value of the field before it was changed. | | Tenant | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The ID of the tenant associated with this change log record. | # TenantSecurityTenantInfo Stores information on changes related to the tenant history. This object is available in API version 56.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read only. ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The unique identifier for this record. | | Instance | Type string Properties Filter, Group, Nillable, Sort Description The instance that the tenant is being hosted on. | | MyDomainName | Type string Properties Filter, Group, Nillable, Sort Description The name of the domain for this tenant. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which the data is being collected. | | SandboxAlias | Type string Properties Filter, Group, Nillable, Sort Description The alias specified by the user when the user creates a Sandbox. | | SandboxType | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The type specified by the user when the user creates a Sandbox. | | Status | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The status of the tenant. For example, active or inactive. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant. | | TenantName | Type string Properties Filter, Group, idLookup, Sort Description The name of the tenant (org) that this record is for. | | TenantType | Type string Properties Filter, Group, idLookup, Sort Description The type of tenant in this org. | ## 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. [TenantSecurityTenantInfoChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityTenantInfoFeed](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. [TenantSecurityTenantInfoHistory](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. [TenantSecurityTenantInfoOwnerSharingRule](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. [TenantSecurityTenantInfoShare](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. # TenantSecurityTransactionPolicyTrend Stores changes to the count of Transaction Security Policies for a connected tenant within Security Center. This object is available for Security Center subscribers in API version 55.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Stores information on a change to the policy. Available options include: - ADDED - REMOVED - UPDATED | | ActionBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the person who made this change. | | ActionConfig | Type textarea Properties Nillable Description Contains a JSON description for how a user is alerted to an action on the policy. For example: - In-app - Email | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description When this change was made. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description Unique identifier for this detail record. | | EventName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the event of the corresponding Transaction Security Policy. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the corresponding TenantSecurityMonitorMetric. | | MetricsType | Type string Properties Filter, Group, Sort Description The type of metric for the data collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for the data collected. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant (org) that this record is for. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant (org) that this record is for. | | TransactionPolicyState | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The state of the transaction security policy. The possible states are ENABLED or DISABLED. | | TransactionPolicyType | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The type of policy configured. The available types are standard policy or a custom Apex policy. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityPolicyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityPolicyFeed](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. [TenantSecurityPolicyHistory](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. [TenantSecurityPolicyOwnerSharingRule](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. [TenantSecurityPolicyShare](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. # TenantSecurityTrigTransactionSecurityPol Stores metric details related to Transaction Security Policy triggering events. This object is available in API version 63.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read only. ## Fields | Field | Details | | --- | --- | | ApexClass | Type string Properties Filter, Group, Nillable, Sort Description The name of the Apex class used to evaluate the policy. | | ApexIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the Apex code used to evaluate the policy. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as “Salesforce.com IP”. | | DetailIdentifier | Type string Properties Filter, Group, Sort Description The ID of the individual detail record. This field is unique within your organization. | | FlowIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the flow used to evaluate the policy. | | FlowName | Type string Properties Filter, Group, Nillable, Sort Description The name of the Flow used to evaluate the policy. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | PolicyName | Type string Properties Filter, Group, Nillable, Sort Description The name of the policy being evaluated. | | PolicyOutcome | Type string Properties Filter, Group, Nillable, Sort Description The result of the transaction policy. | | PolicyType | Type string Properties Filter, Group, Nillable, Sort Description The real time action selected for the policy. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant of this triggered the Transaction Security Policy event. | | TenantName | Type string Properties Filter, Group, Nillable, Sort Description The name of the tenant where this triggered Transaction Security Policy happened. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. | | Username | Type string Properties Filter, Group, Nillable, Sort Description The username of the user who’s using Salesforce services through the UI or the API. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric counted. This field is unique within your organization. | | PolicyIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of this policy. Contains a unique virtual key from child to parent. | | TriggeredTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The time at which the Transaction Security event was generated in ISO8601-compatible format. For example: 2015-07-27T11:32:59.555Z. | # TenantSecurityTrustedIpRangeTrend Stores details of changes related to trusted IP ranges in Security Center.This object is available for Security Center subscribers in API version 54.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object is read-only. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Stores information on a change to the policy. Available options include: - ADDED - REMOVED - UPDATED | | ActionBy | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the person who made this change. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description When this change was made. | | Description | Type string Properties Filter, Group, idLookup, Nillable, Sort Description A description of the trusted IP range. For example, "Trusting the IP addresses from NA-West region". | | DetailIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The identifier for the tenant security trusted IP range trend detail record. This field is unique within your org. | | IpEndAddress | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The end IP address of a trusted IP range. For example, 10.0.0.0 – 10.255.255.255. | | IpRangeIdentifier | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Unique identifier of the IP range. | | IpStartAddress | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The start IP address of a trusted IP range. For example, 10.0.0.0 – 10.255.255.255. | | MetricIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the corresponding TenantSecurityMonitorMetric. | | MetricsType | Type string Properties Filter, Group, Nillable, Sort Description The type of metric for the data collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for the data collected. | | Tenant | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the tenant (org) that this record is for. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant (org) that this record is for. | | UsageOptions | Type string Properties Filter, Group, Nillable, Sort Description For internal use only. | ## 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. [TenantSecurityTrustedIpRangeTrendChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityTrustedIpRangeTrendFeed](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. [TenantSecurityTrustedIpRangeTrendHistory](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. [TenantSecurityTrustedIpRangeTrendOwnerSharingRule](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. [TenantSecurityTrustedIpRangeTrendShare](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. # TenantSecurityUserActivity Stores details related to how a user interacts with a tenant. Use this object to determine whether to reevaluate a user’s access to your org for security purposes. You can check whether a user has never logged in, hasn’t been active for 90 days, has a frozen account, or isn’t using multi-factor authentication. This object is available to Security Center subscribers in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object can only be read and queried. ## Fields | Field | Details | | --- | --- | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique within your org. | | LastLoginDate | Type dateTime Properties Filter, Nillable, Sort Description The last time the user logged in. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of data being collected. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the tenant where the user activity happened. | | UserCreatedDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the user was created. | | UserEmail | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The email address of the user. | | UserLicense | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The license assigned to the user. | | Username | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user’s org username. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityUserActivityChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityUserActivityFeed](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. [TenantSecurityUserActivityHistory](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. [TenantSecurityUserActivityOwnerSharingRule](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. [TenantSecurityUserActivityShare](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. # TenantSecurityUserPerm Stores information on permissions assigned to a user. Use this object to see which tenants a user is assigned to. This object is available to Security Center subscribers in API version 53.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules This object can only be read and queried. ## Fields | Field | Details | | --- | --- | | Action | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The action taken regarding the user’s permission. The options are: - Added - Removed | | ActionBy | Type string Properties Filter, Group, Nillable, Sort Description This field is reserved for future use. | | ActionDate | Type dateTime Properties Filter, Nillable, Sort Description The date that the permission action was taken. | | Context | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the profile or permission set assigned to the user. | | ContextType | Type string Properties Filter, Group, idLookup, Nillable, Sort Description Indicates the method through which the permission was granted. The options are: - Permission Set - Profile | | DataSpaceName | Type string Properties Filter, Group, Nillable, Sort Description The name of the data space where the tenant security user permission is tracked. | | DetailIdentifier | Type string Properties Filter, Group, idLookup, Sort Description The ID of the individual detail record. This field is unique within your org. | | MetricIdentifier | Type string Properties Filter, Group, Sort Description The ID of the type of metric that was counted. | | MetricsType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of metric that the assigned permission represents. | | Name | Type string Properties Filter, Group, idLookup, Sort Description The name of the metric for which data is being collected. | | Tenant | Type string Properties Filter, Group, idLookup, Sort Description The ID of the tenant where the user permission was applied. | | TenantName | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the connected tenant where the user permission was applied. | | UserEmail | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user’s email address. | | UserLicense | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The license assigned to the user. | | Username | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The user’s org username. | ## Associated Objects This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later. [TenantSecurityUserPermChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantSecurityUserPermFeed](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. [TenantSecurityUserPermHistory](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. [TenantSecurityUserPermOwnerSharingRule](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. [TenantSecurityUserPermShare](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. # TenantUsageEntitlement Represents a data structure that contains information about the features or functionalities that a Salesforce org has access to. This object is available in API version 28.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AmountUsed | Type double Properties Filter, Nillable, Sort Description The quantity of an entitlement that has been used. | | CurrentAmountAllowed | Type double Properties Filter, Sort Description The amount of an entitlement that a tenant is allowed to use. | | EndDate | Type date Properties Filter, Group, Nillable, Sort Description The end date of the setting, based on license end dates that entitle the org to that setting. | | Frequency | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description How often the tenant's entitlement data is automatically reviewed to see how much of the entitlement has been used. Possible values are: - Daily - Fortnightly - Monthly - Once - Quarterly - Weekly - Yearly | | HasRollover | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that a certain amount of a customer's unused entitlements from a set time period can be added to the next set time period. This field is reserved for future use. The default value is false. | | IsPersistentResource | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the data that will be saved and available for future use even after closing a session. The default value is false. | | MasterLabel | Type string Properties Group, Nillable Description The overarching name of an element in your organization. A MasterLabel is visible to customers. | | OverageGrace | Type percent Properties Filter, Nillable, Sort Description The percentage of the Allowed Amount that a customer can use without incurring an additional charge. The default value is 100% (no overage grace). This field is reserved for future use. | | ResourceGroupKey | Type string Properties Filter, Group, Sort Description Tracks resource usage across different segments for the same setting. For example, a Messages entitlement that tracks email messages and SMS messages separately could have one ResourceGroupKey of SMS and another ResourceGroupKey of Email. In most cases though, TenantUsageEntitlements are configured for the org and not by segment. | | Setting | Type string Properties Filter, Group, Sort Description A rule or attribute that can be used to configure the appearance or actions in an organization. | | StartDate | Type date Properties Filter, Group, Sort Description This date is the earliest start date of any license contributing to the provisioning aggregation output. | | UsageDate | Type dateTime Properties Filter, Nillable, Sort Description The date an event occurred that deducted from the tenant's entitlement. | ## 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. [TenantUsageEntitlementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantUsageEntitlementFeed](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. [TenantUsageEntitlementHistory](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. [TenantUsageEntitlementOwnerSharingRule](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. [TenantUsageEntitlementShare](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. # Territory Represents a flexible collection of accounts and users where the users have at least read access to the accounts, regardless of who owns the accounts. Available if Sales Territories has been enabled. This object is available in API versions 7.0 to 52.0. Use Territory2 instead of Territory in API version 52.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Standard and partner users can access this object. Users assigned to the Manage Territories permission set can edit this object. ## Fields | Field | Details | | --- | --- | | AccountAccessLevel | Type picklist Properties Create, Filter, Group, Sort, Update Description Account access level granted to users assigned to this territory. | | CaseAccessLevel | Type picklist Properties Create, Filter, Nillable, Group, Sort, Update Description Case access level granted to users assigned to this territory. | | ContactAccessLevel | Type picklist Properties Filter, Group, Nillable, Sort Description A value that represents the type of access granted to the target Group, UserRole, or User for any associated contacts. The possible values are: - None - Read - Edit ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When DefaultContactAccess is set to “Controlled by Parent,” you can’t create or update this field. | | Description | Type string Properties Create, Filter, Nillable, Sort, Update Description A description of the territory that is 1,000 characters or less. | | 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 org. 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. Corresponds to **Territory Name** in the user interface. This field is available in API version 24.0 and later. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | ForecastUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Forecast Manager, who is the user to whom forecasts from this territory’s child territories roll up. | | MayForecastManagerShare | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the forecast manager can manually share their own forecast. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description A name for the territory. Limit is 80 characters. Corresponds to **Label** on the user interface. | | OpportunityAccessLevel | Type picklist Properties Create, Filter, Group, Sort, Update Description Opportunity access level granted to users assigned to this territory. | | ParentTerritoryID | Type reference Properties Create, Filter, Nillable, Update Description Territory immediately above this territory in the territory hierarchy. Label is **Parent Territory ID**. | | RestrictOppTransfer | Type boolean Properties Create, Defaulted on create, Filter, Update Description Indicates whether the opportunities associated with this territory are kept within the bounds of this territory and this territory’s children when account assignment rules are run (true), or if opportunities associated with this territory can be assigned to other nodes of the territory hierarchy when account assignment rules are run (false). Label is **Confine Opportunity Assignment**. | ## Usage Use the Territory object to query your organization’s territory hierarchy. Use it to obtain valid territory IDs when querying or modifying records associated with territories. #### See Also - [AccountTerritoryAssignmentRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountterritoryassignmentrule.htm "An account assignment rule that assigns accounts to territories based on account fields. Available if Sales Territories has been enabled.") - [AccountTerritoryAssignmentRuleItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountterritoryassignmentruleitem.htm "A row of selection criteria for an AccountTerritoryAssignmentRule object. Available if Sales Territories has been enabled.") - [UserTerritory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userterritory.htm "Represents a User who has been assigned to a Territory.") # Territory2 Represents a sales territory. Available if Sales Territories has been enabled. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Standard and partner users can access this object. If a territory model is in Active state, any standard or partner user can view that model, including its territories and assignment rules. For territories in an active model, any standard or partner user can view assigned records and assigned users subject to your Salesforce sharing settings. Users cannot view territory models in other states (such as Planning or Archived). ## Fields | Field Name | Details | | --- | --- | | AccountAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Represents the default account record access levels for users that are assigned to the territory. Values are: - Read Only - Read/Write - Owner | | CaseAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Represents the default case record access levels for users that are assigned to the territory. Values are: - Private - Read Only - Read/Write | | ContactAccessLevel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Represents the default contact record access levels for users that are assigned to the territory. Values are: - Private - Read Only - Read/Write | | Description | Type string Properties Create, Filter, Nillable, Sort, Update Description The description of the territory. The field label in the user interface is Territory Description. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. 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. The field label in the user interface is Territory Name. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | ForecastUserId | Type reference Properties Filter, Group, Nillable, Sort, Update Description Unique identifier of a territory’s forecast manager. To select a ForecastUserId, select someone in the list of users assigned to the territory. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description The name of the territory. The field label in the user interface is Territory Label. | | OpportunityAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Represents the default opportunity record access levels for users that are assigned to the territory. Values are: - Private - Read Only - Read/Write | | ParentTerritory2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the territory’s parent territory (if any). If the territory has no parent territory, this value is null. | | Territory2ModelId | Type reference Properties Create, Filter, Group, Sort Description The ID of the territory model that the territory belongs to. | | Territory2TypeId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the territory type that the territory belongs to. | # Territory2AlignmentLog Represents the start and end status of a territory assignment rule run job. This object is available in API version 54.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Available if Sales Territories has been enabled. Standard and partner users can access this object. If a territory model is in Active state, any standard or partner user can view that model, including its territories and assignment rules. For territories in an active model, any standard or partner user can view assigned records and assigned users subject to your Salesforce sharing settings. Users can’t view territory models in other states (such as Planning or Archived). ## Fields | Field | Details | | --- | --- | | EndTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the assignment rule run job finished. | | Filter | Type textarea Properties Nillable Description Criteria to filter the rule jobs. For example, {RULE\_LAST\_MOD\_DATE\_FORM=2021-08-31, RULE\_LAST\_MOD\_DATE\_TO=2021-09-15}. | | RunAsId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Salesforce user who started the assignment rule run job. This is a relationship field. Relationship Name RunAs Relationship Type Lookup Refers To User | | StartTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the user started the assignment rule run job. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the assignment rule run job. | | Territory2Id | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the territory for which the assignment rule run was performed. If the assignment rule run was for the territory model, this value is null. This is a relationship field. Relationship Name Territory2 Relationship Type Lookup Refers To Territory2 | | Territory2ModelId | Type reference Properties Filter, Group, Sort Description The ID of the territory model for which the assignment rule run was performed. This is a relationship field. Relationship Name Territory2Model Relationship Type Lookup Refers To Territory2Model | ## 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. [Territory2AlignmentLogChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # Territory2Model Represents a territory model. Available if Sales Territories has been enabled. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Standard and partner users can access this object. If a territory model is in Active state, any standard or partner user can view that model, including its territories and assignment rules. For territories in an active model, any standard or partner user can view assigned records and assigned users subject to your Salesforce sharing settings. Users cannot view territory models in other states (such as Planning or Archived). ## Fields | Field Name | Details | | --- | --- | | ActivatedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the territory model was activated. | | DeactivatedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the territory model was archived. | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the territory model. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. 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. The field label in the user interface is Territory Model Name. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | LastOppTerrAssignEndDate | Type dateTime Properties Filter, Nillable, Sort Description Read-only. The date when the opportunity territory assignment filter was last run. Used for Filter-Based Opportunity Territory Assignment (Pilot in Spring ’15 / API version 33). | | LastRunRulesEndDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the last rules run was completed. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description The territory model name. The field label in the user interface is Label. | | State | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The state of the territory model. Values are: Planning, Activating, Activation Failed, Active, Archiving, Archiving Failed, Archived, Deleting, and Deletion Failed. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [Territory2ModelChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [Territory2ModelFeed](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. [Territory2ModelHistory](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. # Territory2ModelHistory Represents the history of changes to the values in the fields on a territory model. Available if Sales Territories has been enabled. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field whose value was changed. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the changed field. | | OldValue | Type anyType Properties Nillable, Sort Description The previous value of the changed field. | | Territory2ModelId | Type reference Properties Filter, Group, Sort Description The ID of the territory model whose history is tracked. | ## Usage This object is automatically generated whenever any field value changes on a territory model record. Use this object it to identify those changes. # Territory2ObjectExclusion Represents the objects that aren’t included in territory assignment rule runs, even when they meet assignment rule criteria. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Available if Sales Territories has been enabled. Standard and partner users can access this object. If a territory model is in Active state, any standard or partner user can view that model, including its territories and assignment rules. For territories in an active model, any standard or partner user can view assigned records and assigned users subject to your org’s sharing settings. Users can’t view territory models in other states (such as Planning or Archived). ## Fields | Field | Details | | --- | --- | | Note | Type string Properties Create, Filter, Group, Nillable, Sort, Update | | ObjectId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Account object to exclude from the territory assignment rule. This is a polymorphic relationship field. Relationship Name Object Relationship Type Lookup Refers To Account | | Territory2Id | Type reference Properties Create, Filter, Group, Sort Description The ID of the territory to exclude from the territory model assignment rule. This is a relationship field. Relationship Name Territory2 Relationship Type Lookup Refers To Territory2 | # Territory2ObjSharingConfig Represents the sharing access level of objects assigned to a particular territory. This object is available in API version 56.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), update() ## Special Access Rules Only standard and partner users can access this object. Any standard or partner user can view object sharing configuration records in an active model. Users without the Manage Territories permission can’t view territory records in the Planning or Archived state. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description The access level of the object for the particular territory. | | Territory2Id | Type reference Properties Filter, Group, Sort Description The territory on which the access level is defined. This field is a relationship field. Relationship Name Territory2 Relationship Type Lookup Refers To Territory2 | | TerritoryMgmtObjectConfigId | Type reference Properties Filter, Group, Sort Description The object configuration record the territory access level is related to. This field is a relationship field. Relationship Name TerritoryMgmtObjectConfig Relationship Type Lookup Refers To TerritoryMgmtObjectConfig | # Territory2Type Represents a category for territories (Territory2). Every Territory2 must have a Territory2Type. Available only if Sales Territories has been enabled for your organization. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Standard and partner users can access this object. ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the territory type. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description Required. 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. The field label in the user interface is Territory Type Name. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Language | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the label in the user interface. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Required The user interface label for the territory type. | | Priority | Type int Properties Create, Filter, Group, SortUpdate Description Required. Used for Filter-Based Opportunity Territory Assignment (Pilot in Spring ’15 / API version 33). Lets you specify a priority for a territory type. For opportunity assignments, the filter examines all territories assigned to the account that the opportunity is assigned to. The account-assigned territory whose territory type priority is highest is then assigned to the opportunity. The priority field value on each territory type must be unique. Further, if there are multiple territories with the same territory type (and therefore the same priority) assigned to the account, no territory is assigned to the opportunity. | # TerritoryAdminAssignment Represents designated team members who can administer specific territories and their descendants. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To designate team members, assign them the Administer Territory Operations permission. ## Fields | Field | Details | | --- | --- | | CanManageHierarchy | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Lets the user update and delete the territory and its descendants, and create descendants. The default value is false. | | CanManageMembers | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Lets the user assign other team members to the territory and its descendants. Also lets the user update the user territory association log. The default value is false. | | CanManageRecordAssociations | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Lets the user add and remove assignments for records, author rules, and assign and run rules for the territory and its descendants. The default value is false. | | Territory2Id | Type reference Properties Create, Filter, Group, Sort Description The ID for the territory you’re letting the user administer. The user can also administer this territory’s descendants. This field is a relationship field. Relationship Name Territory2 Refers To Territory2 | | Territory2ModelId | Type reference Properties Create, Filter, Group, Sort Description The ID for the territory model that includes the territory you’re letting the user administer. This field is a relationship field. Relationship Name Territory2Model Refers To Territory2Model | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID for the user you’re letting administer the territory and its descendants. Requires that the user is assigned the Administer Territory Operations permission set. This field is a polymorphic relationship field. Relationship Name UserOrGroup Refers To Group, User | # TerritoryMgmtObjectConfig Represents territory management settings and defaults for a particular object. This object is available in API version 56.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Only standard and partner users can access this object. ## Fields | Field | Details | | --- | --- | | DefaultAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The default access level of the defined object for all territories. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API name. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language used in the org where the territory model was created. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The readable label for this entity. | | Object | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The name of the Enterprise Territory Management object. Possible values are: - Lead | | State | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The state of the supported object. | # TestSuiteMembership Associates an Apex class with an ApexTestSuite. This object is available in API version 36.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules In API version 49.0 and later, users must have the View Setup and Configuration permission to access this object. ## Fields | Field Name | Description | | --- | --- | | ApexClassId | Type reference Properties Create, Filter, Group, Sort Description The Apex class whose tests are to be executed. This is a relationship field. Relationship Name ApexClass Relationship Type Lookup Refers To ApexClass | | ApexTestSuiteId | Type reference Properties Create, Filter, Group, Sort Description The test suite to which the Apex class is assigned. This is a relationship field. Relationship Name ApexTestSuite Relationship Type Lookup Refers To ApexTestSuite | ## Usage Insert a TestSuiteMembership object using an API call to associate an Apex class with an ApexTestSuite object. (ApexTestSuite and TestSuiteMembership aren’t editable through Apex DML.) To remove the class from the test suite, delete the TestSuiteMembership object. If you delete an Apex test class or test suite, all TestSuiteMembership objects that contain that class or suite are deleted. The following SOQL query returns the membership object that relates this Apex class to this test suite. SELECT Id FROM TestSuiteMembership WHERE ApexClassId = '01pD0000000Fhy9IAC' AND ApexTestSuiteId = '05FD00000004CDBMA2' #### See Also - [ApexTestSuite](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apextestsuite.htm "Represents a suite of Apex classes to include in a test run. A TestSuiteMembership object associates each class with the suite. This object is available in API version 36.0 and later.") # ThirdPartyAccountLink Represents the list of external users who authenticated using an authentication provider. This object is available in API version 32.0 and later. A list of third-party account links is generated when users of an organization authenticate using an external authentication provider. Use this object to list and revoke a given user's social sign-on connections (such as Facebook©). ## Supported Calls describeSObjects(), query() ## Special Access Rules If you try to use [Apex DML operations](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_dml_section.htm) and then query this object in the same call, you get an UncommittedWork error with this description. A callout was unsuccessful because of pending uncommitted work related to a process, flow, or Apex operation. Commit or roll back the work, and then try again. To avoid this error, execute DML operations and queries in separate, asynchronous calls. ## Fields | Field Name | Details | | --- | --- | | Handle | Type string Properties Filter, Nillable, Sort Description The username in the third-party system. | | IsNotSsoUsable | Type boolean Properties Defaulted on create, Filter, Sort Description Support for single sign-on. If true, the link can't be used for a single sign-on flow. It's only available OAuth access and refresh tokens. | | Provider | Type string Properties Filter, Nillable, Sort Description The third-party account provider name. | | RemoteIdentifier | Type string Properties Filter, Nillable, Sort Description The unique ID for the user in the third-party system. | | SsoProvider | Type AuthProvider Properties Filter, Nillable, Sort Description The foreign key to the [AuthProvider](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_authprovider.htm "Represents an authentication provider (auth provider). An auth provider lets users log in to your Salesforce org from an external service provider, such as Facebook, Google, or GitHub. This object is available in API version 27.0 and later.") of the third-party system. | | SsoProviderId | Type reference Properties Filter, Nillable, Sort Description The ID associated with the SsoProvider value. This is a relationship field. Relationship Name SsoProvider Relationship Type Lookup Refers To AuthProvider | | SsoProviderName | Type string Properties Filter, Nillable, Sort Description The name associated with the AuthProvider of the third-party system, in case the user has no access to the provider foreign key (the SsoProvider value). | | ThirdPartyAccountLinkKey | Type string Properties Filter, Nillable, Sort Description A concatenated string including the organization ID, the SsoProviderId value, the SsoProvider value, and the RemoteIdentifier value. | | UserId | Type reference Properties Filter, Nillable, Sort Description The Salesforce user associated with this third-party account link. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Usage Admins (with the Manage Users permission) querying this object can see all the links for all users in the organization. Without the Manage Users permission, users can only retrieve their own links. Users sometimes don't have access to the SsoProvider value (the foreign key). In this case, use the SsoProviderName to render the name of the provider for the associated link. Use the Apex method Auth.AuthToken.revokeAccess() to revoke a link. To use this method, the IsNotSsoUsable field must be false. To make the ThirdPartyAccountLink standard object writable for Salesforce admins, contact Salesforce Customer Support. With this feature, you can easily add or delete third-party account links using the API, but you can’t update existing account links. In API version 34.0 and later, this object was enhanced to help manage high instance counts. A query() call returns up to 500 rows. A queryMore() call returns 500 more, up to 2,500 total. No more records are returned after 2,500. To make sure that you don’t miss any records, issue a COUNT() query in a SELECT clause for ThirdPartyAccountLink. This query gives you the total number of records. If there are more than 2,500 records, use these options to manage your results. - Divide queries by filtering on fields like UserId to return subsets of less than 2,500 records. - Use [OFFSET](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_offset.htm) to get batches of 2,000 records. Start with an OFFSET of 0 and then increment by 2,000. If you use this option, we recommend that you also use [LIMIT](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_limit.htm) to limit each query to 2,000. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The OFFSET clause is limited to 2,000 rows. Requesting an offset greater than 2,000 results in a NUMBER\_OUTSIDE\_VALID\_RANGE error. For example, use an initial query with this structure. SELECT FROM ThirdPartyAccountLink LIMIT 2000 OFFSET 0 Then, run another query with an offset of 2,000. SELECT FROM ThirdPartyAccountLink LIMIT 2000 OFFSET 2000 Continue to increase the offset by 2,000 until you have results for all records. # ThreatDetectionFeedback Represents feedback provided by a user about a Threat Detection event that occurred in your org. The feedback specifies whether the event was malicious, suspicious, not a threat, or unknown. Each ThreatDetectionFeedback object is associated with one of these Threat Detection storage events: ApiAnomalyEventStore, CredentialStuffingEventStore, ReportAnomalyEventStore, or SessionHijackingEventStore. This object is available in API version 49.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Response | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Describes the severity of the threat. Possible values are: - Malicious - Not a Threat - Suspicious - Unknown | | ThreatDetectionEventId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to the unique ID of one of these associated Threat Detection storage events: - [ApiAnomalyEventStore](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_apianomalyeventstore.htm) - [CredentialStuffingEventStore](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_credentialstuffingeventstore.htm) - [ReportAnomalyEventStore](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_reportanomalyeventstore.htm) - [SessionHijackingEventStore](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/sforce_api_objects_sessionhijackingeventstore.htm) For example, 0fjRM000000005p. This is a polymorphic relationship field. Relationship Name ThreatDetectionEvent Refers To ApiAnomalyEventStore, CredentialStuffingEventStore, GuestUserAnomalyEventStore, LoginAnomalyEventStore, ReportAnomalyEventStore, SessionHijackingEventStore, UniversalAnomalyEventStore | | ThreatDetectionFeedbackNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated number used as the unique name for this object. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The origin user’s unique ID. For example, 005000000000123. This is a polymorphic relationship field. Relationship Name User Relationship Type Lookup Refers To User | | Username | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The origin username in the format of user@company.com at the time the object was created. | ## Associated Object This object has the following associated object. It’s available in the same API version as this object. [ThreatDetectionFeedbackFeed](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. #### See Also - [_Salesforce Help_: Threat Detection](https://help.salesforce.com/articleView?id=real_time_em_threat_detection.htm&type=5&language=en_US " Salesforce Help: Threat Detection - HTML (New Window)") # Time-Based Workflow Event Type Time-Based Workflow events contain details about queue activity monitoring. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or the [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Time-Based Workflow events only support workflow rules, and not flow scheduled path time-queue records. Event logs do not show flow scheduled path time-queue records.
      FieldDetails
      CLIENT_IP
      Type
      String
      Description
      The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
      For example: 96.43.144.26.
      CPU_TIME
      Type
      Number
      Description
      The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
      DATA
      Type
      String
      Description
      The record details of time queue activity.
      EVENT_TYPE
      Type
      String
      Description
      The type of event. The value is always TimeBasedWorkflow.
      LOG_GROUP_ID
      Type
      String
      Description
      Marks log records that are committed or rolled back.
      LOGIN_KEY
      Type
      String
      Description
      The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
      For example: GeJCsym5eyvtEK2I.
      NUMBER_OF_RECORDS
      Type
      Number
      Description
      The number of processed records.
      ORGANIZATION_ID
      Type
      Id
      Description
      The 15-character ID of the organization.
      For example: 00D000000000123.
      REQUEST_ID
      Type
      String
      Description
      The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
      For example: 3nWgxWbDKWWDIk0FKfF5DV.
      RUN_TIME
      Type
      Number
      Description
      The amount of time that the request took in milliseconds.
      SESSION_KEY
      Type
      String
      Description
      The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
      For example: d7DEq/ANa7nNZZVD.
      TIMESTAMP
      Type
      String
      Description
      The access time of Salesforce services in GMT.
      For example: 20130715233322.670.
      TIMESTAMP_DERIVED
      Type
      DateTime
      Description
      The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
      For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
      TYPE
      Type
      String
      Description
      The type of time-based workflow event.
      • UIDEL—An entry was deleted from the Time-Based Automations page in Setup.
      • ERRDEL—An entry was deleted from the workflow queue, because there was an error reading the record that triggered the workflow rule. The associated time-dependent actions weren’t processed.
      • DELETE—An entry was deleted from the workflow queue, because it’s no longer relevant. For example, the criteria are no longer met by the associated record. If the evaluation date for the entry changed, the entry is re-added with the updated evaluation date.
      • PROC—An entry was deleted from the workflow queue after processing a time-dependent action.
      URI
      Type
      String
      Description
      The URI of the page that’s receiving the request.
      For example: /home/home.jsp.
      URI_ID_DERIVED
      Type
      ID
      Description
      The 18-character case insensitive ID of the URI of the page that’s receiving the request.
      USER_ID
      Type
      Id
      Description
      The 15-character ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00530000009M943
      USER_ID_DERIVED
      Type
      Id
      Description
      The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00590000000I1SNIA0.
      #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # TimeSheet Represents a schedule of a service resource’s time in Field Service or Workforce Engagement. This object is available in API v47.0 and later. Time sheets are composed of time sheet entries, which typically track individual tasks like travel or asset repair. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service or Workforce Engagement must be enabled. ## Fields | Field Name | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. The label in the user interface is Currency ISO Code. | | EndDate | Type date Properties Create, Filter, Group, Sort, Update Description The last day the time sheet covers. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the time sheet. | | ServiceResourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service resource whose time is being tracked with the time sheet. | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description The first day the time sheet covers. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the time sheet. The picklist includes the following values, which can be customized: - New - Submitted - Approved | | TimeSheetEntryCount | Type int Properties Filter, Group, Nillable, Sort Description (Read Only) The number of related time sheet entries. | | TimeSheetNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number identifying the time sheet. | | TotalDurationInHours | Type double Properties Filter, Nillable, Sort Description Represents the sum total of the duration field of all the time sheet entries related to the time sheet object in hours. | | TotalDurationInMinutes | Type int Properties Filter, Group, Nillable, Sort Description Represents the sum total of the duration field of all the time sheet entries related to the time sheet object in minutes. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [TimeSheetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [TimeSheetFeed](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. [TimeSheetHistory](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. [TimeSheetOwnerSharingRule](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. [TimeSheetShare](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. # TimeSheetEntry Represents a span of time that a service resource spends on a field service task. This object is available in API version 47.0 and later. Time sheets are composed of time sheet entries. Time sheet entries typically track individual tasks like travel or asset repair. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. The label in the user interface is Currency ISO Code. Time sheet entries inherit their time sheet’s currency code. Updates to a time sheet’s currency code aren’t reflected in existing time sheet entries’ currency code. | | Description | Type textarea Properties Create, Nillable, Update Description Notes on how the time was spent. For example, “This service took longer than normal because the machine was jammed.” | | DurationInMinutes | Type int Properties Filter, Group, Nillable, Sort Description Minutes recorded on the time sheet entry. | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time the activity finished. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | LocationTimeZone | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Time zone of the location where the activity occurred. This field is available in API version 50.0 and later. | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time the activity began. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the time sheet entry. The picklist includes the following values, which can be customized: - New - Submitted - Approved | | Subject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Activity performed; for example, repair, lunch, or travel. | | TimeSheetEntryNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the time sheet entry. | | TimeSheetId | Type reference Properties Create, Filter, Group, Sort Description The time sheet associated with the time sheet entry. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of work performed. The picklist includes the following values, which can be customized: - Direct - Indirect | | WorkOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order related to the time sheet entry. Work orders are searchable by their content. | | WorkOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order line item related to the time sheet entry. Work order line items are searchable by their content. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [TimeSheetEntryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [TimeSheetEntryFeed](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. [TimeSheetEntryHistory](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. # TimeSlot Represents a period of time on a specified day of the week during which work can be performed in Field Service, Salesforce Scheduler, or Workforce Engagement. Operating hours consist of one or more time slots. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | DayOfWeek | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The day of the week when the time slot takes place. | | EndTime | Type time Properties Create, Filter, Sort, Update Description The time when the time slot ends. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | MaxAppointments | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Maximum number of appointments for a single time slot. Available in API version 47.0 and later. | | OperatingHoursId | Type reference Properties Create, Filter, Group, Sort Description The operating hours that the time slot belongs to. An operating hours’ time slots appear in the Operating Hours related list. This is a relationship field. Relationship Name OperatingHours Relationship Type Lookup Refers To OperatingHours | | StartTime | Type time Properties Create, Filter, Sort, Update Description The time when the time slot starts. | | RecordSetFilterCriteriaId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the recordset filter criteria selected for the time slot. This is a relationship field. Relationship Name RecordsetFilterCriteria Relationship Type Lookup Refers To RecordsetFilterCriteria | | TimeSlotNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the time slot. The name is auto-populated to a day and time format—for example, Monday 9:00 AM - 10:00 PM—but you can manually update it if you wish. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of time slot. Possible values are Normal and Extended. You may choose to use Extended to represent overtime shifts. | | WorkTypeGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Work type group assigned to the time slot. Available in API version 47.0 and later. This is a relationship field. Relationship Name WorkTypeGroup Relationship Type Lookup Refers To WorkTypeGroup | ## Usage Operating hours are composed of time slots, which indicate the hours of operation for a particular day. After you create operating hours, create time slots for each day. For example, if the operating hours should be 8 AM to 5 PM Monday through Friday, create five time slots, one per day. To reflect breaks such as lunch hours, create multiple time slots in a day: for example, Monday 8:00 AM – 12:00 PM and Monday 1:00 PM – 5:00 PM. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip Time slots don’t come with any built-in rules, but you can create Apex triggers that limit time slot settings in your org. For example, you may want to restrict the start and end times on time slots to half-hour increments, or to prohibit end times later than 8 PM. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [TimeSlotChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_associated_objects_change_event.htm) (API version 54.0) Change events are available for the object. [TimeSlotHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_associated_objects_history.htm;) (API version 62.0) History is available for tracked fields of the object. # TimeSlotHistory Represents the history of changes made to tracked fields on a time slot. This object is available in API version 38.0 and later. ## Supported Calls getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules Field Service must be enabled in your organization, and field tracking for time slot fields must be configured. ## Fields | Field Name | Details | | --- | --- | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The value of the field before it was changed. | | TimeSlotId | Type reference Properties Filter, Group, Sort Description ID of the time slot being tracked. The history is displayed on the detail page for this record. | # TodayGoal Sets the quarterly sales goal on the performance chart. This object is available in API version 35.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Returns true if the goal is locked, or false if it’s not. The default value is false. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the goal can be edited (true) or not (false). The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the goal. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the creator of the goal. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | UserId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user of the goal. This field is unique within your organization. This field is a relationship field. Relationship Name User Refers To User | | Value | Type currency Properties Create, Filter, Nillable, Sort, Update Description The customizable sales goal for the quarter. | ## Usage This object is specific to the performance chart and has no impact on forecast quotas or any other type of goal. The performance chart is available on the home page when Seller Home is not enabled. ## 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. [TodayGoalChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TodayGoalShare](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. # Topic Represents a topic on a Chatter post or record. This object is available in API version 28.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Description | Type string Properties Create, Filter, Nillable, Sort, Update Description Description of the topic. | | ManagedTopicType | Type string Properties Filter, Group, Nillable, Sort Description Type of managed topic. Values are: - Content - Featured - Navigational This field is available in API version 44.0 and later. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update You can change only the spacing and capitalization of a topic name with the update property. Description Name of the topic. | | NetworkId | Type reference Properties Create, Filter, Nillable, Sort Description Identifier of the Experience Cloud site to which the topic belongs. This field is available only if digital experiences is enabled in your org. | | TalkingAbout | Type int Properties Filter, Group, Sort Description Number of people talking about the topic over the last two months, based on factors such as topic additions and comments on posts with the topic. | ## Usage Use this object to query a specific topic or to get a list of all topics, even those used solely in private groups and on records, and the number of people talking about them. Use this object to create, edit, or delete topics. To create a topic, you must have the Create Topics permission. To edit a topic, you must have the Edit Topics permission. To delete a topic, you must have the Delete Topics or Modify All Data permission. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [TopicFeed](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.") (API version 29.0) Feed tracking is available for the object. # TopicAssignment Represents the assignment of a topic to a specific feed item, record, or file. This object is available in API version 28.0 and later. Administrators must enable topics for objects before users can add topics to records of that object type. Topics for most objects are available in API version 30.0 and later. Topics for ContentDocument are available in API version 37.0 and later. ## Supported Calls create(), describeSObjects(), delete(), getDeleted(), getUpdate(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | EntityId | Type reference Properties Create, Filter, Group, Sort Description Identifier of the feed item, record, or file. This is a polymorphic relationship field. Relationship Name Entity Relationship Type Lookup Refers To Account, Asset, Campaign, Case, Contact, ContentDocument, Contract, Event, FeedItem, Lead, Opportunity, Order, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, Shift, Shipment, Solution, Task, WorkOrder, WorkOrderLineItem | | EntityKeyPrefix | Type string Properties Filter, Group, idLookup, Sort Description The first three digits of the EntityID field, which identify the object type (account, opportunity, etc). This read-only field is available in API version 32.0 and later. Interface label is “Record Key Prefix,” which appears only in reports. | | EntityType | Type string Properties Filter, Group, Nillable, Sort Description The standard name for the object type (account, opportunity, etc). This read-only field is available in API version 33.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Querying topic assignments for the ManagedContentVersion entity type isn’t supported. Interface label is “Object Type,” which appears only in reports. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip In most cases, you should use this field rather than EntityKeyPrefix, which exists primarily to support older reports. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Identifier of the community to which the TopicAssignment belongs. This field is available only if digital experiences is enabled in your org. | | TopicId | Type reference Properties Create, Filter, Group, Sort Description Identifier of the topic. This is a relationship field. Relationship Name Topic Relationship Type Lookup Refers To Topic | ## Usage Use this object to query the assignments of topics to feed items, records, or files. To assign or remove topics, you must have the “Assign Topics” permission. In SOQL SELECT syntax, this object supports nested semi-joins, allowing queries on Knowledge articles assigned to specific topics. For example: SELECT parentId FROM KnowledgeArticleViewStat WHERE parentId in (SELECT KnowledgeArticleId FROM KnowledgeArticleVersion WHERE publishStatus = 'Online' AND language = 'en\_US' AND Id in (select EntityId from TopicAssignment where TopicId ='0T0xx0000000xxx')) There is no SOQL limit if the logged-in user has the “View All Data” permission. If they do have that permission, do one of the following: - Specify a LIMIT clause of 1,100 records or fewer. - Filter on Id or Entity when using a WHERE clause with "=". ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Deleting this object's records removes all its data. This action is irreversible. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When you create a report type on the TopicAssignment object, all queries are generated in SQL, which does not enforce the 1,100 record limit clause. #### See Also - [Topic](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_topic.htm "Represents a topic on a Chatter post or record. This object is available in API version 28.0 and later.") - [FeedItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feeditem.htm "FeedItem represents an entry in the feed, such as changes in a record feed, including text posts, link posts, and content posts. This object is available in API version 21.0 and later. This object replaces FeedPost.") # TopicLocalization Represents the translated version of a topic name. Topic localization applies only to navigational and featured topics in Experience Cloud sites. This object is available in API version 33.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Users with the Translation Workbench enabled can view topic translations, but the Customize Application, Manage Translation, or Manage Categories permission is required to create or update them. ## Fields
      Field Name Details
      Language
      Type
      picklist
      Properties
      Create, Filter, Group, Restricted picklist, Sort
      Description
      The combined language and locale ISO code, which controls the language for labels displayed in an application. (The values in this field are not related to the default locale selection.)

      This picklist contains the following fully-supported languages:

      • Chinese (Simplified): zh_CN
      • Chinese (Traditional): zh_TW
      • Danish: da
      • Dutch: nl_NL
      • English: en_US
      • Finnish: fi
      • French: fr
      • German: de
      • Italian: it
      • Japanese: ja
      • Korean: ko
      • Norwegian: no
      • Portuguese (Brazil): pt_BR
      • Russian: ru
      • Spanish: es
      • Spanish (Mexico): es_MX Spanish (Mexico) defaults to Spanish for customer-defined translations.
      • Swedish: sv
      • Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English.

      The following end-user only languages are available.

      • Arabic: ar
      • Bulgarian: bg
      • Croatian: hr
      • Czech: cs
      • English (UK): en_GB
      • Greek: el
      • Hebrew: iw
      • Hungarian: hu
      • Indonesian: in
      • Polish: pl
      • Portuguese (European): pt_PT
      • Romanian: ro
      • Slovak: sk
      • Slovenian: sl
      • Turkish: tr
      • Ukrainian: uk
      • Vietnamese: vi

      The following platform languages are available for organizations that use Salesforce exclusively as a platform.

      • Albanian: sq
      • Afrikaans: af
      • Amharic: am
      • Arabic (Algeria): ar_DZ
      • Arabic (Bahrain): ar_BH
      • Arabic (Egypt): ar_EG
      • Arabic (Iraq): ar_IQ
      • Arabic (Jordan): ar_JO
      • Arabic (Kuwait): ar_KW
      • Arabic (Lebanon): ar_LB
      • Arabic (Libya): ar_LY
      • Arabic (Morocco): ar_MA
      • Arabic (Oman): ar_OM
      • Arabic (Qatar): ar_QA
      • Arabic (Saudi Arabia): ar_SA
      • Arabic (Sudan): ar_SD
      • Arabic (Syria): ar_SY
      • Arabic (Tunisia): ar_TN
      • Arabic (United Arab Emirates): ar_AE
      • Arabic (Yemen): ar_YE
      • Armenian: hy
      • Basque: eu
      • Bosnian: bs
      • Bengali: bn
      • Burmese: my
      • Catalan: ca
      • Chinese (Hong Kong): zh_HK
      • Chinese (Singapore): zh_SG
      • Chinese (Malaysia): zh_MY
      • Dutch (Belgium): nl_BE
      • English (Australia): en_AU
      • English (Belgium): en_BE
      • English (Canada): en_CA
      • English (Cyprus): en_CY
      • English (Germany): en_DE
      • English (Hong Kong): en_HK
      • English (India): en_IN
      • English (Ireland): en_IE
      • English (Israel): en_IL
      • English (Malaysia): en_MY
      • English (Malta): en_MT
      • English (Netherlands): en_NL
      • English (New Zealand): en_NZ
      • English (Philippines): en_PH
      • English (Singapore): en_SG
      • English (South Africa): en_ZA
      • English (United Arab Emirates): en_AE
      • Estonian: et
      • Farsi: fa
      • French (Belgium): fr_BE
      • French (Canada): fr_CA
      • French (Luxembourg): fr_LU
      • French (Morocco): fr_MA
      • French (Switzerland): fr_CH
      • Georgian: ka
      • German (Austria): de_AT
      • German (Belgium): de_BE
      • German (Luxembourg): de_LU
      • German (Switzerland): de_CH
      • Greek (Cyprus): el_CY
      • Greenlandic: kl
      • Gujarati: gu
      • Hawaiian: haw
      • Haitian Creole: ht
      • Hindi: hi
      • Icelandic: is
      • Irish: ga
      • Italian (Switzerland): it_CH
      • Kannada: kn
      • Kazakh: kk
      • Khmer: km
      • Latvian: lv
      • Lithuanian: lt
      • Luxembourgish: lb
      • Macedonian: mk
      • Malay: ms
      • Malayalam: ml
      • Maltese: mt
      • Marathi: mr
      • Montenegrin: sh_ME
      • Romanian (Moldova): ro_MD
      • Romansh: rm
      • Russian (Armenia): ru_AM
      • Russian (Belarus): ru_BY
      • Russian (Kazakhstan): ru_KZ
      • Russian (Kyrgyzstan): ru_KG
      • Russian (Lithuania): ru_LT
      • Russian (Moldova): ru_MD
      • Russian (Poland): ru_PL
      • Russian (Ukraine): ru_UA
      • Samoan: sm
      • Serbian (Cyrillic): sr
      • Serbian (Latin): sh
      • Spanish (Argentina): es_AR
      • Spanish (Bolivia): es_BO
      • Spanish (Chile): es_CL
      • Spanish (Colombia): es_CO
      • Spanish (Costa Rica): es_CR
      • Spanish (Dominican Republic): es_DO
      • Spanish (Ecuador): es_EC
      • Spanish (El Salvador): es_SV
      • Spanish (Guatemala): es_GT
      • Spanish (Honduras): es_HN
      • Spanish (Nicaragua): es_NI
      • Spanish (Panama): es_PA
      • Spanish (Paraguay): es_PY
      • Spanish (Peru): es_PE
      • Spanish (Puerto Rico): es_PR
      • Spanish (United States): es_US
      • Spanish (Uruguay): es_UY
      • Spanish (Venezuela): es_VE
      • Swahili: sw
      • Tagalog: tl
      • Tamil: ta
      • Te reo: mi
      • Telugu: te
      • Urdu: ur
      • Welsh: cy
      • Xhosa: xh
      • Zulu: zu
      NamespacePrefix
      Type
      string
      Properties
      Filter, Group, Nillable, Sort
      Description
      The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

      The namespace prefix can have one of the following values.

      • In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
      • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
      ParentId
      Type
      reference
      Properties
      Create, Filter, Group, Sort
      Description

      ID that identifies the topic. After a TopicLocalization record is created, this ID can’t be modified.
      Value
      Type
      string
      Properties
      Create, Filter, Sort, Update
      Description

      The translated text for the topic name. Label is Topic Name Translation.

      # TopicUserEvent Represents an action (such as comment, post, like, or share) made by a user on a topic. This object is available in API version 42.0 and later. ## Supported Calls delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Only users with the Modify All Data permission can view and delete these data. ## Fields | Field | Details | | --- | --- | | ActionEnum | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The action taken by a user on a topic. The possible values are: - LIKE - COMMENT - POST - ASSIGN - SHARE - FAVORITE - UNFAVORITE - AT\_MENTION - BANG\_MENTION - COMMENT\_LIKE - USER\_ENDORSEMENT - SKILL\_PEER\_ENDORSEMENT - SKILL\_SELF\_ENDORSEMENT - BEST\_ANSWER | | NetworkId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Experience Cloud site where the action was performed. | | TopicId | Type reference Properties Filter, Group, Sort Description Identifier of the topic. | | UserId | Type reference Properties Filter, Group, Sort Description Unique Salesforce user ID. | ## Usage Use the TopicUserEvent object to delete topic-related activities by Experience Cloud site users who would like all their topic-related activities to be removed from a site. # TopInsight For internal use only. # Transaction Security Event Type Transaction Security events contain details about policy execution. This event type is supported in API version 55.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
      FieldDetails
      BOT_IDENTIFIER
      Type
      String
      Description
      The ID of the bot.
      BOT_SESSION_IDENTIFIER
      Type
      String
      Description
      The bot session ID.
      CLIENT_IP
      Type
      String
      Description
      The IP address of the client that is using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as “Salesforce.com IP”.
      For example: 96.43.144.26
      CPU_TIME
      Type
      Number
      Description
      The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
      EVALUATION_TIME_MS
      Type
      Number
      Description
      The time in milliseconds used to evaluate the policy.
      EVENT_TIMESTAMP
      Type
      String
      Description
      The time at which the Transaction Security event was generated in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). This value can be earlier than TIMESTAMP_DERIVED by the amount of time taken to log the event.
      For example: 2015-07-27T11:32:59.555Z
      EVENT_TYPE
      Type
      String
      Description
      The type of event. The value is always TransactionSecurity.
      LOGIN_KEY
      Type
      String
      Description
      The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
      For example: GeJCsym5eyvtEK2I
      ORGANIZATION_ID
      Type
      ID
      Description
      The 15-character ID of the organization.
      For example: 00D000000000123
      PLANNER_IDENTIFIER
      Type
      String
      Description
      The ID of the agent planner.
      POLICY_ID
      Type
      ID
      Description
      The 15-character ID of the policy being evaluated.
      For example: 00530000009M943
      POLICY_ID_DERIVED
      Type
      ID
      Description
      The 18-character case-insensitive ID of the policy being evaluated.
      For example: 00590000000I1SNIA0
      REQUEST_ID
      Type
      String
      Description
      The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
      For example: 3nWgxWbDKWWDIk0FKfF5DV
      RESULT
      Type
      String
      Description
      The outcome of evaluating the policy.
      For example: TRIGGEREDzzz or NOT TRIGGERED
      RUN_TIME
      Type
      Number
      Description
      The amount of time that the request took in milliseconds.
      SESSION_KEY
      Type
      String
      Description
      The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
      For example: d7DEq/ANa7nNZZVD
      TIMESTAMP
      Type
      String
      Description
      The access time of Salesforce services in GMT.
      For example: 20130715233322.670
      TIMESTAMP_DERIVED
      Type
      DateTime
      Description
      The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
      For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
      URI
      Type
      String
      Description
      The URI of the page that’s receiving the request.
      For example: /home/home.jsp
      URI_ID_DERIVED
      Type
      ID
      Description
      The 18-character case insensitive ID of the URI of the page that’s receiving the request.
      USER_ID
      Type
      ID
      Description
      The 15-character ID of the user who is using Salesforce services through the UI or the API.
      For example: 00530000009M943
      USER_ID_DERIVED
      Type
      ID
      Description
      The 18-character case insensitive ID of the user who is using Salesforce services through the UI or the API.
      For example: 00590000000I1SNIA0
      #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # TransactionSecurityEventLog Transaction Security event logs contain details about policy execution. Legacy transaction security policy details are supported in API version 38.0 and later. Enhanced transaction security policy details are supported in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ApexIdentifier | Type String Properties Filter, Group, Nillable, Sort Description The ID of the Apex code used to evaluate the policy. | | BotIdentifier | Type String Description The ID of the bot. | | BotSessionIdentifier | Type String Description The bot session ID. | | ClientIp | Type String Properties Filter, Group, Nillable, Sort Description The IP address of the client that is using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type Double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | EvaluationTime | Type Double Properties Filter, Nillable, Sort Description The time in milliseconds used to evaluate the policy. | | EventName | Type String Properties Filter, Group, Nillable, Sort Description The name of the event, which is Transaction Security Event. | | FlowIdentifier | Type String Properties Filter, Group, Nillable, Sort Description The ID of the flow used to evaluate the policy. | | LoginKey | Type String Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | PlannerIdentifier | Type String Description The ID of the agent planner. | | PolicyIdentifier | Type String Properties Filter, Group, Nillable, Sort Description The 15-character ID of the policy being evaluated. For example: 00530000009M943. | | PolicyOutcome | Type String Properties Filter, Group, Nillable, Sort Description The result of the transaction policy. Possible values are: - Error—The policy caused an undefined error when it executed. - ExemptNoAction—The user is exempt from transaction security policies, so the policy didn’t trigger. - MeteringBlock—The policy took longer than 3 seconds to process, so the user was blocked from performing the operation. - MeteringNoAction—The policy took longer than 3 seconds to process, but the user isn't blocked from performing the operation. - NoAction—The policy didn't trigger. - Notified—A notification was sent to the recipient. | | PolicyType | Type String Properties Filter, Group, Nillable, Sort Description The real time action selected for the policy. | | RequestIdentifier | Type String Properties Filter, Group, Nillable, Sort Description Globally unique id for a given request. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RunTime | Type Double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SendEmailNotification | Type Boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether to send an email notification. The default value is false. | | SendInAppNotification | Type Boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether to send an in-app notification. The default value is false. | | SessionKey | Type String Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type DateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | TriggeredTimestamp | Type String Properties Filter, Group, Nillable, Sort Description The time at which the Transaction Security event was generated in ISO8601-compatible format. For example: 2015-07-27T11:32:59.555Z. | | Uri | Type String Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type String Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who is using Salesforce services through the UI or the API. For example: 00530000009M943. | # TransactionSecurityPolicy Represents a transaction security policy definition. This object is available in API version 42.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ActionConfig | Type textarea Properties Create, Update Description Describes the action to take when the matching Transaction Security policy is triggered. Also indicates the type of notifications selected and the ID of the intended recipient. The recipient must be active and assigned the Modify All Data and View Setup user permissions. Multiple actions can be taken. The actions available depend on the [Event Type](#txnsec_eventtypefield) field. | | ApexPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the Apex TxnSecurity.PolicyCondition or TxnSecurity.EventCondition interface for this policy. | | BlockMessage | Type string Properties Create, Filter, Nillable, Sort, Update Description The custom message sent to a user when a policy blocks their action. Used in Real-Time Event Monitoring only. Maximum of 1000 characters. This field is null when the default message option is selected in the UI. Available only when EventName is set to ApiEvent, ListViewEvent, BulkApiResultEventStore, or ReportEvent. Available in API version 49.0 and later. Include org- or policy-specific information in your custom message, such as the name of the responsible administrator or the business unit. Be careful about what you include. Too much information on how the policy was designed. can aid a malicious user. Two-factor authentication (2FA) isn’t supported in Lightning Experience, so events like ListView and ReportEvent are upgraded to Block in Lightning. Custom messages aren’t translatable. | | CustomEmailContent | Type string Properties Create, Filter, Nillable, Sort, Update Description The administrator-created custom email content sent when a policy is triggered. Used in Real-Time Event Monitoring only. Maximum of 1333 characters. This field is null when the Custom Email Content setting is selected in the UI but no message content is entered. This field is available in API version 54.0 and later. Custom messages aren’t translatable. | | Description | Type string Properties Create, Filter, Nillable, Sort, Update Description The description entered for this policy. | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The API, or program name, for this policy. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | EventName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Used in Real-Time Event Monitoring only. Indicates the name of the event the policy monitors. Valid values are: - AdminSetupEvent— Captures metadata and configuration changes made by administrators within the Setup area of your org. - AdminSetupEventStore— Tracks metadata and configuration changes made by administrators within the Setup area of your org. - ApiEvent—Tracks these user-initiated read-only API calls: query(), queryMore(), and count(). Captures API requests through SOAP API and Bulk API for the Enterprise and Partner WSDLs. Tooling API calls and API calls originating from a Salesforce mobile app aren’t captured. - ApiAnomalyEventStore—Tracks anomalies in how users make API calls. ApiAnomalyEventStore is an object that stores the event data of ApiAnomalyEvent. This object is available in API version 50.0 and later. - BulkApiResultEventStore—Tracks when a user downloads the results of a Bulk API request. BulkApiResultEventStore is a big object that stores the event data of BulkApiResultEvent. This object is available in API version 50.0 and later. - CredentialStuffingEventStore—Tracks when a user successfully logs into Salesforce during an identified credential stuffing attack. Credential stuffing refers to large-scale automated login requests using stolen user credentials.This value is available in API 49.0 and later. - FileEventStore—Tracks when a user downloads, previews, or uploads a file. FileEventStore is a big object that stores the event data of FileEvent. This object is available in API version 57.0 and later. - GuestUserAnomalyEventStore—Tracks data access anomalies that are caused by guest user permission misconfiguration. GuestUserAnomalyEventStore is an object that stores the event data of GuestUserAnomalyEvent. This object is available in API version 60.0 and later. - ListViewEvent—Tracks when users access data with list views using Lightning Experience, Salesforce Classic, or the API. It doesn’t track list views of Setup entities. - LoginAnomalyEventStore—Stores the records of data access anomalies that are caused by potentially malicious login actions.This object is available in API version 64.0 and later. - LoginAsEvent—Tracks the login activity of admins who log in to Salesforce as other users.This object is available in API version 46.0 and later. - LoginEvent—LoginEvent tracks the login activity of users who log in to Salesforce. - PermissionSetEventStore—Tracks changes to permission sets and permission set groups. - ReportAnomalyEventStore—Tracks anomalies in how users run or export reports, including unsaved reports. This value is available in API 49.0 and later. - ReportEvent—Tracks when reports are run in your org. - SessionHijackingEventStore—Tracks when unauthorized users gain ownership of a Salesforce user’s session with a stolen session identifier. To detect such an event, Salesforce evaluates how significantly a user’s current browser fingerprint diverges from the previously known fingerprint using a probabilistically inferred significance of change. This value is available in API 49.0 and later. - UniversalAnomalyEventStore—Stores data for a broad range of system and user activity anomalies that do not map to standard event stores. | | EventType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Used in Legacy Transaction Security only. Indicates the type of event the policy monitors. Valid values are: - AccessResource—Notifies you when the selected resource has been accessed. - AuditTrail—Reserved for future use. - DataExport—Notifies you when any API query is made, such as from the Data Loader API client, or when a Report export occurs. - Entity—Notifies you on use of an object type such as an authentication provider or chatter post. - Login—Notifies you when a user logs in. As of Summer '20, Legacy Transaction Security is a retired feature in all Salesforce orgs. | | ExecutionUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Used in Legacy Transaction Security only. The ID of an active user who is assigned the Modify All Data and View Setup user permissions. As of Summer '20, Legacy Transaction Security is a retired feature in all Salesforce orgs. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The policy’s name. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values: - In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. - In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects. | | ResourceName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used in Legacy Transaction Security only. A resource used to narrow down the conditions under which the policy triggers. For example, with a DataExport event, you can select a resource Lead to specifically monitor export activity occurring on your Lead entities. The resources available depend on the [EventType](#txnsec_eventtypefield) field. As of Summer '20, Legacy Transaction Security is a retired feature in all Salesforce orgs. | | State | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the policy is active. Valid values are: - Disabled - Enabled | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of validation that the policy uses. The valid values are: - CustomApexPolicy— Created with Apex editor. - CustomConditionBuilderPolicy— Created with Condition Builder . | # Translation The Translation object represents the languages enabled for translation in your Salesforce org. This object is available in API version 47.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules - Your organization must be using Enterprise, Performance, Unlimited, or Developer edition. - To view this object, you must have the “View Setup and Configuration” permission. - To use the create(), update(), and upsert() calls, Translation Workbench must be enabled in your org. - To manage translations, Translation Workbench must be enabled in your org. Specify translators for each language through the Translation Language Settings Setup page. ## Fields | Field | Details | | --- | --- | | CanManage | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the language is available for translation (true) or not (false). Specify translators for each language through the Translation Language Setup page. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the translated values for this language display to users (true) or not (false). | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language code. See the Salesforce Help for a full list of languages and their codes. | # TravelMode Represents a travel mode used for travel time calculations. The records include information about the type of transportation (such as Car or Walking), whether a vehicle can take toll roads, and whether a vehicle is transporting hazardous materials. This object is available in API version 54.0 and later. ## Fields | Field | Details | | --- | --- | | CanUseTollRoads | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the vehicle is allowed to drive on toll roads. The default value is false. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the travel model record is locked or not. The default value is false. | | IsTransportingHazmat | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the vehicle is transporting hazardous materials. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the travel model record can be edited or not. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the travel mode. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | TransportType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of transportation. Possible values are: - Bicycle - Car\-Default. - Heavy Truck - Light Truck - Walking | ## 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. [TravelModeFeed](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. [TravelModeOwnerSharingRule](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. [TravelModeShare](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. # TwoFactorInfo Stores a user’s secret for multi-factor operations. Use this object when customizing multi-factor authentication in your organization. (Note that multi-factor authentication was formerly called two-factor authentication.) This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules You need the Manage Multi-Factor Authentication in API permission to create or update this object. ## Fields | Field Name | Details | | --- | --- | | SharedKey | Type string Properties Create, Group, Sort, Update Description This field is never read-enabled, though it is write-enabled. A request for this value always returns null. The value must be a base32-encoded string of a 20-byte secret. You can use the Apex method Auth.SessionManagement.getQrCode() to get a value to write to this field. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you write a secret to this field, in API version 37.0 and later the user gets an email notification that a new identity verification method was added to the user’s account. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The multi-factor method. - TOTP—The time-based one-time password. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID for the user who’s associated with the authentication secret. | # TwoFactorMethodsInfo Stores information about which identity verification methods a user has registered. This object is available in API version 37.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules You need the Manage MFA in API user permission to access this object. Note that multi-factor authentication (MFA) was formerly called two-factor authentication. If you try to use [Apex DML operations](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_dml_section.htm) and then query this object in the same call, you get an UncommittedWork error with this description. A callout was unsuccessful because of pending uncommitted work related to a process, flow, or Apex operation. Commit or roll back the work, and then try again. To avoid this error, execute DML operations and queries in separate, asynchronous calls. ## Fields
      Field Name Details
      ExternalId
      Type
      string
      Properties
      Filter, Group, Nillable, Sort
      Description
      A unique system-generated numerical identifier for the user.
      HasBuiltInAuthenticator
      Type
      boolean
      Properties
      Defaulted on create, Filter, Group, Sort
      Description
      If true, the user has registered a built-in authenticator on their device, such as Touch ID or Windows Hello. The user can verify their identity by using the built-in authenticator.
      This field is available in API version 53.0 and later.
      HasSalesforceAuthenticator
      Type
      boolean
      Properties
      Defaulted on create, Filter, Group, Sort
      Description
      If true, the user has connected the Salesforce Authenticator mobile app. The user can verify identity by approving a notification sent to the app. If the user sets a trusted location in the app, Salesforce Authenticator verifies automatically when the user is in the trusted location.
      HasSecurityKey
      Type
      boolean
      Properties
      Defaulted on create, Filter, Group, Sort
      Description
      If true, the user has registered a WebAuthn-compatible security key. This field includes all security keys registered or used after Summer ’22. The user can verify their identity by inserting the security key into a USB port to generate credentials.
      HasTempCode
      Type
      boolean
      Properties
      Defaulted on create, Filter, Group, Sort
      Description
      If true, the user has a temporary verification code generated by a Salesforce admin or user with Manage Multi-Factor Authentication in User Interface permission.
      HasTotp
      Type
      boolean
      Properties
      Defaulted on create, Filter, Group, Sort
      Description
      If true, the user has connected an authenticator app that generates verification codes, also known as time-based one-time passwords (TOTP). The user can verify identity by entering a code generated by the app.
      HasU2F
      Type
      boolean
      Properties
      Defaulted on create, Filter, Group, Sort
      Description
      If true, the user has registered a U2F security key. The user can verify identity by inserting the security key into a USB port to generate credentials.
      Note

      Note

      For U2F security keys registered or used after Summer ’22, use HasSecurityKey instead.
      HasUserVerifiedEmailAddress
      Type
      boolean
      Properties
      Defaulted on create, Filter, Group, Sort
      Description
      If true, the user's email address is verified.

      This parameter is available in API version 43.0 and later.
      HasUserVerifiedMobileNumber
      Type
      boolean
      Properties
      Defaulted on create, Filter, Group, Sort
      Description
      If true, the user has self-registered and verified a mobile phone number. Salesforce can text a verification code to the user at that number.

      This parameter is available in API version 43.0 and later.
      HasVerifiedMobileNumber
      Type
      boolean
      Properties
      Defaulted on create, Filter, Group, Sort
      Description
      If true, the user has a mobile phone number that was added by an administrator or self-registered by the user. Salesforce can text a verification code to the user at that number.
      UserId
      Type
      reference
      Properties
      Filter, Group, Nillable, Sort
      Description
      ID of the user who’s associated with the identity verification methods.
      ## Usage In API version 34.0 and later, this object was enhanced to help manage high instance counts. A [query()](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_query.htm) call returns up to 500 rows. A [queryMore()](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_querymore.htm)call returns 500 more, up to 2,500 total. No more records are returned after 2,500. To make sure that you don’t miss any records, issue a COUNT() query in a SELECT clause for TwoFactorMethodInfo. This query gives you the total number of records. If there are more than 2,500 records, use these options to manage your results. - Divide queries by filtering on fields like UserId to return subsets of less than 2,500 records. - Use [OFFSET](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_offset.htm) to get batches of 2,000 records. Start with an OFFSET of 0 and then increment by 2,000. If you use this option, we recommend that you also use [LIMIT](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_limit.htm) to limit each query to 2,000. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The OFFSET clause is limited to 2,000 rows. Requesting an offset greater than 2,000 results in a NUMBER\_OUTSIDE\_VALID\_RANGE error. For example, use an initial query with this structure. SELECT FROM TwoFactorMethodsInfo LIMIT 2000 OFFSET 0 Then, run another query with an offset of 2,000. SELECT FROM TwoFactorMethodsInfo LIMIT 2000 OFFSET 2000 Continue to increase the offset by 2,000 until you have results for all records. # TwoFactorTempCode Stores information about a user’s temporary verification code for confirming their identity when logging in. This object is available in API version 37.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules You need the Manage Multi-Factor Authentication in API permission to access this object. (Note that multi-factor authentication was formerly called two-factor authentication.) ## Fields | Field Name | Details | | --- | --- | | Expiration | Type dateTime Properties Filter, Sort Description The date and time when the temporary verification code expires. The code expires in 1 to 24 hours after it’s generated. Salesforce admins and non-admin users with the Manage Multi-Factor Authentication in User Interface permission set the expiration time when generating the code. | | Identifier | Type string Properties Filter, Group, Sort Description The unique identifier for the temporary code. This is a required field that can take any value. | | TempCode | Type encryptedstring Description A request for this value always returns null. | | UserId | Type reference Properties Filter, Group, Sort Description The ID for the user who’s associated with the temporary verification code. | # UI Telemetry Navigation Timing Event Type UI Telemetry Navigation Timing events capture network performance metrics related to page navigation. The event extends from the [UI Telemetry Resource Timing Event](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_uitelemetryresourcetiming.htm "UI Telemetry Resource Timing events capture network performance metrics related to loading an application’s resources. The event includes requests initiated with either the Fetch API or the XMLHttpRequest API. This object is available in API version 61.0 and later.") and includes requests initiated with either the [Fetch API](https://fetch.spec.whatwg.org/) or the [XMLHttpRequest API](https://xhr.spec.whatwg.org/). This object is available in API version 61.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). For information about navigation timing attributes, including a diagram of the order that attributes follow, see section 4.1 of the W3 Standards on [Navigation Timing Level 2](https://www.w3.org/TR/navigation-timing-2/). ## Fields | Field | Details | | --- | --- | | APP\_NAME | Type String Description The name of the application that the user accessed. | | BROWSER\_NAME | Type String Description The name of the browser that the user accessed. Example Chrome, Safari | | BROWSER\_VERSION | Type String Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | CLIENT\_GEO | Type String Description The geolocation of the client in the form of /. Example United States/California | | CLIENT\_ID | Type String Description The API client ID. | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as Salesforce.com IP. Example 96.43.144.26 | | CONNECT\_END | Type Number Description The time in milliseconds when the browser establishes a connection to a server so that it can retrieve a resource. To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT\_START time from the CONNECT\_END time. | | CONNECT\_START | Type Number Description The time in milliseconds after the browser completes the Domain Name System (DNS) lookup and begins connecting to a server so that it can retrieve a resource. To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT\_START time from the CONNECT\_END time. | | CONNECTION\_TYPE | Type String Description The type of connection. Possible Values - CDMA1x - CDMA - EDGE - EVDO0 - EVDOA - EVDOB - GPRS - HRPD - HSDPA - HSUPA - LTE - WIFI | | DECODED\_BODY\_SIZE | Type Number Description The size in octets of the HTTP message body after the removal of any applied content encoding. | | DEVICE\_MODEL | Type String Description The name of the device model. Example iPad, iPhone | | DEVICE\_PLATFORM | Type String Description The type of application experience in name:experience:form format. Possible Values - name: APP\_BUILDER, CUSTOM, S1, SFX - experience: BROWSER, HYBRID - form: DESKTOP, PHONE, TABLET | | DEVICE\_SESSION\_ID | Type String Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0 | | DOM\_COMPLETE | Type Number Description The time in milliseconds when the page’s readyState property is set to complete. Indicates that the page and its subresources have finished loading. | | DOM\_CONTENT\_LOADED\_EVENT\_END | Type Number Description The time in milliseconds when the page’s DOMContentLoaded event handler completes. To calculate the processing time for the DOMContentLoaded event handler, subtract the DOM\_CONTENT\_LOADED\_EVENT\_START time from the DOM\_CONTENT\_LOADED\_EVENT\_END time. | | DOM\_CONTENT\_LOADED\_EVENT\_START | Type Number Description The time in milliseconds when the page’s DOMContentLoaded event handler starts. To calculate the processing time for the DOMContentLoaded event handler, subtract the DOM\_CONTENT\_LOADED\_EVENT\_START time from the DOM\_CONTENT\_LOADED\_EVENT\_END time. | | DOM\_INTERACTIVE | Type Number Description The time in milliseconds when the page’s readyState is set to interactive. Indicates that the page has finished loading, but subresources, such as images and scripts, are still loading. | | DOMAIN\_LOOKUP\_END | Type Number Description The time in milliseconds when the browser completes a DNS lookup for a resource. To calculate the DNS lookup time, subtract the DOMAIN\_LOOKUP\_START time from the DOMAIN\_LOOKUP\_END time. | | DOMAIN\_LOOKUP\_START | Type Number Description The time in milliseconds when the browser starts a DNS lookup for a resource. To calculate the DNS lookup time, subtract the DOMAIN\_LOOKUP\_START time from the DOMAIN\_LOOKUP\_END time. | | DURATION | Type Number Description The total duration in milliseconds of the event from the START\_TIME to the LOAD\_EVENT\_END time. | | ENCODED\_BODY\_SIZE | Type Number Description The size in octets of the HTTP message body before the removal of any applied content encoding. | | EVENT\_TYPE | Type String Description The type of event. The value is always UITelemetryNavigationTiming. | | FETCH\_START | Type Number Description The time in milliseconds when the browser starts to fetch a resource from the server, not including redirects. Occurs before the DNS lookup and the connection to the server is established. To calculate the total time used to fetch a resource without redirects, subtract the FETCH\_START time from the RESPONSE\_END time. | | FIRST\_INTERIM\_RESPONSE\_START | Type Number Description The time in milliseconds when the browser receives the first byte of the interim 1xx response from the server. To calculate the time from when the browser sends a request to when it starts to receive an interim response, subtract the REQUEST\_START time from the FIRST\_INTERIM\_RESPONSE\_START time. | | INITIATOR\_TYPE | Type String Description The HTML element that initiates the resource load. Example css, image, link | | LOAD\_EVENT\_END | Type Number Description The time in milliseconds when the page’s load event handler completes. To calculate the processing time for the load event handler, subtract the LOAD\_EVENT\_START time from the LOAD\_EVENT\_END time. | | LOAD\_EVENT\_START | Type Number Description The time in milliseconds when the page’s load event handler begins. To calculate the processing time for the load event handler, subtract the LOAD\_EVENT\_START time from the LOAD\_EVENT\_END time. | | LOGIN\_KEY | Type String Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I | | NAVIGATION\_TYPE | Type String Description The type of navigation timing data. Possible Values - navigate: a user interaction or a script initiated navigation. - reload: a reload initiated navigation. - back\_forward: navigation traverses the browser’s history. - prerender: a prerender hint initiated navigation. | | NEXT\_HOP\_PROTOCOL | Type String Description The Application-Layer Protocol Negotiation (ALPN) Protocol ID that fetches the resource. Possible Values http/0.9, http/1.0, h2, h2c, h3 | | ORGANIZATION\_ID | Type String Description The 15-character ID of the org. Example 00D000000000123 | | OS\_NAME | Type String Description The operating system name, derived from USER\_AGENT. Example Android, iOS, OSX | | OS\_VERSION | Type String Description The operating system version, derived from USER\_AGENT. | | PAGE\_CONTEXT | Type String Description The name of the component hosting the main content of the page. Example clients:cardsContainer | | PAGE\_ENTITY\_ID | Type String Description The unique entity identifier of the event. Example 0013000000I3zJAAAZ | | PAGE\_ENTITY\_TYPE | Type String Description The entity type of the event. Example task, contacts | | PAGE\_URL | Type String Description The relative URL of the top-level Lightning Experience page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PAGE\_URL. Example /sObject/0064100000JXITSAA5/view | | REDIRECT\_COUNT | Type Number Description The total number of redirects since the last non-redirect navigation in the current browsing context. | | REDIRECT\_END | Type Number Description The time in milliseconds when the browser receives the last byte of the response of the final redirect. To calculate the total redirection time, subtract the REDIRECT\_START time from the REDIRECT\_END time. | | REDIRECT\_START | Type Number Description The time in milliseconds when the browser starts to fetch a resource that initiates a redirect. To calculate the total redirection time, subtract the REDIRECT\_START time from the REDIRECT\_END time. | | RENDER\_BLOCKING\_STATUS | Type String Description The status that indicates whether the resource can block or delay the browser from rendering page content. Possible Values - blocking: the resource can block rendering. - codenon-blocking: the resource doesn’t block rendering. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 3nWgxWbDKWWDIk0FKfF5DV | | REQUEST\_START | Type Number Description The time in milliseconds when the browser starts to request the resource from the server. To calculate the total request time, subtract the REQUEST\_START time from the RESPONSE\_START time. | | RESPONSE\_END | Type Number Description The time in milliseconds when the browser receives the resource’s last byte or when the transport connection closes, whichever comes first. To calculate the total time used to fetch a resource without redirects, subtract the FETCH\_START time from the RESPONSE\_END time. | | RESPONSE\_START | Type Number Description The time in milliseconds when the browser receives the first byte of the response from the server. To calculate the total request time, subtract the REQUEST\_START time from the RESPONSE\_START time. | | RESPONSE\_STATUS | Type Number Description The HTTP response status code. Example 200 | | SDK\_APP\_TYPE | Type String Description The mobile SDK application type. Possible Values - HYBRID - HYBRIDLOCAL - HYBRIDREMOTE - NATIVE - REACTNATIVE | | SDK\_APP\_VERSION | Type String Description The mobile SDK application version number. Example 5.0 | | SDK\_VERSION | Type String Description The mobile SDK version number. Example 2.1.0 | | SECURE\_CONNECT\_START | Type Number Description The time in milliseconds when the browser begins the handshake process that secures the connection. To calculate the Transport Layer Security (TLS) time, subtract the SECURE\_CONNECT\_START time from the REQUEST\_START time. | | SERVER\_REQUEST\_ID | Type String Description The request ID for the server request that’s used to find associated server logs. Example 346000000087551ecb | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session starts. Example cdd09305cb6babf34059e27f70e47f1b11dec868 | | START\_TIME | Type Number Description The time in milliseconds when the browser starts to fetch the resource, including redirects. | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. Example 20130715233322.670 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z. The timezone is GMT. | | TRANSFER\_SIZE | Type Number Description The size in octets of the resource, including the response header and the response payload body. | | UI\_EVENT\_RELATIVE\_TIMESTAMP | Type Number Description The difference in milliseconds between when the event is logged and when the browser tab is opened. Example 29322.23 | | UI\_EVENT\_TIMESTAMP | Type Number Description The time at which this event occurs, measured in milliseconds. Example 1479769912796 | | UI\_ROOT\_ACTIVITY\_ID | Type String Description The ID of the root activity when the event occurs. | | UI\_THREAD\_RESPONSE\_DELAY | Type Number Description The time in milliseconds from when the browser receives the response to when it executes the callback. This delay occurs if the main Javascript thread is busy when the response is received. | | UNLOAD\_EVENT\_END | Type Number Description The time in milliseconds when the page’s unload event handler completes. To calculate the processing time for the unload event handler, subtract the UNLOAD\_EVENT\_START time from the UNLOAD\_EVENT\_END time. | | UNLOAD\_EVENT\_START | Type Number Description The time in milliseconds when the page’s unload event handler starts. To calculate the processing time for the unload event handler, subtract the UNLOAD\_EVENT\_START time from the UNLOAD\_EVENT\_END time. | | URL | Type String Description The URL of the request. | | USER\_ID | Type String Description The 15-character ID of the user accessing Salesforce services through the UI or API. Example 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0 | | USER\_TYPE | Type String Description The category of user license of the user accessing Salesforce services through the UI or API. Possible Values - A: Automated Process - b: High Volume Portal - C: Customer Portal User - D: External Who - F: Self-Service - G: Guest - L: Package License Manager - N: Salesforce to Salesforce - n: CSN Only - O: Power Custom - o: Custom - P: Partner - p: Customer Portal Manager - S: Standard - X: Salesforce Administrator | | WORKER\_START | Type Number Description If a service worker is installed, the time in milliseconds when the active service worker receives the fetch event. To measure the service worker processing time, subtract the WORKER\_START time from the FETCH\_START time. | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # UI Telemetry Resource Timing Event UI Telemetry Resource Timing events capture network performance metrics related to loading an application’s resources. The event includes requests initiated with either the [Fetch API](https://fetch.spec.whatwg.org/) or the [XMLHttpRequest API](https://xhr.spec.whatwg.org/). This object is available in API version 61.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). For information about resource timing attributes, including a diagram of the order that attributes follow, see section 4.6 of the W3 Standards on [Resource Timing](https://www.w3.org/TR/resource-timing/). ## Fields | Field | Details | | --- | --- | | APP\_NAME | Type String Description The name of the application that the user accessed. | | BROWSER\_NAME | Type String Description The name of the browser that the user accessed. Example Chrome, Safari | | BROWSER\_VERSION | Type String Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | CLIENT\_GEO | Type String Description The geolocation of the client in the form of /. Example United States/California | | CLIENT\_ID | Type String Description The API client ID. | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as “Salesforce.com IP.” Example 96.43.144.26 | | CONNECT\_END | Type Number Description The time in milliseconds when the browser establishes a connection to a server so that it can retrieve a resource. To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT\_START time from the CONNECT\_END time. | | CONNECT\_START | Type Number Description The time in milliseconds after the browser completes the Domain Name System (DNS) lookup and begins connecting to a server so that it can retrieve a resource. To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT\_START time from the CONNECT\_END time. | | CONNECTION\_TYPE | Type String Description The type of connection. Possible Values - CDMA1x - CDMA - EDGE - EVDO0 - EVDOA - EVDOB - GPRS - HRPD - HSDPA - HSUPA - LTE - WIFI | | DECODED\_BODY\_SIZE | Type Number Description The size in octets of the HTTP message body after the removal of any applied content encoding. | | DEVICE\_MODEL | Type String Description The name of the device model. Example iPad, iPhone | | DEVICE\_PLATFORM | Type String Description The type of application experience in name:experience:form format. Possible Values - name: APP\_BUILDER, CUSTOM, S1, SFX - experience: BROWSER, HYBRID - form: DESKTOP, PHONE, TABLET | | DEVICE\_SESSION\_ID | Type String Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0 | | DOMAIN\_LOOKUP\_END | Type Number Description The time in milliseconds when the browser completes a DNS lookup for a resource. To calculate the DNS lookup time, subtract the DOMAIN\_LOOKUP\_START time from the DOMAIN\_LOOKUP\_END time. | | DOMAIN\_LOOKUP\_START | Type Number Description The time in milliseconds when the browser starts a DNS lookup for a resource. To calculate the DNS lookup time, subtract the DOMAIN\_LOOKUP\_START time from the DOMAIN\_LOOKUP\_END time. | | DURATION | Type Number Description The total duration in milliseconds of the event from the START\_TIME to the RESPONSE\_END time. | | ENCODED\_BODY\_SIZE | Type Number Description The size in octets of the HTTP message body before the removal of any applied content encoding. | | EVENT\_TYPE | Type String Description The type of event. The value is always UITelemetryResourceTiming. | | FETCH\_START | Type Number Description The time in milliseconds when the browser starts to fetch a resource from the server, not including redirects. Occurs before the DNS lookup and the connection to the server is established. To calculate the total time used to fetch a resource without redirects, subtract the FETCH\_START time from the RESPONSE\_END time. | | FIRST\_INTERIM\_RESPONSE\_START | Type Number Description The time in milliseconds when the browser receives the first byte of the interim 1xx response from the server. To calculate the time from when the browser sends a request to when it starts to receive an interim response, subtract the REQUEST\_START time from the FIRST\_INTERIM\_RESPONSE\_START time. | | INITIATOR\_TYPE | Type String Description The HTML element that initiates the resource load. Example css, image, link | | LOGIN\_KEY | Type String Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I | | NEXT\_HOP\_PROTOCOL | Type String Description The Application-Layer Protocol Negotiation (ALPN) Protocol ID that fetches the resource. Possible Values http/0.9, http/1.0, h2, h2c, h3 | | ORGANIZATION\_ID | Type String Description The 15-character ID of the org. Example 00D000000000123 | | OS\_NAME | Type String Description The operating system name, derived from USER\_AGENT. Example Android, iOS, OSX, Window | | OS\_VERSION | Type String Description The operating system version, derived from USER\_AGENT. | | PAGE\_CONTEXT | Type String Description The name of the component hosting the main content of the page. Example clients:cardsContainer | | PAGE\_ENTITY\_ID | Type String Description The unique entity identifier of the event. Example 0013000000I3zJAAAZ | | PAGE\_ENTITY\_TYPE | Type String Description The entity type of the event. Example task, contacts | | PAGE\_URL | Type String Description Relative URL of the top-level Lightning Experience page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PAGE\_URL. Example /sObject/0064100000JXITSAA5/view | | REDIRECT\_END | Type Number Description The time in milliseconds when the browser receives the last byte of the response of the final redirect. To calculate the total redirection time, subtract the REDIRECT\_START time from the REDIRECT\_END time. | | REDIRECT\_START | Type Number Description The time in milliseconds when the browser starts to fetch a resource that initiates a redirect. To calculate the total redirection time, subtract the REDIRECT\_START time from the REDIRECT\_END time. | | RENDER\_BLOCKING\_STATUS | Type String Description The status that indicates whether the resource can block or delay the browser from rendering page content. Possible Values - blocking: the resource can block rendering. - codenon-blocking: the resource doesn’t block rendering. | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 3nWgxWbDKWWDIk0FKfF5DV | | REQUEST\_START | Type Number Description The time in milliseconds when the browser starts to request the resource from the server. To calculate the total request time, subtract the REQUEST\_START time from the RESPONSE\_START time. | | RESPONSE\_END | Type Number Description The time in milliseconds when the browser receives the resource’s last byte or when the transport connection closes, whichever comes first. To calculate the total time used to fetch a resource without redirects, subtract the FETCH\_START time from the RESPONSE\_END time. | | RESPONSE\_START | Type Number Description The time in milliseconds when the browser receives the first byte of the response from the server. To calculate the total request time, subtract the REQUEST\_START time from the RESPONSE\_START time. | | RESPONSE\_STATUS | Type Number Description The HTTP response status code. Example 200 | | SDK\_APP\_TYPE | Type String Description The mobile SDK application type. Possible Values - HYBRID - HYBRIDLOCAL - HYBRIDREMOTE - NATIVE - REACTNATIVE | | SDK\_APP\_VERSION | Type String Description The mobile SDK application version number. Example 5.0 | | SDK\_VERSION | Type String Description The mobile SDK version number. Example 2.1.0 | | SECURE\_CONNECT\_START | Type Number Description The time in milliseconds when the browser begins the handshake process that secures the connection. To calculate the Transport Layer Security (TLS) time, subtract the SECURE\_CONNECT\_START time from the REQUEST\_START time. | | SERVER\_REQUEST\_ID | Type String Description The requestId for the server request that’s used to find associated server logs. Example 346000000087551ecb | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session starts. Example cdd09305cb6babf34059e27f70e47f1b11dec868 | | START\_TIME | Type Number Description The time in milliseconds when the browser starts to fetch the resource, including redirects. | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. Example 20130715233322.670 | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z. The timezone is GMT. | | TRANSFER\_SIZE | Type Number Description The size in octets of the resource, including the response header and the response payload body. | | UI\_EVENT\_RELATIVE\_TIMESTAMP | Type Number Description The difference in milliseconds between when the event is logged and when the browser tab is opened. Example 29322.23 | | UI\_EVENT\_TIMESTAMP | Type Number Description The time at which this event occurs, measured in milliseconds. Example 1479769912796 | | UI\_ROOT\_ACTIVITY\_ID | Type String Description The ID of the root activity when the event occurs. | | UI\_THREAD\_RESPONSE\_DELAY | Type Number Description The time in milliseconds from when the browser receives the response to when it executes the callback. This delay occurs if the main Javascript thread is busy when the response is received. | | URL | Type String Description The URL of the request. | | USER\_ID | Type String Description The 15-character ID of the user accessing Salesforce services through the UI or API. Example 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0 | | USER\_TYPE | Type String Description The category of user license of the user accessing Salesforce services through the UI or API. Possible Values - A: Automated Process - b: High Volume Portal - C: Customer Portal User - D: External Who - F: Self-Service - G: Guest - L: Package License Manager - N: Salesforce to Salesforce - n: CSN Only - O: Power Custom - o: Custom - P: Partner - p: Customer Portal Manager - S: Standard - X: Salesforce Administrator | | WORKER\_START | Type Number Description The time in milliseconds when the active service worker receives the fetch event, if a service worker is installed. To measure the service worker processing time, subtract the WORKER\_START time from the FETCH\_START time. | #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # UiAgentInteractionEventLog This log tracks client side interactions and events with the Agentforce panel. It is limited to Salesforce Lightning Experience, Salesforce Mobile, and Conversation Preview within Agentforce Builder. This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AgentType | Type string Properties Filter, Group, Nillable, Sort Description The type of agent. | | AppName | Type string Properties Filter, Group, Nillable, Sort Description The app this logline has executed. | | BotIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the agent. | | BotSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Returned with every session (from bots runtime API). The session begins with co-pilot panel is opened and ends when the user logs out of Salesforce, closes the browser tab or exits the browser. For mobile, this id is present throughout the entire time the app is open, and only changes upon cold start or logout. | | BrowserName | Type string Properties Filter, Group, Nillable, Sort Description The name of the browser. | | BrowserVersion | Type string Properties Filter, Group, Nillable, Sort Description Browser major.minor version. Some browseers may not provide a minor version. | | ButtonLabel | Type string Properties Filter, Group, Nillable, Sort Description When the user interacts with a message by clicking a message-level button, this is the label of the button the user selects. | | Channel | Type string Properties Filter, Group, Nillable, Sort Description The name of the channel. For example, mobile, LEX, or Playground. | | ClientGeolocation | Type string Properties Filter, Group, Nillable, Sort Description Client geographic location in format Country/State. | | ClientIdentifier | Type string Properties Filter, Group, Nillable, Sort Description API client ID. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description Client IP address. | | Components | Type textarea Properties Nillable Description An array of strings that contain the names of the components, including the namespace and the name of the component. This should include both input and output components. | | ConnectionType | Type string Properties Filter, Group, Nillable, Sort Description The type of connection. For example, WiFi. | | DeviceModel | Type string Properties Filter, Group, Nillable, Sort Description The device model. | | DevicePlatform | Type string Properties Filter, Group, Nillable, Sort Description The application experience | | DeviceSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Auto-generated ID on the client-side that stays the same for the duration of the browser tab. | | FeedbackIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The turn ID from Agents V1 API. | | HasToxicityWarning | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Flag to identify whether the message contains a toxicity warning. The default value is false. | | IsAgentPanelExited | Type boolean Properties Defaulted on create, Filter, Group, Sort Description A boolean field that is true if the user clicks on a button to navigate away from an agent panel. The default value is false. | | LightningType | Type textarea Properties Nillable Description An array of strings that contains the name of the ES type(s). | | LightningTypeMessage | Type string Properties Filter, Nillable, Sort Description This is the ES type message associated with the co-pilot response (i.e. “Inform” or “Inquire”) | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The hash of the login id to allow tracking of all events from user login to logout. | | MessageIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Returned with every message (from bots runtime API). | | MobileSdkAppType | Type string Properties Filter, Group, Nillable, Sort Description The mobile application type. | | MobileSdkVersion | Type string Properties Filter, Group, Nillable, Sort Description The SDK version. | | ObjectType | Type string Properties Filter, Group, Nillable, Sort Description The name of the object for ES Type recordInfo. | | OperatingSystemName | Type string Properties Filter, Group, Nillable, Sort Description The name of the operating system. | | OperatingSystemVersion | Type string Properties Filter, Group, Nillable, Sort Description The operating system version number. | | PageContext | Type string Properties Filter, Group, Nillable, Sort Description Name of the component hosting the main content of the page. | | PageObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Object id, if any, of the record being displayed. | | PageObjectType | Type string Properties Filter, Group, Nillable, Sort Description Object type of the page being displayed. | | PageUrl | Type string Properties Filter, Group, Nillable, Sort Description Raw url of the page log occurred on. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | SdkAppVersion | Type string Properties Filter, Group, Nillable, Sort Description The SDK app version this logline has executed. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The hash of the session id to allow tracking of all events in a session. | | TaskName | Type string Properties Filter, Group, Nillable, Sort Description This will describe the nature of the event being logged. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description Timestamp at which the log event was generated. | | UiEventElapsedTime | Type double Properties Filter, Nillable, Sort Description The elapsed time for the UI event. | | UiEventTimestamp | Type dateTime Properties Filter, Nillable, Sort Description Time when the message was logged according to the client. | | UiRootActivityIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID for the root activity, if any, when this message was logged. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The user ID of the request. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The type of user. | | VoiceOrText | Type string Properties Filter, Group, Nillable, Sort Description Whether the input by the user was “voice” or “text”. | # UiFormulaCriterion Represents a filter that helps define component visibility on a Lightning page. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | LeftHandSide | Type string Properties Filter, Group, Sort Description Represents the field that the filter is based on. For example, AMOUNT. | | OperatorId | Type string Properties Filter, Group, Nillable, Sort Description Represents the filter operator. Valid values are: - CONTAINS - EQUAL - GE—greater than or equal - GT—greater than - LE—less than or equal - LT—less than - NE—not equal This is a relationship field. Relationship Name Operator Relationship Type Lookup Refers To null | | ParentKeyPrefix | Type string Properties Filter, Group, Nillable, Sort Description Represents the three-digit prefix of the parent ID. | | RightHandSide | Type string Properties Filter, Group, Nillable, Sort Description Represents the value used to evaluate the component’s visibility. For example, 1000000. | | RuleId | Type reference Properties Filter, Group, Sort Description Represents the formula rule ID. This is a relationship field. Relationship Name Rule Relationship Type Lookup Refers To UiFormulaRule | # UiFormulaRule Represents a set of one or more filters that define the conditions under which a component displays on a Lightning page. This object is available in API version 47.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AssociatedElementId | Type reference Properties Filter, Group, Nillable, Sort Description Represents a parent component that UiFormulaRule is associated with, such as PromptVersion. This is a relationship field. Relationship Name AssociatedElement Relationship Type Lookup Refers To PromptVersion | | BooleanFilter | Type string Properties Filter, Group, Nillable, Sort Description Represents the filter logic applied to UiFormulaRule. References the UI formula rule stored by UiFormulaCriterion based on the sortIndex, such as ((1 && 3) || 2). | | DeveloperName | Type string Properties Filter, Group, Sort Description Represents the API name of the UiFormulaRule. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Formula | Type textarea Properties Nillable Description Represents the formula source string of UiFormulaRule. | | Language | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Represents the language of the UiFormulaRule. | | MasterLabel | Type string Properties Filter, Group, Sort Description Required. Represents the label of the UiFormulaRule. | | ParentKeyPrefix | Type string Properties Filter, Group, Nillable, Sort Description Represents the three-digit prefix for AssociatedElementId. | # UiTelemetryNavTmEventLog UI Telemetry Navigation Timing events capture network performance metrics related to page navigation. The event extends from the [UI Telemetry Resource Timing Event](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_uitelemetryresourcetiming.htm "UI Telemetry Resource Timing events capture network performance metrics related to loading an application’s resources. The event includes requests initiated with either the Fetch API or the XMLHttpRequest API. This object is available in API version 61.0 and later.") and includes requests initiated with either the [Fetch API](https://fetch.spec.whatwg.org/) or the [XMLHttpRequest API](https://xhr.spec.whatwg.org/). This object is available in API version 64.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Event Monitoring logs are a source of truth but are not durable. Data loss can occur during Salesforce site switches, instance refreshes, or unplanned outages. For more information, see [Using Event Monitoring](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AppName | Type string Properties Filter, Group, Nillable, Sort Description The name of the application that the user accessed. | | BrowserName | Type string Properties Filter, Group, Nillable, Sort Description The name of the browser that the user accessed. | | BrowserVersion | Type string Properties Filter, Group, Nillable, Sort Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | ClientGeolocation | Type string Properties Filter, Group, Nillable, Sort Description The geolocation of the client in the form of /. | | ClientIdentifier | Type string Properties Filter, Group, Nillable, Sort Description | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as Salesforce.com IP. | | ConnectEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser establishes a connection to a server so that it can retrieve a resource. To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT\_START time from the CONNECT\_END time. | | ConnectStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds after the browser completes the Domain Name System (DNS) lookup and begins connecting to a server so that it can retrieve a resource. To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT\_START time from the CONNECT\_END time. | | ConnectionType | Type string Properties Filter, Group, Nillable, Sort Description The type of connection. | | DecodedBodySize | Type double Properties Filter, Nillable, Sort Description The size in octets of the HTTP message body after the removal of any applied content encoding. | | DeviceModel | Type string Properties Filter, Group, Nillable, Sort Description The name of the device model. | | DevicePlatform | Type string Properties Filter, Group, Nillable, Sort Description The type of application experience in name:experience:form format. | | DeviceSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. | | DomComplete | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the page’s readyState property is set to complete. Indicates that the page and its subresources have finished loading. | | DomContentLoadedEventEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the page’s DOMContentLoaded event handler completes. To calculate the processing time for the DOMContentLoaded event handler, subtract the DOM\_CONTENT\_LOADED\_EVENT\_START time from the DOM\_CONTENT\_LOADED\_EVENT\_END time. | | DomContentLoadedEventStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the page’s DOMContentLoaded event handler starts. To calculate the processing time for the DOMContentLoaded event handler, subtract the DOM\_CONTENT\_LOADED\_EVENT\_START time from the DOM\_CONTENT\_LOADED\_EVENT\_END time. | | DomInteractive | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the page’s readyState is set to interactive. Indicates that the page has finished loading, but subresources, such as images and scripts, are still loading. | | DomainLookupEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser completes a DNS lookup for a resource. To calculate the DNS lookup time, subtract the DOMAIN\_LOOKUP\_START time from the DOMAIN\_LOOKUP\_END time. | | DomainLookupStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts a DNS lookup for a resource. To calculate the DNS lookup time, subtract the DOMAIN\_LOOKUP\_START time from the DOMAIN\_LOOKUP\_END time. | | Duration | Type double Properties Filter, Nillable, Sort Description The total duration in milliseconds of the event from the START\_TIME to the LOAD\_EVENT\_END time. | | EncodedBodySize | Type double Properties Filter, Nillable, Sort Description The size in octets of the HTTP message body before the removal of any applied content encoding. | | FetchStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts to fetch a resource from the server, not including redirects. Occurs before the DNS lookup and the connection to the server is established. To calculate the total time used to fetch a resource without redirects, subtract the FETCH\_START time from the RESPONSE\_END time. | | FirstInterimResponseStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser receives the first byte of the interim 1xx response from the server. To calculate the time from when the browser sends a request to when it starts to receive an interim response, subtract the REQUEST\_START time from the FIRST\_INTERIM\_RESPONSE\_START time. | | InitiatorType | Type string Properties Filter, Group, Nillable, Sort Description The HTML element that initiates the resource load. | | LoadEventEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the page’s load event handler completes. To calculate the processing time for the load event handler, subtract the LOAD\_EVENT\_START time from the LOAD\_EVENT\_END time. | | LoadEventStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the page’s load event handler begins. To calculate the processing time for the load event handler, subtract the LOAD\_EVENT\_START time from the LOAD\_EVENT\_END time. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | MobileSdkAppType | Type string Properties Filter, Group, Nillable, Sort Description The mobile application type. | | MobileSdkVersion | Type string Properties Filter, Group, Nillable, Sort Description Mobile SDK version number. | | NavigationType | Type string Properties Filter, Group, Nillable, Sort Description The type of navigation timing data. Possible Values - navigate: a user interaction or a script initiated navigation. - reload: a reload initiated navigation. - back\_forward: navigation traverses the browser’s history. - prerender: a prerender hint initiated navigation. | | NextHopProtocol | Type string Properties Filter, Group, Nillable, Sort Description The Application-Layer Protocol Negotiation (ALPN) Protocol ID that fetches the resource. Possible Values http/0.9, http/1.0, h2, h2c, h3 | | OperatingSystemName | Type string Properties Filter, Group, Nillable, Sort Description The operating system name, derived from USER\_AGENT. | | OperatingSystemVersion | Type string Properties Filter, Group, Nillable, Sort Description The operating system version, derived from USER\_AGENT. | | PageContext | Type string Properties Filter, Group, Nillable, Sort Description The name of the component hosting the main content of the page. | | PageObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique object identifier of the event. | | PageObjectType | Type string Properties Filter, Group, Nillable, Sort Description The object type of the event. | | PageUrl | Type string Properties Filter, Group, Nillable, Sort Description The relative URL of the top-level Lightning Experience page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PAGE\_URL. | | RedirectCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of redirects since the last non-redirect navigation in the current browsing context. | | RedirectEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser receives the last byte of the response of the final redirect. To calculate the total redirection time, subtract the REDIRECT\_START time from the REDIRECT\_END time. | | RedirectStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts to fetch a resource that initiates a redirect. To calculate the total redirection time, subtract the REDIRECT\_START time from the REDIRECT\_END time. | | RenderBlockingStatus | Type string Properties Filter, Group, Nillable, Sort Description The status that indicates whether the resource can block or delay the browser from rendering page content. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | RequestStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts to request the resource from the server. To calculate the total request time, subtract the REQUEST\_START time from the RESPONSE\_START time. | | ResponseEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser receives the resource’s last byte or when the transport connection closes, whichever comes first. To calculate the total time used to fetch a resource without redirects, subtract the FETCH\_START time from the RESPONSE\_END time. | | ResponseStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser receives the first byte of the response from the server. To calculate the total request time, subtract the REQUEST\_START time from the RESPONSE\_START time. | | ResponseStatus | Type double Properties Filter, Nillable, Sort Description The HTTP response status code. | | SdkAppVersion | Type string Properties Filter, Group, Nillable, Sort Description The mobile SDK application version. | | SecureConnectionStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser begins the handshake process that secures the connection. | | ServerRequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The request ID for the server request that’s used to find associated server logs. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session starts. | | StartTime | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts to fetch the resource, including redirects. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | TransferSize | Type double Properties Filter, Nillable, Sort Description The size in octets of the resource, including the response header and the response payload body. | | UiEventElapsedTime | Type double Properties Filter, Nillable, Sort Description The difference in milliseconds between when the event is logged and when the browser tab is opened. | | UiEventTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The time at which this event occurs, measured in milliseconds. | | UiRootActivityIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the root activity when the event occurs. | | UiThreadResponseDelay | Type double Properties Filter, Nillable, Sort Description The time in milliseconds from when the browser receives the response to when it executes the callback. This delay occurs if the main Javascript thread is busy when the response is received. | | UnloadEventEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the page’s unload event handler completes. To calculate the processing time for the unload event handler, subtract the UNLOAD\_EVENT\_START time from the UNLOAD\_EVENT\_END time. | | UnloadEventStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the page’s unload event handler starts. To calculate the processing time for the unload event handler, subtract the UNLOAD\_EVENT\_START time from the UNLOAD\_EVENT\_END time. | | Url | Type string Properties Filter, Group, Nillable, Sort Description The URL of the request. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user accessing Salesforce services through the UI or API. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license of the user accessing Salesforce services through the UI or API. | | WorkerStart | Type double Properties Filter, Nillable, Sort Description If a service worker is installed, the time in milliseconds when the active service worker receives the fetch event. To measure the service worker processing time, subtract the WORKER\_START time from the FETCH\_START time. | # UiTelemetryRsrcTmEventLog UI Telemetry Resource Timing events capture network performance metrics related to loading an application’s resources. The event includes requests initiated with either the [Fetch API](https://fetch.spec.whatwg.org/) or the [XMLHttpRequest API](https://xhr.spec.whatwg.org/). This object is available in API version 64.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Event Monitoring logs are a source of truth but are not durable. Data loss can occur during Salesforce site switches, instance refreshes, or unplanned outages. For more information, see [Using Event Monitoring](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | AppName | Type string Properties Filter, Group, Nillable, Sort Description The name of the application that the user accessed. | | BrowserName | Type string Properties Filter, Group, Nillable, Sort Description The name of the browser that the user accessed. | | BrowserVersion | Type string Properties Filter, Group, Nillable, Sort Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version. | | ClientGeolocation | Type string Properties Filter, Group, Nillable, Sort Description The geolocation of the client in the form of /. | | ClientIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The API client ID. | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as “Salesforce.com IP.” | | ConnectEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser establishes a connection to a server so that it can retrieve a resource. To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT\_START time from the CONNECT\_END time. | | ConnectStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds after the browser completes the Domain Name System (DNS) lookup and begins connecting to a server so that it can retrieve a resource. To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT\_START time from the CONNECT\_END time. | | ConnectionType | Type string Properties Filter, Group, Nillable, Sort Description The type of connection. | | DecodedBodySize | Type double Properties Filter, Nillable, Sort Description The size in octets of the HTTP message body after the removal of any applied content encoding. | | DeviceModel | Type string Properties Filter, Group, Nillable, Sort Description The name of the device model. | | DevicePlatform | Type string Properties Filter, Group, Nillable, Sort Description The type of application experience in name:experience:form format. | | DeviceSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. | | DomainLookupEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser completes a DNS lookup for a resource. To calculate the DNS lookup time, subtract the DOMAIN\_LOOKUP\_START time from the DOMAIN\_LOOKUP\_END time. | | DomainLookupStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts a DNS lookup for a resource. To calculate the DNS lookup time, subtract the DOMAIN\_LOOKUP\_START time from the DOMAIN\_LOOKUP\_END time. | | Duration | Type double Properties Filter, Nillable, Sort Description The total duration in milliseconds of the event from the START\_TIME to the RESPONSE\_END time. | | EncodedBodySize | Type double Properties Filter, Nillable, Sort Description The size in octets of the HTTP message body before the removal of any applied content encoding. | | FetchStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts to fetch a resource from the server, not including redirects. Occurs before the DNS lookup and the connection to the server is established. To calculate the total time used to fetch a resource without redirects, subtract the FETCH\_START time from the RESPONSE\_END time. | | FirstInterimResponseStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser receives the first byte of the interim 1xx response from the server. To calculate the time from when the browser sends a request to when it starts to receive an interim response, subtract the REQUEST\_START time from the FIRST\_INTERIM\_RESPONSE\_START time. | | InitiatorType | Type string Properties Filter, Group, Nillable, Sort Description The HTML element that initiates the resource load. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | MobileSdkAppType | Type string Properties Filter, Group, Nillable, Sort Description The mobile application type. | | MobileSdkVersion | Type string Properties Filter, Group, Nillable, Sort Description Mobile SDK version number. | | NextHopProtocol | Type string Properties Filter, Group, Nillable, Sort Description The ALPN Protocol ID. | | OperatingSystemName | Type string Properties Filter, Group, Nillable, Sort Description The name of the operating system. | | OperatingSystemVersion | Type string Properties Filter, Group, Nillable, Sort Description The operating system version number. | | PageContext | Type string Properties Filter, Group, Nillable, Sort Description The name of the component hosting the main content of the page. | | PageObjectIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique object identifier of the event. | | PageObjectType | Type string Properties Filter, Group, Nillable, Sort Description The object type of the event. | | PageUrl | Type string Properties Filter, Group, Nillable, Sort Description Relative URL of the top-level Lightning Experience page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PAGE\_URL. | | RedirectEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser receives the last byte of the response of the final redirect. To calculate the total redirection time, subtract the REDIRECT\_START time from the REDIRECT\_END time. | | RedirectStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts to fetch a resource that initiates a redirect. To calculate the total redirection time, subtract the REDIRECT\_START time from the REDIRECT\_END time. | | RenderBlockingStatus | Type string Properties Filter, Group, Nillable, Sort Description The status that indicates whether the resource can block or delay the browser from rendering page content. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | RequestStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts to request the resource from the server. To calculate the total request time, subtract the REQUEST\_START time from the RESPONSE\_START time. | | ResponseEnd | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser receives the resource’s last byte or when the transport connection closes, whichever comes first. To calculate the total time used to fetch a resource without redirects, subtract the FETCH\_START time from the RESPONSE\_END time. | | ResponseStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser receives the first byte of the response from the server. To calculate the total request time, subtract the REQUEST\_START time from the RESPONSE\_START time. | | ResponseStatus | Type double Properties Filter, Nillable, Sort Description The HTTP response status code. | | SdkAppVersion | Type string Properties Filter, Group, Nillable, Sort Description The mobile SDK application type. Possible Values - HYBRID - HYBRIDLOCAL - HYBRIDREMOTE - NATIVE - REACTNATIVE | | SecureConnectionStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser begins the handshake process that secures the connection. | | ServerRequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The requestId for the server request that’s used to find associated server logs. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session starts. | | StartTime | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the browser starts to fetch the resource, including redirects. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. | | TransferSize | Type double Properties Filter, Nillable, Sort Description The size in octets of the resource, including the response header and the response payload body. | | UiEventElapsedTime | Type double Properties Filter, Nillable, Sort Description The difference in milliseconds between when the message was logged and when the browser tab started meaning | | UiEventTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The difference in milliseconds between when the event is logged and when the browser tab is opened. | | UiRootActivityIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the root activity when the event occurs. | | UiThreadResponseDelay | Type double Properties Filter, Nillable, Sort Description The time in milliseconds from when the browser receives the response to when it executes the callback. This delay occurs if the main Javascript thread is busy when the response is received. | | Url | Type string Properties Filter, Group, Nillable, Sort Description The URL of the request. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user accessing Salesforce services through the UI or API. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license of the user accessing Salesforce services through the UI or API. | | WorkerStart | Type double Properties Filter, Nillable, Sort Description The time in milliseconds when the active service worker receives the fetch event, if a service worker is installed. To measure the service worker processing time, subtract the WORKER\_START time from the FETCH\_START time. | # UndecidedEventRelation Represents event participants (invitees or attendees) with the status Not Responded for a given event. This object is available in API versions 29.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | EventId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the event. This is a relationship field. Relationship Name Event Relationship Type Lookup Refers To Event | | RelationId | Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the invitee. This is a polymorphic relationship field. Relationship Name Relation Relationship Type Lookup Refers To Calendar, Contact, Lead, User | | RespondedDate | Type dateTime Properties Filter, Nillable, Sort Description This field is always null. | | Response | Type string Properties Filter, Group, Nillable, Sort Description Indicates the content of the response field. Label is Comment. | | Type | Type string Properties Filter, Group, Nillable, Sort Description Indicates whether the invitee is a user, lead or contact, or resource. | ## Usage Query invitees who have not responded to an invitation to an event SELECT eventId, type, response FROM UndecidedEventRelation WHERE eventid='00UTD000000ZH5LA' #### See Also - [AcceptedEventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_acceptedeventrelation.htm "Represents event participants (invitees or attendees) with the status Accepted for a given event.") - [DeclinedEventRelation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_declinedeventrelation.htm "Represents event participants (invitees or attendees) with the status Declined for a given event. This object is available in API versions 29.0 and later.") # UnifiedActivity Represents an activity that is automatically captured from Einstein Activity Capture (EAC) or other activity data, such as calls, manually logged tasks, and emails. This object consists of fields common to all types of activity-related objects such as Event, Task, EmailMessage, VoiceCall, VideoCall, and so on. Available for reports and dashboards in API version 59.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules We’re retiring Einstein Activity Capture Activity 360 Reporting. Starting in Summer ’25, this object isn’t available with Einstein Activity Capture unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Fields | Field | Details | | --- | --- | | ActivityDateTime | Type dateTime Properties Filter, Sort Description The date and time of the activity in the Coordinated Universal Time (UTC) time zone. | | ActivitySubType | Type picklist Properties Filter, Nillable, Restricted picklist Description Provides standard subtypes to facilitate creating and searching for specific activity subtypes. Possible values are: - Captured - LegacyCall - Streamed - VoiceCall | | ActivityType | Type picklist Properties Filter, Nillable, Restricted picklist Description The type of activity. Possible values are: - UnifiedActivity - UnifiedEmail - UnifiedMeeting - UnifiedTask - UnifiedVideoCall - UnifiedVoiceCall | | DetailId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the object that contains detailed activity-specific information. The object depends on the activity type. For example, the detail for a Task activity is a Task object. The detail for an Event activity is an Event object. This field is a polymorphic relationship field. Relationship Name Detail Relationship Type Lookup Refers To EmailMessage, Event, Task, VideoCall, VoiceCall | | InternalEventKey | Type string Properties Filter, Group, Nillable, Sort Description Reserved for internal use. | | IsInsightAvailable | Type boolean Properties Defaulted on create, Filter Description Indicates whether the activity has an insight associated with it (true) or not (false). The default value is false. | | Snippet | Type string Properties Nillable Description An abbreviation of the activity body or description. This field has a maximum length of 255 characters. | | Subject | Type string Properties None Description Contains the subject of the task or event. | # UnifiedActivityInsight Represents an insight related to a unified activity. Available for reports and dashboards in API version 59.0 and later. ## Supported Calls describeSObjects(), query() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules We’re retiring Einstein Activity Capture Activity 360 Reporting. Starting in Summer ’25, this object isn’t available with Einstein Activity Capture unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Fields | Field | Details | | --- | --- | | ActivityId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the unified activity that this insight is associated with. This field is a polymorphic relationship field. Relationship Name Activity Relationship Type Lookup Refers To UnifiedActivity, UnifiedEmail, UnifiedMeeting, UnifiedTask, UnifiedVideoCall, UnifiedVoiceCall | | AggregatedKeywordOccurrences | Type int Properties Filter, Nillable, Sort Description The number of keyword occurrences that triggered this insight. This field is the sum of occurrences for all the attached UnifiedActivityInsightKeyword objects. | | InsightType | Type string Properties Filter, Nillable, Sort Description Type of the insight. | | OwnerId | Type reference Properties Filter, Group, Nillable, Sort Description Optional. ID of the owner of the insight. Only user-scoped insights have owners (Scope\=USER). This field is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To User | | Scope | Type picklist Properties Filter, Nillable, Restricted picklist, Sort Description The scope of the insight. Possible values are: - ORG - USER | # UnifiedActivityParticipant Represents a participant in an activity. For example, a participant in a voice call is someone who initiated the call or someone who received the call. Available for reports and dashboards in API version 59.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules We’re retiring Einstein Activity Capture Activity 360 Reporting. Starting in Summer ’25, this object isn’t available with Einstein Activity Capture unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Fields | Field | Details | | --- | --- | | ActivityId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the activity that the person participated in. This field is a polymorphic relationship field. Relationship Name Activity Relationship Type Lookup Refers To UnifiedActivity, UnifiedEmail, UnifiedMeeting, UnifiedTask, UnifiedVideoCall, UnifiedVoiceCall | | ChannelAddress | Type string Properties Filter, Nillable Description The channel-specific address used to identify the participant in an external communication. For example, an email address in an email or a phone number in a voice call. The value is captured at the time of the communication; it doesn’t change if the contact’s email address or phone number is updated later. | | ParticipantType | Type picklist Properties Filter, Nillable, Restricted picklist Description The role of the participant in the activity. Possible values are: - AssignedTo - Attendee - BCC - CC - From - OptionalAttendee - Organizer - To | | PersonId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the person who participated in the activity. This field is a polymorphic relationship field. Relationship Name Person Relationship Type Lookup Refers To Contact, Lead, User | # UnifiedActivityRelation Represents a relationship between an activity and a related record that’s a target or topic of the activity. For example, a related record can be an opportunity, account, and so on. Available for reports and dashboards in API version 59.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules We’re retiring Einstein Activity Capture Activity 360 Reporting. Starting in Summer ’25, this object isn’t available with Einstein Activity Capture unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Fields | Field | Details | | --- | --- | | ActivityId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the activity. This field is a polymorphic relationship field. Relationship Name Activity Relationship Type Lookup Refers To UnifiedActivity, UnifiedVideoCall, UnifiedVoiceCall | | RelatedId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the related record. This field is a polymorphic relationship field. Relationship Name Related Relationship Type Lookup Refers To Account, Contact, Contract, Lead, Opportunity, User | # UnifiedActvtyInsightKeyword Represents a keyword in a communication that triggered the activity insight. Available for reports and dashboards in API version 59.0 and later. ## Supported Calls describeSObjects(), query() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules We’re retiring Einstein Activity Capture Activity 360 Reporting. Starting in Summer ’25, this object isn’t available with Einstein Activity Capture unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Fields | Field | Details | | --- | --- | | InsightId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the activity insight associated with the keyword. This field is a relationship field. Relationship Name Insight Relationship Type Lookup Refers To UnifiedActivityInsight | | Keyword | Type string Properties Filter, Nillable, Sort Description Keyword mentioned in the communication. | | Occurrences | Type int Properties Filter, Nillable, Sort Description Number of times the keyword was mentioned in the communication. | # UnifiedEmail Represents an email that was captured or synced from an EmailMessage or Task record. Available for reports and dashboards in API version 59.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Starting in Summer ’25, this object isn’t available unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules Einstein Activity Capture and Activity 360 Reporting must be enabled. ## Fields | Field | Details | | --- | --- | | ActivityDateTime | Type dateTime Properties Filter, Sort Description The date and time of the email in the Coordinated Universal Time (UTC) time zone. | | ActivitySubType | Type picklist Properties Filter, Nillable, Restricted picklist Description Always blank for this object. | | ActivityType | Type picklist Properties Filter, Nillable, Restricted picklist Description The type of activity. Possible value is UnifiedEmail. | | DetailId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the object that contains detailed activity-specific information. The object depends on the activity type. For example, the detail for a Task activity is a Task object. The detail for an Event activity is an Event object. If the email was captured from Einstein Activity Capture, this field returns a blank value. This field is a relationship field. Relationship Name Detail Relationship Type Lookup Refers To EmailMessage | | Direction | Type picklist Properties Filter, Nillable, Restricted picklist Description The direction in which the email was sent or received. Possible values are: - Inbound - Internal - Outbound | | InternalEventKey | Type string Properties Filter, Group, Nillable, Sort Description Reserved for internal use. | | IsInsightAvailable | Type boolean Properties Defaulted on create, Filter Description Indicates whether the activity has an insight associated with it (true) or not (false). The default value is false. | | IsPrivate | Type boolean Properties Defaulted on create Filter Description Indicates whether the activity's sensitive fields (Subject and Snippet) are masked (true) or visible (false) for non-owners. The default value is false. | | Snippet | Type string Properties Nillable Description An abbreviation of the email content. This field has a maximum length of 255 characters. | | Subject | Type string Properties None Description Contains the subject of the email. | # UnifiedEmailParticipant Represents a participant in an email. Available for reports and dashboards in API version 59.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Starting in Summer ’25, this object isn’t available unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules Einstein Activity Capture and Activity 360 Reporting must be enabled. ## Fields | Field | Details | | --- | --- | | ActivityId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the email the person is participating in. This field is a relationship field. Relationship Name Activity Relationship Type Lookup Refers To UnifiedEmail | | ChannelAddress | Type string Properties Filter, Nillable Description Email address of the participant. The email address is captured at the time of the communication; it doesn’t change if the contact’s email address is updated later. | | ParticipantType | Type picklist Properties Filter, Nillable, Restricted picklist Description Participant’s role in the email. Possible values are: - AssignedTo - Attendee - BCC - CC - From - OptionalAttendee - Organizer - To | | PersonId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the person participating in the email. This field is a polymorphic relationship field. Relationship Name Person Relationship Type Lookup Refers To Contact, Lead, User | # UnifiedMeeting Represents a meeting that was captured or synced from an Event record. Available for reports and dashboards in API version 59.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Starting in Summer ’25, this object isn’t available unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules Einstein Activity Capture and Activity 360 Reporting must be enabled. ## Fields | Field | Details | | --- | --- | | ActivityDateTime | Type dateTime Properties Filter, Sort Description The date and time of the meeting in the Coordinated Universal Time (UTC) time zone. | | ActivitySubType | Type picklist Properties Filter, Nillable, Restricted picklist Description Always blank for this object. | | ActivityType | Type picklist Properties Filter, Nillable, Restricted picklist Description The type of activity. Possible value is UnifiedMeeting. | | DetailId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the object that contains detailed activity-specific information. The object depends on the activity type. For example, the detail for a Task activity is a Task object. The detail for an Event activity is an Event object. This field is a relationship field. Relationship Name Detail Relationship Type Lookup Refers To Event | | InternalEventKey | Type string Properties Filter, Group, Nillable, Sort Description Reserved for internal use. | | IsInsightAvailable | Type boolean Properties Defaulted on create, Filter Description Indicates whether the activity has an insight associated with it (true) or not (false). The default value is false. | | Snippet | Type string Properties Nillable Description An abbreviation of the event description. This field has a maximum length of 255 characters. | | Subject | Type string Properties None Description Contains the subject of the meeting. | # UnifiedMeetingParticipant Represents a participant in a meeting. Available for reports and dashboards in API version 59.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Starting in Summer ’25, this object isn’t available unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules Einstein Activity Capture and Activity 360 Reporting must be enabled. ## Fields | Field | Details | | --- | --- | | ActivityId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the meeting that the person is participating in. This field is a relationship field. Relationship Name Activity Relationship Type Lookup Refers To UnifiedMeeting | | ChannelAddress | Type string Properties Filter, Nillable Description The email address of the participant. The email address is captured at the time of the communication; it doesn’t change if the contact’s email address is updated later. | | ParticipantType | Type picklist Properties Filter, Nillable, Restricted picklist Description The participant’s role in the meeting. Possible values are: - AssignedTo - Attendee - BCC - CC - From - OptionalAttendee - Organizer - To | | PersonId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the contact, lead, or user participating in the meeting. This field is a polymorphic relationship field. Relationship Name Person Relationship Type Lookup Refers To Contact, Lead, User | # UnifiedTask Represents a business activity such as a to-do item. Available for reports and dashboards in API version 59.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Starting in Summer ’25, this object isn’t available unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules Einstein Activity Capture and Activity 360 Reporting must be enabled. ## Fields | Field | Details | | --- | --- | | ActivityDateTime | Type dateTime Properties Filter, Sort Description The date and time of the activity in the Coordinated Universal Time (UTC) time zone. | | ActivitySubType | Type picklist Properties Filter, Nillable, Restricted picklist Description Always blank for this object. | | ActivityType | Type picklist Properties Filter, Nillable, Restricted picklist Description The type of activity. Possible value is UnifiedTask. | | DetailId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the object that contains detailed activity-specific information. The object depends on the activity type. For example, the detail for a Task activity is a Task object. This field is a relationship field. Relationship Name Detail Relationship Type Lookup Refers To Task | | InternalEventKey | Type string Properties Filter, Group, Nillable, Sort Description Reserved for internal use. | | IsInsightAvailable | Type boolean Properties Defaulted on create, Filter Description Indicates whether the activity has an insight associated with it (true) or not (false). The default value is false. | | Snippet | Type string Properties Nillable Description An abbreviation of the task body or description. This field has a maximum length of 255 characters. | | Subject | Type string Properties None Description The subject line of the task. | # UnifiedTaskParticipant Represents a participant in a task. Available for reports and dashboards in API version 59.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Starting in Summer ’25, this object isn’t available unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules Einstein Activity Capture and Activity 360 Reporting must be enabled. ## Fields | Field | Details | | --- | --- | | ActivityId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the activity the person is participating in. This field is a relationship field. Relationship Name Activity Relationship Type Lookup Refers To UnifiedTask | | ChannelAddress | Type string Properties Filter, Nillable Description Username of the participant. The username is captured at the time of the communication; it doesn’t change if the contact’s username is updated later. | | ParticipantType | Type picklist Properties Filter, Nillable, Restricted picklist Description The participant’s role in the activity. Possible values are: - AssignedTo - Attendee - BCC - CC - From - OptionalAttendee - Organizer - To | | PersonId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the contact, lead, or user participating in the activity. This field is a polymorphic relationship field. Relationship Name Person Relationship Type Lookup Refers To Contact, Lead, User | # UnifiedVideoCall Represents a video call that is captured or synced from the VideoCall or Task record. Available for reports and dashboards in API version 59.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules We’re retiring Einstein Activity Capture Activity 360 Reporting. Starting in Summer ’25, this object isn’t available with Einstein Activity Capture unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Fields | Field | Details | | --- | --- | | ActivityDateTime | Type dateTime Properties Filter, Sort Description The date and time of the activity in the Coordinated Universal Time (UTC) time zone. | | ActivitySubType | Type picklist Properties Filter, Nillable, Restricted picklist Description Provides standard subtypes to facilitate creating and searching for specific activity subtypes. Possible values are: - Captured - LegacyCall - Streamed - VoiceCall | | ActivityType | Type picklist Properties Filter, Nillable, Restricted picklist Description The type of activity. Possible value is UnifiedVideoCall. | | CallDurationInSeconds | Type int Properties Filter, Nillable Description The duration of the video call in seconds. | | DetailId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the object that contains detailed activity-specific information. The object depends on the activity type. For example, the detail for a Task activity is a Task object. The detail for an Event activity is an Event object. This field is a relationship field. Relationship Name Detail Relationship Type Lookup Refers To VideoCall | | InternalEventKey | Type string Properties Filter, Group, Nillable, Sort Description Reserved for internal use. | | IsInsightAvailable | Type boolean Properties Defaulted on create, Filter Description Indicates whether the activity has an insight associated with it. The default value is false. | | Snippet | Type string Properties Nillable Description An abbreviation of the activity body or description. This field has a maximum length of 255 characters. | | Subject | Type string Properties None Description Contains the subject of the video call. | # UnifiedVideoCallParticipant Represents a participant in a video call. Available for reports and dashboards in API version 59.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules We’re retiring Einstein Activity Capture Activity 360 Reporting. Starting in Summer ’25, this object isn’t available with Einstein Activity Capture unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Fields | Field | Details | | --- | --- | | ActivityId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the video call the person is participating in. This field is a relationship field. Relationship Name Activity Relationship Type Lookup Refers To UnifiedVideoCall | | ChannelAddress | Type string Properties Filter, Nillable Description The email address of the participant. The email address is captured at the time of the communication; it doesn’t change if the contact’s email address is updated later. | | ListenRatio | Type double Properties Filter, Nillable Description Ratio of time the participant was listening versus talking in the video call. | | ParticipantType | Type picklist Properties Filter, Nillable, Restricted picklist Description The participant’s role in the activity. Possible values are: - AssignedTo - Attendee - BCC - CC - From - OptionalAttendee - Organizer - To | | PersonId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the person participating in the activity. This field is a polymorphic relationship field. Relationship Name Person Relationship Type Lookup Refers To Contact, Lead, User | | TalkRatio | Type double Properties Filter, Nillable Description Ratio of time the participant was talking versus listening in the video call. | # UnifiedVoiceCall Represents a voice call that is captured or synced from a VoiceCall or Task record. Available for reports and dashboards in API version 59.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules We’re retiring Einstein Activity Capture Activity 360 Reporting. Starting in Summer ’25, this object isn’t available with Einstein Activity Capture unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Fields | Field | Details | | --- | --- | | ActivityDateTime | Type dateTime Properties Filter, Sort Description The date and time of the activity in the Coordinated Universal Time (UTC) time zone. | | ActivitySubType | Type picklist Properties Filter, Nillable, Restricted picklist Description Provides standard subtypes to facilitate creating and searching for specific activity subtypes. Possible values are: - Captured - LegacyCall - Streamed - VoiceCall | | ActivityType | Type picklist Properties Filter, Nillable, Restricted picklist Description The type of activity. Possible value is UnifiedVoiceCall. | | CallDurationInSeconds | Type int Properties Filter, Nillable Description The duration of the voice call in seconds. | | DetailId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the object that contains detailed activity-specific information. The object depends on the activity type. For example, the detail for a Task activity is a Task object. The detail for an Event activity is an Event object. This field is a relationship field. Relationship Name Detail Relationship Type Lookup Refers To VoiceCall | | InternalEventKey | Type string Properties Filter, Group, Nillable, Sort Description Reserved for internal use. | | IsInsightAvailable | Type boolean Properties Defaulted on create, Filter Description Indicates whether the activity has an insight associated with it (true) or not (false). The default value is false. | | Snippet | Type string Properties Nillable Description An abbreviation of the voice call content. This field has a maximum length of 255 characters. | | Subject | Type string Properties None Description Contains the subject of the voice call. | # UnifiedVoiceCallParticipant Represents a participant in a voice call. Available for reports and dashboards in API version 59.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object is available only for reporting. It isn’t supported for SOQL queries and APIs. ## Special Access Rules We’re retiring Einstein Activity Capture Activity 360 Reporting. Starting in Summer ’25, this object isn’t available with Einstein Activity Capture unless Activity 360 Reporting was enabled in your org in Spring ’25 or earlier. See Knowledge Article: [Einstein Activity Capture Activity 360 Reporting, Activity Metrics, Activities Dashboard Upcoming Retirement](https://help.salesforce.com/s/articleView?id=004633781&type=1&language=en_US) ## Fields | Field | Details | | --- | --- | | ActivityId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the voice call the person is participating in. This field is a relationship field. Relationship Name Activity Relationship Type Lookup Refers To UnifiedVoiceCall | | ChannelAddress | Type string Properties Filter, Nillable Description The phone number of the participant. The phone number is captured at the time of the communication; it doesn’t change if the contact’s phone number is updated later. | | ListenRatio | Type double Properties Filter, Nillable Description Ratio of time the participant was listening versus talking in the voice call. | | ParticipantType | Type picklist Properties Filter, Nillable, Restricted picklist Description The participant’s role in the activity. Possible values are: - AssignedTo - Attendee - BCC - CC - From - OptionalAttendee - Organizer - To | | PersonId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the person participating in the voice call. This field is a polymorphic relationship field. Relationship Name Person Relationship Type Lookup Refers To Contact, Lead, User | | TalkRatio | Type double Properties Filter, Nillable Description Ratio of time the participant was talking versus listening in the voice call. | # Unique Query Event Type Unique Query events capture specific search queries (SOQL), filter IDs, and report IDs that are processed, along with the underlying database queries (SQL). This event type is available in API versions 64.0 and later. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
      FieldDetails
      BOT_IDENTIFIER
      Type
      string
      Description
      The ID of the bot.
      BOT_SESSION_IDENTIFIER
      Type
      string
      Description
      The bot session ID.
      LOGIN_KEY
      Type
      String
      Description
      The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
      For example: GeJCsym5eyvtEK2I.
      ORGANIZATION_ID
      Type
      Id
      Description
      The 15-character ID of the organization.
      For example: 00D000000000123.
      PLANNER_IDENTIFIER
      Type
      string
      Description
      The ID of the agent planner.
      QUERY_IDENTIFIER
      Type
      String
      Description
      The text of the SOQL query run or the Id of the report or list view run.
      QUERY_TYPE
      Type
      String
      Description
      The input type to the optimizer that was translated.
      Possible Values
      • soql
      • filter
      • report
      SESSION_KEY
      Type
      String
      Description
      The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
      For example: d7DEq/ANa7nNZZVD.
      SQL_ID
      Type
      String
      Description
      The unique identifier generated for the database query.
      # UniqueQueryEventLog Unique Query events capture specific search queries (SOQL), filter IDs, and report IDs that are processed, along with the underlying database queries (SQL). This object is available in API version 65.0 and later. ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | BotIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the bot. | | BotSessionIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The bot session ID. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. | | PlannerIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The ID of the agent planner. | | QueryIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The text of the SOQL query run or the Id of the report or list view run. | | QueryType | Type string Properties Filter, Group, Nillable, Sort Description The input type to the optimizer that was translated. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. | | SqlIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique identifier generated for the database query. (Its SQL Id in the ELF); | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description Timestamp at which the log event was generated. | | UserId | Type reference Properties Nillable Description The origin user’s unique ID. For example, 005000000000123. A polymorphic relationship field. Relationship Name User Relationship Type Lookup Refers To User | # UnitOfMeasure Defines the units and systems of units used to express and account for quantities. This object is available in API version 61.0 and later. Examples of units of measure include Litre (for volume), Kilogram (for weight), and single units (such as Can, sachet, and packet). ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ConversionFactor | Type double Properties Create, Filter, Nillable, Sort, Update Description The factor or rate that's used to convert this unit of measurement to the base unit. For example, for the Weight unit of measure class, the default unit of measure is pounds (lbs). Then, all units of measure records with the Weight unit of measure class are converted to equate 1 unit to 1 pound. If the unit of measure is kilogram, the conversion factor is 2.2 as 1 pound consists ‌of 2.2 kilograms. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of this unit of measure. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the unit of measure. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user or group that owns the job., This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The type of the unit of measure. For example, weight, distance, period. | | Sequence | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The sequence number assigned to the unit of measure. | | Status | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the status of the unit of measure. Possible values are: - Active - Draft - Inactive | | UnitCode | Type string Properties Create, Filter, Group, Sort, Update Description Code for the unit of measure. | | UnitOfMeasureClassId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The class associated with the unit of measurement. This field is a relationship field. Relationship Name UnitOfMeasureClass Refers To UnitOfMeasureClass | # URI Event Type URI events contain details about user interaction with the web browser UI. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
      FieldDetails
      CLIENT_IP
      Type
      String
      Description
      The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
      For example: 96.43.144.26.
      CPU_TIME
      Type
      Number
      Description
      The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
      DB_BLOCKS
      Type
      Number
      Description
      Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
      DB_CPU_TIME
      Type
      Number
      Description
      The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request.
      DB_TOTAL_TIME
      Type
      Number
      Description
      The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
      EVENT_TYPE
      Type
      String
      Description
      The type of event. The value is always URI.
      LOGIN_KEY
      Type
      String
      Description
      The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
      For example: GeJCsym5eyvtEK2I.
      ORGANIZATION_ID
      Type
      Id
      Description
      The 15-character ID of the organization.
      For example: 00D000000000123.
      REFERRER_URI
      Type
      String
      Description
      The referring URI of the page that’s receiving the request.
      REQUEST_ID
      Type
      String
      Description
      The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
      For example: 3nWgxWbDKWWDIk0FKfF5DV.
      REQUEST_STATUS
      Type
      String
      Description
      The status of the request for a page view or user interface action.
      For example:
      • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
      • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
      • U—Undefined
      • A—Authorization Error
      • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
      • N—Not Found. 404 error.
      This field can have a blank value.
      RUN_TIME
      Type
      Number
      Description
      The amount of time that the request took in milliseconds.
      SESSION_KEY
      Type
      String
      Description
      The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
      For example: d7DEq/ANa7nNZZVD.
      TIMESTAMP
      Type
      String
      Description
      The access time of Salesforce services in GMT.
      For example: 20130715233322.670.
      TIMESTAMP_DERIVED
      Type
      DateTime
      Description
      The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
      For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
      URI
      Type
      String
      Description
      The URI of the page that’s receiving the request. For more granular URI information for Lightning Experience and the Salesforce app, see the Lightning Error, Lightning Interaction, Lightning Page View, and Lightning Performance event types.
      Examples
      /aura (Lightning Experience), /lightning (Lightning Experience and the Salesforce app), /home/home.jsp (Salesforce Classic)
      URI_ID_DERIVED
      Type
      ID
      Description
      The 18-character case insensitive ID of the URI of the page that’s receiving the request.
      USER_ID
      Type
      Id
      Description
      The 15-character ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00530000009M943
      USER_ID_DERIVED
      Type
      Id
      Description
      The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00590000000I1SNIA0.
      USER_TYPE
      Type
      String
      Description
      The category of user license.
      Possible values are:
      • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
      • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
      • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
      • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
      • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
      • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
      • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
      • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
      #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # UriEventLog URI events contain details about user interaction with the web browser UI. This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseBlocks | Type double Properties Filter, Nillable, Sort Description Indicates how much activity is occurring in the database. | | DatabaseCpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DatabaseCpuTime. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | ReferrerUri | Type string Properties Filter, Group, Nillable, Sort Description The referring URI of the page that’s receiving the request. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestStatus | Type String Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | # UsageImpactFactor Represents a collection of fields to set up the Usage Impact Factors used across jurisdictions and programs.This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only with the EAndU Cloud Usage Impact Access permission set. ## Fields
      Field Details
      IsActive

      Type: boolean

      Properties: Create, Defaulted on create, Filter, Group, Sort, Update

      Description: Indicates whether the Usage Impact Factor is active.

      The default value is false.
      Name

      Type: string

      Properties: Create, Filter, Group, idLookup, Sort, Update

      Description: The name of the Usage Impact Factor.
      ShortForm

      Type: string

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The acronym of the Usage Impact Factor.
      Type

      Type: picklist

      Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

      Description: Specifies the type of Usage Impact Factor

      Possible values are:

      • AdjustedGrossAnnual—Adjusted Gross Annual
      • AdjustedGrossAnnualMMBTU—Adjusted Gross Annual MMBTU
      • AdjustedGrossAnnualkW—Adjusted Gross Annual kW
      • AdjustedGrossAnnualkWSummer—Adjusted Gross Annual kW Summer
      • AdjustedGrossAnnualkWWinter—Adjusted Gross Annual kW Winter
      • AdjustedGrossAnnualkWh—Adjusted Gross Annual kWh
      • GrossAnnualMMBTU—Gross Annual MMBTU
      • GrossAnnualkW—Gross Annual kW
      • GrossAnnualkWh—Gross Annual kWh
      • NetAnnual—Net Annual
      • NetLifetime—Net Lifetime
      • NetToGross—Net To Gross
      • NetToGrossFR—Net To Gross FR
      • UsefulLife—Useful Life
      ## 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. [UsageImpactFactorChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [UsageImpactFactorFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [UsageImpactFactorHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [UsageImpactFactorOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [UsageImpactFactorShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # UsageImpactGroup Represents a collection of fields to set up the Usage Impact Groups used across jurisdictions and programs. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only with the EAndU Cloud Usage Impact Access permission set. ## Fields
      Field Details
      Description

      Type: string

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The description of the Usage Impact Group.
      IsActive

      Type: boolean

      Properties: Create, Defaulted on create, Filter, Group, Sort, Update

      Description: Indicates whether the Usage Impact Group is active.

      The default value is false.
      Name

      Type: string

      Properties: Create, Filter, Group, idLookup, Sort, Update

      Description: The name of the Usage Impact Group.
      ShortForm

      Type: string

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The acronym of the Usage Impact Group.
      Type

      Type: picklist

      Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

      Description: Specifies the type of Usage Impact Group.

      Possible values are:

      • ForwardMarkets—Forward Markets
      • Planning
      • Production
      ## 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. [UsageImpactGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [UsageImpactGroupFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [UsageImpactGroupHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [UsageImpactGroupOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [UsageImpactGroupShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # UsageImpactGroupFactor Represents a junction between an Usage Impact Group version and Usage Impact Factor. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only with EAndU Cloud Usage Impact Access permission set. ## Fields
      Field Details
      FactorValue

      Type: double

      Properties: Create, Filter, Nillable, Sort, Update

      Description: Defines the value of the Usage Impact Group Factor.
      IsActive

      Type: boolean

      Properties: Create, Defaulted on create, Filter, Group, Sort, Update

      Description: Indicates whether the Usage Impact Group Factor is active.

      The default value is false.
      Name

      Type: string

      Properties: Create, Filter, Group, idLookup, Sort, Update

      Description: The name of the Usage Impact Group Factor.
      UnitOfMeasureId

      Type: reference

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The UnitOfMeasure object associated with the Usage Impact Group Factor.

      This field is a relationship field.

      Relationship Name: UnitOfMeasure

      Relationship Type: Lookup

      Refers To: UnitOfMeasure
      UsageImpactFactorId

      Type: reference

      Properties: Create, Filter, Group, Sort, Update

      Description: The Usage Impact Factor object associated with the Usage Impact Group Factor.

      This field is a relationship field.

      Relationship Name: UsageImpactFactor

      Relationship Type: Lookup

      Refers To: UsageImpactFactor
      UsageImpactGroupVersionId

      Type: reference

      Properties: Create, Filter, Group, Sort, Update

      Description: The Usage Impact Group Version object associated with the Usage Impact Group Factor.

      This field is a relationship field.

      Relationship Name: UsageImpactGroupVersion

      Relationship Type: Lookup

      Refers To: UsageImpactGroupVersion
      ## 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. [UsageImpactGroupFactorChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [UsageImpactGroupFactorFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [UsageImpactGroupFactorHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [UsageImpactGroupFactorOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [UsageImpactGroupFactorShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # UsageImpactGroupPgmMeasure Represents a junction between the program, product, and Usage Impact Group version. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available only with EAndU Cloud Usage Impact Access permission set. ## Fields
      Field Details
      Description

      Type: string

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The description of the Usage Impact Group Program Measure.
      Name

      Type: string

      Properties: Create, Filter, Group, idLookup, Sort, Update

      Description: The name of the Usage Impact Group Program Measure.
      Product2Id

      Type: reference

      Properties: Create, Filter, Group, Sort, Update

      Description: The Product2 object associated with the Usage Impact Group Program Measure.

      This field is a relationship field.

      Relationship Name: Product2

      Relationship Type: Lookup

      Refers To: Product2
      ProgramId

      Type: reference

      Properties: Create, Filter, Group, Sort, Update

      Description: The Program object associated with the Usage Impact Group Program Measure.

      This field is a relationship field.

      Relationship Name: Program

      Relationship Type: Lookup

      Refers To: Program
      UsageImpactGroupVersionId

      Type: reference

      Properties: Create, Filter, Group, Sort, Update

      Description: The Usage Impact Group Version associated with the Energy Saving Group Association.

      This field is a relationship field.

      Relationship Name: UsageImpactGroupVersion

      Relationship Type: Lookup

      Refers To: UsageImpactGroupVersion
      ## 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. [UsageImpactGroupPgmMeasureChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [UsageImpactGroupPgmMeasureFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [UsageImpactGroupPgmMeasureHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [UsageImpactGroupPgmMeasureOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [UsageImpactGroupPgmMeasureShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # UsageImpactGroupVersion Represents a collection of fields to set up the versions of Usage Impact Groups. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only with EAndU Cloud Usage Impact Access permission set. ## Fields
      Field Details
      ApprovedMeasureExtlid

      Type: string

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The approved Measure Category ID assigned by a regulator.
      Description

      Type: string

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The description of the Usage Impact Group Version.
      EndDate

      Type: date

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The date when the validity of Usage Impact Group Version ends.
      IsActive

      Type: boolean

      Properties: Create, Defaulted on create, Filter, Group, Sort, Update

      Description: Indicates whether the Usage Impact Group Version is active.

      The default value is false.
      Name

      Type: string

      Properties: Create, Filter, Group, idLookup, Sort, Update

      Description: The name of the Usage Impact Group Version.
      StartDate

      Type: date

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The date when the validity of Usage Impact Group Version begins.
      TechResourceManualCode

      Type: string

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The code and version of the Technical Reference Manual which is the source for the values associated with this Usage Impact Group Version. This is necessary for regulatory reporting.
      UsageImpactGroupId

      Type: reference

      Properties: Create, Filter, Group, Sort, Update

      Description: The Usage Impact Group object associated with the Usage Impact Group Version.

      This field is a relationship field.

      Relationship Name: UsageImpactGroup

      Relationship Type: Lookup

      Refers To: UsageImpactGroup
      Version

      Type: int

      Properties: Create, Filter, Group, Nillable, Sort, Update

      Description: The version number of the Usage Impact Group Version.
      ## 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. [UsageImpactGroupVersionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [UsageImpactGroupVersionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [UsageImpactGroupVersionHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [UsageImpactGroupVersionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [UsageImpactGroupVersionShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # User Represents a user in your organization. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules - To create or update a User record, you must have the Manage Internal Users permission. If the user is a Customer Portal user, you must have the Manage Customer Users permission. If the user is a partner portal user, you must have the Manage External Users permission. But the describeSObjects call always returns createable as true. - If digital experiences is enabled, to create or update external users for Customer Portal, partner portal, or Experience Cloud sites, you must also have the Manage External Users permission. - Information in hidden fields in a user's profile isn’t searchable by external users (with a portal profile) in an Experience Cloud site. For example, if a user in a site has a hidden email address and an external user searches for it, the user record isn’t returned in the search results. Hidden field values also aren’t returned when external users perform searches on nonhidden fields. So if an external user searches for a user's name (can’t be hidden), any hidden field values associated with the user record such as a hidden email address aren’t returned in the search results. But internal users belonging to the same Experience Cloud site can search for and view hidden field values in search results. - When requested by portal users, queries that look up to the User object, such as owner.name or owner.email sometimes don’t return values when the portal user making the request doesn’t have Read access to the User record being queried. The behavior depends on the number of domains associated with the lookup field. If the object can look up to more than one domain, owner.name returns a value, but other detail fields don’t. For example, Case owner can look up to the User or Queue objects. In this case, portal users can see only the value of owner.name. Other User detail fields, such as owner.email or owner.phone don’t return a value. If the object can look up to only a single domain, such as Account owner, then no detail fields return values, including owner.name. - To change ownership of a record by updating its OwnerId field, you must have both the Transfer Record permission and Read access to the User record of the new record owner. - To view the NumberOfFailedLogins field, you must have the Manage User permission. ## Fields | Field | Details | | --- | --- | | AboutMe | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Information about the user, such as areas of interest or skills. This field is available even if Chatter is disabled. | | AccountId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the Account associated with a Customer Portal user. This field is null for Salesforce users. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | Address (beta) | Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | Alias | Type string Properties Create, Filter, Group, Sort, Update Description Required. The user’s alias. For example, jsmith. | | BadgeText | Type string Properties Filter, Group, Nillable, Sort Description The Experience Cloud site role, displayed on the user profile page just below the user name. | | BannerPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for the user's banner photo. This field is available in API version 36.0 and later. | | CallCenterId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description If Salesforce CRM Call Center is enabled, represents the call center that this user is assigned to. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city associated with the user. Up to 40 characters allowed. | | CommunityNickname | Type string Properties Create, Filter, Group, Sort, Update Description Unique name used to identify this user in the Experience Cloud site. | | CompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the user’s company. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Contact associated with this account. The contact must have a value in the AccountId field or an error occurs. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country associated with the user. Up to 80 characters allowed. | | CountryCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code associated with the user. | | CurrentStatus | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Text that describes what the user is working on. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you update this field, the API automatically adds a post of type UserStatus on the user’s profile in Chatter. This field is deprecated in API version 25.0. To achieve similar behavior, post to the user directly by creating a FeedItem with the user’s ParentId. | | DefaultCurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The user's default currency setting for new records. For example, if a user in France sets DefaultCurrencyIsoCode to euros, then that’s their default currency. Only applicable for organizations that use multiple currencies. | | DefaultDivision | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description This record’s default division. Only applicable if divisions are enabled. | | DefaultGroupNotificationFrequency | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. The default frequency for sending the user's Chatter group email notifications when the user joins groups. The valid values are: - P—Email on every post - D—Daily digests - W—Weekly digests - N—Never The default value is N. For Professional, Enterprise, Unlimited, and Developer Edition organizations that existed before API version 22.0, the default value remains D. This field is available in API version 21.0 and later. | | DelegatedApproverId | Type reference Properties Create, Filter, Group, Nillable,Sort, Update Description Id of the user who is a delegated approver for this user. | | Department | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The company department associated with the user. | | DigestFrequency | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. The send frequency of the user’s Chatter personal email digest. The valid values are: - D = Daily - W = Weekly - N = Never The default value is D. | | Division | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The division associated with this user, similar to Department, and unrelated to DefaultDivision. | | Email | Type email Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The user’s email address. | | EmailEncodingKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The email encoding for the user, such as ISO-8859-1 or UTF-8. | | EmailPreferencesAutoBcc | Type boolean Properties Create, Filter, Update Description Determines whether the user receives copies of sent emails. This option applies only if compliance BCC emails aren’t enabled. | | EmployeeNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s employee number. | | EndDay | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time of day that the user generally stops working. Used to define the times that display in the user’s calendar. This field is available in API version 63.0 and later. | | Extension | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s phone extension number. | | Fax | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s fax number. | | FederationIdentifier | Type string Properties Create, Filter, idLookup, Nillable, Sort, Update Description Indicates the value that must be listed in the Subject element of a Security Assertion Markup Language (SAML) IDP certificate to authenticate the user for a client application using single sign-on. This value must be specified if the SAML User ID Type is Assertion contains Federation ID from the User record. Otherwise, this field can’t be edited. | | FirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s first name. | | ForecastEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the user is enabled for forecasts (true) or not (false). Forecast user has access to the forecasts page. | | FullPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for the user's profile photo. This field is available even if Chatter is disabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo is uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. This field is available in API version 20.0 and later. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates. | | HasUserVerifiedEmail | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user's email is verified (true) or not (false). The default value is false. This field is available in API version 63.0 and later. | | HasUserVerifiedPhone | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user's phone number is verified (true) or not (false). The default value is false. This field is available in API version 63.0 and later. | | IndividualId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the data privacy record associated with this user. This field is available if Data Protection and Privacy is enabled. This is a relationship field. Relationship Name Individual Relationship Type Lookup Refers To Individual | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the user has access to log in (true) or not (false). You can modify a User's active status from the user interface or via the API. | | IsPartner | Type boolean Properties Defaulted on create, Filter Description Indicates whether the user is a partner who has access to the partner portal (true) or not (false). This field isn’t available for release 9.0 and later. Instead, use UserType with the value Partner or Power Partner. | | IsPortalEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether an active, external, user has access to Experience Cloud sites or portals (true) or not (false). This field is only available if one of these conditions is true: - Digital experiences is enabled and you have community or portal user licenses - Portals are enabled ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Users with External Identity licenses can access Experience Cloud sites even if the flag is false. | | IsPortalSelfRegistered | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the user is a Customer Portal user who self-registered for your organization's Customer Portal (true) or not (false). This field isn’t available for release 9.0 and earlier. | | IsPrmSuperUser | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Available for partner portal users only. Indicates whether the user has super user access in the partner portal (true) or not (false). This field is available in API version 24.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field isn’t automatically enabled. Contact Salesforce to enable this field. | | IsProfilePhotoActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has a profile photo (true) or not (false). This field is available in API version 36.0 and later. | | JigsawImportLimitOverride | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The Data.com user’s monthly addition limit. The value must be between zero and the organization’s monthly addition limit. Label is **Data.com Monthly Addition Limit**. This field is available in API version 27.0 and later. | | LanguageLocaleKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The user’s language, such as French or Chinese (Traditional). Label is **Language**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note In API version 47.0 and later, when using the DescribeSObjectResult API to return PicklistEntry values from this picklist, the active value indicates whether the language is in the user’s **Displayed Languages** (true) or the user’s **Available Languages** (false). All other languages aren’t in the returned active value array. In API version 46.0 and earlier, the PicklistEntry active values indicate whether the language is in either the user’s **Displayed Languages** or **Available Languages** lists (true) or not in either list (false). | | LastLoginDate | Type dateTime Properties Filter, Sort, Nillable Description The date and time when the user last successfully logged in. This value is updated if 60 seconds elapses since the user’s last login. | | LastName | Type string Properties Create, Filter, Group, Sort, Update Description Required. The user’s last name. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) but not viewed. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the geolocation of an address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | LocaleSidKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This field is a restricted picklist field. The value of the field affects formatting and parsing of values, especially numeric values, in the user interface. It doesn’t affect the API. The field values are named according to the language, and the country if necessary, using two-letter ISO codes. The set of names is based on the ISO standard. You can also manually set a user’s locale in the user interface, and then use that value for inserting or updating other users via the API. | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the geolocation of an address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | Manager | Type picklist Properties Create, Filter, Restricted picklist, Update Description User lookup field used to select the user's manager. This field establishes a hierarchical relationship, preventing you from selecting a user that directly or indirectly reports to themselves. | | ManagerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Id of the user who manages this user. This is a relationship field. Relationship Name Manager Relationship Type Lookup Refers To User | | MediumBannerPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for the medium-sized user profile banner photo. | | MiddleName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s middle name. Maximum size is 40 characters. To enable this field, contact Salesforce Customer Support. | | MobilePhone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s mobile device number. | | Name | Type string Properties Filter, Group, Sort Description Concatenation of FirstName and LastName. Limited to 203 characters, including whitespaces. | | NumberOfFailedLogins | Type int Properties Filter, Group, Nillable, Sort Description The number of failed UI login attempts for the user’s account. When the maximum number of failed UI login attempts is reached, the counter resets and the user’s account is locked. If there’s a successful UI login before the maximum number of failed UI login attempts is reached, the counter resets and the user’s account remains unlocked. | | OfflineTrialExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the user’s Connect Offline trial expires. | | PasswordExpirationDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the user’s password expires. This field is available in API version 63.0 and later. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s phone number. | | PortalRole | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The role of the user in the Customer Portal (either Executive, Manager, User, or PersonAcount). In API version 15.0 and earlier, if you set this field to null, the system automatically included a portal role. In API version 16.0 and above, when you set this field to null, a portal role is not automatically created. When this field is null and a ContactId is provided, the user is assigned to the User role. The Update property is available in API version 43.0 and later. The field is available if Customer Portal is enabled OR digital experiences is enabled and Experience Cloud sites have available partner portal, Customer Portal, or High-Volume Portal User licenses. | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s postal or ZIP code. Label is **Zip/Postal Code**. | | ProfileId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the user’s Profile. Use this value to cache metadata based on profile. In earlier releases, this was RoleId. If you change the user’s profile, the user’s license also changes, because every profile belongs to exactly one user license type. This is a relationship field. Relationship Name Profile Relationship Type Lookup Refers To Profile | | ReceivesAdminInfoEmails | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the user receives email for administrators from Salesforce (true) or not (false). | | ReceivesInfoEmails | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the user receives informational email from Salesforce (true) or not (false). | | SenderEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address used as the From address when the user sends emails. This address is the same value shown in Setup on the My Email Settings page. | | SenderName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name used as the email sender when the user sends emails. This name is the same value shown in Setup on the My Email Settings page. | | Signature | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The signature text added to emails. This text is the same value shown in Setup on the My Email Settings page. | | SmallBannerPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for the small user profile banner photo. | | SmallPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for a thumbnail of the user's profile photo. This field is available even if Chatter is disabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo is uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. This field is available in API version 20.0 and later. | | StartDay | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time of day that the user generally starts working. Used to define the times that display in the user’s calendar. This field is available in API version 63.0 and later. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state associated with the User. Up to 80 characters allowed. | | StateCode | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code associated with the user. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street address associated with the User. | | SuAccessExpirationDate | Type date Properties Filter, Group, Nillable, Sort Description The expiration date for allowing Salesforce Customer Support to log in as this user with Login As functionality. After this date, the user must grant login access to Salesforce Customer Support again. This field is available in API version 63.0 or later. | | Suffix | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s name suffix. Maximum size is 40 characters. To enable this field, contact Salesforce Customer Support. | | TimeZoneSidKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This field is a restricted picklist field. A User time zone affects the offset used when displaying or entering times in the user interface. But the API doesn’t use a User time zone when querying or setting values. Values for this field are named using region and key city, according to ISO standards. You can also manually set one User time zone in the user interface, and then use that value for creating or updating other User records via the API. | | Title | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s business title, such as Vice President. | | Username | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Contains the name that a user enters to log in to the API or the user interface. The value for this field must be in the form of an email address, using all lowercase characters. It must also be unique across all organizations. If you try to create or update a User with a duplicate value for this field, the operation is rejected. Each inserted User also counts as a license. Every organization has a maximum number of licenses. If you attempt to exceed the maximum number of licenses by inserting User records, the create request is rejected. | | UserPermissionsCallCenterAutoLogin | Type boolean Properties Create, Filter, Update Description Required if Salesforce CRM Call Center is enabled. Indicates whether the user is enabled to use the auto login feature of the call center (true) or not (false). | | UserPermissionsChatterAnswersUser | Type boolean Properties Create, Filter, Update Description Indicates whether the portal user is enabled to use the Chatter Answers feature (true) or not (false). This field defaults to false when a Customer Portal user is created from the API. | | UserPermissionsInteractionUser | Type boolean Properties Create, Filter, Update Description Indicates whether the user can run flows or not. Label is **Flow User**. | | UserPermissionsJigsawProspectingUser | Type boolean Properties Create, Filter, Update Description Indicates whether the user is allocated one Data.com user license (true) or not (false). The Data.com user lets the user add Data.com contact and lead records to Salesforce in supported editions. Label is **Data.com User**. | | UserPermissionsKnowledgeUser | Type boolean Properties Create, Filter, Update Description Indicates whether the user is enabled to use Salesforce Knowledge (true) or not (false). Label is **Knowledge User**. | | UserPermissionsLiveAgentUser | Type boolean Properties Create, Filter, Update Description Indicates whether the user is enabled to use Chat (true) or not (false). Label is **Live Agent User**. | | UserPermissionsMarketingUser | Type boolean Properties Create, Filter, Update Description Required. Indicates whether the user is enabled to manage campaigns in the user interface (true) or not (false). Label is **Marketing User**. | | UserPermissionsOfflineUser | Type boolean Properties Create, Filter, Update Description Required. Indicates whether the user is enabled to use Offline Edition (true) or not (false). Label is **Offline User**. | | UserPermissionsSFContentUser | Type boolean Properties Create, Filter, Update Description Indicates whether the user is allocated one Salesforce CRM Content User License (true) or not (false). Label is **Salesforce CRM Content User**. The Salesforce CRM Content User license grants the user access to the Salesforce CRM Content application. | | UserPermissionsSiteforceContributorUser | Type boolean Properties Create, Filter, Update Description Indicates whether the user is allocated one Site.com Contributor feature license (true) or not (false). Label is **Site.com Contributor User**. The Site.com Contributor feature license grants the user access to the Site.com application. Users with a Contributor license can use Site.com Studio to edit site content only. | | UserPermissionsSiteforcePublisherUser | Type boolean Properties Create, Filter, Update Description Indicates whether the user is allocated one Site.com Publisher feature license (true) or not (false). Label is **Site.com Publisher User**. The Site.com Publisher feature license grants the user access to the Site.com application. Users with a Publisher license can build and style websites, control the layout and functionality of pages and page elements, and add and edit content. | | UserPermissionsSupportUser | Type boolean Properties Create, Filter, Update Description When true, the user can use the Salesforce console. | | UserPermissionsWirelessUser | Type boolean Properties Create, Filter, Update Description Required if the Wireless permission is enabled. Indicates whether the user is enabled to use Wireless Edition (true) or not (false). Label is **Wireless User**. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note As of November 2005, Salesforce Wireless Edition is no longer available for purchase. You can continue to use Wireless Edition through the end of your existing contract term if you are: - A Professional Edition customer and purchased Wireless Edition before November 7, 2005. - An Enterprise Edition customer who signed or renewed their Salesforce contract before November 7, 2005. | | UserPermissionsWorkDotComUserFeature | Type boolean Properties Create, Filter, Update Description Indicates whether the WDC feature is enabled for the user (true) or not (false). | | UserPreferencesActivityRemindersPopup | Type boolean Properties Create, Filter, Update Description When true, a reminder window automatically opens when an activity reminder is due. Corresponds to the Trigger alert when reminder comes due checkbox at the Reminders page in the personal settings in the user interface. | | UserPreferencesAgentGdprConsent | Type boolean Properties Create, Filter, Update Description When true, indicates that the user has consented that calls may be recorded and transcribed, and such calls, recordings and transcripts may be analyzed for quality or training purposes. When false, the user has not given that consent. | | UserPreferencesAllowConversationReminders | Type boolean Properties Create, Filter, Update Description When true, voice and call reminders are displayed as notification cards in Lightning Experience. Corresponds to the Show conversation reminders in Lightning Experience checkbox in the Activity Reminders page in the personal settings in the user interface. This field is available in API version 55.0 and later. | | UserPreferencesApexPagesDeveloperMode | Type boolean Properties Create, Filter, Update Description When true, indicates that the user has enabled developer mode for editing Visualforce pages and controllers. | | UserPreferencesAutoForwardCall | Type boolean Properties Create, Filter, Update Description When true, the user receives Dialer calls simultaneously in their browser and on their forwarding number. | | UserPreferencesContentEmailAsAndWhen | Type boolean Properties Create, Filter, Update Description When false, a user with Salesforce CRM Content subscriptions receives a once-daily email summary if activity occurs on the subscribed content, libraries, tags, or authors. To receive email, the UserPreferencesContentNoEmail field must also be false. The default value is false. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is only visible when Salesforce CRM Content is enabled. | | UserPreferencesContentNoEmail | Type boolean Properties Create, Filter, Update Description When false, a user with Salesforce CRM Content subscriptions receives email notifications if activity occurs on the subscribed content, libraries, tags, or authors. To receive real-time email alerts, set this field to false and set the UserPreferencesContentEmailAsAndWhen field to true. The default value is false. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is only visible when Salesforce CRM Content is enabled. | | UserPreferencesEnableAutoSubForFeeds | Type boolean Properties Create, Filter, Update Description When true, the user automatically subscribes to feeds for any objects that the user creates. This field is available in API version 25.0 and later. | | UserPreferencesDisableAllFeedsEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email for all updates to Chatter feeds, based on the types of feed emails and digests the user has enabled. This field is available in API version 24.0 and later. | | UserPreferencesDisableAutoSubForFeeds | Type boolean Properties Create, Filter, Update Description When false, the user automatically subscribes to feeds for any objects that the user creates. This field is deprecated in API version 25.0 and later. Starting with API version 25.0, use UserPreferencesEnableAutoSubForFeeds to enable or disable auto-follow for objects a user creates. | | UserPreferencesDisableBookmarkEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on a Chatter feed item after the user has bookmarked it. This field is available in API version 24.0 and later. | | UserPreferencesDisableChangeCommentEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on a change the user has made, such as an update to their profile. This field is available in API version 24.0 and later. | | UserPreferencesDisableEndorsementEmail | Type boolean Properties Create, Filter, Update Description When false, the member automatically receives email every time someone endorses them for a topic. | | UserPreferencesDisableFileShareNotificationsForApi | Type boolean Properties Create, Filter, Update Description When false, email notifications are sent from the person who shared the file to the users that the file is shared with. This field is available in API version 25.0 and later. | | UserPreferencesDisableFollowersEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone starts following the user in Chatter. This field is available in API version 24.0 and later. | | UserPreferencesDisableLaterCommentEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on a feed item after the user has commented on the feed item. This field is available in API version 24.0 and later. | | UserPreferencesDisableLikeEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone likes their post or comment. This field is available in API version 24.0 and later. | | UserPreferencesDisableMentionsPostEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time they’re mentioned in posts. This field is available in API version 24.0 and later. | | UserPreferencesDisableProfilePostEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone posts to the user’s profile. This field is available in API version 24.0 and later. | | UserPreferencesDisableSharePostEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time their post is shared. This field is available in API version 24.0 and later. | | UserPreferencesDisableFeedbackEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives emails related to WDC feedback. The user receives these emails when someone requests or offers feedback, shares feedback with the user, or reminds the user to answer a feedback request. This field isn’t visible as of API version 54.0. | | UserPreferencesDisCommentAfterLikeEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on a post that the user liked. This field is available in API version 24.0 and later. | | UserPreferencesDisMentionsCommentEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time the user is mentioned in comments. This field is available in API version 24.0 and later. | | UserPreferencesDisableMessageEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email for Chatter messages sent to the user. This field is available in API version 24.0 and later. | | UserPreferencesDisableRewardEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives emails related to WDC rewards. The user receives these emails when someone gives a reward to the user. | | UserPreferencesDisableWorkEmail | Type boolean Properties Create, Filter, Update Description When false, the user receives emails related to WDC feedback, goals, and coaching. The user must also sign up for individual emails listed on the WDC email settings page. When true, the user doesn’t receive any emails related to WDC feedback, goals, or coaching even if they’re signed up for individual emails. | | UserPreferencesDisProfPostCommentEmail | Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on posts on the user’s profile. This field is available in API version 24.0 and later. | | UserPreferencesEnableVoiceCallRecording | Type boolean Properties Create, Filter, Update Description When true, voice call recording is enabled for the user. | | UserPreferencesEnableVoiceLocalPresence | Type boolean Properties Create, Filter, Update Description When true, local numbers are shown when the user calls customers with Sales Dialer. | | UserPreferencesEventRemindersCheckboxDefault | Type boolean Properties Create, Filter, Update Description When true, a reminder popup is automatically set on the user's events. Corresponds to the By default, set reminder on Events to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders. | | UserPreferencesHideBiggerPhotoCallout | Type boolean Properties Create, Filter, Update Description When true, users can choose to hide the callout text below the large profile photo. | | UserPreferencesHideChatterOnboardingSplash | Type boolean Properties Create, Filter, Update Description When true, the initial Chatter onboarding prompts don’t appear. | | UserPreferencesHideCSNDesktopTask | Type boolean Properties Create, Filter, Update Description When true, the Chatter recommendations panel never displays the recommendation to install Chatter Desktop. This field is available in API version 26.0 and later. | | UserPreferencesHideCSNGetChatterMobileTask | Type boolean Properties Create, Filter, Update Description When true, the Chatter recommendations panel never displays the recommendation to install Chatter Mobile. This field is available in API version 26.0 and later. | | UserPreferencesHideEndUserOnboardingAssistantModal | Type boolean Properties Create, Filter, Update Description Reserved for future use. | | UserPreferencesHideLightningMigrationModal | Type boolean Properties Create, Filter, Update Description Reserved for future use. | | UserPreferencesHideSecondChatterOnboardingSplash | Type boolean Properties Create, Filter, Update Description When true, the secondary Chatter onboarding prompts don’t appear. | | UserPreferencesHideS1BrowserUI | Type boolean Properties Create, Filter, Update Description Controls the interface that the user sees when logging in to Salesforce from a supported mobile browser. If false, the user is automatically redirected to the Salesforce mobile web. If true, the user sees the full Salesforce site. The default value is false. Label is **Salesforce User**. This field is available in API version 29.0 or later. | | UserPreferencesHideSfxWelcomeMat | Type boolean Properties Create, Filter, Update Description Controls whether a user sees the Lightning Experience new user message. That message welcomes users to the new interface and provides step-by-step instructions that describe how to return to Salesforce Classic. | | UserPreferencesJigsawListUser | Type boolean Properties Create, Filter, Update Description When true, the user is a Data.com List user so shares record additions from a pool. UserPermissionsJigsawProspectingUser must also be set to true. Label is **Data.com List User**. This field is available in API version 27.0 and later. | | UserPreferencesLightningExperiencePreferred | Type boolean Properties Create, Filter, Update Description When true, redirects the user to the Lightning Experience interface. Label is **Switch to Lightning Experience**. This field is available in API version 35.0 and later. | | UserPreferencesLiveAgentMiawSetupDeflection | Type boolean Properties Create, Filter, Update Description When true, disables the pop-up to deflect users on Chat setup nodes to the Messaging setup. The default value is false. This field is available in API version 59.0 and later. | | UserPreferencesNativeEmailClient | Type boolean Properties Create, Filter, Update Description Use this field to set a default email preference for the user’s native email client. This field is available in API version 47.0 and later. The default value is false, corresponding to the Salesforce docked email composer. | | UserPreferencesOptOutOfTouch | Type boolean Properties Create, Filter, Update Description This field is deprecated in API version 29.0. When false, the user automatically accesses the Salesforce Touch app when logging in to Salesforce from an iPad. If true, automatic access to the Salesforce Touch app is turned off and the user’s iPad is directed to the full Salesforce site instead. The default value is false. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Salesforce Touch must be enabled before this field is visible. | | UserPreferencesOutboundBridge | Type boolean Properties Create, Filter, Update Description When true, outbound calls are made through the user’s phone. | | UserPreferencesPathAssistantCollapsed | Type boolean Properties Create, Filter, Update Description When true, Sales Path appears collapsed or hidden to the user. This field is available in API version 35.0 and later. | | UserPreferencesProcessAssistantCollapsed | Type boolean Properties Create, Filter, Update Description When true, Sales Path appears collapsed or hidden to the user. This field is available in API versions 33.0 and 34.0 only. In API versions 35.0 and later, use UserPreferencesPathAssistantCollapsed. | | UserPreferencesReceiveNoNotificationsAsApprover | Type boolean Properties Create, Filter, Update Description Controls email notifications from the approval process for _approvers_. - If true, emails are _disabled_. - If false, emails are _enabled_. The default value is false. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The Receive Approval Request Emails setting in the UI controls this field and the UserPreferencesReceiveNotificationsAsDelegatedApprover field. - Setting: **If I’m an approver or delegated approver** Result: - UserPreferencesReceiveNoNotificationsAsApprover = false - UserPreferencesReceiveNotificationsAsDelegatedApprover = true - Setting: **Only if I’m an approver** Result: - UserPreferencesReceiveNoNotificationsAsApprover = false - UserPreferencesReceiveNotificationsAsDelegatedApprover = false - Setting: **Only if I’m a delegated approver** Result: - UserPreferencesReceiveNoNotificationsAsApprover = true - UserPreferencesReceiveNotificationsAsDelegatedApprover = true - Setting: **Never** Result: - UserPreferencesReceiveNoNotificationsAsApprover = true - UserPreferencesReceiveNotificationsAsDelegatedApprover = false | | UserPreferencesReceiveNotificationsAsDelegatedApprover | Type boolean Properties Create, Filter, Update Description Controls email notifications from the approval process for _delegated approvers_. - If true, emails are _enabled_. - If false, emails are _disabled_. The default value is false. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The Receive Approval Request Emails setting in the UI controls this field and the UserPreferencesReceiveNoNotificationsAsApprover field. - Setting: **If I’m an approver or delegated approver** Result: - UserPreferencesReceiveNoNotificationsAsApprover = false - UserPreferencesReceiveNotificationsAsDelegatedApprover = true - Setting: **Only if I’m an approver** Result: - UserPreferencesReceiveNoNotificationsAsApprover = false - UserPreferencesReceiveNotificationsAsDelegatedApprover = false - Setting: **Only if I’m a delegated approver** Result: - UserPreferencesReceiveNoNotificationsAsApprover = true - UserPreferencesReceiveNotificationsAsDelegatedApprover = true - Setting: **Never** Result: - UserPreferencesReceiveNoNotificationsAsApprover = true - UserPreferencesReceiveNotificationsAsDelegatedApprover = false | | UserPreferencesReminderSoundOff | Type boolean Properties Create, Filter, Update Description When true, a sound automatically plays when an activity reminder is due. Corresponds to the Play a reminder sound checkbox on the Reminders page in the user interface. | | UserPreferencesShowCityToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the city field in the user’s contact information. City is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. City is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowCityToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowCityToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the city field in the user’s contact information. When true, city is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowCityToExternalUsers, making the user’s city visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowCountryToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the country field in the user’s contact information. Country is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. Country is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowCountryToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowCountryToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the country field in the user’s contact information. When true, country is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowCountryToExternalUsers, making the user’s country visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowEmailToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the email address field in the user’s contact information. Email address is visible only to internal members of the user’s organization when this field is false. Email address is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowEmailToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the email address field in the user’s contact information. When true, the email address is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true, this field overrides the value ​false in UserPreferencesShowEmailToExternalUsers, making the user’s email address visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. | | UserPreferencesShowFaxToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the fax number field in the user’s contact information. Fax number is visible only to internal members of the user’s organization when this field is false. Fax number is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowFaxToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the fax number field in the user’s contact information. When true, the fax number field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true, this field overrides the value ​false in UserPreferencesShowFaxToExternalUsers, making the user’s fax number visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. | | UserPreferencesShowManagerToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the manager field in the user’s contact information. Manager is visible only to internal members of the user’s organization when this field is false. Manager is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowManagerToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the manager field in the user’s contact information. When true, the manager field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true, this field overrides the value ​false in UserPreferencesShowManagerToExternalUsers, making the user’s manager visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. | | UserPreferencesShowMobilePhoneToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the mobile device number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowMobilePhoneToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the mobile phone field in the user’s contact information. When true, the mobile phone field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true, this field overrides the value ​false in UserPreferencesShowMobilePhoneToExternalUsers, making the user’s mobile phone visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. | | UserPreferencesShowPostalCodeToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the postal or ZIP code field in the user’s contact information. Postal code is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. Postal code is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowPostalCodeToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowPostalCodeToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the postal or ZIP code field in the user’s contact information. When true, postal code is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value ​false in UserPreferencesShowPostalCodeToExternalUsers, making the user’s postal code visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowProfilePicToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the user’s profile photo. When true, the photo is visible to guest users in an Experience Cloud site. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the stock photo. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowStateToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the state field in the user’s contact information. State is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. State is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowStateToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowStateToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the state field in the user’s contact information. When true, state is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowStateToExternalUsers, making the user’s state visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowStreetAddressToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the street address field in the user’s contact information. The address is visible only to internal members of the user’s organization when this field is false. The address is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowStreetAddressToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the street address field in the user’s contact information. When true, the street address field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true, this field overrides the value ​false in UserPreferencesShowStreetAddressToExternalUsers, making the user’s street address visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. | | UserPreferencesShowTitleToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the business title field in the user’s contact information. Title is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. Title is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowTitleToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is true. This field is available in API version 26.0 and later. | | UserPreferencesShowTitleToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the business title field in the user’s contact information. When true, title is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowTitleToExternalUsers, making the user’s title visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowWorkPhoneToExternalUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the work phone number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowWorkPhoneToGuestUsers | Type boolean Properties Create, Filter, Update Description Indicates the visibility of the work phone field in the user’s contact information. When true, the work phone field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true, this field overrides the value ​false in UserPreferencesShowWorkPhoneToExternalUsers, making the user’s work phone visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. | | UserPreferencesSortFeedByComment | Type boolean Properties Create, Filter, Update Description Specifies the data value used in sorting a user’s feed. When true, the feed is sorted by most recent comment activity. When false, the feed is sorted by post date. | | UserPreferencesSuppressEventSFXReminders | Type boolean Properties Create, Filter, Update Description When true, event reminders don’t appear. Corresponds to the **Show event reminders in Lightning Experience** checkbox on the Activity Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders. | | UserPreferencesSuppressTaskSFXReminders | Type boolean Properties Create, Filter, Update Description When true, task reminders don’t appear. Corresponds to the **Show task reminders in Lightning Experience**. checkbox on the Activity Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders. | | UserPreferencesTaskRemindersCheckboxDefault | Type boolean Properties Create, Filter, Update Description When true, a reminder popup is automatically set on the user's tasks. Corresponds to the By default, set reminder on Tasks to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders. | | UserPreferencesUserDebugModePref | Type boolean Properties Create, Filter, Update Description When true, the Lightning Component framework executes in debug mode for the user. Corresponds to the Debug Mode checkbox on the Advanced User Details page of personal settings in the user interface. | | UserRoleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user’s UserRole. Label is **Role ID**. This is a relationship field. Relationship Name UserRole Relationship Type Lookup Refers To UserRole | | UserType | Type picklist Properties Filter, Group, Nillable, Sort, Restricted picklist Description The category of user license. Each UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. In API version 10.0 and later, valid values include: - Standard: user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses. Label is **Standard**. - PowerPartner: User whose access is limited because they’re a partner and typically access the application through a partner portal or Experience Cloud site. Label is **Partner**. - CspLitePortal: user whose access is limited because they’re an org's customer and access the application through a Customer Portal or Experience Cloud site. Label is **High Volume Portal**. - CustomerSuccess: user whose access is limited because they’re an org's customer and access the application through a Customer Portal. Label is **Customer Portal User**. - PowerCustomerSuccess: user whose access is limited because they’re an org's customer and access the application through a Customer Portal. Label is **Customer Portal Manager**. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the Customer Portal role hierarchy. - CsnOnly: user whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. Label is **Chatter Free**. - Guest: user whose access is limited because they’re an unauthenticated user without login credentials. Label is **Guest**. | | WirelessEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Wireless email address associated with this user. For use with Salesforce Wireless Edition. This field is available only if the Wireless and Email permissions are enabled for your organization. As of November 2005, Salesforce Wireless Edition is no longer available for purchase. You can continue to use Wireless Edition through the end of your existing contract term if you are: - A Professional Edition customer and purchased Wireless Edition before November 7, 2005. - An Enterprise Edition customer who signed or renewed their Salesforce contract before November 7, 2005. | ## Usage Use this object to query information about users and to provision and modify users in your organization. Unlike other objects, the records in the User table represent actual users—not data owned by users. Any user can query or describe User records. For example, the following SOQL code finds users with a particular user role. SELECT Id, Username FROM User WHERE UserRoleId='00ED0000000xicT' Each portal user is associated with a portal account. A portal account can have a maximum of three portal roles (Executive, Manager, and User). You can select the default number of roles to be created from the user interface. The role hierarchy is maintained when you insert and delete portal roles, and roles are created bottom-up. Deleting the User role causes the Manager role to be renamed to User role. Deleting both the Executive and User roles causes the Manager role to be renamed to User role. Before deleting a role, you must assign users under that role to another role. ## Deactivate Users You can’t delete a user in the user interface or the API. You can deactivate a user in the user interface; and you can deactivate or disable a Customer Portal or partner portal user in the user interface or the API. Because users can never be deleted, we recommend that you exercise caution when creating them. Be aware of the expected behaviors when deactivating users. See [Considerations for Deactivating Users](https://help.salesforce.com/s/articleView?id=platform.users_deactivate_considerations.htm&type=5&language=en_US). The user interface provides options to auto-remove a user from teams, but the removal isn’t supported in API. If you deactivate a user, any EntitySubscription where the user is associated with the ParentId or SubscriberId field, meaning all subscriptions both to and from the user, are soft deleted. If the user is reactivated, the subscriptions are restored. However, if you deactivate multiple users at once and these users follow each other, their subscriptions are hard deleted. In this case, the user-to-user EntitySubscription is deleted twice (double deleted). Such subscriptions can’t be restored upon user reactivation. ## Passwords For security reasons, you can’t query User passwords via the API or the user interface. But the API allows you to set and reset User passwords using the setPassword() and resetPassword() calls. The password lockout status and the ability to reset the User locked-out status isn’t available via the API. Check and reset the User password lockout status using the user interface. ## 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. [UserChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 44.0) Change events are available for the object. [UserFeed](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.") (API version 18.0) Feed tracking is available for the object. [UserHistory](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.") (Beta) (API version 65.0) History is available for tracked fields of the object. [UserShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usershare.htm "Represents a sharing entry on a user record. This object is available in API version 26.0 and later.") Sharing is available for the object. #### See Also - [_SOAP API Developer Guide_: Frequently-Occurring Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_objects_fequently_occurring_fields.htm "SOAP API Developer Guide: Frequently-Occurring Fields - HTML (New Window)") - [UserRole](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_role.htm "Represents a user role in your organization.") - [UserLicense](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlicense.htm "Represents a user license in your organization. A user license entitles a user to specific functionality and determines the profiles and permission sets available to the user.") # UserAccessChange Represents a change related to user access. This object is available in API version 57.0 and later. UserAccessChange records are created through different access-related operations. For example, being assigned to or removed from a permission set. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules To access UserAccessChange records, users must have the View Setup and Configuration permission. ## Fields | Field | Details | | --- | --- | | Source | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The source of the user access change. For example, UserAccessPolicyId. | # UserAccessPolicy Represents a user access policy. This object is available in API version 57.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules To create or modify user access policies, users must have the Manage User Access Policies permission. ## Fields | Field | Details | | --- | --- | | BooleanFilter | Type string Properties Filter, Group, Nillable, Sort Description The logic that determines how your user criteria filters are applied in the user access policy. | | Description | Type textarea Properties Filter, Group, Nillable, Sort Description Description of the user access policy. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name for the user access policy. | | Language | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The language of the user access policy. | | MasterLabel | Type string Properties Filter, Group, Sort Description Label for the user access policy. In the UI, this field is Label. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values: - In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. - In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects. | | Order | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the order for which active policy is applied when a user meets the criteria for multiple policies. Must be an integer from 0 to 10,000. Only the active policy with the lowest Order value is applied. This field is required only if the Status field is set to Active. Available in API version 61.0 and later. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status of the user access policy. Possible values are: - Active - Completed - Design - Failed - Migrate - Testing - Updating The default value is Design. | | TriggerType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of user record trigger for which this user access policy runs. Possible values are: - Create—The user access policy runs when a user who matches the policy criteria is created. - CreateAndUpdate—The user access policy runs when a user who matches the policy criteria is either created or updated. - Update—The user access policy runs when a user who matches the policy criteria is updated. | ## Usage For more information, see [User Access Policies](https://help.salesforce.com/s/articleView?id=platform.perm_user_access_policies.htm&type=5&language=en_US) in Salesforce Help. # UserAccountTeamMember Represents a User on the default account team of another User. See also OpportunityTeamMember, which represents a User on the opportunity team of an Opportunity ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Customer Portal and Chatter Free users can't access this object. ## Fields | Field | Details | | --- | --- | | AccountAccessLevel | Type picklist Properties Create, Filter, Restricted picklist, Update Description Required. For Account records that the user has added to his or her default account team, the level of access the account team member has. . The possible values are: - Read - Edit This field must be set to an access level that is higher than the organization’s default access level for accounts. | | CaseAccessLevel | Type picklist Properties Create, Filter, Restricted picklist, Update Description Required. Level of access that the account team member has to Case records related to the account. The possible values are: - None - Read - Edit This field must be set to an access level that is higher than the organization's default access level for cases. | | ContactAccessLevel | Type picklist Properties Create, Filter, Restricted picklist, Update Description Required. ForContact records related to the account, the level of access that the account team member has. The possible values are: - None - Read - Edit This field must be set to an access level that is higher than the organization's default access level for contacts. When DefaultContactAccess is set to Controlled by Parent, you can’t create or update this field. | | OpportunityAccessLevel | Type picklist Properties Create, Filter, Restricted picklist, Update Description Required. Level of access that the team member has to Opportunity records related to the account. The possible values are: - None - Read - Edit This field must be set to an access level that is higher than the organization’s default access level for opportunities. | | OwnerId | Type reference Properties Create, Filter Description Required. ID of the User who owns the default account team. | | TeamMemberRole | Type picklist Properties Create, Filter, Nillable, Update Description Role that the team member has on opportunities for which the user has added his or her default account team. The valid values are set by the organization’s administrator in the Account Team Roles picklist. Label is **Team Role**. | | UserId | Type reference Properties Create, Filter Description Required. ID of the User who is a member of the default account team. This field cannot be updated. | ## Usage This object is available only in organizations that have enabled the account teams functionality, which can be done using the user interface. If you attempt to create a record that matches an existing record, the create call updates any modified fields and returns the existing record. You can set up a User record so the default account team includes the others who typically work with them on accounts. # UserAppInfo Stores the last Lightning app logged in to. If the user hasn’t logged into Salesforce or if the user lost access to the last accessed app, the UserAppInfo object stores a Null value. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AppDefinitionId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the last Lightning app that the user logged in to. This field is available in API version 43.0 and later. This is a relationship field. Relationship Name AppDefinition Relationship Type Lookup Refers To AppDefinition | | FormFactor | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The relative size of the app as displayed. Values are: - Small—suitable for a small device like a mobile phone - Medium—suitable for a tablet - Large—suitable for a large display device, like a monitor It’s possible to have three versions of the app as the one last logged in to, where each version has a different form factor. | | UserId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user that used this app. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## 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. [UserAppInfoChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # UserAppMenuCustomization Represents an individual user’s settings for items in the app menu or App Launcher. This object is available in API version 35.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ApplicationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 15-character ID for the application associated with the menu item. This is a relationship field. Relationship Name Application Relationship Type Lookup Refers To ConnectedApplication | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user for these specific settings. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | SortOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The index value that controls where this item appears in the menu. For example, a menu item with a sort order value of 5 will appear between items with sort order values of 3 and 9. | ## Usage See the AppMenuItem object for the organization-wide default settings This object contains the fields representing any changes the user made to the menu. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [UserAppMenuCustomizationOwnerSharingRule](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. [UserAppMenuCustomizationShare](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. # UserAppMenuItem Represents the organization-wide settings for items in the app menu or App Launcher that the requesting user has access to in Setup. This object is available in API version 35.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), search() ## Fields | Field Name | Details | | --- | --- | | AppMenuItemId | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID for the menu item. | | ApplicationId | Type reference Properties Filter, Group, Nillable, Sort Description The 15-character ID for the application associated with the menu item. | | Description | Type string Properties Filter, Group, Nillable, Sort Description A description of this menu item. | | IconUrl | Type url Properties Filter, Group, Nillable, Sort Description The icon for the menu item’s application. | | InfoUrl | Type url Properties Filter, Group, Nillable, Sort Description The URL for more information about the application. | | IsUsingAdminAuthorization | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the app is pre-authorized for certain users by the administrator. | | IsVisible | Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the app is visible to the user. | | Label | Type string Properties Filter, Group, Nillable, Sort Description The app’s name. | | LogoUrl | Type url Properties Filter, Group, Nillable, Sort Description The logo for the menu item’s application. The default is the initials of the Label value. | | MobileStartUrl | Type url Properties Filter, Group, Nillable, Sort Description The location mobile users are directed to after they’ve authenticated. This is only used with connected apps. | | Name | Type string Properties Filter, Group, Nillable, Sort Description The API name of the item. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description The index value that controls where this item appears in the menu. For example, a menu item with a sort order value of 5 will appear between items with sort order values of 3 and 9. | | StartUrl | Type url Properties Filter, Group, Nillable, Sort Description The location users are directed to after they’ve authenticated. For a connected app, this is the location specified by the StartUrl. Otherwise it’s the application’s default start page. | | Type | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of application represented by this item. The types are: - ConnectedApplication - Network - ServiceProvider - TabSet | | UserSortOrder | Type int Properties Filter, Group, Nillable, Sort Description The index value that represents where the user set this item in the menu (or App Launcher). For example, an item with a sort order value of 5 will appear between items with sort order values of 3 and 9. This value is separate from SortOrder so you can create logic incorporating both values. For example, if you want the user-sorted items to appear first, followed by the organization order for the rest, use: SELECT ApplicationId,SortOrder,UserSortOrder FROM AppMenuItem order by userSortOrder NULLS LAST, sortOrder NULLS LAST | ## Usage See the AppMenuItem object for the organization-wide default settings This object contains the fields the requesting user has permission to see. # UserAuthCertificate Represents a user authentication certificate in your org. A user certificate is a unique PEM-encoded X.509 digital certificate to authenticate individual users to your org. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules This object is only available in orgs with Let users authenticate with a certificate enabled in Identity Verification. Only users with the Manage Internal Users permission can access this object. ## Fields | Field | Details | | --- | --- | | CertificateChain | Type base64 Properties Create, Update Description The uploaded PEM files can contain a single certificate or up to 10 certificates in a certificate chain. Uploaded PEM files can’t be larger than 1 MB. | | CertificateChainLength | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The auto-generated length of the certificate or certificate chain in the uploaded PEM file. | | DeveloperName | Type string Properties 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 org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, Salesforce generates one for each record, which slows performance. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | ExpirationDate | Type dateTime Properties Filter, Sort Description The expiration date of the uploaded certificate. | | Fingerprint | Type string Properties Filter. Group, idLookup, Sort Description The unique fingerprint of the uploaded certificate. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language in which to display the certificate. Possible values are: - da (Danish) - de (German) - en\_US (English) - es (Spanish) - es\_MX (Spanish - Mexico) - fi (Finnish) - fr (French) - it (Italian) - ja (Japanese) - ko (Korean) - nl\_NL (Dutch) - no (Norwegian) - pt\_BR (Portuguese - Brazil) - ru (Russian) - sv (Swedish) - th (Thai) - zh\_CN (Chinese - Simplified) - zh\_TW (Chinese - Traditional) | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description A descriptive name for the certificate. | | SerialNumber | Type string Properties Filter, Group, Sort Description The serial number of the uploaded certificate. | | UserID | Type reference Properties Create, Filter, Group, Sort, Update Description The user associated with the certificate. | # UserConfigTransferButton Represents the association between a Chat configuration and a live chat button. This association allows users associated with a specific configuration to transfer chats to a button queue. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. ## Fields | Field Name | Details | | --- | --- | | LiveChatButtonId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the live chat button that agents can transfer chats to. | | LiveChatUserConfigId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Chat configuration; agents associated with this configuration can transfer chats to the chat button indicated by the LiveChatButtonId. | # UserConfigTransferSkill Represents the association between a Chat configuration and a skill. This association allows users associated with a specific configuration to transfer chats to agents who have that skill. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | LiveChatUserConfigId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Chat configuration; agents associated with this configuration can transfer chats to the chat button indicated by the LiveChatButtonId. | | SkillId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the skill group that agents can transfer chats to. | # UserCustomBadge Represents a custom badge for a user. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | BadgeType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of badge. Valid values are: - Customer - Partner - Employee | | CustomText | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Custom text for the badge. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Experience Cloud site or org that the badge is in. | # UserCustomBadgeLocalization Represents the translated version of a custom badge for a user. This object is available in API version 38.0 and later. ## Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules - Translation Workbench must be enabled for your org. - Users with the “Customize Application” or “Manage Translation” permission can create or update UserCustomBadge translations. ## Fields | Field Name | Details | | --- | --- | | Language | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language the UserCustomBadge is translated into. This picklist contains these fully supported languages. - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the UserCustomBadge. | | Value | Type string Properties Create, Filter, Sort, Update Description The translated text for the UserCustomBadge. Label is **Translation Text**. | # UserDailyMetric Represents the daily engagement metrics for a user. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Sales Engagement must be enabled. ## Fields | Field | Details | | --- | --- | | AllCallsCallBackLater | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this user with the call result Call Back Later. | | AllCallsLeftVoicemail | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this user with the call result Left Voicemail. | | AllCallsMeaningfulConnect | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this user with the call result Meaningful Connect. | | AllCallsNotInterested | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this user with the call result Not Interested. | | AllCallsUncategorized | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this user with no call result specified. | | AllCallsUnqualified | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the day for this user with the call result Unqualified. | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total of hard and soft bounced emails for this user in the day. This is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of successfully delivered emails for this user in the day. This is a calculated field. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of hard bounced emails for this user in the day. | | AllEmailsNotDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that were undelivered for all recipients on the email. Available in API version 54.0 and later. This is a calculated field. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that triggered an out-of-office reply for this user in the day. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent by this user in the day. This is a calculated field. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails soft bounced for this user in the day. | | AllEmailsTrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent by this user with engagement tracking enabled in the day. | | AllEmailsUntrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent by this user without engagement tracking enabled in the day. | | AllTotalCallsCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of calls by this user with all call results in the day. This is a calculated field. | | DailyCutOffTimeStamp | Type dateTime Properties Filter, Sort Description The time of day when each 24-hour metrics period starts and ends. | | Date | Type date Properties Filter, Group, Sort Description The date on which the engagement occurred. | | DateInt | Type int Properties Filter, Group, idLookup, Sort Description The date on which the engagement occurred, in yyyymmdd format. | | HardBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with hard bounce tracking. Available in API version 53.0 and later. | | LinkClickTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with link click tracking. Available in API version 53.0 and later. | | OpenTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with open tracking. Available in API version 53.0 and later. | | OutOfOfficeTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with out-of-office tracking. Available in API version 53.0 and later. | | RecipientReplies | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who responded to an email. Available in API version 53.0 and later. | | RecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who were sent an email. Available in API version 53.0 and later. | | ReplyTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent an email with reply tracking. Available in API version 53.0 and later. | | ReplyTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with reply tracking. Available in API version 53.0 and later. | | SoftBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with soft bounce tracking. Available in API version 53.0 and later. | | SomeEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that were successfully delivered to at least one recipient on the email. Available in API version 54.0 and later. This is a calculated field. | | SomeEmailsDeliveredRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails that were successfully delivered to at least one recipient on the email. Available in API version 54.0 and later. This is a calculated field. | | TrackableRecipientSendReplyRt | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with reply tracking that received replies from unique recipients. Available in API version 53.0 and later. This is a calculated field. | | TrackableSendHardBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with hard bounce tracking that hard bounced. Available in API version 54.0 and later. This is a calculated field. | | TrackableSendLinkClickRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with link tracking that had link clicks. Available in API version 53.0 and later. This is a calculated field. | | TrackableSendOpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with open tracking that were opened by a recipient. Available in API version 53.0 and later. This is a calculated field. | | TrackableSendOutOfOfficeRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with out-of-office tracking that received out-of-office replies. Available in API version 54.0 and later. This is a calculated field. | | TrackableSendReplyRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with reply tracking that received replies. Available in API version 53.0 and later. This is a calculated field. | | TrackableSendSoftBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with soft bounce tracking that soft bounced. Available in API version 54.0 and later. This is a calculated field. | | UniqueEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who clicked a link in an email sent by the user on the day. | | UniqueEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who opened an email sent by the user on the day. | | UniqueEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who replied to an email sent by the user on the day. | | UserId | Type reference Properties Filter, Group, Sort Description The ID of the related user. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## 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. [UserDailyMetricOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userdailymetricownersharingrule.htm "Represents the rules for sharing the user daily metric with users other than the owner.") Sharing rules are available for the object. [UserDailyMetricShare](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. # UserDailyMetricOwnerSharingRule Represents the rules for sharing the user daily metric with users other than the owner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Sales Engagement must be enabled. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Determines the level of access users have to records. Values are: - Read (read only) - Edit (read/write) | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the sharing rule. Maximum length is 1000 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the source group. Records that are owned by users in the source group trigger the rule to give access. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the sharing rule as it appears in the UI. Maximum length is 80 characters. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that you are granting access to. | ## Usage Use this object to manage the sharing rules for cases. General sharing and territory management-related sharing use this object. #### See Also - [UserDailyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userdailymetric.htm "Represents the daily engagement metrics for a user. This object is available in API version 52.0 and later.") - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") # UserDefinedLabel Represents a label created by a user to help organize, track, and find records. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Color | Type string Properties Create, Filter, Group, Sort, Update Description Hexadecimal value of the color used to help organize the UserDefinedLabel records. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly. For example, accessed through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. For example, accessed through a list view or related record. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the UserDefinedLabel record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user or group that owns the label. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | TotalAssignments | Type int Properties Filter, Group, Nillable, Sort Description Calculated field. Number of related UserDefinedLabelAssignment records. Available in API version 62.0 and later. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Type of user-defined label. Possible values are: - Starred - Tag - User | ## Associated Objects This object has these 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. [UserDefinedLabelOwnerSharingRule](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. [UserDefinedLabelShare](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. # UserDefinedLabelAssignment Represents a relationship between a record label and the item the user assigned it to. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | EntityType | Type string Properties Filter, Group, Nillable, Sort Description Object label of the Item record derived from ItemId. Available in API version 62.0 and later. | | ItemId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the Item record added to the UserDefinedLabel record. This field is a polymorphic relationship field. Relationship Name Item Refers To Account, ActionCadence, ActionCadenceStepTracker, CallTemplate, Case, Contact, EmailTemplate, FlowOrchestrationWorkItem, Lead, Opportunity, Task | | LabelId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the UserDefinedLabel record that the Item record is assigned to. This field is a relationship field. Relationship Name Label Refers To UserDefinedLabel | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user or group that owns this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | SortOrder | Type int Properties Filter, Group, idLookup, Nillable, Sort Description Order of the assigned items for a given UserDefinedLabel record. | | SubjectOrName | Type string Properties Filter, Group, Nillable, Sort Description Name of the Item record. If it's a task, the value is the subject of the Item record. | ## Associated Objects This object has these 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. [UserDefinedLabelAssignmentOwnerSharingRule](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. [UserDefinedLabelAssignmentShare](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. # UserDevice Represents information unique to a device. Available in API version 43.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules You must have View Devices enabled to see devices. ## Fields | Field Name | Details | | --- | --- | | BrowserType | Type string Properties Filter, Group, Nillable, Sort Description The browser used for login. | | DeviceNativeUid | Type string Properties Filter, Group, idLookup, Nillable, Sort Description A unique string used to identify a mobile device. | | DeviceType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The device used to log in to Salesforce. The picklist options are: - Desktop - Tablet - iPad - iPhone - Phone - Unknown | | IsVerified | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Reserved for future use. | | LastLoginHistoryId | Type reference Properties Filter, Group, Nillable, Sort Description The most recent LoginHistory associated with the device. | | Name | Type string Properties Filter, Group, idLookup, Sort Description This field is system-generated and can’t be changed. | | PlatformType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The operating system of the device. The picklist options are: - iOS - Android - OSX - Linux - Phone - Windows - AppleApp - Blackberry - Other | | PlatformVersion | Type string Properties Filter, Group, Nillable, Sort Description The version of the operating system running on the device. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The activity status of the device. The picklist options are: - Approved - Pending Approval - Revoked | | UserId | Type reference Properties Filter, Group, Sort Description The ID of the user. | | UserLastSeen | Type dateTime Properties Filter, Nillable, Sort Description The date and time of the user’s last access. | | UserProvidedDeviceIdentifier | Type string Properties Filter, Group, Nillable, Sort, Update Description An identifier for the user’s device such as the International Mobile Equipment Identity (IMEI) number or the device serial number. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field isn’t automatically populated. The developer must provide values. | # UserDeviceApplication Represents information on applications installed on a device that is accessing Salesforce. Available in API version 43.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules You must have View Devices enabled to see devices. ## Fields | Field Name | Details | | --- | --- | | | | | ApplicationType | Type string Properties Filter, Group, Nillable, Sort Description The type of application used to log in to Salesforce. | | Name | Type string Properties Filter, Group, idLookup, Sort Description This field is system-generated and cannot be changed. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The activity status of the device application. The picklist options are: - Approved - Pending Approval - Revoked | | UserDeviceId | Type reference Properties Filter, Group, Nillable, Sort Description The unique identifier used to identify a device when tracking events. UserDeviceId is a generated value that’s created when the mobile app is initially run after installation. | | UserId | Type reference Properties Filter, Group, Sort Description The ID of the user. | # UserDeviceHistory Represents tracking information on the UserDevice sObject. This object is available in API version 50.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of data that has changed. Possible values are: - Address - AnyType - AutoNumber - Base64 - BitVector - Boolean - Content - Currency - DataCategoryGroupReference - DateOnly - DateTime - Division - Double - DynamicEnum - Email - EncryptedBase64 - EncryptedText - EntityId - EnumOrId - ExternalId - Fax - File - HtmlMultiLineText - HtmlStringPlusClob - InetAddress - Json - Location - MultiEnum - MultiLineText - Namespace - Percent - PersonName - Phone - Raw - RecordType - SfdcEncryptedText - SimpleNamespace - StringPlusClob - Switchable\_PersonName - Text - TimeOnly - Url - YearQuarter | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The field that has changed. Possible values are: - BrowserType—Browser - DeviceNativeUid—Device Native ID - DeviceType—Device Type - HashedBrowserFingerPrint—Hashed Browser Fingerprint - IsVerified—Is Device Verified - LastLoginHistory—Login History - Name - PlatformType—Platform or OS Type - PlatformVersion—Platform or OS Version - RawBrowserFingerPrint—Raw Browser Fingerprint Data - Status—Device Status - User - UserLastSeen—Last time user was seen - UserProvidedDeviceIdentifier—User provided device identifier - created—Created. - feedEvent—Feed event - individualMerged—Individual Merged - locked—Record locked. - ownerAccepted—Owner (Accepted) - ownerAssignment—Owner (Assignment) - unlocked—Record unlocked. | | NewValue | Type anyType Properties Nillable, Sort Description The value after a change has occurred. | | OldValue | Type anyType Properties Nillable, Sort Description The value before a change has occurred. | | UserDeviceId | Type reference Properties Filter, Group, Sort Description The ID of the UserDevice object. | # UserEmailCalendarSync Represents the user assignments of an Einstein Activity Capture configuration. This object is available in API version 49.0 and later. ## Supported Calls create(), describeSObjects(), query(), update(), upsert() ## Special Access Rules To access this object, enable Einstein Activity Capture in your org. ## Fields | Field | Details | | --- | --- | | AssignedId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user or profile. Only Einstein Activity users can be added to a configuration. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When an org is in the process of migrating from Lightning Sync to Einstein Activity Capture via the migration tool, the API can assign Lightning Sync users to EAC configurations. See [Working with Lightning Sync Migration Tool](https://help.salesforce.com/s/articleView?id=sales.lightning_sync_move_how_work.htm&type=5&language=en_US). | | ConfigurationId | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Einstein Activity Capture configuration. The configuration is created in Salesforce Setup. After the configuration is created, the autogenerated ID is visible on the Configurations tab. From Setup, in the Quick Find box, enter Einstein Activity Capture, and then select **Settings**. Click the Configurations tab. | ## Usage Use UserEmailCalendarSync to add and remove users to an Einstein Activity Capture configuration. You can add users to a configuration via a user ID or a profile ID. You can add a profile to only one configuration and assign a profile to only one user. This example adds two users to an Einstein Activity Capture configuration. // Create a list of UserEmailCalendarSync records List usersToAdd = new ArrayList<>(); // Populate the UserEmailCalendarSync record with the ID of // the user or profile, and with the ID of the Activity Capture configuration you are adding them to UserEmailCalendarSync user1 = new UserEmailCalendarSync(ConfigurationId = '0063xxxxxxxxxxx', AssignedId = '005xxxxxxxxxxxx'); UserEmailCalendarSync user2= new UserEmailCalendarSync(ConfigurationId = '0063xxxxxxxxxxx', AssignedId = '005xxxxxxxxxxxx'); // add the UserEmailCalendarSync users to your list usersToAdd.add(user1); usersToAdd.add(user2); // Insert the list of UserEmailCalendarSync into the database Database.SaveResult\[\] results = Database.insertImmediate(usersToAdd); This example removes a user from an Einstein Activity Capture configuration. To remove a user, call UserEmailCalendarSync(), passing in null for ConfigurationId. UserEmailCalendarSync user2Remove= new UserEmailCalendarSync(ConfigurationId = "", AssignedId ='005xxxxxxxxxxxx'); Database.SaveResult results =Database.insertImmediate(user2Remove); # UserEmailPreferredPerson Represents a mapping for a user’s preferred record for an email address when multiple records match an email field.This object is available in API version 44.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules As of Summer ‘20 and later, only authenticated internal and external users can access this object. ## Fields | Field | Details | | --- | --- | | Email | Type email Properties Create, Filter,Group, idLookup, Sort, Update Description Required. The unique email the mapping applies to. This field is unique for each user. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Read-only. Auto-generated field. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. The userId that owns the record. Each record is only accessible to the owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PersonRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The recordId of a contact, lead, or user that represents the preferred record for the email address. Use cascade delete for contact and lead, and delete if the personId is a deactivated user record. This is a polymorphic relationship field. Relationship Name PersonRecord Relationship Type Lookup Refers To Contact, Lead, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [UserEmailPreferredPersonChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [UserEmailPreferredPersonShare](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. # UserEmailPreferredPersonShare Represents a sharing entry on a UserEmailPreferredPerson object. Sharing is not customizable for UserEmailPreferredPerson records.This object is available in API version 44.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter,Group, Restricted picklist, Sort, Update Description Required. The level of access allowed. Values can be: - All - Edit - Read . | | ParentId | Type reference Properties Create, Filter,Group, Sort, Description Id of the parent record, if any. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To UserEmailPreferredPerson | | RowCause | Type picklist Properties Create, Filter,Group, Nillable, Restricted picklist, Sort, Description Required. Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values can include: - Manual—The User or Group has access because a user with All access manually shared the record with them. - Owner—The User is the owner of the record or is in a role above the record owner in the role hierarchy. | | UserOrGroupId | Type reference Properties Create, Filter,Group, Sort, Description Required. ID of the user or group that has been given access to the UserEmailPreferredPerson record. The UserOrGroupID is polymorphic. The label is User/Group Id. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | # UserLicense Represents a user license in your organization. A user license entitles a user to specific functionality and determines the profiles and permission sets available to the user. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | LicenseDefinitionKey | Type string Properties Filter, Group, Sort Description A string that uniquely identifies a particular user license. Label is License Def. ID. Values are: **AUL**: corresponds to the Salesforce Platform user license **AUL1**: corresponds to the Salesforce Platform One user license **AUL\_LIGHT** corresponds to the Salesforce Platform Light user license **FDC\_ONE** corresponds to the Lightning Platform - One App user license **FDC\_SUB** corresponds to the Lightning Platform App Subscription user license **Overage\_Platform\_Portal\_User** corresponds to the Overage Authenticated Website user license **PID\_STRATEGIC\_PRM**: corresponds to the Gold Partner user license **PID\_CHATTER** corresponds to the Chatter Only user license **PID\_CONTENT** corresponds to the Content Only user license **PID\_Customer\_Portal\_Basic**: corresponds to the Customer Portal Manager Standard user license and the Customer Portal User license **PID\_Customer\_Portal\_Standard**: corresponds to the Customer Portal Manager Custom user license **PID\_FDC\_FREE** corresponds to the Lightning Platform Free user license **PID\_IDEAS** corresponds to the Ideas Only user license **PID\_Ideas\_Only\_Portal** corresponds to the Ideas Only Portal user license **PID\_Ideas\_Only\_Site** corresponds to the Ideas Only Site user license **PID\_KNOWLEDGE** corresponds to the Knowledge Only user license **PID\_Customer\_Community** corresponds to the Customer Community license. **PID\_Customer\_Community\_Login** corresponds to the Customer Community Login license. **PID\_Partner\_Community** corresponds to the Partner Community license. **PID\_Partner\_Community\_Login** corresponds to the Partner Community Login license. **PID\_Limited\_Customer\_Portal\_Basic**: corresponds to the Limited Customer Portal Manager Standard user license **PID\_Limited\_Customer\_Portal\_Standard**: corresponds to the Limited Customer Portal Manager Custom user license **PID\_Overage\_Customer\_Portal\_Basic**: corresponds to the Overage Customer Portal Manager Standard user license **PID\_Overage\_High Volume Customer Portal** corresponds to the Overage High Volume Customer Portal user license **Platform\_Portal\_User**: corresponds to the Authenticated Website user license **POWER\_PRM**: corresponds to the Partner user license **POWER\_SSP**: corresponds to the Customer Portal Manager user license **SFDC**: corresponds to the Full CRM user license | | MasterLabel | Type string Properties Filter, Group, Sort Description The user license label. This field is available in API version 32.0 and later. | | MonthlyLoginsEntitlement | Type int Properties Filter, Group, Nillable, Sort Description The maximum number of customer or partner portal logins allowed per month. A null value in this field means the user license is charged according to the number of users rather than the number of logins. This field is available in API version 20.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To be visible and queryable, this field requires: - Digital Experiences enabled - the View Setup and Configuration user permission | | MonthlyLoginsUsed | Type int Properties Group, Nillable, Sort Description The number of successful logins for all users associated with a customer or partner portal user license. This field has a non-null value if MonthlyLoginsEntitlement has a non-null value. This field is available in API version 20.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To be visible and queryable, this field requires: - Digital Experiences enabled - the View Setup and Configuration user permission | | Name | Type string Properties Filter, Group, idLookup, Sort Description The internal name of the user license. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Your organization may also include custom user licenses. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The current status of the user license. Valid values for this field are Active and Disabled. This field is available in API version 32.0 and later. | | TotalLicenses | Type int Properties Filter, Group, Sort Description The number of user licenses in the organization. This field is available in API version 32.0 and later. | | UsedLicenses | Type int Properties Filter, Group, Sort Description The number of user licenses that are assigned to active users in the organization. This field is available in API version 32.0 and later. This field isn’t filterable in API version 64.0 or later when using it in a WHERE clause in a SOQL query. Instead, you have to process the data after fetching all the records. | | UsedLicensesLastUpdated | Type dateTime Properties aggregate, Filter, Sort Description The timestamp of the query. If your license count exceeds your org’s allotted threshold, the count timestamp reflects the previous day, otherwise the timestamp reflects the current day and time. This field is available in API version 41.0 and later. | ## Usage Users with the “View Setup and Configuration” permission can use the UserLicense object to view the set of currently defined user licenses in your organization. The UserLicense object is currently used by bulk user creation to determine the user license to which each profile and permission set belongs. For example, if you use the API to create portal users and you want to know which profile belongs to each portal user license, you can query this object for each profile and check the LicenseDefinitionKey to identify the associated user license. #### See Also - [Profile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profile.htm "Represents a profile, which defines a set of permissions to perform different operations. Operations can include creating a custom profile or querying, adding, updating, or deleting information.") - [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.") # UserListView Represents the customizations a user made to a list view. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Name | Details | | --- | --- | | LastViewedChart | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The last chart a user viewed. | | ListViewId | Type reference Properties Create, Filter, Group, Sort Description The ID of the list view. This is a relationship field. Relationship Name ListView Relationship Type Lookup Refers To ListView | | SobjectType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The API name of the sObject for the user list view. | | UserId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | # UserListViewCriterion Represents the criterion for a user’s customized list view. The criterion consists of the filters or sort order a user added to a list view for the Salesforce Mobile app. This object is available in API version 32.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Name | Details | | --- | --- | | ColumnName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the column in the user list view. | | Operation | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The criteria to apply, such as “equals” or “starts with.” | | SortOrder | Type int Properties Create, Filter, Group, Sort, Update Description The order in which the list view is evaluated compared to other UserListViewCriterion objects for the given UserListView. | | UserListViewId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user list view. This is a relationship field. Relationship Name UserListView Relationship Type Lookup Refers To UserListView | | Value | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The field values used to filter the list view. For example, a value of 94105 if the Field is Billing Zip/Postal Code shows only rows that have a billing ZIP code of 94105. | # UserLocationAssignment Represents the assignment between a location and a user. This object is available in API version 57.0 and later. ## Supported Calls: create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules: This object is only available in Salesforce Order Management orgs. ## Fields | Field | Details | | --- | --- | | UserLocationAssignmentNumber | Type text Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated number for the association | | AssignedTo | Type foreignkey (user) Properties Create, Filter, Group, Sort, Update Description User being associated with the location | | Location | Type foreignkey (location) Properties Create, Filter, Group, Sort, Update Description Location being associated to the User | | Username | Type string (derived) Properties Filter, Sort Description Username of the User that is associated to the Location | | IsActive | Type boolean Properties Create, Filter, Group, Sort, Update Description Whether the location is active or not | ## Usage: The UserLocationAssignment object associates a user to specified work locations. To assign a user to multiple locations, create Multiple UserLocationAssignment objects. Use the isActive field to indicates the user's current active location. # UserLogin Represents the settings that affect a user’s ability to log into an organization. To access this object, you need the UserPermissions.ManageUsers permission. This object is available in API version 29.0 and later. ## Supported Calls describeSObjects(), query(), retrieve(), update() ## Fields | Field Name | Details | | --- | --- | | IsFrozen | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description If true, the user account associated with this object is [frozen](https://help.salesforce.com/s/articleView?id=platform.users_freeze.htm&language=en_US). If a user's account is frozen, they can't log in, but their account isn't deactivated. | | IsPasswordLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description If true, the user account associated with this object is locked because of too many login failures. From the API, you can set this field to false, but not true. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If the Lockout effective period is set to Forever (must be reset by admin) in your org’s Password Policies Setup page, this field isn’t set to false. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated user account. This field can’t be updated. | ## Usage To query for all frozen users in your organization: SELECT Id, UserId FROM UserLogin WHERE IsFrozen = true To freeze or unfreeze multiple users, [use Data Loader](https://help.salesforce.com/s/articleView?id=000387522&type=1&language=en_US). # UserMembershipSharingRule Represents the rules for sharing user records from a source group to a target group. A user record contains details about a user. Users who are members of the source group can be shared with members of the target group. The source and target groups can be based on roles, portal roles, public groups, or territories. This object is available in API version 26.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object, and only users with the Manage Sharing permission can edit this object. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, 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 org. 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. Corresponds to **Rule Name** in the user interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to **Label** on the user interface. | | UserAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. The possible values are: - Read - Edit | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID representing the target group being given access. | ## Usage Use this object to manage sharing rules for user records. Source and target groups can include internal users, portal users, Chatter or Chatter External users. # UserMonthlyMetric Represents the monthly engagement metrics for a user. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Sales Engagement must be enabled. ## Fields | Field | Details | | --- | --- | | AllCallsCallBackLater | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this user with the call result Call Back Later. | | AllCallsLeftVoicemail | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this user with the call result Left Voicemail. | | AllCallsMeaningfulConnect | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this user with the call result Meaningful Connect. | | AllCallsNotInterested | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this user with the call result Not Interested. | | AllCallsUncategorized | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this user with no call result specified. | | AllCallsUnqualified | Type int Properties Filter, Group, Nillable, Sort Description The number of calls in the month for this user with the call result Unqualified. | | AllEmailsBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The total of hard and soft bounced emails sent by this user in the month. This is a calculated field. | | AllEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of successfully delivered emails sent by this user in the month. This is a calculated field. | | AllEmailsHardBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of hard bounced emails sent by this user in the month. | | AllEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails containing a link clicked by the recipient sent by this user in the month. | | AllEmailsNotDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that were undelivered for all recipients on the email. Available in API version 54.0 and later. | | AllEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails opened by the recipient sent by this user in the month. | | AllEmailsOutOfOfficeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that triggered an out-of-office reply sent by this user in the month. | | AllEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails replied to for this user in the month. | | AllEmailsSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent by this user in the month. This is a calculated field. | | AllEmailsSoftBouncedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent by this user that soft bounced in the month. | | AllEmailsTrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent by this user with engagement tracking enabled in the month. | | AllEmailsUntrackedSentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent by this user without engagement tracking enabled in the month. | | AllTotalCallsCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of calls with all call results for this user in the month. This is a calculated field. | | DeliveredRecipientCount | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who successfully received an email. Available in API version 53.0 and later. This is a calculated field. | | DeliveredRecipientRate | Type percent Properties Filter, Nillable, Sort Description The percentage of unique recipients who successfully received an email. Available in API version 53.0 and later. This is a calculated field. | | HardBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with hard bounce tracking. Available in API version 53.0 and later. | | HrdBncTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent an email with hard bounce tracking. Available in API version 53.0 and later. | | LinkClickTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with link click tracking. Available in API version 53.0 and later. | | LinkClkTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent an email with link click tracking. Available in API version 53.0 and later. | | Month | Type date Properties Filter, Group, Sort Description The month in which the engagement occurred. | | MonthInt | Type int Properties Filter, Group, idLookup, Sort Description The month in which the engagement occurred, in yyyymm format. | | OooTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent an email with out-of-office tracking. Available in API version 53.0 and later. | | OpenTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent an email with open tracking. Available in API version 53.0 and later. | | OpenTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with open tracking. Available in API version 53.0 and later. | | OutOfOfficeTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with out-of-office tracking. Available in API version 53.0 and later. | | RecipientReplies | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who responded to an email. Available in API version 53.0 and later. | | RecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who were sent an email. Available in API version 53.0 and later. | | RecipientsHardBounced | Type int Properties Filter, Group, Nillable, Sort Description The number of email recipients who were sent an email that hard bounced. Available in API version 54.0 and later. | | RecipientsOutOfOffice | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who responded with an out-of-office reply. Available in API version 54.0 and later. | | RecipientsSoftBounce | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent an email that soft bounced. Available in API version 54.0 and later. | | ReplyTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent an email with reply tracking. Available in API version 53.0 and later. | | ReplyTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with reply tracking. Available in API version 53.0 and later. | | SftBncTrackableRecipientSends | Type int Properties Filter, Group, Nillable, Sort Description The number of recipients who were sent an email with soft bounce tracking. Available in API version 53.0 and later. | | SoftBounceTrackableSends | Type int Properties Filter, Group, Nillable, Sort Description The number of emails sent with soft bounce tracking. Available in API version 53.0 and later. | | SomeEmailsDeliveredCount | Type int Properties Filter, Group, Nillable, Sort Description The number of emails that were successfully delivered to at least one recipient on the email. Available in API version 54.0 and later. This field is a calculated field. | | SomeEmailsDeliveredRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails that were successfully delivered to at least one recipient on the email. Available in API version 54.0 and later. This field is a calculated field. | | TrackableRecipientSendHrdBncRt | Type percent Properties Filter, Nillable, Sort Description The percentage of unique recipients who hard bounced an email with hard bounce tracking. Available in API version 54.0 and later. This field is a calculated field. | | TrackableRecipientSendOooRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with out-of-office tracking that resulted in out-of-office replies from unique recipients. This field is a calculated field. Available in API version 54.0 and later. This field is a calculated field. | | TrackableRecipientSendReplyRt | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with reply tracking that received replies from unique recipients. Available in API version 54.0 and later. This field is a calculated field. | | TrackableRecipientSendSftBncRt | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent to unique recipients with soft bounce tracking that soft bounced. This field is a calculated field. Available in API version 54.0 and later. | | TrackableSendHardBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with hard bounce tracking that hard bounced. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendLinkClickRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with link tracking that had link clicks. Available in API version 53.0 and later. This field is a calculated field. | | TrackableSendOpenRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with open tracking that were opened by a recipient. Available in API version 53.0 and later. This field is a calculated field. | | TrackableSendOutOfOfficeRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with out-of-office tracking that received out-of-office replies. Available in API version 54.0 and later. This field is a calculated field. | | TrackableSendReplyRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with reply tracking that received replies. Available in API version 53.0 and later. This field is a calculated field. | | TrackableSendSoftBounceRate | Type percent Properties Filter, Nillable, Sort Description The percentage of emails sent with soft bounce tracking that soft bounced. Available in API version 54.0 and later. This field is a calculated field. | | UniqueEmailsLinkClickedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who clicked a link in an email sent by this user in the month. | | UniqueEmailsOpenedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who opened an email sent by this user in the month. | | UniqueEmailsRepliedCount | Type int Properties Filter, Group, Nillable, Sort Description The number of unique recipients who replied to an email sent by this user in the month. | | UserId | Type reference Properties Filter, Group, Sort Description The ID of the related user. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## 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. [UserMonthlyMetricOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usermonthlymetricownersharingrule.htm "Represents the rules for sharing the user monthly metric with users other than the owner.") Sharing rules are available for the object. [UserMonthlyMetricShare](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. # UserMonthlyMetricOwnerSharingRule Represents the rules for sharing the user monthly metric with users other than the owner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Sales Engagement must be enabled. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Determines the level of access users have to records. Values are: - Read (read only) - Edit (read/write) | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the sharing rule. Maximum length is 1000 characters. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, 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 org. 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | GroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the source group. Records that are owned by users in the source group trigger the rule to give access. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the sharing rule as it appears in the UI. Maximum length is 80 characters. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that you are granting access to. | ## Usage Use this object to manage the sharing rules for cases. General sharing and territory management-related sharing use this object. #### See Also - [UserMonthlyMetric](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_usermonthlymetric.htm "Represents the monthly engagement metrics for a user. This object is available in API version 52.0 and later.") - [_Metadata API Developer Guide_: SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm " Metadata API Developer Guide: SharingRules - HTML (New Window)") # UserPackageLicense Represents a license for an installed managed package, assigned to a specific user. This object is available in API version 31.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() update() ## Fields | Field Name | Details | | --- | --- | | IsRevoked | Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Reserved for internal use. This field is available in API version 58.0 and later. | | LastCreatedByChangeId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the user access change record related to this managed package license assignment. This field is available only if user access policies are enabled. This field is available in API version 58.0 and later. This field is a relationship field. Relationship Name LastCreatedByChange Relationship Type Lookup Refers To UserAccessChange | | LastDeletedByChangeId | Type reference Properties Create, Filter, Group, Sort Description ID of the user access change record related to this managed package license assignment being revoked. This field is available only if user access policies are enabled. This field is available in API version 58.0 and later. This field is a relationship field. Relationship Name LastCreatedByChange Relationship Type Lookup Refers To UserAccessChange | | PackageLicenseId | Type reference Properties Create, Filter, Group, Sort Description The 18-character Globally Unique ID (GUID) that identifies the package license This is a relationship field. Relationship Name PackageLicense Relationship Type Lookup Refers To PackageLicense | | UserId | Type reference Properties Create, Filter, Group, Sort Description The User ID of the user licensed to use this package | ## Usage Use this object, in conjunction with PackageLicense, to provide users access to a managed package installed in your organization. # UserPermissionAccess Represents the permissions accessibility for a current user. Available in API version 41.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | LastCacheUpdate | Type dateTime Properties Filter, Nillable, Sort Description The last modified date and time of either the user info or org info, whichever is later. | | Permissions | Type boolean Properties Filter Description The name of the permission, such as PermissionsActivateContract or PermissionsAuthorApex and whether it’s available to the user (true) or not (false). | ## Usage API users without PermissionsViewSetup can use this object to check if their own sessions have access to a feature. #### See Also - [Profile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_profile.htm "Represents a profile, which defines a set of permissions to perform different operations. Operations can include creating a custom profile or querying, adding, updating, or deleting information.") - [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionset.htm "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.") # UserPreference Represents a functional preference for a specific user in your organization. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Customer Portal users can't access this object. Only users with the View All Data or Manage Users permission can access UserPreference records of other users but all users can access their own UserPreference record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This behavior does not affect other types of user access such as Create or Edit. ## Fields | Field | Details | | --- | --- | | Preference | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The name of the user preference. Supported values are: - 57 (Event Reminder Default Lead Time) - 58 (Task Reminder Default Time) - 91 (Prevent Logs on Load) - 92 (Autocomplete Apex After Key Press) - 93 (Visualforce Viewstate Inspector) - 94 (Forecasting Displayed Type) - 96 (Editor Theme) - 97 (Editor Font Size) - 98 (Pinned Folders) - 99 (Enable Query Plan) - 100 (Enable New Open Dialog) - 101 (Email Transport Type) - 102 (Pinned Wave Folders) - 108 (Density) - 109 (Lightning Flow Builder) - 111 (Format with Tabs) - 112 (Format Tab Width) - 113 (Format Print Width) - 114 (Record Page Activities Display) - 118 (Lightning Flow Explorer) - 119 (For internal use only) - 120 (Simple Auth Option) - 122 (Sales Alert Notifications Snooze Time) - 131 (Color Scheme) - 136 (Last Gong Insights Sync Time) Event Reminder Default Lead Time and Task Reminder Default Time are related to these fields on the User object: - UserPreferencesEventRemindersCheckboxDefault - UserPreferencesTaskRemindersCheckboxDefault - UserPreferencesSuppressEventSFXReminders - UserPreferencesSuppressTaskSFXReminders Enable New Open Dialog is reserved for future use. When creating SOQL queries, tolabel is required to return accurate results. For example, select Id, tolabel(Preference), Value, UserId from UserPreference. 108 (Density) is available in API v44.0 and later. | | UserId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the user associated with this role. The corresponding field label is **User ID**. Admin users can create and edit preferences for other users. Standard users can delete their own preferences only. For a standard user, the value of the UserId field must be their own UserId. | | Value | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The value of the user preference. For Event Reminder Default Lead Time, the values are increasing intervals of time from 0 minutes to 2 days. For Task Reminder Default Time, the values are half-hours from 12:00 AM to 11:30 PM. To view the respective sets of values, access the Reminders in your personal settings in the online application. | ## Usage Use this object to query the set of currently configured user preferences in your organization. In your client application, you can query the User object to obtain valid User IDs to access the UserPreference object. All users can invoke the supported calls with this object. Standard users can invoke these calls, but only on their own preferences. # UserPrioritizedRecord Represents records that Pipeline Inspection, Account Intelligence, Contact Intelligence, and Lead Intelligence users flag as important for tracking in pipeline and intelligence views and filters. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To use UserPrioritizedRecord in Pipeline Inspection and the Account Intelligence, Contact Intelligence, and Lead Intelligence views, enable the Pipeline Inspection user permission and the Pipeline Inspection setting. ## Fields | Field | Details | | --- | --- | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who marked this record as important. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | TargetId | Type reference Properties Create, Filter, Group, Sort Description The ID of the target object that is marked as important. Supported objects include: - Account - Contact - Lead - Opportunity This field is a polymorphic relationship field. Relationship Name Target Relationship Type Lookup Refers To - Account - Contact - Lead - Opportunity | | TargetKeyPrefix | Type string Properties Filter, Group, idLookup, Sort Description The key prefix of the target object that is marked as important. | ## 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. [UserPrioritizedRecordOwnerSharingRule](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. [UserPrioritizedRecordShare](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. # UserProfile Represents a Chatter user profile. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object has been deprecated as of API version 32.0. Use the [User](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_user.htm "Represents a user in your organization.") object to query information about a user in API version 32.0 and later. ## Supported Calls describeLayout(), query(), retrieve() ## Special Access Rules - Information in hidden fields in a user's profile isn’t searchable by external users (with a portal profile) in an Experience Cloud site. For example, if a user in a site has a hidden email address and an external user searches for it, the user record isn’t returned in the search results. Hidden field values also aren’t returned when external users perform searches on nonhidden fields. So if an external user searches for a user's name (can’t be hidden), any hidden field values associated with the user record such as a hidden email address aren’t returned in the search results. internal users belonging to the same Experience Cloud site can search for and view hidden field values in search results. - Any fields that have been restricted in visibility will be returned empty, whether or not they are, and will not be removed from the field listing. ## Fields | Field | Details | | --- | --- | | AboutMe | Type textarea Properties Filter, Nillable, Sort Description Information about the user, such as areas of interest or skills. | | Address (beta) | Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior.") for details on compound address fields. | | City | Type string Properties Filter, Group, Nillable, Sort Description The city associated with the user profile. | | CompanyName | Type string Properties Filter, Group, Nillable, Sort Description The company associated with the user profile. | | Country | Type string Properties Filter, Group, Nillable, Sort Description The country associated with the user profile. | | Email | Type email Properties Filter, Group, idLookup, Sort Description The email address associated with the user profile. | | Fax | Type phone Properties Filter, Group, Nillable, Sort Description The fax number associated with the user profile. | | FirstName | Type string Properties Filter, Group, Nillable, Sort Description The user’s first name. | | FullPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for the user's profile photo if Chatter is enabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo is uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user has access to log in (true) or not (false). You can modify a User's active status from the user interface or via the API. | | IsBadged | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user is visually badged (true) or not (false). Users of the same Chatter user type (internal, external) are badged. Different user types are not badged. | | LastName | Type string Properties Filter, Group, Sort Description The user’s last name. | | Latitude (beta) | Type double Properties Filter, Nillable, Sort Description Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") | | Longitude (beta) | Type double Properties Filter, Nillable, Sort Description Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") | | ManagerId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who manages this user. | | MobilePhone | Type phone Properties Filter, Group, Nillable, Sort Description The user’s mobile or cellular phone number. | | Name | Type string Properties Filter, Group, Sort Description Concatenation of FirstName and LastName. | | Phone | Type phone Properties Filter, Group, Nillable, Sort Description The user’s phone number. | | PostalCode | Type string Properties Filter, Group, Nillable, Sort Description The user’s postal or ZIP code. Label is **Zip/Postal Code**. | | SmallPhotoUrl | Type url Properties Filter, Nillable, Sort Description The URL for a thumbnail of the user's profile photo if Chatter is enabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo is uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. | | State | Type string Properties Filter, Group, Nillable, Sort Description The state associated with the user profile. | | Street | Type textarea Properties Filter, Group, Nillable, Sort Description The street address associated with the user profile. | | Title | Type string Properties Filter, Group, Nillable, Sort Description The user’s business title, such as “Vice President.” | | UserPreferencesActivityRemindersPopup | Type boolean Properties Filter Description When true, a reminder window automatically opens when an activity reminder is due. Corresponds to the Trigger alert when reminder comes due checkbox at the Reminders page in the personal settings in the user interface. | | UserPreferencesApexPagesDeveloperMode | Type boolean Properties Filter Description When true, indicates that the user has enabled developer mode for editing Visualforce pages and controllers. | | UserPreferencesDisableAllFeedsEmail | Type boolean Properties Filter Description When false, the user automatically receives email for all updates to Chatter feeds, based on the types of feed emails and digests the user has enabled. | | UserPreferencesDisableBookmarkEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time someone comments on a Chatter feed item after the user has bookmarked it. | | UserPreferencesDisableChangeCommentEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time someone comments on a change the user has made, such as an update to their profile. | | UserPreferencesDisableEndorsementEmail | Type boolean Properties Filter Description When false, the member automatically receives email every time someone endorses them for a topic. | | UserPreferencesDisableFeedbackEmail | Type boolean Properties Filter Description When false, the user automatically receives emails related to WDC feedback. This includes when someone requests or offers feedback, shares feedback with the user, or reminds the user to answer a feedback request. | | UserPreferencesDisableFileShareNotificationsForApi | Type boolean Properties Filter Description When false, email notifications are sent from the person who shared the file to the users that the file is shared with. | | UserPreferencesDisableFollowersEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time someone starts following the user in Chatter. | | UserPreferencesDisableLaterCommentEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time someone comments on a feed item after the user has commented on the feed item. | | UserPreferencesDisableLikeEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time someone likes their post or comment. | | UserPreferencesDisableMentionsPostEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time they’re mentioned in posts. | | UserPreferencesDisableMessageEmail | Type boolean Properties Filter Description When false, the user automatically receives email for Chatter messages sent to the user. | | UserPreferencesDisableProfilePostEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time someone posts to the user’s profile. | | UserPreferencesDisableRewardEmail | Type boolean Properties Filter Description When false, the user automatically receives emails related to WDC rewards. This includes when someone someone gives a reward to the user. | | UserPreferencesDisableSharePostEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time their post is shared. | | UserPreferencesDisableWorkEmail | Type boolean Properties Filter Description When false, the user receives emails related to WDC feedback, goals, and coaching. The user must also sign up for individual emails listed on the WDC email settings page. When true, the user will not receive any emails related to WDC feedback, goals, or coaching even if they are signed up for individual emails. | | UserPreferencesDisCommentAfterLikeEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time someone comments on a post that the user liked. | | UserPreferencesDisMentionsCommentEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time the user is mentioned in comments. | | UserPreferencesDisProfPostCommentEmail | Type boolean Properties Filter Description When false, the user automatically receives email every time someone comments on posts on the user’s profile. | | UserPreferencesEnableAutoSubForFeeds | Type boolean Properties Filter Description When true, the user automatically subscribes to feeds for any objects that the user creates. | | UserPreferencesEventRemindersCheckboxDefault | Type boolean Properties Filter Description When true, a reminder popup is automatically set on the user's events. Corresponds to the By default, set reminder on Events to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders. | | UserPreferencesHideChatterOnboardingSplash | Type boolean Properties Filter Description When true, the initial Chatter onboarding prompts do not appear. | | UserPreferencesHideCSNDesktopTask | Type boolean Properties Filter Description When true, the Chatter recommendations panel never displays the recommendation to install Chatter Desktop. | | UserPreferencesHideCSNGetChatterMobileTask | Type boolean Properties Filter Description When true, the Chatter recommendations panel never displays the recommendation to install Chatter Mobile. | | UserPreferencesHideS1BrowserUI | Type boolean Properties Filter Description Controls the interface that the user sees when logging in to Salesforce from a supported mobile browser. If false, the user is automatically redirected to the Salesforce mobile web. If true, the user sees the full Salesforce site. The default value is false. Label is **Salesforce User**.This field is available in API version 29.0 or later. | | UserPreferencesHideSecondChatterOnboardingSplash | Type boolean Properties Filter Description When true, the secondary Chatter onboarding prompts do not appear. | | UserPreferencesReminderSoundOff | Type boolean Properties Filter Description When true, a sound automatically plays when an activity reminder is due. Corresponds to the Play a reminder sound checkbox on the Reminders page in the user interface. | | UserPreferencesShowCityToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the city field in the user’s contact information. City is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. City is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowCityToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowCityToGuestUsers | Type boolean Properties Filter Description Indicates the visibility of the city field in the user’s contact information. When true, city is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowCityToExternalUsers, making the user’s city visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowCountryToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the country field in the user’s contact information. Country is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. Country is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowCountryToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowCountryToGuestUsers | Type boolean Properties Filter Description Indicates the visibility of the country field in the user’s contact information. When true, country is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowCountryToExternalUsers, making the user’s country visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowEmailToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the email address field in the user’s contact information. Email address is visible only to internal members of the user’s organization when this field is false. Email address is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowFaxToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the fax number field in the user’s contact information. Fax number is visible only to internal members of the user’s organization when this field is false. Fax number is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowManagerToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the manager field in the user’s contact information. Manager is visible only to internal members of the user’s organization when this field is false. Manager is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowMobilePhoneToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the mobile device number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowPostalCodeToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the postal or ZIP code field in the user’s contact information. Postal code is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. Postal code is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowPostalCodeToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowPostalCodeToGuestUsers | Type boolean Properties Filter Description Indicates the visibility of the postal or ZIP code field in the user’s contact information. When true, postal code is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value ​false in UserPreferencesShowPostalCodeToExternalUsers, making the user’s postal code visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowProfilePicToGuestUsers | Type boolean Properties Filter Description Indicates the visibility of the user’s profile photo. When true, the photo is visible to guest users in an Experience Cloud site. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the stock photo. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowStateToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the state field in the user’s contact information. State is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. State is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowStateToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowStateToGuestUsers | Type boolean Properties Filter Description Indicates the visibility of the state field in the user’s contact information. When true, state is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowStateToExternalUsers, making the user’s state visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowStreetAddressToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the street address field in the user’s contact information. The address is visible only to internal members of the user’s organization when this field is false. The address is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesShowTitleToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the business title field in the user’s contact information. Title is visible only to internal members of the user’s organization when: - This field is false. When false, this field returns the value #N/A. Title is visible to external members in an Experience Cloud site when: - This field is true, or - This field is false but UserPreferencesShowTitleToGuestUsers is true, which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is true. This field is available in API version 26.0 and later. | | UserPreferencesShowTitleToGuestUsers | Type boolean Properties Filter Description Indicates the visibility of the business title field in the user’s contact information. When true, title is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowTitleToExternalUsers, making the user’s title visible to external members. The default value is false. This field is available in API version 28.0 and later. | | UserPreferencesShowWorkPhoneToExternalUsers | Type boolean Properties Filter Description Indicates the visibility of the work phone number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in an Experience Cloud site when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. | | UserPreferencesTaskRemindersCheckboxDefault | Type boolean Properties Filter Description When true, a reminder popup is automatically set on the user's tasks. Corresponds to the By default, set reminder on Tasks to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders. | ## Usage Use this object to query Chatter—related information about the user. While the User object contains all the information about a user and is historically tied to user management, UserProfile is a read-only entity that contains the information that is relevant in a Chatter context. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [UserProfileFeed](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.") (API version 18.0–26.0) Feed tracking is available for the object. # UserProvAccount Represents information that links a Salesforce user account with an account in a third-party (target) system, such as Google, for users of connected apps with Salesforce user provisioning enabled. This object is available in API version 33.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ConnectedAppId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 15 character application ID. This is a relationship field. Relationship Name ConnectedApp Relationship Type Lookup Refers To ConnectedApplication | | DeletedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the associated user account in the target system was deleted. This value is automatically updated during the provisioning and reconciling processes. | | ExternalEmail | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The email address as stored in the target system for the associated user account. | | ExternalFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first name as stored in the target system for the associated user account. | | ExternalLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last name as stored in the target system for the associated user account. | | ExternalUserId | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier for the user as stored in the target system. | | ExternalUsername | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The username as stored in the target system for the associated user account. | | IsKnownLink | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Setting the IsKnownLink value to true implies the administrator or another user is managing the relationship between the Salesforce user account and the third-party user account, manually. This field helps Salesforce coordinate updates between the UserProvAccountStaging object and the UserProvAccount object while committing staged accounts. Typically, for a matching user account (the same ExternalUserId for both objects), Salesforce copies the values from the UserProvAccountStaging object to the UserProvAccount object. However, if Salesforce encounters a UserProvAccountStaging object with a matching ExternalUserId but different LinkState and SalesforceUserId values during this process, Salesforce checks the UserProvAccount IsKnownLink value. If the IsKnownLinkvalue is true, Salesforce doesn’t copy the LinkState and SalesforceUserId values from the UserProvAccountStaging object to the UserProvAccount object (all other values are copied). The default is false, meaning Salesforce manages the account relationship. | | LinkState | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The state of the current connection between the user account in the Salesforce organization and the associated user account in the target system. The valid values are: - linked— changes to the account in the Salesforce organization are queued to be updated for the associated user account in the target system. - duplicate— an associated account in the target system exists. - orphaned—no associated account exists in the target system. - ignored— changes to the account in the Salesforce organization have no effect on the associated user account in the target system. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name for this object. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Namepointing, Sort, Update Description The user ID of the owner of this object—typically a Salesforce administrator. | | SalesforceUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user ID for the user account in the Salesforce organization that is associated with the user account in the target system. This is a relationship field. Relationship Name SalesforceUser Relationship Type Lookup Refers To User | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the account in the target system. The valid values are: - Active - Deactivated - Deleted | # UserProvAccountStaging Temporarily stores user account information while a user completes the User Provisioning Wizard. This information that is stored in the UserProvAccount object when you click the button to collect and analyze accounts on the target system. User provisioning links a Salesforce user account with an account in a third-party (target) system. To configure user provisioning, you use a User Provisioning Wizard that guides you through the setup process. As you enter values about account details in the wizard, these values are stored in this object until you click the button to collect and analyze accounts on the target system. The general user provisioning configuration details are stored in the UserProvisioningConfig object. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ConnectedAppId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 15 character connected app ID. This is a relationship field. Relationship Name ConnectedApp Relationship Type Lookup Refers To ConnectedApplication | | ExternalEmail | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The email address as stored in the target system for the associated user account. | | ExternalFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first name as stored in the target system for the associated user account. | | ExternalLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last name as stored in the target system for the associated user account. | | ExternalUserId | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier for the user as stored in the target system. | | ExternalUsername | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The username as stored in the target system for the associated user account. | | LinkState | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The state of the current connection between the user account in the Salesforce organization and the associated user account in the target system. The valid values are: - linked— a user account matches one in the target system. - duplicate— an associated account in the target system exists. - orphaned—no associated account exists in the target system. - ignored— changes to the account in the Salesforce organization have no effect on the associated user account in the target system. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name for this object. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user ID of the owner of this object—typically a Salesforce administrator. | | SalesforceUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user ID for the user account in the Salesforce organization that is associated with the user account in the target system. This is a relationship field. Relationship Name SalesforceUser Relationship Type Lookup Refers To User | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the account in the target system. The valid values are: - Active - Deactivated - Deleted | ## Usage When committing fields from a UserProvAccountStaging to a UserProvAccount object, Salesforce looks up the UserProvAccount record where UserProvAccountStaging.ExternalUserId = UserProvAccount.ExternalUserId. - If an ExternalUserId doesn't match an existing account, Salesforce creates a UserProvAccount record based on the UserProvAccountStaging record. - If an ExternalUserId matches, then Salesforce checks the UserProvAccount.isKnownLink value, and does the following. - If UserProvAccount.IsKnownLink = true, Salesforce copies the UserProvAccountStaging values to the UserProvAccount object, except for the ExternalUserId and LinkState values. - If UserProvAccount.IsKnownLink = false, Salesforce copies all of the UserProvAccountStaging values to the UserProvAccount object. # UserProvisioningConfig Represents information for a flow to use during a user provisioning request process, such as the attributes for an update. This object is available in API version 34.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ApprovalRequired | Type textarea Properties Create, Nillable, Update Description Denotes whether approvals are required for provisioning users for the associated connected app. If the value is null, no approval is required. | | ConnectedAppId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 18-digit application ID for the connected app. This is a relationship field. Relationship Name ConnectedApp Relationship Type Lookup Refers To ConnectedApplication | | DeveloperName | Type string Properties 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 org. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | Enabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether user provisioning is enabled for the associated connected app (true) or not (false). | | EnabledOperations | Type textarea Properties Create, Nillable, Update Description Lists the operations, as comma-separated values, that create a UserProvisioningRequest object for the associated connected app. Allowed values are: - Create - Update - EnableAndDisable (activation and deactivation) - SuspendAndRestore (freeze and unfreeze) | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The two- to five-character code that represents the language and locale ISO. This code controls the language for labels displayed in an application. | | LastReconDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when user accounts were last reconciled between Salesforce and the target system. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The primary label for this object. This value is the internal label that doesn’t get translated. | | NamedCredentialId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce ID of the named credential that’s used for a request. The named credential identifies the third-party system and the third-party authentication settings. This is a relationship field. Relationship Name NamedCredential Relationship Type Lookup Refers To NamedCredential | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Notes | Type textarea Properties Create, Nillable, Update Description A utility field for administrators to add any additional information about the configuration. This field is for internal reference only, and is not used by any process. | | OnUpdateAttributes | Type textarea Properties Create, Nillable, Update Description Lists the user attributes, as comma-separated values, that generate a UserProvisioningRequest object during an update. | | ReconFilter | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description When collecting and analyzing users on a third-party system, the plug-in uses this filter to limit the scope of the collection. | | UserAccountMapping | Type textarea Properties Create, Nillable, Update Description Stores the attributes used to link the Salesforce user to the account on the third-party system, in JSON format. For example: {"linkingSalesforceUserAttribute":"Username", "linkingTargetUserAttribute":"Email"} | # UserProvisioningLog Represents messages generated during the process of provisioning users for third-party applications. This object is available in API version 33.0 and later. Some messages for this object are generated automatically by Salesforce, and others are created by the developers of the user provisioning plugin. Developers can use this object to log messages from the flow associated with the user provisioning process or the Apex plugin that calls the target system. Administrators can use this object as a log of all user provisioning activity and as a troubleshooting tool if desired behavior is missing. This object is available as a custom report type. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Details | Type textarea Properties Create, Nillable, Update Description The value of this field depends on the log entry. For example, if the target system returns an error, the error message may be recorded in this field. | | ExternalUserId | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier for the user in the target system. | | ExternalUsername | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The username set in the target system for the associated user account. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name for this object. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce ID of the Group or User who owns this object. | | Status | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The status of the user provisioning request. Based on the context of the log, it can contain different values, such as an HttpStatusCode. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce ID of the user making the request. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | | UserProvisioningRequestId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A unique identifier for the user provisioning request. This is a relationship field. Relationship Name UserProvisioningRequest Relationship Type Lookup Refers To UserProvisioningRequest | # UserProvisioningRequest Represents an individual provisioning request to create, update, or delete a single user account in a third-party service system (or another Salesforce organization). This object is available in API version 33.0 and later. A UserProvisioningRequest (UPR) record is created for each provisioning action for each user, and for each connected app available to the user. For example, if a user has two connected apps, and a provisioning request is sent to two different services to create an account for the user, Salesforce creates two UPR objects. Provisioning actions include creating, updating, or deleting a user account. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AppName | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique name of the connected app associated with the service provider. | | ApprovalStatus | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the approval for the current request. If the user provisioning setup for the connected app does not have an approval process enabled, the status is Not Required. If an approval process is enabled, supported values are: - Required— An approval process is enabled in the user provisioning setup for the associated connected app, but there is no response to the request yet. - Not Required— An approval process is not enabled in the user provisioning setup for the associated connected app. - Approved - Denied | | ConnectedAppId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 18-digit application ID for the connected app. This is a relationship field. Relationship Name ConnectedApp Relationship Type Lookup Refers To ConnectedApplication | | ExternalUserId | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier for the user in the target system. | | ManagerId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce ID of the user who manages the user specified in the SalesforceUserId field. If an approval process is configured for the user provisioning request. this value allows the manager to approve the request. Available in API version 34.0 and later. This is a relationship field. Relationship Name Manager Relationship Type Lookup Refers To User | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name for this object. | | Operation | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The Apex method called by the trigger associated with the provisioning request (typically a change to the User object). Supported values are: - Create - Read - Update - Deactivate - Activate - Freeze - Unfreeze - Reconcile - Linking For example, when the User object field isActive is set to false, the UPR object Operation field value is set to Deactivate. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce ID of the Group or User who owns this object. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentID | Type reference Properties Create, Filter, Group, Sort, Update Description When a retry event is created, the failed UPR is cloned and resubmitted. This field contains a lookup to the failed UPR that was cloned to create the current record. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To UserProvisioningRequest | | Retry Count | Type int Properties Create, Filter, Group, Sort, Update Description Number of retry attempts performed on a UPR. Retry Count enables custom business logic such as “Retry 5 times then stop and notify your admin.” | | SalesforceUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce ID of the user making the request. This is a relationship field. Relationship Name SalesforceUser Relationship Type Lookup Refers To User | | ScheduleDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description When to send this request to the service provider. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Scheduling is not implemented yet. Currently, provisioning changes are queued immediately to be sent to the service provider. | | State | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Status of this request. Supported values are: - New - Requested - Completed - Failed - Collecting - Collected - Analyzing - Analyzed - Committing - Retried - Manually Completed The State goes from New to Requested to Completed or Failed, unless a reconciliation process is occurring. For details about the reconciliation process State value changes, see [Usage](#usage). The State goes from Failed to Retried or Manually Completed when troubleshooting UPR failures. For details about handling failures, see [State Values for Managing Provisioning Failures](#troubleshooting). | | UserProvAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID value of the associated UserProvAccount object. This is a relationship field. Relationship Name UserProvAccount Relationship Type Lookup Refers To UserProvAccount | | UserProvConfigId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID value of the associated UserProvisioningConfig object. Available in API version 34.0 and later. This is a relationship field. Relationship Name UserProvConfig Relationship Type Lookup Refers To UserProvisioningConfig | ## Usage The State value changes during a reconciliation process (Operation = Reconcile) to gather and compare users on the third-party system to Salesforce users. Typically, when a UPR entry is first created, it has a State value of New. When a collection process is triggered, the State transitions to Collecting until that process is finished and the State is Collected. When an analyze process is triggered, the State transitions to Analyzing until that process is finished and the State is Analyzed. If a process commits the request, the State then transitions to Committing, and the properties move from the UserProvAccountStaging object to the UserProvAccount object. When those properties are saved in the UserProvAccount object, the State transitions to Completed. However, the State does not necessarily start at New. For example, UserProvAccountStaging entries can be inserted programmatically. If a process is initiated that triggers linking these rows to accounts on the third-party service, a UPR entry could start with the Analyzing State. Also, the State cannot go backwards from an active task. For example, a successful Analyzing State must progress to Analyzed; unless the active process fails, and then the State must change to Failed. Certain State transitions cannot be made programmatically and must be triggered by Salesforce. The following table shows the State transitions that can occur for each State value. Each row corresponds to a current State value and each column corresponds to a new State after a potential transition. - ![no](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/x_16.png) — the transition to this value is not allowed. - ![yes](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/checkmark_16.png) — the transition to this value is allowed. - ![Salesforce only](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/dev_guides/api/images/salesforce_logo_16.png) — only Salesforce can transition the State to this value.
      New Requested Collecting Collected Analyzing Analyzed Committing Completed Failed Retried Manually Completed
      New yes Salesforce only yes yes yes yes yes yes yes no no
      Requested no yes Salesforce only Salesforce only Salesforce only Salesforce only Salesforce only Salesforce only Salesforce only no no
      Collecting no no yes Salesforce only Salesforce only Salesforce only Salesforce only Salesforce only Salesforce only no no
      Collected no no no yes yes yes yes yes yes no no
      Analyzing no no no Salesforce only yes Salesforce only Salesforce only Salesforce only Salesforce only no no
      Analyzed no no no no no yes yes yes yes no no
      Committing no no no no no Salesforce only yes Salesforce only Salesforce only no no
      Completed no no no no no no no yes no no no
      Failed no no no no no no no no yes yes yes
      Retried no no no no no no no no no no no
      Manually Completed no no no no no no no no no no no
      ## State Values for Managing Provisioning Failures The state value changes to Failed for several reasons, such as network outages, session timeouts, permissions issues, and record locks. The Failed state can transition to either Retried or Manually Completed to indicate what action was taken to address the failure. Actions can include correcting the root cause of the failure and requesting that the provisioning engine retry the UPR. Or, it can be completing the action against the target manually. Each UPR is an independent transaction and it’s possible the retry causes a failure with a different root cause. So it’s hard to distinguish failed events that you addressed from the ones that require more action. If you tried to correct the cause of the failure and requested the provisioning engine to retry the UPR, you can mark the failed UPR Retried. Or, if the action against the target was completed manually, you can mark it Manually Completed. When a retry event is created, the failed UPR is cloned, and resubmitted. The ParentID field contains a lookup to the failed UPR to use to clone the new UPR. The Retry Count field contains the number of retry attempts that were performed on a UPR. With the Retry Count field, you can add custom business logic like "Retry 5 times then stop and notify your admin." ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [UserProvisioningRequestOwnerSharingRule](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.") (API version 34.0) Sharing rules are available for the object. [UserProvisioningRequestShare](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.") (API version 34.0) Sharing is available for the object. # UserProvMockTarget Represents an entity for testing user data before committing the data to a third-party system for user provisioning. During the user provisioning process, user account information is sent to a third-party system to create, update or delete a user account on that system. While configuring user provisioning for your organization using a flow or Apex action, you can use this object to confirm the associated flow or Apex code is sending the desired data. After confirming the correct fields and values, you can update the flow or Apex action to send the data to the target system. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ExternalEmail | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The email address as stored in the target system for the associated user account. | | ExternalFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first name as stored in the target system for the associated user account. | | ExternalLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last name as stored in the target system for the associated user account. | | ExternalUserId | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier for the user as stored in the target system. | | ExternalUsername | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The username as stored in the target system for the associated user account. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique name for this object. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user ID of the owner of this object—typically a Salesforce administrator. | # UserRecordAccess Represents a user’s access to a set of records. This object is read only and is available in API version 24.0 and later. This object doesn’t consider whether a user’s access is blocked by a restriction rule. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | HasAllAccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user can share the record. | | HasDeleteAccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has delete access to the record (true) or not (false). | | HasEditAccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has edit access to the record (true) or not (false). | | HasTransferAccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has transfer access to the record (true) or not (false). | | HasReadAccess | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has read access to the record (true) or not (false). | | MaxAccessLevel | Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Indicates a user’s maximum level of access to a record. Valid values are: - None - Read - Edit - Delete - Transfer - All | | RecordId | Type picklist Properties Filter, Group, Restricted picklist, Sort Description ID of the record. | | UserId | Type reference Properties Filter, Group Description ID of the user. | ## Usage Use this object to query a user’s access to records. You can only query records of objects listed on the Sharing Settings Setup page. You can’t create, delete, or update any records using this object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note UserRecordAccess doesn’t consider whether a user’s access is blocked due to a [restriction rule](https://developer.salesforce.com/docs/atlas.en-us.264.0.restriction_rules.meta/restriction_rules/restriction_rules_about.htm). If a user’s access is blocked even though query results state that they should have access, check to see if a restriction rule on the object prevents the user’s access. Up to 200 record IDs can be queried. You can include an ORDER BY clause for any field that is being selected in the query. The following sample query returns the records, whether the queried user has read and transfer access to each record, and the user’s maximum access level to each record. SELECT RecordId, HasReadAccess, HasTransferAccess, MaxAccessLevel FROM UserRecordAccess WHERE UserId = \[single ID\] AND RecordId = \[single ID\] //or Record IN \[list of IDs\] The following query returns the records to which a queried user has read access. SELECT RecordId FROM UserRecordAccess WHERE UserId = \[single ID\] AND RecordId = \[single ID\] //or Record IN \[list of IDs\] AND HasReadAccess = true Using API version 30.0 and later, UserRecordAccess is a foreign key on the records. You can’t filter by or provide the UserId or RecordId fields when using this object as a lookup or foreign key. The previous sample queries can be run as: SELECT Id, Name, UserRecordAccess.HasReadAccess, UserRecordAccess.HasTransferAccess, UserRecordAccess.MaxAccessLevel FROM Account SELECT Id, Name, UserRecordAccess.HasReadAccess FROM Account SOQL restrictions: - When the running user is querying a user's access to a set of records, records that the running user doesn’t have read access to are filtered out of the results. - When filtering by UserId and RecordId only, you must use SELECT RecordId and optionally one or more of the access level fields:HasReadAccess, HasEditAccess, HasDeleteAccess, HasTransferAccess, and HasAllAccess. You can include MaxAccessLevel. - When filtering by UserId, RecordId, and an access level field, you must use SELECT RecordId only. #### See Also - [_Developer Guide_: Restriction Rules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) # UserRelatedRecordContent Represents the link between a managed content record, an account, event, or opportunity record, and a user record. This object is reserved for future use. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ContentOwnerId | Type reference Properties Create, Filter, Group, Sort Description The user who owns the managed content record associated with the given account, event, or opportunity record. This field is a relationship field. Relationship Name ContentOwner Refers To User | | ManagedContentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the managed content record created for the associated Salesforce record. One unique managed content record is created per account, event, or opportunity record per user. This field is a relationship field. Relationship Name ManagedContent Refers To ManagedContent | | RelatedRecordId | Type reference Properties Create, Filter, Group, Sort Description The ID of the Salesforce record (e.g., account, opportunity, or event) associated with the managed content record. This field is a polymorphic relationship field. Relationship Name RelatedRecord Refers To Account, Event, Opportunity | # UserRole Represents a user role in your organization. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object was called “Role” in previous versions of the API documentation. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only users with the View Roles and Role Hierarchy permission can access this object, and only users with the Manage Roles permission can edit this object. ## Fields | Field | Details | | --- | --- | | CaseAccessForAccountOwner | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The case access level for the account owner. | | ContactAccessForAccountOwner | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The contact access level for the account owner. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note When DefaultContactAccess is set to Controlled by Parent, you can’t create or update this field. | | DeveloperName | Type string Properties Create, Filter, Group, Nillable, 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 org. 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. Corresponds to **Role Name** in the user interface. This field is available in API version 24.0 and later. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. | | ForecastUserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the forecast manager associated with this role. Label is **User ID**. | | IsPartner | Type boolean Properties Defaulted on create, Filter Description Indicates whether the user role is a partner who has access to the partner portal (true) or not (false). This field is not available for release 9.0 and later. Instead, use PortalType with the value Partner. | | MayForecastManagerShare | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the forecast manager can manually share their own forecast. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the role. Corresponds to **Label** on the user interface. | | OpportunityAccessForAccountOwner | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The opportunity access level for the account owner. Note that you can’t set a user role with an opportunity access less than that specified in organization-wide defaults. | | ParentRoleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent role. | | PortalAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the role’s associated portal account. This field is read-only. | | PortalAccountOwnerId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the role’s associated portal account’s owner. This field is read-only. | | PortalRole | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The portal role: Executive, Manager, User, or PersonAccount. | | PortalType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description This value indicates the type of portal for the role: - None: Salesforce application role. - CustomerPortal: Customer portal role. - Partner: partner portal role. The field IsPartner used in release 8.0 will map to this value. This field replaces [IsPartner](# "Represents a user role in your organization.") beginning with release 9.0. | | RollupDescription | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the forecast rollup. Label is **Description**. | ## Usage Use this object to query the set of currently configured user roles in your organization. Use it in your client application to obtain valid UserRole IDs to use when querying or modifying a User record. Users with the View Roles and Role Hierarchy permission can query or describe this object. If your client application logs in with the “Manage Users” permission, it can query, create, update, or delete UserRole records. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note You can’t update any field for a portal role. For example, the following code finds all roles that are not assigned to any users. SELECT Id, Name, DeveloperName FROM UserRole WHERE Id NOT IN (SELECT UserRoleId FROM User WHERE UserRoleId !='000000000000000') #### See Also - [Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Salesforce objects and fields are analogous to database tables and the table columns. Objects and fields structure data. For example, the central object in the Salesforce data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors.") # UserServicePresence Represents a presence user’s real-time presence status. This object is available in API version 32.0 and later. ## Supported Calls delete(), query(), getDeleted(), getUpdated(), retrieve(), undelete() ## Special Access Rules To access this object, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&type=5&language=en_US) must be enabled. ## Fields | Field | Details | | --- | --- | | AtCapacityDuration | Type int Properties Filter, Group, Nillable, Sort Description The duration that the user is at full capacity. This field is updated when the agent’s capacity changes, such as when the agent is assigned, declines, or closes a work item. Available in API versions 34.0 and later. | | AverageCapacity | Type double Properties Filter, Nillable, Sort Description The user’s average capacity. This field is updated when the agent’s capacity changes, such as when the agent is assigned, declines, or closes a work item. Available in API versions 34.0 and later. | | ConfiguredCapacity | Type int Properties Filter, Group, Nillable, Sort Description The user’s total configured primary capacity. | | ConfiguredInterruptCapacity | Type int Properties Filter, Group, Nillable, Sort Description The user’s total configured interruptible capacity. Available in version 57.0 and later when the Interruptible Capacity feature is enabled. | | | | | IdleDuration | Type int Properties Filter, Group, Nillable, Sort Description The duration that the user is idle. This field is updated when the agent’s capacity changes, such as when the agent is assigned, declines, or closes a work item. Available in API versions 34.0 and later. | | IsAway | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user’s status is Away. The default value is false. | | IsCurrentState | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a presence status is the user’s current state. If true, the agent is in that presence status. Available in API versions 34.0 and later. The default value is false. | | Name | Type string Properties Create, Filter, Nillable, Sort, Update Description An automatically generated ID number that identifies the record. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the owner of the UserServicePresence entity. For external routing, allows the entity to be used in the Streaming API to listen to events whenever a UserServicePresence record is created, modified, or deleted. | | ServicePresenceStatusId | Type reference Properties Create, Filter, Nillable, Sort, Update Description The ID of the presence status that’s associated with the presence user that’s specified by the UserId. | | StatusDuration | Type int Properties Filter, Group, Nillable, Sort Description The duration of the user service presence status. This field is set only when the current user service presence status ends, such as when the agent changes to another presence status or logs out. Available in API versions 34.0 and later. This field is a calculated field: StatusEndDate - StatusStartDate. | | StatusEndDate | Type dateTime Properties Filter, Nillable, Sort Description The end date of the user service presence status. This field is set only when the current user service presence status ends, such as when the agent changes to another presence status or logs out. Available in API versions 34.0 and later. | | StatusStartDate | Type dateTime Properties Filter, Nillable, Sort Description The start date of the user service presence status. Available in API versions 34.0 and later. | | UserId | Type string Properties Create, Filter, Group, Sort, Update Description The ID of the Omni-Channel user. | ## Usage Apex triggers aren’t supported with UserServicePresence. In API version 41.0 or later, UserServicePresence records can be deleted programmatically. The Customize Application permission is required. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [UserServicePresenceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [UserServicePresenceOwnerSharingRule](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. [UserServicePresenceShare](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. # UserSetupEntityAccess Represents the enabled custom permissions of the running user. This object is available in API version 48.0 and later. ## Supported Calls describeSObjects(), query() ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Filter, Group, Nillable, Sort Description The unique name of the custom permission in the API. 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. | | DurableId | Type string Properties Filter, Group, Nillable, Sort Description This field isn't used. | | KeyPrefix | Type string Properties Filter, Group, Nillable, Sort Description The first 3 characters of the SetupEntityId. | | LastCacheUpdate | Type dateTime Properties Filter, Nillable, Sort Description The last modified date and time of the running user's info. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that’s associated with the custom permission. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | SetupEntityId | Type string Properties Filter, Group, Nillable, Sort Description The ID of the custom permission assigned to the user. | ## Usage API users without the View Setup and Configuration permission can use this object to check their assigned custom permissions. # UserShare Represents a sharing entry on a user record. This object is available in API version 26.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only standard users or users with the Customize Application permission can access this object. ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field | Details | | --- | --- | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the User has access to log in (true) or not (false). You can modify a User's active status from the user interface or via the API. | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Possible values include: - Manual—The User or Group has access to the user record because a User with “All” access manually shared the User with them. - Rule—The User or Group has access to the user record via a User sharing rule. - GuestRule—The User or Group has access via a User guest user sharing rule. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. | | UserAccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the specified user. The specified user is denoted by the UserId. The possible values are: - Read - Edit This field must be set to an access level that is at least equal to the organization’s default UserAccessLevel. UserAccessLevel can be updated only if RowCause is set to Manual Sharing. | | UserId | Type reference Properties Create, Filter, Group, Sort Description ID of the User being shared. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the User. This field can’t be updated. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | ## Usage This object allows you to determine which users and groups can view or edit User records owned by other users. # UserSharedFeature For internal use only. # UserTeamMember Represents a single User on the default opportunity team of another User. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - This object is available only in organizations that have enabled the team selling functionality. - Customer Portal users can’t access this object. ## Fields | Field | Details | | --- | --- | | OpportunityAccessLevel | Type picklist Properties Create, Filter, Restricted picklist, Update Description Required. Level of access that the team member has to opportunities for which the user has added his or her default opportunity team. The possible values are: - Read - Edit This field must be set to an access level that is higher than the organization’s default access level for opportunities. | | OwnerId | Type reference Properties Create, Filter Description Required. ID of the User who owns the default opportunity team. This field can’t be updated. | | TeamMemberRole | Type picklist Properties Create, Filter, Nillable, Update Description Role that the team member has on opportunities for which the User has added his or her default opportunity team. The valid values are set by the organization’s administrator in the Opportunity Team Roles picklist. Label is **Team Role**. | | UserId | Type reference Properties Create, Filter Description Required. ID of the User who is a member of the default opportunity team. This field can’t be updated. | ## Usage If you attempt to create a record that matches an existing record, the create request updates any modified fields and returns the existing record. Users can set up their default opportunity team to include other users that typically work with them on opportunities. #### See Also - [OpportunityTeamMember](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunityteammember.htm "Represents a User on the opportunity team of an Opportunity.") # UserTerritory Represents a User who has been assigned to a Territory. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules - Only available if territory management has been enabled for your organization. - As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object, and only users with the Manage Territories permission can edit this object. ## Fields | Field | Details | | --- | --- | | IsActive | Type boolean Properties Defaulted on create, Filter Description Indicates whether the user is active in the given territory (true), or inactive in the given territory (false): - Users who are active in a territory are explicitly assigned to the territory and can have open opportunities, closed opportunities, or no opportunities associated with that territory. - Users who are inactive in a territory are not explicitly assigned to the territory, but own an open or closed opportunity that is associated with the territory. For example, a user may have been transferred out of a territory, but still own opportunities in his or her old territory. Until a user is deleted from a territory (not simply removed from the territory), the record is not returned in a getDeleted() call. | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | TerritoryId | Type reference Properties Create, Filter Description ID of the Territory to which the user has been assigned. This field is required when creating a record in API version 20.0 and later. | | UserId | Type reference Properties Create, Filter Description ID of the user. This field is required when creating a record. | ## Usage If a user is inactive in a territory, and the opportunities they own that are associated with the territory are all closed, the user is not returned in the Territories related list on the User page in Setup. Regardless of whether the user is inactive or the opportunities are closed, the user is returned in the Quotas related list. #### See Also - [Territory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_territory.htm "Represents a flexible collection of accounts and users where the users have at least read access to the accounts, regardless of who owns the accounts. Available if Sales Territories has been enabled. This object is available in API versions 7.0 to 52.0. Use Territory2 instead of Territory in API version 52.0 and later.") - [AccountTerritoryAssignmentRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountterritoryassignmentrule.htm "An account assignment rule that assigns accounts to territories based on account fields. Available if Sales Territories has been enabled.") - [AccountTerritoryAssignmentRuleItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountterritoryassignmentruleitem.htm "A row of selection criteria for an AccountTerritoryAssignmentRule object. Available if Sales Territories has been enabled.") # UserTerritory2Association Represents an association (by assignment) between a territory and a user record. Available only if Sales Territories has been enabled. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve() ## Special Access Rules Standard and partner users can access this object. If a territory model is in Active state, any standard or partner user can view that model, including its territories and assignment rules. For territories in an active model, any standard or partner user can view assigned records and assigned users based on your Salesforce sharing settings. Users cannot view territory models in other states (such as Planning or Archived). ## Fields ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note UserTerritory2Association doesn’t support adding custom fields. | Field Name | Details | | --- | --- | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user is active (true) or inactive (false) in the given territory. | | RoleInTerritory2 | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The role of the user in a territory. Possible values are: Owner, Administrator, Sales Rep. Label is Role in Territory. | | Territory2Id | Type reference Properties Create, Filter, Group, Sort Description The ID of the territory that the user is assigned to. | | UserId | Type reference Properties Create, Filter, Group, Sort Description The ID of the user who is assigned to the territory. | # UserTerritory2AssocLog Represents a log of when a user is assigned and unassigned from a territory. This object is available in API version 57.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Special Access Rules To see this object, enable Sales Territory and User Tracking on the Territory Settings page. Activate a territory model to start the tracking. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description ISO code of currency. Possible values are: - EUR—Euro - INR—Indian Rupee - USD—U.S. Dollar The default value is USD. | | EndDate | Type dateTime Properties Filter, Nillable, Sort Description Date when the user is unassigned from a territory. If the end date is empty, the user is still assigned. | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description Auto-generated unique name of the log. | | RoleInTerritory2 | Type picklist Properties Filter, Group, Nillable, Sort Description User’s role in the territory between the start and end date. The picklist is, by default, empty. Add values to this field using Object Manager. | | StartDate | Type dateTime Properties Filter, Sort Description Date the user is assigned to the territory. | | Territory2Id | Type reference Properties Filter, Group, Sort Description ID of the territory associated with the log. This field is a relationship field. Relationship Name Territory2 Refers To Territory2 | | Territory2ModelId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the territory model associated with the log. This field is a relationship field. Relationship Name Territory2Model Refers To Territory2Model | | UserId | Type reference Properties Filter, Group, Sort Description ID of the user associated with the log. This field is a relationship field. Relationship Name User Refers To User | # UserUIPreference Represents user preferences for Salesforce components. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules ## Fields | Field | Details | | --- | --- | | AsyncOperationTrackers | Type textarea Properties Create, Update Description Stores a JSON object that maps each quote ID to its asynchronous sales transaction request details, which includes a tracker ID and the start date. This field is available with Revenue Cloud in API version 66.0 and later. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The system-generated number for the user preferences. Read-only. | | ObjectScope | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of the object that the preference applies to. For example, the preference applies to the Quote object. | | PreferenceAttribute | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the type of preference. | | SourceScope | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the component, feature, or product that the preference is for. For example, a preference for column widths that's associated with the Transaction Line Table component in Revenue Cloud. | | UserId | Type reference Properties Create, Filter, Group, Sort Description The user associated with the user preferences. This field is a relationship field. Relationship Name User Relationship Type Master-detail Refers To User (the master object) | | Value | Type textarea Properties Create, Update Description The JSON for the user's preferences. | # UserWorkList Represents a list of work items in the My List tab for Sales Engagement users. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the work list is active or not. | | ListType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of list, such as a call or email. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the work list. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the list. | # UserWorkListItem Represents an individual work item in the My List tab for Sales Engagement users. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | PriorityOrder | Type int Properties Filter, Group, Nillable, Sort Description The order of the item in the list. | | RelatedRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the related record. | | UserWorkListId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related work list. | # VendorCallCenterStatusMap Stores a mapping between a call center vendor agent status and a Salesforce presence status for an associated call center. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules To access this object, Omni-Channel and Salesforce Voice must be enabled. ## Fields | Field | Details | | --- | --- | | CallCenterId | Type reference Properties Create, Filter, Group, Sort, Update Description Reference to a call center. This is a relationship field. Relationship Name CallCenter Relationship Type Lookup Refers To CallCenter | | ExternalStatus | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Status value to set for the call center vendor agent. | | ServicePresenceStatusId | Type reference Properties Create, Filter, Group, Sort, Update Description Reference to a presence status that can be assigned to a service channel. This is a relationship field. Relationship Name ServicePresenceStatus Relationship Type Lookup Refers To ServicePresenceStatus | # VerificationHistory Represents the past six months of your org users’ attempts to verify their identity. This object is available in API version 36.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules Only users with Manage Users permission can access this object. ## Fields | Field Name | Details | | --- | --- | | Activity | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The action the user attempted that requires identity verification. The label is User Activity. Available values are: - AccessReports—The user attempted to access reports or dashboards. - Apex—The user attempted to access a Salesforce resource with a verification Apex method. - ChangeEmail—The user attempted to change an email address. - ConnectSms—The user attempted to connect a phone number. - ConnectToopher—The user attempted to connect Salesforce Authenticator. - ConnectTotp—The user attempted to connect a one-time password generator. - ConnectU2F—The user attempted to register a U2F security key. - ConnectWebAuth—The user attempted to register a built-in authenticator. - ConnectedApp—The user attempted to access a connected app. - EnableLL—The user attempted to enroll in Lightning Login. - ExportPrintReports—The user attempted to export or print reports or dashboards. - ExternalClientApp— The user attempted to access an external client app. - ExtraVerification—Reserved for future use. - ListView—The user attempted to access a list view. - Login—The user attempted to log in. - Registration—Reserved for future use. - TempCode—The user attempted to generate a temporary verification code. - VerifyEmail—The user attempted to verify the email address. | | EventGroup | Type int Properties Filter, Group, Sort Description ID of the verification attempt. Verification can involve several attempts and use different verification methods. For example, in a user’s session, a user enters an invalid verification code (first attempt). The user then enters the correct code and successfully verifies identity (second attempt). Both attempts are part of a single verification and, therefore, have the same ID. The label is Verification Attempt. | | LoginGeoId | Type reference Properties Filter, Group, Nillable, Sort Description The 18-character ID for the record of the geographic location of the user for a successful or unsuccessful identity verification attempt. Due to the nature of geolocation technology, the accuracy of geolocation fields (for example, country, city, postal code) can vary. This is a relationship field. Relationship Name LoginGeo Relationship Type Lookup Refers To LoginGeo | | LoginHistoryId | Type reference Properties Filter, Group, Sort Description The ID for the record of the user’s successful or unsuccessful login attempt. This is a relationship field. Relationship Name LoginHistory Relationship Type Lookup Refers To LoginHistory | | Policy | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The identity verification security policy or setting. The label is Triggered By. Available values are: - CustomApex—Identity verification made by a verification Apex method. - DeviceActivation—Identity verification required for users logging in from an unrecognized device or new IP address. This verification is part of Salesforce’s risk-based authentication. - EnableLightningLogin—Identity verification required for users enrolling in Lightning Login. This verification is triggered when the user attempts to enroll. Users are eligible to enroll if they have the Lightning Login User user permission and the org has enabled Allow Lightning Login in Session Settings. - ExtraVerification—Reserved for future use. - HighAssurance—High assurance session required for resource access. This verification is triggered when the user tries to access a resource, such as a connected app, report, or dashboard, that requires a high-assurance session level. - LightningLogin—Identity verification required for internal users logging in via Lightning Login. This verification is triggered when the enrolled user attempts to log in. Users are eligible to log in if they have the Lightning Login User user permission and have successfully enrolled in Lightning Login. Also, from Session Settings in Setup, Allow Lightning Login must be enabled. - PageAccess—Identity verification required for users attempting to perform an action, such as changing an email address or adding a verification method for multi-factor authentication (MFA). - PasswordlessLogin—Identity verification required for customers attempting to log in to an Experience Cloud site that is set up for passwordless login. The admin controls which registered verification methods can be used, for example, email, SMS, Salesforce Authenticator, or TOTP. - ProfilePolicy—Session security level required at login. This verification is triggered by the Session security level required at login setting on the user’s profile. - TwoFactorAuthentication—Multi-factor authentication (formerly called two-factor authentication) required at login. This verification is triggered by the Multi-Factor Authentication for User Interface Logins user permission assigned to a custom profile. Or the user permission is included in a permission set that is assigned to a user. | | Remarks | Type string Properties Filter, Group, Nillable, Sort Description The text the user sees on the page or in Salesforce Authenticator when prompted to verify identity. For example, if identity verification is required for a user’s login, the user sees “You’re trying to Log In to Salesforce.” In this case, the Remarks value is “Log In to Salesforce.” But if the Activity value is Apex, the Remarks value is a custom description passed by an Apex method. If the user is verifying identity using Salesforce Authenticator, the custom description also appears in the app. If the custom description isn’t specified, the value is the name of the Apex method. The label is Activity Message. | | ResourceId | Type reference Properties Filter, Group, Nillable, Sort Description If the Activity value is ConnectedApp, the ResourceId value is the ID of the connected app. The label is Connected App ID. This is a relationship field. Relationship Name Resource Relationship Type Lookup Refers To ConnectedApplication | | SourceIp | Type string Properties Filter, Group, Sort Description The IP address of the machine from which the user attempted the action that requires identity verification. For example, the IP address of the machine from where the user tried to log in or access reports. If it’s a non-login action that required verification, the IP address can be different from the address from where the user logged in. This address can be an IPv4 or IPv6 address. | | Status | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the identity verification attempt. Available values are: - AutomatedSuccess—Salesforce Authenticator approved the request for access because the request came from a trusted location. After users enable location services in Salesforce Authenticator, they can designate trusted locations. When a user trusts a location for a particular activity, such as logging in from a recognized device, that activity is approved from the trusted location for as long as the location is trusted. - Denied—The user denied the approval request in the authenticator app, such as Salesforce Authenticator. - FailedGeneralError—An error caused by something other than an invalid verification code, too many verification attempts, or authenticator app connectivity. - FailedInvalidCode—The user entered an invalid verification code. - FailedInvalidPassword—The user entered an invalid password. - FailedPasswordLockout—The user attempted to enter a password too many times. - FailedTooManyAttempts—The user attempted to verify identity too many times. For example, the user entered an invalid verification code repeatedly. - Initiated—Salesforce initiated identity verification but hasn’t yet challenged the user. - InProgress—Salesforce challenged the user to verify identity and is waiting for the user to respond or for Salesforce Authenticator to send an automated response. - RecoverableError—Salesforce can’t reach the authenticator app to verify identity, but it continues to retry. - ReportedDenied—The user denied the approval request in the authenticator app, such as Salesforce Authenticator, and also flagged the approval request to report to an administrator. - Succeeded—The user’s identity was verified. | | UserId | Type reference Properties Filter, Group, Sort Description ID of the user verifying identity. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | | VerificationMethod | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The method by which the user attempted to verify identity in the verification event. The label is Method. Available values are: - BuiltInAuthenticator—A built-in authenticator set up on the user’s device, such as Touch ID or Windows Hello, generated the required credentials. This value is available in API version 53.0 and later. - Email—Salesforce sent an email with a verification code to the address associated with the user’s account. - EnableLL—Salesforce Authenticator sent a notification to the user’s mobile device to enroll in Lightning Login. This value is available in API version 38.0 and later. - LL—Salesforce Authenticator sent a notification to the user’s mobile device to approve login via Lightning Login. This value is available in API version 38.0 and later. - PwlessPasskey (beta)—Salesforce prompted the user to use a passkey to perform passwordless login. This value is available in API version 66.0 and later. Passwordless login with passkeys is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/?_ga=2.247987783.1372150065.1709219475-629000709.1639001992). Use of this pilot or beta service is at the Customer's sole discretion. - SalesforceAuthenticator—Salesforce Authenticator sent a notification to the user’s mobile device to verify account activity. - Sms—Salesforce sent a text message with a verification code to the user’s mobile device. SMS messaging requires a Salesforce add-on license for Identity Verification Credits. - TempCode—A Salesforce admin or a user with the Manage Multi-Factor Authentication in User Interface permission generated a temporary verification code for the user. This value is available in API version 37.0 and later. - Totp—An authenticator app generated a time-based, one-time password (TOTP) on the user’s mobile device. - U2F—A U2F security key generated required credentials for the user. This value is available in API version 38.0 and later. | | VerificationTime | Type dateTime Properties Filter, Sort Description The date and time of the identity verification attempt, for example, 7/19/2025, 3:19:13 PM PDT. The time zone is based on GMT. The label is Time. | ## Usage Here are two examples queries that you can perform on VerificationHistory. | Query | String | | --- | --- | | Show verification history for a user’s login record | SELECT Activity, EventGroup, Policy, Remarks, Status, UserId,VerificationMethod, VerificationTime FROM VerificationHistory WHERE LoginHistoryId = '0YaD000#########' | | Get detailed geographic location information for a user’s verification attempt | SELECT City, CountryIso, Latitude, Longitude, PostalCode FROM LoginGeo WHERE LoginGeoId = '0LE###############' | # VideoCall Represents a video call. One VideoCall record can be related to several VideoCallRecording records — for example, a video call can have several video recordings and a transcript. As well, one video call record can be associated with several video call participant records. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Fields | Field | Details | | --- | --- | | AcceptanceTimeStamp | Type dateTime Properties Create, Filter, Nillable, Sort Description The timestamp when the user consented for uploading the video call recording. Reserved for future use. This field is available in API version 62.0 and later. | | ConsentedUserId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the user who consented to upload the video call recording. Reserved for future use. This field is available in API version 62.0 and later. This field is a relationship field. Relationship Name ConsentedUser Refers To User | | Description | Type textarea Properties Create, Nillable, Update Description Description of the video call. Typically, the sales rep enters the description. | | DurationInSeconds | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The video call duration in seconds. | | EndDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Time the video call ended, in universal time coordinated (UTC). | | EventId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the event record associated with this video call. The related record and suggested participant information can also be pulled from the associated event. This is a relationship field. Relationship Name Event Relationship Type Lookup Refers To Event | | ExternalId | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The ID of the video call, sent by the video call provider. | | HostId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who hosted the meeting. This is a relationship field. Relationship Name Host Relationship Type Lookup Refers To User | | IntelligenceScore | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The Einstein Intelligence score for the video call. Video calls with scores greater than zero are likely to contain a transcript or insights. Prior to the migration of Einstein Conversation Insight's data to the Salesforce Platform, video calls with multiple insights often had a higher score. After the migration, the score may be 1 if there is a transcript or any insights present. | | IsCallCoachingIncluded | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Einstein Conversation Insights is available for this org and this user (true) or not (false). | | IsDiarizationOptIn | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether optimal speaker separation (diarization) is opted in (true) or not (false) for the call. | | IsLegacyProcessingSkipped | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether legacy processing is skipped (true) or not (false). The default value is false. | | IsRecorded | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the video call was recorded (true) or not (false). | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | MeetingType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the call. Reserved for future use. This field is available in API version 61.0 and later. Possible values are: - EXTERNAL—A call with two or more participants (default). - MANUAL—A call that is manually uploaded. - SINGLE\_USER—A single user call where the sales rep is evaluated and coached. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the video call. Typically entered by the sales rep. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who created the video call. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RelatedRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the account or opportunity related to this video call. This is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To Account, Opportunity | | StartDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that the video call started, in universal time coordinated (UTC). | | TranscribedLanguage | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The language that is transcribed for this video call. | | UsageType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The cloud using the VideoCall. This field is available in API version 63.0 and later. Possible values are: - Life Sciences—Remote Engagement. - Sales Cloud | | VendorMeetingKey | Type string Properties Create, Filter, Group, Sort, Update Description The vendor's ID for this video call. | | VendorMeetingUuid | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The vendor's unique identifier for this video call. | | VendorName | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The name of the vendor providing the video call software. Possible values are: - AMAZON CHIME—Amazon Chime - ConversationAgent—Conversation Agent - Gong - INTERNAL—Internal - InPerson—In Person - ZOOM—Zoom - googlemeet—Google Meet - msteams—Microsoft Teams - twilio—Twilio | ## 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. [VideoCallChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 51.0) Change events are available for the object. [VideoCallOwnerSharingRule](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.") (API version 66.0) Sharing rules are available for the object. [VideoCallShare](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.") (API version 66.0) Sharing is available for the object. #### See Also - [VideoCallParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallparticipant.htm "Represents a participant in a video call. Participant information can come from the video call provider (for example, Zoom), or Salesforce. This object is available in API version 51.0 and later.") - [VideoCallRecording](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallrecording.htm "Represents a recording from a video call, such as a video recording, a voice recording, or a transcript. Video call recordings aren’t saved in Salesforce. This object is available in API version 51.0 and later.") # VideoCallInsight Represents the video call insight data associated with a video call. Each record represents the call insight of a specific recording or transcript within a call. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Einstein Conversation Insight must be enabled and the user requires the Conversation Insights for Sales permission set. ## Fields | Field | Details | | --- | --- | | EngagementInsightType | Type string Properties Filter, Group, Sort Description Required. The unique identifier of the platform setup entity that defines the configuration for this engagement insight type. | | GenerationDateTime | Type dateTime Properties Filter, Sort Description Required. The timestamp when the call insight was generated. | | InsightConfigName | Type string Properties Filter, Group, Nillable, Sort Description The name of the insight configuration, or category, used to classify the insight. | | InsightLanguage | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The language associated with the insight type. Each insight type is currently limited to a single language. If the same insight type is mapped to a different language, a new insight type is created. | | InsightModel | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. The category of the insight type. Possible values are: - FOUNDTIONAL—Foundational - GENERATIVE—Generative - KEYWORD—Keyword - SITUATIONAL—Situational - TIME\_BASED—Time-Based The default value is KEYWORD. | | InsightOccurrenceCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times a particular insight occurred in the transcript. | | InsightSubject | Type string Properties Filter, Group, Nillable, Sort Description The specific text, phrase, or subject identified in the video call transcript that serves as the basis for the insight. | | InsightText | Type textarea Properties Nillable Description The text content of the insight derived from the video call transcript. | | IsUserEdited | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether an insight has been edited by a user (true) or not (false). The default value is false. . | | Scope | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. The scope of the insight type. Possible values are: - Organization - User The default value is Organization. | | VideoCallId | Type reference Properties Filter, Group, Sort Description Required. ID of the associated parent VideoCall record. This field is a relationship field. Relationship Name VideoCall Relationship Type Master-detail Refers To VideoCall (the master object) | | VideoCallRecordingId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated parent VideoCallRecording record. This field is a relationship field. Relationship Name VideoCallRecording Refers To VideoCallRecording | | VideoCallTranscriptId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated VideoCallTranscript record. This field is a relationship field. Relationship Name VideoCallTranscript Refers To VideoCallTranscript | # VideoCallInsightAction Represents a suggested follow-up action derived from a video call insight. VideoCallInsightAction manages recommended steps—such as sending an email, creating a task, or scheduling a meeting—that address specific moments, including competitor mentions, pricing discussions, or objections. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Einstein Conversation Insight must be enabled and the user requires the Conversation Insights for Sales permission set. ## Fields | Field | Details | | --- | --- | | ActionCategory | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The category that classifies the purpose of the action. Possible values are: - FollowUp - NeedsAttention | | ActionReferenceId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the reference record associated with the generated action. This field is a relationship field. Relationship Name ActionReference Refers To VideoCallInsightReason | | ActionType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The specific type of action to be performed for the insight. Possible values are: - CreateCalendarEvent - CreateTaskWithDate - EciCreateCallback - EciScheduleMeetings - EciSendCallResponse - ViewContactProfile The default value is CreateTaskWithDate. | | CompletionDateTime | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the action was completed. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the insight action. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status of the insight action. Possible values are: - Active - Completed The default value is Active. | | VideoCallInsightId | Type reference Properties Filter, Group, Sort Description Required. ID of the VideoCallInsight record associated with a video call. Each record represents the call insight of a specific recording or transcript within a call. This field is a relationship field. Relationship Name VideoCallInsight Relationship Type Master-detail Refers To VideoCallInsight (the master object) | # VideoCallInsightReason Represents the video call insight reason that contains the insight keyword, insight moments associated with a keyword, and the number of keyword occurrences. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Einstein Conversation Insight must be enabled and the user requires the Conversation Insights for Sales permission set. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the insight reason. | | OccurrenceInfo | Type string Properties Filter, Nillable, Sort Description The metadata associated with the insight reason. | | OccurrenceSnippet | Type textarea Properties Nillable Description The specific excerpt from the video call transcript that helped generate the insight. Reserved for future use. | | SpeakerParticipantId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated VideoCallParticipant record. This field is a relationship field. Relationship Name SpeakerParticipant Refers To VideoCallParticipant | | VideoCallInsightId | Type reference Properties Filter, Group, Sort Description Required. ID of the VideoCallInsight record associated with a video call. Each record represents the call insight of a specific recording or transcript within a call. This field is a relationship field. Relationship Name VideoCallInsight Relationship Type Master-detail Refers To VideoCallInsight (the master object) | # VideoCallParticipant Represents a participant in a video call. Participant information can come from the video call provider (for example, Zoom), or Salesforce. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Email | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The email address of the participant, from the video call provider. | | IsAllowed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the participant is admitted into the video call (true) or not (false). The default value is false. | | JoinDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the participant joins the video call. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The 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. | | LeaveDateTime | Type dateTime Properties Filter, Nillable, Sort Description The date and time when the participant leaves the video call. | | Name | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The participant's name or phone number. This information is provided by the video call provider. | | ParticipantType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The role of the participant in the video call. Available in API version 65.0 and later. Available only in orgs that have Einstein Conversation Insights (ECI) enabled and ECI data stored on the Salesforce Platform. Possible values are: - Attendee - Organizer | | RelatedPersonId | Type reference Properties Filter, Group, Nillable, Sort Description The Salesforce ID of the user, lead, or contact record for this participant. This is a polymorphic relationship field. Relationship Name RelatedPerson Relationship Type Lookup Refers To Contact, Lead, User | | VideoCallId | Type reference Properties Filter, Group, Sort Description The ID of the video call record. This is a relationship field. Relationship Name VideoCall Relationship Type Lookup Refers To VideoCall | ## 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. [VideoCallParticipantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. #### See Also - [VideoCall](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocall.htm "Represents a video call. One VideoCall record can be related to several VideoCallRecording records — for example, a video call can have several video recordings and a transcript. As well, one video call record can be associated with several video call participant records. This object is available in API version 51.0 and later.") - [VideoCallRecording](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallrecording.htm "Represents a recording from a video call, such as a video recording, a voice recording, or a transcript. Video call recordings aren’t saved in Salesforce. This object is available in API version 51.0 and later.") # VideoCallRecording Represents a recording from a video call, such as a video recording, a voice recording, or a transcript. Video call recordings aren’t saved in Salesforce. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DurationInSeconds | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The video call duration in seconds, not the recording duration. | | EndDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Time the call ended, in universal time coordinated (UTC). | | ExpirationDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Reserved for internal use. This field is available in API version 59.0 and later. | | ExternalRecordingKey | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The ID of the video call recording, from the recording provider. For example, the Zoom ID of the recording. This value is unique. | | ExternalRecordingKeyLong | Type string Properties Create, Filter, Nillable, Sort, Update Description The ID of the video call recording, from the recording provider, that's more than 255 characters. For example, the MS Team ID of the recording. This value is unique. If ExternalRecordingKey is null, this ID is used by default. Available in API version 61.0 and later. | | FileSizeInByte | Type long Properties Create, Filter, Group, Nillable, Sort, Update Description The size of the video call recording, in bytes. A 0-byte value for video calls with the FileType of TRANSCRIPT is expected behavior. This entity is still used with Google Meet and Microsoft Teams integrations to locate and process the vendor's data. | | FileType | Type string Properties Create, Filter, Group, Sort, Update Description The file type of the video call recording. Possible values are: - MP4—Video file - M4A—Audio-only file - TIMELINE—Time stamp file in JSON format. - TRANSCRIPT—Transcription files in VTT format. - CHAT—Text file containing chat messages from the video call. - CC—File containing closed captions of the video call recording. The file is in VTT format. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The 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 The timestamp when the current user last viewed this record or list view. If this value is null, the user only accessed this record or list view (LastReferencedDate) but not viewed it. | | Name | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The name of the video call recording, entered by the sales rep. | | StartDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The start time of the video call recording. | | VideoCallRecordId | Type reference Properties Create, Filter, Group, Sort Description ID of the VideoCall record (the parent record). This is a relationship field. Relationship Name VideoCallRecord Relationship Type Lookup Refers To VideoCall | ## 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. [VideoCallRecordingChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 51.0) Change events are available for the object. #### See Also - [VideoCallParticipant](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocallparticipant.htm "Represents a participant in a video call. Participant information can come from the video call provider (for example, Zoom), or Salesforce. This object is available in API version 51.0 and later.") - [VideoCall](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_videocall.htm "Represents a video call. One VideoCall record can be related to several VideoCallRecording records — for example, a video call can have several video recordings and a transcript. As well, one video call record can be associated with several video call participant records. This object is available in API version 51.0 and later.") # VideoCallRecordingStructure Represents the structure of a video call recording, having relation to a video call participant, speaking order, start offset, and end offset. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Einstein Conversation Insight must be enabled and the user requires the Conversation Insights for Sales permission set. ## Fields | Field | Details | | --- | --- | | ListenRatio | Type double Properties Filter, Sort Description Required. The ratio of the time the speaker spent listening versus talking on the call. | | Name | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the video call recording. | | ParticipantSpeakingOrder | Type int Properties Filter, Group, Sort Description Required. The sequence in which participants first spoke during the call. Only the initial speaking turn of each participant is captured. | | TalkRatio | Type double Properties Filter, Sort Description Required. The ratio of the time that the speaker spent talking versus listening on the call. | | TalkSegment | Type textarea Properties None Description The transcript of specific segments that the participant was speaking. | | VideoCallId | Type reference Properties Filter, Group, Sort Description Required. ID of the associated VideoCall. This field is a relationship field. Relationship Name VideoCall Relationship Type Master-detail Refers To VideoCall (the master object) | | VideoCallParticipantId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated VideoCallParticipant. This field is a relationship field. Relationship Name VideoCallParticipant Refers To VideoCallParticipant | | VideoCallRecordingId | Type reference Properties Filter, Group, Sort Description Required. ID of the associated VideoCallRecording. This field is a relationship field. Relationship Name VideoCallRecording Refers To VideoCallRecording | # VideoCallTranscript Represents the complete transcript text and metadata of a recorded video call. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | IsTranscriptTruncated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates whether the transcript is truncated (true) or not (false). The default value is false. | | Name | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The unique name for the video call transcript record. | | TotalDuration | Type double Properties Filter, Sort Description Required. The difference between the end timestamp of the last entry and the start timestamp of the first entry in the transcript. This field helps identify the longest transcript for a given call. The unit of measurement is seconds. | | TranscribedLanguage | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The language in which the transcript is generated. Possible values are: - ar—Arabic - bg—Bulgarian - ca—Catalan - cs—Czech - da—Danish - de—German - el—Greek - en—English - es—Spanish - fi—Finnish - fr—French - he—Hebrew - hi—Hindi - hr—Croatian - hu—Hungarian - id—Indonesian - is—Icelandic - it—Italian - ja—Japanese - ko—Korean - lt—Lithuanian - lv—Latvian - nl—Dutch - no—Norwegian - pa—Punjabi - pl—Polish - pt—Portuguese - ro—Romanian - ru—Russian - sk—Slovak - sr—Serbian - sv—Swedish - th—Thai - tr—Turkish - uk—Ukrainian - vi—Vietnamese - zh—Chinese | | TranscriptContent | Type textarea Properties Nillable, Sort Description The full content of the video call transcript in the JSON or CSV format, including all spoken sentences during the call, with timestamps and speaker information. | | TranscriptCreationTimestamp | Type dateTime Properties Filter, Sort Description Required. The date and time when the transcript was created by the transcription service. | | Type | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. Specifies how the transcript was generated. Possible values are: - ai-generated— Generated using advanced AI transcription tools - post-call— Generated after the call using the final recording - real-time— Generated during the call, before the recording is available | | UsageType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. The source from where the video call originated. Possible values are: - eci— Einstein Conversation Insights | | VideoCallId | Type reference Properties Filter, Group, Sort Description Required. Reference to the associated parent video call. This field is a relationship field. Relationship Name VideoCall Relationship Type Master-detail Refers To VideoCall (the master object) | | VideoCallRecordingId | Type reference Properties Filter, Group, Nillable, Sort Description Reference to the associated optional parent video call recording. This field is a relationship field. Relationship Name VideoCallRecording Refers To VideoCallRecording | | VideoCallStartTimestamp | Type dateTime Properties Filter, Nillable, Sort Description The start time of the video call recording to use with the transcript for calculating relative timestamps. | # Visualforce Request Event Type Visualforce Request events contain details of Visualforce requests. Requests can originate from the browser (UI). For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
      FieldDetails
      CLIENT_IP
      Type
      String
      Description
      The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
      For example: 96.43.144.26.
      CONTROLLER_TYPE
      Type
      Number
      Description
      The type of controller that’s used by the requested Visualforce page.
      Possible Values
      • 0: NOT_SPECIFIED—The controller type is not specified.
      • 1: STANDARD—The controller is a standard controller.
      • 2: CUSTOM—The controller is a custom controller or controller extension.
      • 3: JAVA—For internal use only.
      • 4: STANDARD_SET—The controller is a standard list controller.
      • 5: SPRING—Not used.
      CPU_TIME
      Type
      Number
      Description
      The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
      DB_BLOCKS
      Type
      Number
      Description
      Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
      DB_CPU_TIME
      Type
      Number
      Description
      The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request.
      DB_TOTAL_TIME
      Type
      Number
      Description
      The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
      EVENT_TYPE
      Type
      String
      Description
      The type of event. The value is always VisualforceRequest.
      HTTP_METHOD
      Type
      String
      Description
      The HTTP method of the request.
      For example: GET, POST, PUT, and so on.
      IS_AJAX_REQUEST
      Type
      Boolean
      Description
      The value is true if the request is a partial page request.
      IS_FIRST_REQUEST
      Type
      Boolean
      Description
      1 if this page is the first Visualforce transaction in the request, or 0 if it isn't.
      LOGIN_KEY
      Type
      String
      Description
      The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
      For example: GeJCsym5eyvtEK2I.
      MANAGED_PACKAGE_NAMESPACE
      Type
      String
      Description
      If the page is part of a managed package, the namespace of that package.
      ORGANIZATION_ID
      Type
      Id
      Description
      The 15-character ID of the organization.
      For example: 00D000000000123.
      PAGE_NAME
      Type
      String
      Description
      The name of the Visualforce page that was requested.
      QUERY
      Type
      String
      Description
      The query string used to access the requested Visualforce page.
      Example
      Let’s assume that the requested Visualforce page (/apex/myAccountDetailPage?id=001xx000003GYv6AAG) shows details of the account whose ID is in the URL. The value of QUERY in this case is ?id=001xx000003GYv6AAG.
      REQUEST_ID
      Type
      String
      Description
      The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
      For example: 3nWgxWbDKWWDIk0FKfF5DV.
      REQUEST_SIZE
      Type
      Number
      Description
      The size of the request body, in bytes. Value is -1 if the request body content is larger than 2GB, or if the request has no body (for example, a typical GET request).
      REQUEST_STATUS
      Type
      String
      Description
      The status of the request for a page view or user interface action.
      For example:
      • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
      • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
      • U—Undefined
      • A—Authorization Error
      • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
      • N—Not Found. 404 error.
      This field can have a blank value.
      REQUEST_TYPE
      Type
      String
      Description
      The request type.
      Possible values are:
      • page—a normal request for a page
      • content_UI—a content request for a page that originated in the user interface
      • content_apex—a content request initiated by an Apex call
      • PDF_UI—a request for a page in PDF format through the user interface
      • PDF_apex—a request for PDF format by an Apex call (usually a Web Service call)
      RESPONSE_SIZE
      Type
      Number
      Description
      The size of the response, in bytes.
      RUN_TIME
      Type
      Number
      Description
      The amount of time that the request took in milliseconds.
      SESSION_KEY
      Type
      String
      Description
      The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
      For example: d7DEq/ANa7nNZZVD.
      TIMESTAMP
      Type
      String
      Description
      The access time of Salesforce services in GMT.
      For example: 20130715233322.670.
      TIMESTAMP_DERIVED
      Type
      DateTime
      Description
      The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
      For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
      URI
      Type
      String
      Description
      The URI of the page that’s receiving the request.
      For example: /home/home.jsp.
      URI_ID_DERIVED
      Type
      ID
      Description
      The 18-character case insensitive ID of the URI of the page that’s receiving the request.
      USER_AGENT
      Type
      Number
      Description
      The numeric code for the type of client used to make the request (for example, the browser, application, or API).
      USER_ID
      Type
      Id
      Description
      The 15-character ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00530000009M943
      USER_ID_DERIVED
      Type
      Id
      Description
      The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00590000000I1SNIA0.
      USER_TYPE
      Type
      String
      Description
      The category of user license.
      Possible values are:
      • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
      • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
      • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
      • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
      • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
      • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
      • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
      • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.
      VIEW_STATE_SIZE
      Type
      Number
      Description
      The size of the Visualforce view state, in bytes.
      #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # VisualforceAccessMetrics Represents summary statistics for Visualforce pages. ## Supported Calls count(), describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, to access VisualforceAccessMetrics, users must have the Customize Application permission. ## Fields | Field | Details | | --- | --- | | ApexPageId | Type reference Properties Aggregate, Filter, Group, Sort Description The ID of the Visualforce page. This is a relationship field. Relationship Name ApexPage Relationship Type Lookup Refers To ApexPage | | ProfileId | Type reference Properties Aggregate, Filter, Group, Nillable, Sort Description The ID of the use who viewed the Visualforce page. This is a relationship field. Relationship Name Profile Relationship Type Lookup Refers To Profile | | DailyPageViewCount | Type int Properties Aggregate, Filter, Group, Nillable, Sort Description The number of views received by the specified Visualforce page. | | MetricsDate | Type date Properties Aggregate, Filter, Group, Sort Description The date the metrics are queried. | | LogDate | Type date Properties Aggregate, Filter, Group, Nillable, Sort Description The most recent page access date. | ## Usage Use this object to query information on the Visualforce pages in your org. SELECT ApexPageId, DailyPageViewCount, Id, ProfileId, MetricsDate, LogDate FROM VisualforceAccessMetrics # VisualforceRequestEventLog Visualforce Request events contain details of Visualforce requests. Requests can originate from the browser (UI). This object is available in API version 61.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## Supported Calls describeSObjects(), query() ## Special Access Rules To access this object, you must have the View Event Log Object Data user permission. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms](https://www.salesforce.com/company/legal/agreements/). ## Fields | Field | Details | | --- | --- | | ClientIp | Type string Properties Filter, Group, Nillable, Sort Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26. | | ControllerType | Type string Properties Filter, Group, Nillable, Sort Description The type of controller that’s used by the requested Visualforce page. Possible values are: - 0—Not Specified - 1—Standard - 2—Standard Set - 3—Custom - 4—Java - 5—Spring | | CpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DatabaseBlocks | Type double Properties Filter, Nillable, Sort Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries benefits performance. | | DatabaseCpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DatabaseCpuTime. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | HttpMethod | Type string Properties Filter, Group, Nillable, Sort Description The HTTP method of the request. For example: GET, POST, PUT, and so on. | | IsAjaxRequest | Type boolean Properties Defaulted on create, Filter, Group, Sort Description The value is true if the request is a partial page request. The default value is false. | | IsFirstRequest | Type boolean Properties Defaulted on create, Filter, Group, Sort Description 1 if this page is the first Visualforce transaction in the request, or 0 if it isn't. The default value is 0. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I. | | ManagedPackageNamespace | Type string Properties Filter, Group, Nillable, Sort Description If the page is part of a managed package, the namespace of that package. | | PageName | Type string Properties Filter, Group, Nillable, Sort Description The name of the Visualforce page that was requested. | | QueryString | Type string Properties Filter, Group, Nillable, Sort Description The query string used to access the requested Visualforce page. Example Let’s assume that the requested Visualforce page (/apex/myAccountDetailPage?id=001xx000003GYv6AAG) shows details of the account whose ID is in the URL. The value of QueryString in this case is ?id=001xx000003GYv6AAG. | | RequestIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestSize | Type double Properties Filter, Nillable, Sort Description The size of the callout response, in bytes. | | RequestStatus | Type String Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned. - F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only. - U—Undefined - A—Authorization Error - R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page. - N—Not Found. 404 error. This field can have a blank value. | | RequestType | Type string Properties Filter, Group, Nillable, Sort Description The request type. Possible values are: - page—A normal request for a page - content\_UI—A content request for a page that originated in the user interface - content\_apex—A content request initiated by an Apex call - PDF\_UI—A request for a page in PDF format through the user interface - PDF\_apex—A request for PDF format by an Apex call (usually a Web Service call) | | ResponseSize | Type double Properties Filter, Nillable, Sort Description The size of the callout request body, in bytes. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time that the request took in milliseconds. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD. | | Timestamp | Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort Description The category of user license. Possible values are: - CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. - CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site. - CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. - Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. - PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. - PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site. - SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal. - Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org. | | ViewStateSize | Type double Properties Filter, Nillable, Sort Description The size of the Visualforce view state in bytes. | # VoiceCall Represents a call in Salesforce Voice, Sales Dialer, or other supported voice connectors. For Salesforce Voice, this can be a phone or Voice over Internet Protocol (VoIP) call. This object is available in API version 40.0 and later. To manage VoiceCall records when using Salesforce Voice, see the [Telephony Integration REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.voice_developer_guide.meta/voice_developer_guide/voice_rest_overview.htm). The fields in the VoiceCall object apply to the Sales Dialer and Salesforce Voice features unless otherwise stated in the field description. In addition to the standard fields listed in this page, you can define up to 300 custom fields for the VoiceCall object. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Only users with the Modify All Data permission can delete call records. To edit voice call records, Sales Dialer or Salesforce Voice permissions are required. This includes the Dialer Outbound permission set for Sales Dialer, or the Salesforce Voice Contact Center Rep or Salesforce Voice Contact Center Admin permission sets for Salesforce Voice, or Agentforce Contact Center Admin (Salesforce Voice) permission set. ## Fields | Field Name | Details | | --- | --- | | ActivityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique ID of the activity record. Available in API version 48.0 and later. This is a relationship field. Relationship Name Activity Refers To Task | | AgentSentimentScore | Type double Properties Filter, Nillable, Sort Description If [Sentiment Journey](https://help.salesforce.com/s/articleView?id=service.voice_conversation_sentiments.htm&type=5&language=en_US) in Salesforce Voice with Telephony Providers is set up, this field represents the rep’s overall sentiment score post-call in a conversation event. The value must be between -5 (lowest negative sentiment score) and 5 (highest positive sentiment score), with 0 being a neutral sentiment score. Available in API version 59.0 and later. This field isn't available in Salesforce Voice (Native Telephony). | | AverageJitter | Type int Properties Create, Filter, Group, Nillable, Sort Description Average inter-arrival jitter of RTP packets on the agent leg over the entire call duration, measured in milliseconds. Higher values indicate inconsistent packet timing, which can cause audio choppiness. This field is available in API version 68.0 and later, and only in Salesforce Voice (Native Telephony). | | AveragePacketLoss | Type percent Properties Create, Filter, Nillable, Sort Description Average percentage of RTP packets lost on the agent leg over the entire call duration. Higher values indicate sustained network degradation, which can cause audio gaps. This field is available in API version 68.0 and later, and only in Salesforce Voice (Native Telephony). | | CallAcceptDateTime | Type dateTime Properties Create, Filter, Nillable, Sort Description If Salesforce Voice is enabled, this field represents the date and time (in UTC) when an agent accepts the call. Available in API version 48.0 and later. | | CallCenterId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If Salesforce Voice with Telephony Providers is enabled, this field represents the unique ID of the call center (CallCenter Id) where the activity took place. Available in API version 48.0 and later. This is a relationship field. This field isn't available in Salesforce Voice (Native Telephony). | | CallConnectDateTime | Type datetime Properties Create, Filter, Nillable, Sort Description For Sales Dialer, this field represents the date and time (in UTC) when the call was connected. | | CallDisposition | Type string Properties Create, Filter, Group, Nillable, Sort Description The status of the phone call. For Sales Dialer, possible values are: - in progress - busy - failed For Salesforce Voice, possible values are: - new—The voice call record has been created. - in-progress—The call has been accepted (or, for outbound messages, initiated) by an agent. - completed—The call has ended. This includes calls that are transferred. (If a call is transferred, another voice call record is created to track the state of the transferred call.) If After Conversation Work (ACW) is enabled, that work begins after the call completes. | | CallDurationInSeconds | Type int Properties Create, Filter, Group, Nillable, Sort Description The total duration (in seconds) of the call. | | CallEndDateTime | Type dateTime Properties Create, Filter, Sort Description The date and time (in UTC) when the call ended. | | CallerId | Type reference Properties Create, Filter, Group, Nillable, Sort Description For Salesforce Voice, this field represents the unique ID of the participant who initiated the call. If “Match Callers to End User Records” is enabled in Lightning Experience, the value is null and the EndUserId field is used instead to determine the end user associated with this voice call. Available in API version 48.0 and later. This is a relationship field. Relationship Name Caller Relationship Type Lookup Refer To ConversationParticipant | | CallerIdType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description For Sales Dialer, this field represents the number displayed for outbound calls. Possible values are: - VendorLine—User. - CompanyNumber—Company. - LocalPresence—Local Presence. - CustomCallerId—Custom Caller ID. Available in API version 41.0 and later. | | CallOrigin | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Information about how this call originated. For Salesforce Voice, possible values are: - Preview—Preview dialer. - Progressive—Progressive dialer. - Voicemail—Voicemail call. Available in API version 56.0 and later. | | CallQueuedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort Description If Salesforce Voice is enabled, this field represents the date and time (in UTC) when the call was added to a queue to be routed to an agent. Available in API version 48.0 and later. | | CallRecordingId | Type reference Properties Create, Filter, Group, Nillable, Sort Description For Salesforce Voice, this field represents the unique ID of the call recording for the voice call. An update to the CallRecordingId value is an internal process and doesn't trigger automation such as flows. Available in API version 41.0 and later. This is a relationship field. Relationship Name CallRecording Relationship Type Lookup Refers To VoiceCallRecording | | CallResolution | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The resolution outcome of the call. The default value is Resolved, meaning the call has been resolved. Available in API version 48.0 and later. | | CallStartDateTime | Type dateTime Properties Create, Filter, Sort Description The date and time (UTC) when the call started. | | CallStatus | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description For internal use only. Available in API version 63.0 and later. | | CallSubtype | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description For Salesforce Voice, this field represents the network or protocol over which the phone or Voice over Internet Protocol (VoIP) call is made. Possible values are: - PSTN - WebRTC Available in API version 62.0 and later. | | CallType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The types of call. For Sales Dialer, possible values are: - Bridge - Coach - Inbound - Internal - Outbound For Salesforce Voice, possible values are: - Callback - Consult - Inbound - InternalCall - Outbound - Transfer | | CoachingDurationInSeconds | Type int Properties Create, Filter, Group, Nillable, Sort Description For Sales Dialer, this field represents the total duration (in seconds) of the coaching session. This field only appears if call coaching is enabled. Available in API version 41.0 and later. | | ConferenceKey | Type string Properties Create, Filter, Group, Nillable, Sort Description For Sales Dialer, this field represents the related conference key. This field is only available if call monitoring is enabled. Available in API version 41.0 and later. | | ConversationId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If Salesforce Voice is enabled, this field represents the unique ID of the conversation. This field is only available if call monitoring is enabled. Available in API version 48.0 and later. This is a relationship field. Relationship Name Conversation Relationship Type Lookup Refers To Conversation | | CurrencyCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description For Sales Dialer, this field represents the ISO currency code used to bill the call. | | CustomerHoldDuration | Type int Properties Create, Filter, Group, Nillable, Sort Description If Salesforce Voice is enabled, this field represents the total duration (in seconds) of all the holds that occurred during the voice call. Available in API version 49.0 and later. | | CustomerSentimentScore | Type double Properties Filter, Nillable, Sort Description If [Sentiment Journey](https://help.salesforce.com/s/articleView?id=service.voice_conversation_sentiments.htm&type=5&language=en_US) in Salesforce Voice with Telephony Providers is set up, this field represents the customer’s overall sentiment score post-call in a conversation event. The value must be between -5 (lowest negative sentiment score) and 5 (highest positive sentiment score), with 0 being a neutral sentiment score. Available in API version 59.0 and later. This field isn't available in Salesforce Voice (Native Telephony). | | Description | Type textarea Properties Create, Nillable, Update Description If Salesforce Voice is enabled, this field represents a text field where the agent can enter a summary of the call. Available in API version 48.0 and later. | | DisconnectReason | Type string Properties Create, Filter, Group, Nillable Description If Salesforce Voice is enabled, this field represents the reason why the voice call was disconnected. For Salesforce Voice with Telephony Providers, the partner telephony provides the reason. For Amazon Connect instances, this value is automatically populated through the contact record if you have Contact Center version 13.0 or later. See DisconnectReason in the [Amazon Connect contact records data model page](https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html) for a list of possible reasons why a voice call may be disconnected. For all other partner telephony models, configure this feature through the disconnectReason parameter in the Update a Voice Call Record Telephony Integration API. Available in API version 59.0 and later. For Salesforce Voice (Native Telephony), possible values for inbound calls are: - Customer Disconnect - Flow Disconnect - Rep Disconnect - Agent Disconnect - Customer Queue Disconnect For Salesforce Voice (Native Telephony), possible values for outbound calls are: - Customer Disconnect - Flow Disconnect - Rep Disconnect - Agent Disconnect - Ring No Answer - Call Rejected For Agentforce Voice, possible values are: - Bot Terminated: The AI agent terminated the session. - Customer Intent Fulfilled: A customer interaction successfully completed. - Customer Unresponsive: The session ended after the AI agent made three attempts to engage the customer without a response. - Disconnected by Customer: The customer ended the session. - Error: The session ended due to a system error. - Expiration Error: The bot session expired. - Internal Orchestrator Service Unavailable: The session ended because an internal service is temporarily unavailable. Contact Salesforce support. - Maximum Duration Reached: The session ended after reaching the maximum allowed duration of 60 minutes. - Missing Flow Id: The escalation flow isn’t configured for the AI agent. - Other: The session ended due to reasons that aren’t captured by other DisconnectReason values. - Session Initiation Failure: The bot session couldn’t be established. - Transferred: The session was escalated to a rep. | | EndUserId | Type reference Properties Create, Filter, Group, Nillable, Sort Description For Salesforce Voice, if “Match Callers to End User Records” is enabled in Lightning Experience, this field represents the unique ID of the messaging end user (MessagingEndUser ID) associated with this voice call. Available in API version 53.0 and later. This is a relationship field. Relationship Name EndUser Relationship Type Lookup Refers To MessagingEndUser | | FromPhoneNumber | Type phone Properties Create, Filter, Group, Sort Description The number of the user who initiated the call. | | IsDiarizationOptIn | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether optimal speaker separation (diarization) is opted in (true) or not (false) for the call. | | IsRecorded | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether a Voice Call Recording record was created (true) or not (false) for this voice call. The default value is false. Available in API version 44.0 and later. | | IvrDuration | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Total duration, in seconds, that a caller spends in the Interactive Voice Response (IVR) system. The duration includes time spent on automated prompts and responses before being placed in a queue or connected to a service rep. This field is available in API version 66.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time (in UTC) when the current user last viewed a record related to this voice call. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time (in UTC) when the current user last viewed this voice call. If the record has not been viewed before, this value is null. Referencing a record (LastReferencedDate) doesn’t count as viewing it. | | LongestHoldDuration | Type int Properties Create, Filter, Group, Nillable, Sort Description If Salesforce Voice is enabled, this field represents the longest hold duration (in seconds) that occurred during the call. Available in API version 49.0 and later. | | MaximumJitter | Type int Properties Create, Filter, Group, Nillable, Sort Description Maximum inter-arrival jitter of RTP packets on the agent leg, measured in milliseconds over rolling 5-second windows. Captures sudden, temporary timing spikes that cause brief audio choppiness, even if the overall call average appears stable. This field is available in API version 68.0 and later, and only in Salesforce Voice (Native Telephony). | | MaximumPacketLoss | Type percent Properties Create, Filter, Nillable, Sort Description Maximum percentage of RTP packets lost on the agent leg, measured over rolling 5-second windows. Captures sharp bursts of packet loss that call-wide averages can mask. This field is available in API version 68.0 and later, and only in Salesforce Voice (Native Telephony). | | MediaProviderId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The unique ID of the related media provider. Available in API version 49.0 and later. This is a relationship field. Relationship Name MediaProvider Relationship Type Lookup Refers To CallCoachingMediaProvider | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the voice call record. For example, VC-00000001. Available in API version 60.0 and later. | | NextCallId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If Salesforce Voice with Telephony Providers is enabled, this field represents the unique ID of the next call if the call was transferred to another agent. If there is no other agent, this value is null. Available in API version 48.0 and later. This field isn't available in Salesforce Voice (Native Telephony). This is a relationship field. Relationship Name NextCall Relationship Type Lookup Refers To VoiceCall | | NumberOfHolds | Type int Properties Create, Filter, Group, Nillable, Sort Description If Salesforce Voice is enabled, this field represents the number of times the customer was put on hold. Available in API version 49.0 and later. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The unique ID of the user who owns the voice call record. Don’t modify this field during active call routing through automation, such as record-triggered flows or Apex triggers. Modifying this field during active call routing by customer automation creates conflicts with the Salesforce Voice with Telephony Providers internal platform logic. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PreviousCallId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If Salesforce Voice with Telephony Providers is enabled, this field represents the unique ID of the previous call if the call was transferred from another agent. When there is no previous call, this value is null. Available in API version 48.0 and later. This field isn't available in Salesforce Voice (Native Telephony). This is a relationship field. Relationship Name PreviousCall Relationship Type Lookup Refers To VoiceCall | | Price | Type double Properties Create, Filter, Nillable, Sort Description For Sales Dialer, this field represents the cost of the phone call. | | QualityScore | Type double Properties Create, Filter, Nillable, Sort, Update Description If Salesforce Voice is enabled, this field represents the value of the Mean Opinion Score (MOS) that measures voice call quality. This algorithm is based on packet loss percentage, average latency, and average jitter. Available in API version 53.0 and later. | | QueueName | Type string Properties Create, Filter, Group, Nillable, Sort Description If Salesforce Voice is enabled, this field represents the name of the agent queue. Available in API version 49.0 and later. | | RecipientId | Type reference Properties Create, Filter, Group, Nillable, Sort Description For Salesforce Voice, this field represents the unique ID of the participant who received the call. If “Match Callers to End User Records” is enabled in Lightning Experience, this value is null and the EndUserId field is used instead to determine the end user associated with this voice call. This is a relationship field. Relationship Name Recipient Relationship Type Lookup Refers To ConversationParticipant | | RecordTypeId | Type reference Properties Create, Filter, Nillable, Updates Description The ID of the voice call record type assigned to this voice call. If a record type isn't assigned to this voice call, the value is null. Available in API version 59.0 and later. This is a relationship field. Relationship Name RecordType Relationship Type Lookup Refers To RecordType | | RelatedRecordId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unique ID of the related record. Associates the VoiceCall record to a standard or custom object record. For Salesforce Voice, supported related records include the standard objects Account, Case, Collection Plan, Contact, Contact Request, Lead, Opportunity, and WorkOrder. For Sales Dialer, supported related records include custom objects. This is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To Account, Case, CollectionPlan, Contact, ContactRequest, Lead, Opportunity, Workorder | | SourceType | Type picklist Properties Create, Group, Nillable, Restricted picklist, Sort, Update Description The general purpose of the call. The permission sets assigned to the voice call owner determine the value. A call’s source type controls which insights Einstein Conversation Insights applies during analysis. Possible values are: - Sales - Service Available in API version 52.0 and later. | | ToPhoneNumber | Type phone Properties Create, Filter, Group, Sort Description The recipient of the call. For inbound, transfer, and callback calls, this value is the agent's number. For outbound calls, this value is the customer's number. | | TranscribedLanguage | Type string Properties Filter, Group, Nillable, Sort Description The language that is transcribed for this voice call. Don’t set or change this value. It’s automatically populated by the Conversation Intelligence platform. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field can be set at record creation but can’t be edited after creation through API, Apex, or the Telephony Integration API (CTR sync). This field is automatically populated by Einstein Conversation Insights (ECI) when post-call transcripts are processed. The value is a two-letter ISO 639-1 language code detected from the transcript. You must enable Einstein Conversation Insights for ECI to populate this field. This field can’t be set through the callAttributes property of the voice call update API. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The unique ID of the Salesforce user who initiates an outbound call or accepts an inbound call. If no one takes the call, this value defaults to null. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | | VendorCallKey | Type string Properties Create, Filter, Group, Nillable, idLookup, Sort Description The unique ID of the child leg of the call that’s provided by the Sales Dialer vendor or Salesforce Voice. | | VendorParentCallKey | Type string Properties Create, Filter, Group, Nillable, Sort Description For Sales Dialer, this field represents the unique ID of the parent leg of the call that’s provided by the Dialer vendor. | | VendorType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description For Sales Dialer, this field represents the type of Dialer vendor. For Salesforce Voice, this field is always set to ContactCenter. Available in API version 41.0 and later. | | VoiceVendorLineId | Type reference Properties Create, Filter, Group, Nillable, Sort Description For Sales Dialer, this field represents the unique ID of the associated Dialer vendor line. This is a relationship field. Relationship Name VoiceVendorLine Relationship Type Lookup Refers To VoiceVendorLine | ## Associated Objects This object has these 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. [VoiceCallChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (Available in API version 48.0 and later) Change events are available for the object. [VoiceCallFeed](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.") (Available in API version 50.0 and later.) Feed tracking is available for the object. [VoiceCallOwnerSharingRule](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. [VoiceCallShare](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. - **[VoiceCall Sharing Models](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecall_sharing_models.htm)** The VoiceCall object supports multiple sharing models to control who can access voice call records. The right sharing model depends on your org’s structure and access requirements. # VoiceCall Sharing Models The VoiceCall object supports multiple sharing models to control who can access voice call records. The right sharing model depends on your org’s structure and access requirements. By default, the org-wide default (OWD) for voice calls is set to Private, which means only the voice call record owner can see and edit the record. You can broaden access using any of the supported sharing models described here. ## Supported Sharing Models for Voice Call Records | Sharing Model | Supported? | Sharing Rules Available in Setup? | How It Works | | --- | --- | --- | --- | | Organization-Wide Defaults (OWD) | Yes | N/A (configured in Sharing Settings) | Controls the baseline sharing level for all voice call records in your org. Default is Private. Other options are Public Read Only, and Public Read/Write. | | Role Hierarchy | Yes | N/A (automatic) | Users higher in the role hierarchy automatically have access to voice call records owned by users below them. Other types of hierarchies don’t support voice call sharing from child to parent. | | Role-Based Sharing Rules | Yes | Yes (Role, or Role and Internal Subordinates) | Creates sharing rules to share voice call records with users in specific roles. When a voice call owner’s role changes or the role hierarchy changes, sharing access is recalculated. | | Public Group Sharing Rules | Yes | Yes (Public Groups) | Creates sharing rules to share voice call records with members of public groups. Public groups can include users, roles, and other groups. When group membership changes, sharing access is recalculated. | | Queue Member Access | Yes | N/A (automatic) | When a voice call is owned by a queue, all members of that queue can access the voice call record. The voice call must be owned by the queue itself, not by individual queue members. | | Queue-Based Sharing Rules | Yes | Yes (share voice calls owned by queues to roles or groups) | Creates sharing rules to share voice calls owned by queues with users in roles, public groups, or territories. Queue-to-queue sharing isn’t supported, and is a platform-wide sharing rule limitation. For more information, see [Sharing Rule Categories](https://help.salesforce.com/s/articleView?id=platform.security_sharing_data_set_categories.htm&type=5&language=en_US). | | Territory-Based Sharing Rules | Yes | Yes (Territories, or Territories and Internal Subordinates) | Creates sharing rules to share voice call records based on territory assignments. Territories are primarily used with Agentforce Sales (formerly Sales Cloud). | | Manager Group Sharing Rules | Yes | Yes (Manager Groups, or Manager and Internal Subordinate Groups) | Creates sharing rules based on the management hierarchy defined by the Manager field on user records. Two types of manager groups are available: direct managers only, or managers and all their internal subordinates. | | Manual Sharing | Yes | N/A (per-record) | Manually share individual voice call records with specific users or groups using the Share button on the voice call record page, Apex, or APIs. | ## Sharing Models Not Supported for Voice Calls | Sharing Model | Why It Isn’t Supported | | --- | --- | | Portal and External User Sharing | The external OWD for voice calls is always set to Private and can’t be changed. External users can’t access voice call records. | | Implicit Sharing | VoiceCall doesn’t participate in any implicit sharing relationship. No parent entity (such as Account) grants automatic access to voice call records. | | Criteria-Based Sharing Rules | Voice call ownership is assigned automatically by Omni-Channel routing rather than set directly by admins, so a specific subset of voice call records can’t be shared with a specific public group or role based on field criteria. | ## Considerations - Voice call recordings have separate access requirements. Even if a user has access to a voice call record through sharing, they might need extra permissions to listen to call recordings. See [Requirements to Access Voice Call Recordings](https://help.salesforce.com/s/articleView?id=service.voice_call_recordings.htm&language=en_US&type=5). - Sharing rule recalculation takes time. When you make changes that affect sharing, such as role or group changes, sharing rules are recalculated. For large orgs with many records, this can take some time. You can [suspend and resume sharing rule calculations](https://help.salesforce.com/s/articleView?id=service.service_omni_queues_manage.htm&language=en_US&type=5) when making bulk changes. - Queue-to-queue sharing isn’t available. You can share voice calls owned by a queue with roles, groups, or territories, but you can’t create a sharing rule from one queue to another. For more information, see [Sharing Rule Categories](https://help.salesforce.com/s/articleView?id=platform.security_sharing_data_set_categories.htm&type=5&language=en_US). #### See Also - [_Salesforce Help_: Set Up Org-Wide Sharing for Voice Calls](https://help.salesforce.com/s/articleView?id=service.voice_org_wide_sharing.htm&language=en_US) - [_Salesforce Help_: Voice Call Recordings](https://help.salesforce.com/s/articleView?id=service.voice_call_recordings.htm&language=en_US) - [_Salesforce Help_: Manage Contact Center Queues in Salesforce and Your Telephony Provider Using Groups](https://help.salesforce.com/s/articleView?id=service.service_omni_queues_manage.htm&language=en_US) - [_Salesforce Help_: Sharing Rule Categories](https://help.salesforce.com/s/articleView?id=platform.security_sharing_data_set_categories.htm&language=en_US) # VoiceCallInsight Represents the voice call insight data associated with a voice call. Each record represents the call insight of a specific recording or transcript within a call. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Einstein Conversation Insight must be enabled and the user requires the Conversation Insights for Sales permission set. ## Fields | Field | Details | | --- | --- | | EngagementInsightType | Type string Properties Filter, Group, Sort Description Required. The unique identifier of the platform setup entity that defines the configuration for this engagement insight type. | | GenerationDateTime | Type dateTime Properties Filter, Sort Description Required. The timestamp when the call insight was generated. | | InsightConfigName | Type string Properties Filter, Group, Nillable, Sort Description The name of the insight configuration, or category, used to classify the insight. | | InsightLanguage | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The language associated with the insight type. Each insight type is currently limited to a single language. If the same insight type is mapped to a different language, a new insight type is created. | | InsightModel | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. The category of the insight type. Possible values are: - FOUNDTIONAL—Foundational - GENERATIVE—Generative - KEYWORD—Keyword - SITUATIONAL—Situational - TIME\_BASED—Time-Based The default value is KEYWORD. | | InsightOccurrenceCount | Type int Properties Filter, Group, Nillable, Sort Description The number of times a particular insight occurred in the transcript. | | InsightSubject | Type string Properties Filter, Group, Nillable, Sort Description The specific text, phrase, or subject identified in the voice call transcript that serves as the basis for the insight. | | InsightText | Type textarea Properties Nillable Description The text content of the insight derived from the voice call transcript. | | Name | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the insight type. | | Scope | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. The scope of the insight type. Possible values are: - Organization - User The default value is Organization. | | VoiceCallId | Type reference Properties Filter, Group, Sort Description Required. ID of the associated parent VoiceCall. This field is a relationship field. Relationship Name VoiceCall Relationship Type Master-detail Refers To VoiceCall (the master object) | | VoiceCallRecordingId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated parent VoiceCallRecording. This field is a relationship field. Relationship Name VoiceCallRecording Refers To VoiceCallRecording | | VoiceCallTranscript | Type string Properties Filter, Group, Nillable, Sort Description The transcript of the voice call. This field requires the canUserDoCloudIntegration permission. | # VoiceCallInsightAction Represents a suggested follow-up action derived from a voice call insight. VoiceCallInsightAction manages recommended steps—such as sending an email, creating a task, or scheduling a meeting—that address specific moments, including competitor mentions, pricing discussions, or objections. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Einstein Conversation Insight must be enabled and the user requires the Conversation Insights for Sales permission set. ## Fields | Field | Details | | --- | --- | | ActionCategory | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The category that classifies the purpose of the action. Possible values are: - FollowUp - NeedsAttention | | ActionReferenceId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the record associated with the generated action. This field is a relationship field. Relationship Name ActionReference Refers To VoiceCallInsightReason | | ActionType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The specific type of action to be performed for the insight. Possible values are: - CreateCalendarEvent - CreateTaskWithDate - EciCreateCallback - EciScheduleMeetings - EciSendCallResponse - ViewContactProfile The default value is CreateTaskWithDate. | | CompletionDateTime | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the action was completed. | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the insight action. | | Status | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status of the insight action. Possible values are: - Active - Completed The default value is Active. | | VoiceCallInsightId | Type reference Properties Filter, Group, Sort Description Required. ID of the VoiceCallInsight record associated with a voice call. Each record represents the call insight of a specific recording or transcript within a call. This field is a relationship field. Relationship Name VoiceCallInsight Relationship Type Master-detail Refers To VoiceCallInsight (the master object) | # VoiceCallInsightReason Represents the voice call insight reason that contains the insight keyword, insight moments associated with a keyword, and the number of keyword occurrences. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Einstein Conversation Insight must be enabled and the user requires the Conversation Insights for Sales permission set. ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the insight reason. | | OccurrenceInfo | Type string Properties Filter, Nillable, Sort Description The metadata associated with the insight reason. | | OccurrenceSnippet | Type textarea Properties Nillable Description The specific excerpt from the voice call transcript that helped generate the insight. Reserved for future use. | | VoiceCallInsightId | Type reference Properties Filter, Group, Sort Description Required. ID of the VoiceCallInsight data associated with a voice call. Each record represents the call insight of a specific recording or transcript within a call. This field is a relationship field. Relationship Name VoiceCallInsight Relationship Type Master-detail Refers To VoiceCallInsight (the master object) | # VoiceCallList Represents a prioritized list of numbers to call. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the call list is active or not. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the call list. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the call list owner. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceCallListOwnerSharingRule](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. [VoiceCallListShare](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. # VoiceCallListItem Represents a single phone number in a prioritized call list. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | CallListId | Type reference Properties Create, Filter, Group, Sort Description The ID of the related call list. | | Ordinal | Type int Properties Create, Filter, Group, Sort, Update Description The order of the item in the overall call list. | | RelatedRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the related record. | | State | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Whether the call list item is not called, called, or skipped. | # VoiceCallMetrics Represents metrics for a VoiceCall lifecycle event, aggregated daily. This object is available in API version 56.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AverageSCVCallDuration | Type double Properties Filter, Nillable, Sort Description The average call duration, measured in minutes, for a given day. | | AvgMessagesPerCall | Type int Properties Filter, Group, Nillable, Sort Description The average number of transcription messages per call for a given day. | | InboundCallsAgentsConnected | Type int Properties Filter, Group, Nillable, Sort Description The number of inbound calls where agents connect with callers for a given day. | | MaxMessagesPerCall | Type int Properties Filter, Group, Nillable, Sort Description The number of transcription messages for the call with the highest number of said messages for a given day. | | MaxSCVCallDuration | Type double Properties Filter, Nillable, Sort Description The longest call duration, measured in minutes, for a given day. | | MetricsDate | Type date Properties Filter, Group, Sort Description The date and time (in UTC) when the metric was gathered. For example, daily metrics jobs run at 12am local instance time (not UTC). | | NumACWInitiated | Type int Properties Filter, Group, Nillable, Sort Description The number of calls where After Conversation Work (ACW) is initiated for a given day. | | NumCallbackCallsCtrCompleted | Type int Properties Filter, Group, Nillable, Sort Description The number of callback calls where interactive voice response (IVR) data is fully and completely captured from a telephony provider for a given day. | | NumInboundCallsCtrCompleted | Type int Properties Filter, Group, Nillable, Sort Description The number of inbound calls where interactive voice response (IVR) data is fully and completely captured from a telephony provider for a given day. | | NumInboundIVRAbandonCalls | Type int Properties Filter, Group, Nillable, Sort Description The number of inbound calls where callers disconnected while waiting in the interactive voice response (IVR) system for a given day. | | NumInboundQueueAbandonCalls | Type int Properties Filter, Group, Nillable, Sort Description The number of inbound calls where callers disconnected while waiting in the queue for a given day. | | NumOutboundCallsCtrCompleted | Type int Properties Filter, Group, Nillable, Sort Description The number of outbound calls where interactive voice response (IVR) data is fully and completely captured from a telephony provider for a given day. | | NumRecordedCalls | Type int Properties Filter, Group, Nillable, Sort Description The number of calls where the conversation between an agent and caller is recorded for a given day. | | NumSCVCallbackCalls | Type int Properties Filter, Group, Nillable, Sort Description The number of callback calls for a given day. | | NumSCVInboundCalls | Type int Properties Filter, Group, Nillable, Sort Description The number of inbound calls for a given day. | | NumSCVOutboundCalls | Type int Properties Filter, Group, Nillable, Sort Description The number of outbound calls for a given day. | | NumSCVTransferCalls | Type int Properties Filter, Group, Nillable, Sort Description The number of transfer calls for a given day. | | NumTransferCallsCtrCompleted | Type int Properties Filter, Group, Nillable, Sort Description The number of transfer calls where interactive voice response (IVR) data is fully and completely captured from a telephony provider for a given day. | | OutboundCallsAgentsConnected | Type int Properties Filter, Group, Nillable, Sort Description The number of outbound calls where an agent is connected with a caller for a given day. | | TotalACWInboundMinutes | Type double Properties Filter, Nillable, Sort Description The total number of minutes agents spent in After Conversation Work (ACW) for inbound calls for a given day. | | TotalACWOutboundMinutes | Type double Properties Filter, Nillable, Sort Description The total number of minutes agents spent in After Conversation Work (ACW) for outbound calls for a given day. | | TotalAgentInboundMinutes | Type double Properties Filter, Nillable, Sort Description The total number of minutes agents spent talking to callers on inbound calls for a given day. | | TotalHoldDurationMinutes | Type double Properties Filter, Nillable, Sort Description The number of minutes callers were put on hold for a given day. | | TotalIVRInboundMinutes | Type double Properties Filter, Nillable, Sort Description The total number of minutes callers spent in the IVR system on inbound calls for a given day. | | TotalMessages | Type int Properties Filter, Group, Nillable, Sort Description The total number of transcription messages for a given day. | | TotalOutboundMinutes | Type double Properties Filter, Nillable, Sort Description The total number of minutes agents spent talking to callers on outbound calls for a given day. | | TotalQueueInboundMinutes | Type double Properties Filter, Nillable, Sort Description For inbound calls, the total number of minutes callers spent in the queue waiting for a given day. | # VoiceCallQualityFeedback Represents feedback given by a Sales Dialer user about the quality of a [VoiceCall](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecall.htm "Represents a call in Salesforce Voice, Sales Dialer, or other supported voice connectors. For Salesforce Voice, this can be a phone or Voice over Internet Protocol (VoIP) call. This object is available in API version 40.0 and later.") . ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Fields | Field Name | Details | | --- | --- | | FeedbackText | Type textarea Properties Nillable Description The detailed feedback about a call left by a user. | | FeedbackType | Type string Properties Filter, Group, Nillable, Sort Description The feedback category (Call could not connect, Audio lagged, etc.) selected by a user. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user leaving the feedback. | | VoiceCallId | Type reference Properties Filter, Group, Sort Description The ID of the related [VoiceCall](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_voicecall.htm "Represents a call in Salesforce Voice, Sales Dialer, or other supported voice connectors. For Salesforce Voice, this can be a phone or Voice over Internet Protocol (VoIP) call. This object is available in API version 40.0 and later."). | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceCallQualityFeedbackOwnerSharingRule](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. [VoiceCallQualityFeedbackShare](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. # VoiceCallRecording Represents a call recording in Salesforce Voice and Sales Dialer. Call recordings for Salesforce Voice with Amazon Connect and for Salesforce Voice with Partner Telephony from Amazon Connect are stored in S3 buckets on your Amazon Web Services (AWS) account and can be accessed via AWS. Call recordings for Sales Dialer are saved as files in Salesforce. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | DurationInSeconds | Type int Properties Create, Filter, Group, Sort, Update Description The total length (in seconds) of the voice call recording. This value depends on which parameters are passed to the PATCH /telephony/v1/voiceCalls/{CALL ID} API. - If the totalRecordingDuration parameter is passed, then DurationInSeconds = totalRecordingDuration. - If the agentInteractionDuration and totalHoldDuration parameters are passed, then DurationInSeconds = agentInteractionDuration + totalHoldDuration. - If the agentInteractionDuration, totalHoldDuration, and totalRecordingDuration parameters are passed, then DurationInSeconds = totalRecordingDuration. | | IntelligenceScore | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The intelligence score of the recording. | | IsConsented | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the call recording was indicated as consented or not. | | MediaContentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related media content, a ContentDocument. The record counts toward your org’s file storage quota. This is a relationship field. Relationship Name MediaContent Relationship Type Lookup Refers To ContentDocument | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the call recording file. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the call recording. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RecordingStartTime | Type datetime Properties Filter, Nillable, Sort Description The time and date that the recording was started. | | UploadDateTime | Type dateTime Properties Filter, Nillable, Sort Description The time and date that the recording was uploaded. | | VoiceCallId | Type reference Properties Filter, Group, Sort Description Required. The ID of the related phone call. The property nillable has been removed in API version 50.0 and later. This is a relationship field. Relationship Name VoiceCall Relationship Type Lookup Refers To VoiceCall | ## 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. [VoiceCallRecordingChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [VoiceCallRecordingOwnerSharingRule](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. Removed in API version 50.0 and later. [VoiceCallRecordingShare](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. Removed in API version 50.0 and later. # VoiceCallRecordingStructure Represents the structure of a voice call recording, which includes voice call participants, speaking order, start offset, and end offset. This object is available in API version 66.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules Einstein Conversation Insight must be enabled and the user requires the Conversation Insights for Sales permission set. ## Fields | Field | Details | | --- | --- | | ListenRatio | Type double Properties Filter, Sort Description Required. The ratio of the time the speaker spent listening versus talking on the call. | | Name | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the voice call recording. | | ParticipantSpeakingOrder | Type int Properties Filter, Group, Sort Description Required. The sequence in which participants first spoke during the call. Only the initial speaking turn of each participant is captured. | | TalkRatio | Type double Properties Filter, Sort Description Required. The ratio of the time that the speaker spent talking versus listening on the call. | | TalkSegment | Type textarea Properties None Description The transcript of specific segments that the participant was speaking. | | VoiceCallId | Type reference Properties Filter, Group, Sort Description Required. ID of the associated VoiceCall. This field is a relationship field. Relationship Name VoiceCall Relationship Type Master-detail Refers To VoiceCall (the master object) | | VoiceCallParticipantId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated VoiceCallParticipant. This field is a relationship field. Relationship Name VoiceCallParticipant Refers To ConversationParticipant | | VoiceCallRecordingId | Type reference Properties Filter, Group, Sort Description Required. ID of the associated VoiceCallRecording. This field is a relationship field. Relationship Name VoiceCallRecording Refers To VoiceCallRecording | # VoiceCallSessionData Represents a record that stores SIP session metadata for a voice call. Use this object to access SIP header values from inbound calls in flows for Agentforce Voice and to configure disconnect behavior for escalations and call terminations. This object is available in API version 67.0 and later. When an inbound SIP INVITE arrives, the Telephony service creates a VoiceCallSessionData record associated with the VoiceCall and inserts the SIP header values from the request. The inbound Omni-Channel flow can query this record by VoiceCallId to read those headers for routing and context decisions. Customers can also update DisconnectMethod and related fields in their escalation or fallback flows to control how Salesforce signals the end of the call to the telephony partner. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules Available with Agentforce Voice. ## Fields | Field | Details | | --- | --- | | AssertedIdentityInfo | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the SIP P-Asserted-Identity header from the inbound SIP INVITE. A trusted SIP network node uses this header to assert the authenticated identity of the caller, such as a phone number or SIP URI. Use this field in your inbound Omni-Channel flow to make routing decisions. When DisconnectMethod is set to SIP\_REFER, Salesforce includes this value in the SIP REFER signal sent to the telephony partner. Use the syntax: \["display-name"\] or . | | DisconnectMethod | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The SIP method used to disconnect the call. Set this field in your inbound Omni-Channel flow, escalation flow, or fallback flow to control how Salesforce signals the end of the call to the telephony partner. If this field is null when a failure or unsupported event occurs, Salesforce defaults to SIP\_BYE. Possible values are: - SIP\_BYE: Standard call termination per RFC 3261. One party ends the call. - SIP\_REFER: Call transfer per RFC 3515. The call is transferred to the destination specified in ReferToUri. If ReferToUri isn’t set, the disconnect defaults to SIP BYE. | | DisconnectReason | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason the Agentforce Voice session ended, populated by Salesforce. Use this value in a fallback flow to determine the appropriate disconnect method and response headers for the specific failure scenario. Values include: - Bot Terminated: The AI agent terminated the session. - Customer Intent Fulfilled: A customer interaction successfully completed. - Customer Unresponsive: The session ended after the AI agent made three attempts to engage the customer without a response. - Disconnected by Customer: The customer ended the session. - Error: The session ended due to a system error. - Expiration Error: The bot session expired. - Internal Orchestrator Service Unavailable: The session ended because an internal service is temporarily unavailable. Contact Salesforce support. - Maximum Duration Reached: The session ended after reaching the maximum allowed duration of 60 minutes. - Missing Flow Id: The escalation flow isn’t configured for the AI agent. - Other: The session ended due to reasons that aren’t captured by other DisconnectReason values. - Session Initiation Failure: The bot session couldn’t be established. - Transferred: The session was escalated to a rep. | | FallbackFlowApiName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of the autolaunched flow to execute when an Agentforce Voice session ends in a failure or unsupported state. The fallback flow can set DisconnectMethod, ReferToUri, and response headers before Salesforce sends the disconnect signal. If this field is null when a failure occurs, Salesforce sends SIP\_BYE as the default disconnect method. Example value: Voice\_Fallback\_Flow | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated name for the VoiceCallSessionData record. Example value: VCSD-00000001 | | PreferredIdentityInfo | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the SIP P-Preferred-Identity header from the inbound SIP INVITE. Indicates the caller's preferred identity for the network to assert on their behalf. Use this field in your inbound Omni-Channel flow for routing decisions. When DisconnectMethod is set to SIP\_REFER, Salesforce can include this value in the SIP REFER signal sent to the telephony partner. Use the syntax: \["display-name"\] or . Example value: "Salesforce" | | PriorityInfo | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the SIP Priority header from the inbound SIP INVITE. Indicates the urgency or priority level of the call request. Use this field for priority-based routing, such as routing emergency calls in enterprise contact center environments. Example values: emergency, urgent, normal, non-urgent | | PrivacyInfo | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the SIP Privacy header from the inbound SIP INVITE. Specifies the privacy services requested by the caller, such as identity masking or caller ID blocking. Use this field to apply appropriate caller privacy handling in your Omni-Channel flow. Example values: id, full, user, header, session, none | | ReasonInfo | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the SIP Reason header from the inbound SIP INVITE. Provides context for why the request was issued, such as a call forwarding reason or rejection cause. Use this field for troubleshooting call flows. Use the syntax: protocol;cause=value;text="description". Example value: SIP;cause=200;text="Speak with a Human" | | ReferToUri | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The target URI for a SIP REFER transfer operation. This value must conform to the SIP URI syntax specified in RFC 3261. Set this field in your flow when DisconnectMethod is SIP\_REFER to specify the destination to which the call is transferred. Required when DisconnectMethod is SIP\_REFER. Use the syntax: sip:user@host:port;uri-parameters?header-parameters. Example value: sip:+15555551234@123.123.123.123:5061;user=phone | | ReferredByInfo | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the SIP Referred-By header from the inbound SIP INVITE. Identifies the user or entity that initiated the call transfer. Use this field for audit trails and transfer tracking. When DisconnectMethod is SIP\_REFER, Salesforce can include this value in the SIP REFER signal sent to the telephony partner. If not set, defaults to Salesforce. Use the syntax: . Example value: | | RequestUri | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the SIP Request-URI from the inbound SIP INVITE. Identifies the target resource of the SIP request such as the destination user or number and host. Salesforce writes this to the VoiceCallSessionData record for the call so it can be read in your inbound Omni-Channel flow and echoes it back on the corresponding SIP BYE or SIP REFER response headers. Use the syntax: sip:user@host:port;uri-parameters. Example value: sip:entrypoint@sbc.domain.com:5060 | | UserToUserInfo | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the SIP User-to-User (UUI) header from the inbound SIP INVITE. Carries caller context passed between SIP endpoints, such as caller intent, account details, or transaction identifiers. This is the existing authentication and context mechanism; the x-header–based fields in this object provide an alternative for SBCs with character-limit constraints on UUI headers. Use the syntax: uui-data;encoding=value. Example value: 61314232633344342d353637382d393065662d676831322d696a6b6c6d6e6f7071727374;encoding=hex | | VoiceCallId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the associated VoiceCall record. This field is unique within your org. To retrieve a VoiceCallSessionData record from an Omni-Channel flow, query by this field: SELECT Id FROM VoiceCallSessionData WHERE VoiceCallId = :callId. Example reference value is an 18-character Salesforce ID: 0LQ8W0000001234AAA This field is a relationship field. Relationship Name VoiceCall Refers To VoiceCall | ## Usage The Telephony service creates one VoiceCallSessionData record per call when an inbound SIP INVITE arrives. Each record has a one-to-one relationship with its parent VoiceCall. **Access SIP headers in an inbound flow** The Telephony service populates the standard SIP header fields (such as AssertedIdentityInfo and UserToUserInfo) before the inbound Omni-Channel flow executes. Query the record using VoiceCallId to retrieve header values for routing and context decisions. To store additional SIP headers not covered by the standard fields, add custom fields to this object using the convention-based naming approach: replace hyphens in the SIP header name with underscores and append the \_\_c suffix. For example, the X-Account-ID header maps to a custom field named X\_Account\_ID\_\_c. The Telephony service maps incoming header values to matching custom fields automatically. **Configure the disconnect method** Set DisconnectMethod in your escalation flow or fallback flow to control whether Salesforce sends SIP\_BYE or SIP\_REFER to the telephony partner when the call ends. When using SIP\_REFER, also set ReferToUri to specify the transfer destination. **Configure a fallback flow** Set FallbackFlowApiName to the API name of an autolaunched flow that should execute when an Agentforce Voice session ends in a failure or unsupported state. The fallback flow has access to DisconnectReason and other fields on this record, allowing you to set the appropriate disconnect method per scenario. If FallbackFlowApiName is null when a failure occurs, Salesforce defaults to SIP\_BYE. # VoiceCoaching Represents a call that is using call monitoring. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the manager monitoring the call. | | RelatedRecordId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the call list owner. | | TraineeId | Type reference Properties Filter, Group, Sort, Unique Description The ID of the call list owner. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceCoachingOwnerSharingRule](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. [VoiceCoachingShare](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. # VoiceLocalPresenceNumber Represents a phone number with the same area code as the person who’s being called. ## Supported Calls query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | CountryCode | Type string Properties Filter, Group, idLookup, Sort Description The country code of the phone number. | | LastUsedDate | Type dateTime Properties Filter, Nillable, Sort Description The date the phone number was last used. | | PhoneNumber | Type phone Properties Filter, Group, Sort Description The local presence phone number. | | Prefix | Type reference Properties Filter, Group, Sort Description The area code of the phone number. | # VoiceMailContent Represents a voicemail message left by a caller to the context user. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | DurationInSeconds | Type int Properties Create, Filter, Group, Sort, Update Description The duration of the voicemail message in seconds. | | FirstHeardDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time and date when the user first listened to the voicemail message. | | MediaContentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related media content, a [ContentDocument](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm). The record counts toward your org’s file storage quota. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the voicemail message. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the voicemail message. | | VoiceCallId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related Dialer call. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceMailContentOwnerSharingRule](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. [VoiceMailContentShare](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. # VoiceMailGreeting Represents a custom greeting message that plays upon reaching a user’s voicemail. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | DurationInSeconds | Type int Properties Create, Filter, Group, Sort, Update Description The duration of the voicemail greeting message in seconds. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the greeting is the user’s default greeting (true) or not (false). | | MediaContentId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the related content document. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the voicemail greeting message. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the voicemail greeting message owner. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceMailGreetingOwnerSharingRule](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. [VoiceMailGreetingShare](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. # VoiceMailGreeting2 Represents information about a voicemail message that reps can drop during outbound customer calls, or set to play when they're unable to take calls from customers. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | DurationInSeconds | Type int Properties Create, Filter, Group, Sort, Update Description The duration of the voicemail message in seconds. | | GreetingUrl | Type string Properties Create, Filter, Group, Sort, Update Description The URL of the audio file for the voicemail message. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the voicemail message. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the voicemail message owner. This is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ReferenceGreetingResourceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the content document that contains the voicemail message. This is a relationship field. Relationship Name ReferenceGreetingResource Refers To ContentDocument | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of voicemail message. Possible values are: - Greeting - VoicemailDrop | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceMailGreeting2OwnerSharingRule](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. [VoiceMailGreeting2Share](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. # VoiceMailGreeting2Rep Represents information about the voicemail message and its associated service rep. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether this is the rep's default voicemail message (true) or not (false). The default value is false. | | Name | Type string Properties Filter, Group, idLookup, Nillable, Sort Description The name of the voicemail message. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description User ID of the voicemail message owner. This is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | OwnerType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The ownership type of the voicemail message. Possible values are: - Owned - Shared | | RepId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the rep associated with the voicemail message. This is a relationship field. Relationship Name Rep Refers To User | | Sequence | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The order in which the voicemail message is applied for the rep. | | VoiceMailGreeting2Id | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the related VoiceMailGreeting2 record. This is a relationship field. Relationship Name VoiceMailGreeting2 Refers To VoiceMailGreeting2 | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceMailGreeting2RepShare](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. # VoiceMailMessage Represents a prerecorded voicemail message. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | DurationInSeconds | Type int Properties Create, Filter, Group, Sort, Update Description The duration of a prerecorded voicemail message in seconds. | | IsDefault | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the message is the context user’s default voicemail drop message. | | MediaContentId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the file. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the prerecorded voicemail message. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the prerecorded voicemail message. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceMailMessageOwnerSharingRule](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. [VoiceMailMessageShare](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. # VoiceOrgSetting Represents the org's customized voice settings. This object is available in API version 46.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ConsentMessage | Type string Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description A custom message displayed for recording consent. Available in API version 49.0 and later. | | CustomDisposition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If set, this field identifies which custom field in the Activity object is used as the call dispositions picklist. Possible values are: - AccountContactRole - AccountOwnership - AccountRating - AccountType - AgeOver - AssetRelationshipType - AssetStatus - AssociatedLocationType - BuyerAttributes - CampaignMemberStatus - CaseContactRole - CaseOrigin - CasePriority - CaseReason - CaseStatus - CaseType - ComplianceGroup - ConsequenceOfFailure - ContactPointAddressType - ContactPointUsageType - ContactRequestReason - ContactRequestRequestedChannel - ContactRequestStatus - ContactRole - ContractContactRole - ContractStatus - DataImportRefreshHours - DataModelSupplierType - DigitalAssetStatus - EventSubject - EventType - ExceptionType - FieldBusinessStatus - FieldClassification - FiscalYearPeriodName - FiscalYearPeriodPrefix - FiscalYearQuarterName - FiscalYearQuarterPrefix - FlowEnvironment - ForecastCategoryName - ForecastingItemCategory - GenderIdentity - IdeaMultiCategory - IdeaStatus - Industry - LeadSource - LeadStatus - LocationType - MilitaryService - OpportunityCompetitor - OpportunityStage - OpportunityType - OrderStatus - OrderType - OrgMetricCategory - OrgMetricErrorMessage - OrgMetricImplEffort - OrgMetricStatus - OrgMetricType - PartnerRole - ProcessExceptionCategory - ProcessExceptionPriority - ProcessExceptionSeverity - ProcessExceptionStatus - Product2Family - Pronoun - QuantityUnitOfMeasure - QuickTextCategory - QuickTextChannel - SalesEngagementActivityType - SalesTeamRole - Salutation - ScorecardMetricCategory - SecurityClassification - SocialPostClassification - SocialPostEngagementLevel - SocialPostReviewedStatus - SolutionStatus - StatusReason - TaskPriority - TaskStatus - TaskSubject - TaskType - WorkOrderLineItemStatus - WorkOrderPriority - WorkOrderStatus | | DefaultDisposition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Identifies which picklist value set is used as default for call dispositions. Possible values are: - AccountContactRole - AccountOwnership - AccountRating - AccountType - AgeOver - AssetRelationshipType - AssetStatus - AssociatedLocationType - BuyerAttributes - CampaignMemberStatus - CaseContactRole - CaseOrigin - CasePriority - CaseReason - CaseStatus - CaseType - ComplianceGroup - ConsequenceOfFailure - ContactPointAddressType - ContactPointUsageType - ContactRequestReason - ContactRequestRequestedChannel - ContactRequestStatus - ContactRole - ContractContactRole - ContractStatus - DataImportRefreshHours - DataModelSupplierType - DigitalAssetStatus - EventSubject - EventType - ExceptionType - FieldBusinessStatus - FieldClassification - FiscalYearPeriodName - FiscalYearPeriodPrefix - FiscalYearQuarterName - FiscalYearQuarterPrefix - FlowEnvironment - ForecastCategoryName - ForecastingItemCategory - GenderIdentity - IdeaMultiCategory - IdeaStatus - Industry - LeadSource - LeadStatus - LocationType - MilitaryService - OpportunityCompetitor - OpportunityStage - OpportunityType - OrderStatus - OrderType - OrgMetricCategory - OrgMetricErrorMessage - OrgMetricImplEffort - OrgMetricStatus - OrgMetricType - PartnerRole - ProcessExceptionCategory - ProcessExceptionPriority - ProcessExceptionSeverity - ProcessExceptionStatus - Product2Family - Pronoun - QuantityUnitOfMeasure - QuickTextCategory - QuickTextChannel - SalesEngagementActivityType - SalesTeamRole - Salutation - ScorecardMetricCategory - SecurityClassification - SocialPostClassification - SocialPostEngagementLevel - SocialPostReviewedStatus - SolutionStatus - StatusReason - TaskPriority - TaskStatus - TaskSubject - TaskType - WorkOrderLineItemStatus - WorkOrderPriority - WorkOrderStatus | | DeveloperName | Type string Properties 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. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the MasterLabel. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label of the voice org setting. | # VoiceUserLine Represents a user’s forwarding phone number. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | IsCustomCallerId | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the number is a custom caller ID (true) or not (false). | | IsVerified | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Reserved for future use. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort Description The name of the phone number. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the phone number. | | PhoneNumber | Type phone Properties Create, Filter, Group, Sort, Update Description The user’s phone number. | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user using the phone number. | | VendorVerifiedCallerIdKey | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The ID for a custom phone number provided by the Sales Dialer service provider. | | VoiceVendorInfoId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related Sales Dialer service provider. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceUserLineOwnerSharingRule](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. [VoiceUserLineShare](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. # VoiceUserPreferences Represents the number the user displays when making outbound calls. This object is available in API version 41.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | CallerIdType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The number displayed for outbound calls. The possible values are: - VendorLine - CompanyNumber - LocalPresence - CustomCallerId | | DeskPhoneNumber | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description A separate phone number users can utilize as part of a call bridge. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the phone number owner. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceUserPreferencesOwnerSharingRule](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. [VoiceUserPreferencesShare](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. # VoiceVendorInfo Represents information about the Salesforce Voice or Sales Dialer provider’s vendor. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | CorporateNumber | Type phone Properties Filter, Group, Nillable, Sort Description The standard number that users can choose to display when making outgoing calls. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the vendor is active or not. | | LocalPresenceDefaultNumber | Type phone Properties Filter, Group, Nillable, Sort Description The default routing number that’s available for incoming local presence calls. | | TenantConfigVersion | Type string Properties Filter, Group, Nillable, Sort Description The version of the Service Cloud Voice tenant configuration. Available in API version 51.0 and later. | | VendorAccountKey | Type string Properties Filter, Group, idLookup, Sort Description The account key of the vendor. | | VendorProviderName | Type string Properties Filter, Group, Sort Description The name of the vendor. | | VendorType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the telephony vendor. | # VoiceVendorLine Represents a user’s phone number reserved with the vendor. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules As of Spring ’20 and later, only your Salesforce org's internal users can access this object. ## Fields | Field Name | Details | | --- | --- | | CallUsageInSecondsLastMonth | Type int Properties Filter, Group, Nillable, Sort Description An org’s total call usage last month in seconds. | | OwnerId | Type reference Properties Filter, Group, Sort Description The ID of the user who owns the phone number. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PhoneNumber | Type phone Properties Filter, Group, idLookup, Sort Description The unique vendor phone number. | | ShouldRecord | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Reserved for future use. | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether the number is currently active or released. | | UserId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user using the phone number. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | | VoiceVendorInfoId | Type reference Properties Filter, Group, Sort Description The ID of the Dialer vendor. This is a relationship field. Relationship Name VoiceVendorInfo Relationship Type Lookup Refers To VoiceVendorInfo | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [VoiceVendorLineOwnerSharingRule](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. [VoiceVendorLineShare](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. # Vote Represents a vote that a user has made on a Knowledge Article, Idea, or Reply. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note In API version 16.0 and earlier, SOQL queries on the Vote object only return votes for the Idea object. Starting in API version 17.0, SOQL queries return votes for both Idea and Reply. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules As of Summer ’20 and later, only authenticated internal and external users can access this object. Voting on Knowledge articles is available only when Knowledge is enabled. ## Fields | Field | Details | | --- | --- | | IsDeleted | Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. | | LastModifiedById | Type reference Properties Defaulted on create, Filter, Group, Sort Description ID of the user most recently associated with this vote. | | LastModifiedDate | Type dateTime Properties Defaulted on create, Filter, Sort Description The datetime when this vote was last modified. | | ParentId | Type reference Properties Group, Sort, Create, Filter Description ID of the Knowledge Article, Idea, or Reply associated with this vote. This is a polymorphic relationship field. Relationship Name Parent Relationship Type Lookup Refers To Idea, IdeaComment, KnowledgeArticle, Solution | | Type | Type picklist Properties Group, Sort, Create, Filter, Restricted picklist, Update Description Picklist that indicates the type of vote. The value Up indicates that the vote is a user's positive endorsement of the associated idea or reply. The value Down indicates that the vote is a user's negative endorsement of the associated idea or reply. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If you are importing Vote data into Salesforce and need to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself.. ## Usage For Knowledge Articles, one vote record is inserted per user per Knowledge Article. Voting for another article version overrides the vote for the previous version. In version 12.0 and later, use this object to track the votes that users made on ideas. For more information on ideas, see “Understand and Work with Ideas” in the Salesforce Help . In version 17.0 and later, you must filter using the following syntax when querying this object in a SOQL query: ParentId = single ID, Parent.Type = single Type, Id = single ID, or Id IN (list of IDs). See Comparison Operators in the [Salesforce SOQL and SOSL Reference Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/ "HTML (New Window)") for a sample query. A SOQL query must filter using one of the following Parent or Id clauses. - ParentId = \[single ID\] - Parent.Type = \[single type\] - Id = \[single ID\] - Id IN = \[list of IDs\] #### See Also - [Idea](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_idea.htm "Represents an idea on which users are allowed to comment and vote, for example, a suggestion for an enhancement to an existing product or process. This object is available in API version 12 and later.") - [IdeaComment](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ideacomment.htm "Represents a comment that a user has submitted in response to an idea.") # WarrantyTerm Represents warranty terms defining the labor, parts, and expenses covered, along with any exchange options, provided to rectify issues with products. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | Code | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A code or other identifier associated with this warranty term. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the warranty term. | | EffectiveStartDate | Type picklist Properties Create, Filter, Group, Sort, Update Description Date on which the warranty term became available for use. Possible values are: - InstallDate - ManufactureDate - PurchaseDate | | ExchangeType | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of exchange offered. Possible values are: - AdvanceExchange - Loaner - ReturnExchange | | Exclusions | Type textarea Properties Create, Nillable, Update Description Description of any exclusions. | | ExpensesCovered | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of expenses covered. | | ExpensesCoveredDuration | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The duration for which expenses are covered. | | ExpensesCoveredUnitOfTime | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit in which expenses covered duration is measured. Possible values are: - Days - Months - Weeks - Years | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Defines whether the warranty term is active. | | IsTransferable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Defines whether the warranty can be transferred to a new owner. | | LaborCovered | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of labor covered. | | LaborCoveredDuration | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The duration for which labor is covered. | | LaborCoveredUnitOfTime | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit in which labor covered duration is measured. Possible values are: - Days - Months - Weeks - Years | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the warranty term was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the warranty term was last viewed. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The warranty term’s assigned owner. | | PartsCovered | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of parts covered. | | PartsCoveredDuration | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The duration for which parts are covered. | | PartsCoveredUnitOfTime | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit in which parts covered duration is measured. Possible values are: - Days - Months - Weeks - Years | | Pricebook2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the price book item associated with this warranty term. | | WarrantyDuration | Type int Properties Create, Filter, Group, Sort, Update Description The duration of the warranty offered by this term. | | WarrantyTermName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the warranty term. | | WarrantyType | Type picklist Properties Create, Filter, Group, Sort, Update Description The type of warranty. Possible values are: - Repair - Standard - Supplier | | WarrantyUnitOfTime | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The unit in which the warranty duration is measured. Possible values are: - Days - Months - Weeks - Years | ## 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. [WarrantyTermChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # Wave Change Event Type Wave Change events represent route or page changes made in the CRM Analytics user interface. A Wave Change event type is captured every time the user opens a new CRM Analytics asset or tab, switches between tabs, or changes dashboard pages. Wave Change events are logged when opening new tabs and switching back to previously opened tabs. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
      FieldDetails
      ANALYTICS_MODE
      Type
      String
      Description
      The location in which the dashboard is displayed. In the Salesforce mobile app, embedded dashboards are logged as embedded first. When a user interacts with the dashboard, a full-screen dashboard is displayed to allow for user interaction, and is logged as mobileNative.
      Possible values are:
      • studio—Analytics Studio
      • tab—Analytics tab
      • embedded— Embedded in Aura or Lightning.
      • embeddedInCommunities— Embedded in Experience Cloud.
      • mobileNative— CRM Analytics mobile app for iOS/Android or Salesforce mobile app for iOS/Android
      CLIENT_IP
      Type
      String
      Description
      The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
      For example: 96.43.144.26.
      CPU_TIME
      Type
      Number
      Description
      The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
      EVENT_TYPE
      Type
      String
      Description
      The type of event. The value is always WaveChange.
      IS_MOBILE
      Type
      Boolean
      Description
      If true, the dashboard is displayed in the Tableau CRM mobile app for iOS and Android, in the Salesforce mobile app for iOS and Android, or in a mobile browser.
      IS_NEW
      Type
      Boolean
      Description
      The field indicates that this action opens a new tab or goes back to a previously opened tab. If the change routes to a new page, the value of this field is true. If it routes to an existing page, this field is false.
      LOGIN_KEY
      Type
      String
      Description
      The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
      For example: GeJCsym5eyvtEK2I.
      ORGANIZATION_ID
      Type
      Id
      Description
      The 15-character ID of the organization.
      For example: 00D000000000123.
      PAGE_CONTEXT
      Type
      String
      Description
      The context of the page in which the dashboard is displayed. In the Salesforce mobile app, embedded dashboards are logged as aura first. When a user interacts with the dashboard, a full-screen dashboard is displayed to allow for user interaction, and is logged as iOS or android.
      Possible values are:
      • aura—Lightning Components
      • vf—Visualforce
      • iOS— CRM Analytics or Salesforce mobile app for iOS
      • android— CRM Analytics or Salesforce mobile app for Android
      PAGE_ID
      Type
      String
      Description

      The ID of the CRM Analytics dashboard page.

      This field is only available in v58.0 and higher.

      RECORD_ID
      Type
      String
      Description
      The Salesforce ID of the CRM Analytics object.
      REOPEN_COUNT
      Type
      Number
      Description
      If IS_NEW is false, the number of times that an existing page opens.
      REQUEST_ID
      Type
      String
      Description
      The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
      For example: 3nWgxWbDKWWDIk0FKfF5DV.
      RUN_TIME
      Type
      Number
      Description
      The amount of time that the request took in milliseconds.
      SAVED_VIEW_ID
      Type
      String
      Description
      The ID of the CRM Analytics dashboard saved view.
      SESSION_KEY
      Type
      String
      Description
      The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
      For example: d7DEq/ANa7nNZZVD.
      TAB_ID
      Type
      String
      Description
      The ID of the particular Analytics tab in the user interface.
      For example: dashboard-0FKB0000000Ec64GDK.
      TIMESTAMP
      Type
      String
      Description
      The access time of Salesforce services in GMT.
      For example: 20130715233322.670.
      TIMESTAMP_DERIVED
      Type
      DateTime
      Description
      The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
      For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
      TYPE
      Type
      String
      Description
      The CRM Analytics object type.
      URI
      Type
      String
      Description
      The URI of the page that’s receiving the request.
      For example: /home/home.jsp.
      URI_ID_DERIVED
      Type
      ID
      Description
      The 18-character case insensitive ID of the URI of the page that’s receiving the request.
      USER_ID
      Type
      Id
      Description
      The 15-character ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00530000009M943.
      USER_ID_DERIVED
      Type
      Id
      Description
      The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00590000000I1SNIA0.
      VIEW_MODE
      Type
      String
      Description
      The view mode for the CRM Analytics asset. Possible values include view, edit, present, json, or print.
      WAVE_SESSION_ID
      Type
      String
      Description
      The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session.
      WAVE_TIMESTAMP
      Type
      Number
      Description
      The time at which this log line was generated.
      #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Wave Download Event Type Wave Download events represent downloads made from lens explorations and dashboard widgets in the CRM Analytics user interface. A Wave Download event type is captured when a user downloads images ( .png ), Microsoft® Excel® data ( .xls ), or comma-separated values ( .csv ) files. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | ASSET\_ID | Type ID Description The ID of the asset the user downloads from. | | ASSET\_TYPE | Type String Description The type of the asset the user downloads from. Values - Lens—A _lens_ is a view into a dataset used in an exploratory mode or to get insight to a specific business question. The lens can be saved and shared independently. It can also be clipped to a dashboard. - Dashboard—A _dashboard_ is a curated set of charts, metrics, and tables based on the data in one or more lenses. | | CLIENT\_IP | Type String Description The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. Example 96.43.144.26 | | CPU\_TIME | Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer. | | DATASET\_IDS | Type String Description Comma-separated list of IDs of utilized data sets. | | DOWNLOAD\_ERROR | Type String Description The message for the error blocking the download request, if any. | | DOWNLOAD\_FORMAT | Type String Description The data format of the export. Values - png—Image - csv—Comma-separated values - xls— Microsoft Excel | | EVENT\_TYPE | Type String Description The type of event. The value is always WaveDownload. | | LOGIN\_KEY | Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I | | NUMBER\_OF\_RECORDS | Type Number Description The number of records exported. | | ORGANIZATION\_ID | Type Id Description The 15-character ID of the organization. Example 00D000000000123 | | REQUEST\_ID | Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST\_ID. Example 3nWgxWbDKWWDIk0FKfF5DV | | RUN\_TIME | Type Number Description The amount of time that the request took in milliseconds. | | SESSION\_KEY | Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. Example d7DEq/ANa7nNZZVD | | TIMESTAMP | Type String Description The access time of Salesforce services in GMT. For example: 20130715233322.670. | | TIMESTAMP\_DERIVED | Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). For example: 2015-07-27T11:32:59.555Z. Timezone is GMT. | | URI | Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp | | URI\_ID\_DERIVED | Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. | | USER\_ID | Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943 | | USER\_ID\_DERIVED | Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0 | | USER\_TYPE | Type String Description The type of Salesforce user. | | WAVE\_SESSION\_ID | Type String Description The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session. | | WAVE\_TIMESTAMP | Type Number Description The time at which this log line was generated. | # Wave Interaction Event Type Wave Interaction events represent route or page changes made in the CRM Analytics user interface. A Wave Interaction event type is captured when a tab is closed. It also collates the interaction statistics over the life of the tab, including total open time, read time, and so on. These statistics are aggregated as you go to other tabs and return, and logged only once when the tab is closed. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Because Wave Interaction events are logged only when the tab or browser window is closed, these events might not match Wave Change events exactly if a user allows their Salesforce session to time out before closing. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
      FieldDetails
      CLIENT_IP
      Type
      String
      Description
      The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
      For example: 96.43.144.26.
      CPU_TIME
      Type
      Number
      Description
      The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
      EVENT_TYPE
      Type
      String
      Description
      The type of event. The value is always WaveInteraction.
      LOGIN_KEY
      Type
      String
      Description
      The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
      For example: GeJCsym5eyvtEK2I.
      NUM_CLICKS
      Type
      Number
      Description
      The number of clicks performed on a page in the CRM Analytics user interface.
      NUM_SESSIONS
      Type
      Number
      Description
      The number of times a user returned to a particular page.
      ORGANIZATION_ID
      Type
      Id
      Description
      The 15-character ID of the organization.
      For example: 00D000000000123.
      READ_TIME
      Type
      Number
      Description
      The amount of time a user spent on a particular tab.
      RECORD_ID
      Type
      String
      Description
      The Salesforce ID of the CRM Analytics object.
      REQUEST_ID
      Type
      String
      Description
      The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
      For example: 3nWgxWbDKWWDIk0FKfF5DV.
      RUN_TIME
      Type
      Number
      Description
      The amount of time that the request took in milliseconds.
      SESSION_KEY
      Type
      String
      Description
      The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
      For example: d7DEq/ANa7nNZZVD.
      TAB_ID
      Type
      String
      Description
      The ID of the particular Analytics tab in the user interface.
      Example
      dashboard-0FKB0000000Ec64GDK
      TIMESTAMP
      Type
      String
      Description
      The access time of Salesforce services in GMT.
      For example: 20130715233322.670.
      TIMESTAMP_DERIVED
      Type
      DateTime
      Description
      The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
      For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
      TOTAL_TIME
      Type
      Number
      Description
      The total amount of time a tab was open in milliseconds.
      TYPE
      Type
      String
      Description
      The CRM Analytics object type.
      URI
      Type
      String
      Description
      The URI of the page that’s receiving the request.
      For example: /home/home.jsp.
      URI_ID_DERIVED
      Type
      ID
      Description
      The 18-character case insensitive ID of the URI of the page that’s receiving the request.
      USER_ID
      Type
      Id
      Description
      The 15-character ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00530000009M943
      USER_ID_DERIVED
      Type
      Id
      Description
      The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00590000000I1SNIA0.
      VIEW_MODE
      Type
      String
      Description
      The view mode for the CRM Analytics asset. Possible values include view, edit, present, json, or print.
      WAVE_SESSION_ID
      Type
      String
      Description
      The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session.
      WAVE_TIMESTAMP
      Type
      Number
      Description
      The time at which this log line was generated.
      #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # Wave Performance Event Type Wave Performance events help you track trends in your Analytics performance. For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)"). ## Fields
      FieldDetails
      CLIENT_IP
      Type
      String
      Description
      The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
      For example: 96.43.144.26.
      CPU_TIME
      Type
      Number
      Description
      The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
      EPT
      Type
      Number
      Description
      The experienced page time in milliseconds.
      EVENT_TYPE
      Type
      String
      Description
      The type of event. The value is always WavePerformance.
      IS_INITIAL
      Type
      Boolean
      Description
      Indicates whether the event is for the initial load of dashboard (true) or not (false).
      LOGIN_KEY
      Type
      String
      Description
      The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
      For example: GeJCsym5eyvtEK2I.
      NAME
      Type
      String
      Description
      The asset title or query string.
      ORGANIZATION_ID
      Type
      Id
      Description
      The 15-character ID of the organization.
      For example: 00D000000000123.
      QUERY_ID
      Type
      String
      Description
      This field is deprecated in API version 50.0. The number of queries can be determined using the Uri Event type logs, referenced here
      RECORD_ID
      Type
      String
      Description
      The Salesforce ID of the CRM Analytics object.
      REQUEST_ID
      Type
      String
      Description
      The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
      For example: 3nWgxWbDKWWDIk0FKfF5DV.
      RUN_TIME
      Type
      Number
      Description
      The amount of time that the request took in milliseconds.
      SESSION_KEY
      Type
      String
      Description
      The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
      For example: d7DEq/ANa7nNZZVD.
      TAB_ID
      Type
      String
      Description
      The ID of the particular Analytics tab in the user interface.
      Example
      dashboard-0FKB0000000Ec64GDK
      TIMESTAMP
      Type
      String
      Description
      The access time of Salesforce services in GMT.
      For example: 20130715233322.670.
      TIMESTAMP_DERIVED
      Type
      DateTime
      Description
      The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
      For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
      TYPE
      Type
      String
      Description
      The CRM Analytics object type. This field is scheduled for deprecation in v59.0. Use the new IS_INITIAL field to determine the log line type.
      URI
      Type
      String
      Description
      The URI of the page that’s receiving the request.
      For example: /home/home.jsp.
      URI_ID_DERIVED
      Type
      ID
      Description
      The 18-character case insensitive ID of the URI of the page that’s receiving the request.
      USER_ID
      Type
      Id
      Description
      The 15-character ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00530000009M943
      USER_ID_DERIVED
      Type
      Id
      Description
      The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
      For example: 00590000000I1SNIA0.
      VIEW_MODE
      Type
      String
      Description
      The view mode for the CRM Analytics asset. Possible values include view, edit, present, json, or print.
      WAVE_SESSION_ID
      Type
      String
      Description
      The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session.
      WAVE_TIMESTAMP
      Type
      Number
      Description
      The time at which this log line was generated.
      #### See Also - [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.") - [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.") # WaveAutoInstallRequest Provides access to the concrete object that represents a CRM Analytics auto-install request. The auto-install request tracks the progress of CRM Analytics applications created from CRM Analytics templates by the automated process user. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules CRM Analytics must be enabled in your org. A user must have the Auto Install permission enabled. ## Fields | Field | Details | | --- | --- | | Configuration | Type textarea Properties Create, Nillable Description CRM Analytics application configuration for the auto-install request. | | FailedReason | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description If the CRM Analytics application fails to complete successfully, this value indicates why the failure occurred. Values can be: - OrganizationIncompatible: the org didn't pass the template compatibility checks. - AppInstallationSkipped: the org didn't pass the template compatibility checks and was skipped. - RetriesExhausted: the request exhausted the maximum number of retries. - RequestCancelled: the user canceled the request. - AppCreateFailure: the app or folder creation failed. Check the request log and try again. - AppUpdateFailure: the app or folder update failed. Check the request log and try again. - AppConstructionFailure: the app or folder construction failed. Check the request log and try again. - WaveDisabled: the org doesn't have the Wave org permission or preference enabled. Check the licenses for CRM Analytics and try again. - CancelFailed: canceling an in-progress app failed. Check the request log and try again. - DeleteFailed: deleting an app failed. Check the request log and try again. - DependencyFailure: a dependent auto-install request failed. Check App Install History and try again. - DependencyCancelled: the user canceled a dependent auto-install request. Check App Install History and try again. - FailedToEnqueue: the request failed to enqueue. Check the request log and try again. - FailedOther: the request failed for another reason. Check the request log and try again. | | FolderId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the CRM Analytics application created by the auto-install request. This is a relationship field. Relationship Name Folder Relationship Type Lookup Refers To Folder | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the auto-install request is locked or not. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the auto-install request can be edited or not. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the auto-install request, provided at creation by the user. | | RequestLog | Type textarea Properties Create, Nillable, Update Description A log of the auto-install progress and completion results. | | RequestStatus | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the auto-install request. Values can be New, Enqueued, Cancelled, In Progress, AppInProgress, Failed, and Success. | | RequestType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of auto-install request. Values can be WaveEnable, OrgCompatibilityCheck, WaveAppCreate, WaveAppUpdate, WaveAppDelete, and StartDataflow. | | TemplateApiName | Type string Properties Create, Filter, Group, Nillable, Sort Description The API name of the CRM Analytics template to create the CRM Analytics app from. | | TemplateVersion | Type string Properties Create, Filter, Group, Nillable, Sort Description The version of the CRM Analytics template to create the CRM Analytics app from. | ## Usage Use this object to query and create auto-install requests for CRM Analytics applications in your org. This object is useful to troubleshoot issues with templated applications that the automated process user creates. ## 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. [WaveAutoInstallRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # WebCart Represents an online shopping cart for a store built with B2B Commerce or D2C Commerce, with total amounts for products, shipping and handling, and taxes. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The WebCart object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the account that owns this WebCart. In API version 51.0 and later, if the WebCart was created through Guest Browsing, this ID is the ID of the GuestBuyerProfile. This field is a polymorphic relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | BillingAddress | Type address Properties Filter, Nillable Description The mailing address to which this WebCart is billed. | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the billing address. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the billing address. | | BillingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The accuracy rating of the geocode for the billing address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude of the geocode for the billing address. | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude of the geocode for the billing address. | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code for the billing address. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the billing address. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the billing address. Enter up to 255 characters. | | CollaborationLockedAt | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description If the advanced cart management feature is enabled, this field shows the ID of the user who locked the cart. This field is available in API version 67.0 and later. | | CollaborationLockedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description If the advanced cart management feature is enabled, this field shows the date and time when the user locked the cart. This field is a relationship field. This field is available in API version 67.0 and later. Relationship Name CollaborationLockedBy Refers To User | | CollaborationStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If the advanced cart management feature is enabled, this field indicates whether the cart is shared for collaboration. Possible values are: - None - Shared This field is available in API version 67.0 and later. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Possible values are: - EUR—Euro - USD—U.S. Dollar Although this field is Nillable, if you want to use [Commerce Webstore Cart Promotions](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_cart_promotions.htm) with multi-currency enabled, this field is required. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description Sum of all cart items’ TotalAmount, or WebCart TotalAmount plus WebCart TotalTaxAmount. This value includes all taxes and adjustments. | | GuestCompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Company name associated with a delivery for a guest customer. This field is available in API version 59.0 and later. | | GuestEmailAddress | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address of a guest buyer. This field is available in API version 52.0 and later. | | GuestFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first name of a guest buyer. This field is available in API version 52.0 and later. | | GuestLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last name (or surname) of a guest buyer. This field is available in API version 52.0 and later. | | GuestPhoneNumber | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number of a guest buyer. This field is available in API version 52.0 and later. | | GuestSecondName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The second name of a guest buyer. This field is available in API version 52.0 and later. | | InitialOrderReferenceNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique identifier assigned to the WebCart at the beginning of the checkout process. Initially populated when the checkout process is initiated, the InitialOrderReferenceNumber is then associated with the order created when the checkout is complete. This field is available in API version 61.0 and later. | | InventoryReservationIdentifier | Type string Properties Filter, Group, Nillable, Sort Description Reserved for future use. This field is available in API version 57.0 and later. | | IsRepricingNeeded | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the cart has changed since the last repricing. The default value is False. | | IsSecondary | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the cart is a secondary cart or a primary cart. This field is available in API version 52.0 and later. | | LastRepricingDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date when the last repricing was done. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this WebCart record. Name can be up to 255 characters. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of this WebCart. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaymentGroupId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the WebCart payment group. This field is a relationship field. Relationship Name PaymentGroup Relationship Type Lookup Refers To PaymentGroup | | PaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The method of payment for this WebCart. This field is a polymorphic relationship field. Relationship Name PaymentMethod Relationship Type Lookup Refers To AlternativePaymentMethod, CardPaymentMethod, DigitalWallet | | PoNumber | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The purchase order number. Enter up to 80 characters. | | QuoteLineItemCount | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description Tracks the count of items added to the webcart from quotes. This field is a calculated field. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of this WebCart. Possible values are: - Active—Cart is created and available for modifications, like adding or removing products or promotions. - Checkout—Cart is in checkout. If the customer modifies the cart, the current checkout session is canceled. - Closed—Checkout is complete and an order was created. The cart cannot be modified. - PendingClosed—Cart is marked to be closed, but the request isn't completed yet. The cart can’t be modified. This value is available in API version 57.0 and later. - PendingDelete—Cart is marked for delete, but the request isn't completed yet. The cart can’t be modified. - Processing—Cart is processing. For example, taxes are being calculated. The cart can’t be modified. | | TaxLocaleType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of tax locale. Possible values are: - Net - Gross This field is available in API versions 52.0 to 54.0. | | TaxType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of tax policy. Possible values are: - Automatic - Net - Gross This field is available in API version 55.0 and later. | | TotalAdjustmentAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description A calculated field that reflects the total of all adjustments to the cart subtotal. Adjustments include item, tier, and cart level discounts. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all cart items’ TotalPrice, or TotalProductAmount plus TotalChargeAmount. If the store tax type is Gross, the sum includes taxes. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Although this field is Nillable, if you want to use [Commerce Webstore Cart Promotions](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_cart_promotions.htm), this field is required and must have a value greater than or equal to zero (0). | | TotalAmountAfterAllAdjustments | Type currency Properties Filter, Nillable, Sort Description The sum of all cart items after all price adjustments are applied. Adjustments include various types of discounts. This field is available in API version 52.0 and later. | | TotalCartLevelAdjAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description Total cart level discount amount for the cart. This field is available in API version 61.0 and later. | | TotalChargeAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description The sum of all cart items’ TotalPrice for cart items of the type Charge. | | TotalChargeTaxAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description The sum of all the cart items’ TotalTaxAmount for cart items of the type Charge. | | TotalLineItemsWithErrors | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description A calculated field that shows the total number of cart line items of type Product with errors. This field is available in API version 50.0 and later. | | TotalListAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description Sum of all the cart items’ TotalListPrice. | | TotalProductAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description The sum of all the cart items’ TotalPrice for cart items of the type Product. | | TotalProductCount | Type double Properties Defaulted on create, Filter, Nillable, Sort Description A count of all the products in the WebCart. | | TotalProductItemAdjAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description Total item level discount amount for the cart. This field is available in API version 61.0 and later. | | TotalProductItemAdjTaxAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description The total tax on itemized adjustments, including discounts and surcharges, across all product items in the cart. This field is available in API version 68.0 and later. For WebCart records created before the 68.0 version or before Winter ’27, this field value is Null. | | TotalProductLineItemCount | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description A calculated field that shows the total number of cart line items of type Product. This field is available in API version 60.0 and later. | | TotalProductListAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description The sum of all the cart items’ TotalListAmount for the CartItem type Product. This field is available in API version 59.0 and later. | | TotalProductTaxAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description The sum of all the cart items’ TotalTaxAmount for the CartItem type Product. | | TotalPromoAdjustmentAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description The total of all item discounts related to product promotions. This field is available in API version 52.0 and later. | | TotalPromoAdjustmentTaxAmount | Type currency Properties Defaulted on create, Filter, Nillable, Sort Description The total tax adjustment for all item discounts related to product promotions. This field is available in API version 52.0 and later. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all cart items’ TotalTaxAmount, or TotalProductTaxAmount plus TotalDeliveryTaxAmount. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The WebCart type. Default value is Cart. Possible values are: - Cart - ConsumerSales - PayNowReadOnly - ReadOnly - Template | | UniqueProductCount | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The count of unique product SKUs in the WebCart. | | WebStoreId | Type reference Properties Create, Filter, Group, Sort, Update Description The store ID related to this WebCart. This field is a relationship field. Relationship Name WebStore Relationship Type Lookup Refers To WebStore | ## Usage Notes - In a B2B Commerce for Lightning store, customers who created custom components for adding items to carts noticed that, after adding items, the cart badge didn’t refresh. A hard refresh causes the value to properly update. ## Associated Objects This object has the following associated objects. Unless it’s noted, associated objects are available in the same API version as this object. [WebCartChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [WebCartHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcarthistory.htm "WebCartHistory represents the history of changes to the values in the fields of the WebCart object.") History is available for tracked fields of the object. [WebCartOwnerSharingRule](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. [WebCartShare](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. #### See Also - [Commerce Webstore Cart Promotions](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_cart_promotions.htm "Commerce Webstore Cart Promotions - html (New Window)") - [Commerce Webstore Promotions, Associate Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_promotions_actions_associate.htm "Commerce Webstore Promotions, Associate Action - html (New Window)") - [Commerce Webstore Promotions, Execute Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_commerce_webstore_promotions_actions_execute.htm "Commerce Webstore Promotions, Execute Action - html (New Window)") - [_Salesforce DX Developer Guide_: Get Started with Scratch Org](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_snapshots_get_started.htm) # WebCartAdjustmentBasis Coupons that trigger promotions for the cart. When a customer tries to add a coupon to the cart, the store looks for promotions associated with the coupon. If a promotion results in a price adjustment, a WebCartAdjusmentBasis record is created. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentBasisDetail | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Coupon code for the coupon associated with the promotion. | | AdjustmentBasisReferenceId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Foreign key reference to the coupon. This field is a relationship field. Relationship Name AdjustmentBasisReference Relationship Type Lookup Refers To Coupon | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency ISO code of the cart. Possible values are: - EUR - USD The default value is USD. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the WebCartAdjustmentBasis record. | | WebCartId | Type reference Properties Create, Filter, Group, Sort Description ID of the cart. This field is a relationship field. Relationship Name WebCart Relationship Type Lookup Refers To WebCart | ## 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. [WebCartAdjustmentBasisChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # WebCartAdjustmentGroup Group of price adjustments for a cart. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The WebCartAdjustmentGroup object is available only if the B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AdjustmentSource | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Price adjustment type. Possible values are: - Discretionary - Promotion - System | | AdjustmentTargetType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Target for the price adjustment (the cart itself or individual items). Possible values are: - Cart - Item | | AdjustmentType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates if the price adjustment is applied as percentage or an absolute amount. Possible values are: - AdjustmentAmount - AdjustmentPercentage | | AdjustmentValue | Type double Properties Create, Filter, Sort, Update Description Numeric value of the adjustment (for example, 10 if the price adjustment is either 10% off or $10 off). | | CartId | Type reference Properties Create, Filter, Group, Sort Description ID of the cart to which the price adjustment belongs. This is a relationship field. Relationship Name Cart Relationship Type Lookup Refers To WebCart | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Possible values are: - EUR—Euro - USD—U.S. Dollar | | Description | Type textarea Properties Create, Nillable, Update Description Description of the adjustment group. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the adjustment group. | | PriceAdjustmentCauseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of entity that caused this adjustment (for example, a promotion ID). If unspecified, then Description populates the display name. This is a relationship field. Relationship Name PriceAdjustmentCause Relationship Type Lookup Refers To Promotion | | Priority | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description If there are multiple price adjustments, sequence in which the price adjustments are applied. | | TaxAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Tax on the total adjusted price. | | TotalAmount | Type currency Properties Create, Filter, Nillable, Sort, Update Description Total price after adjustments. | | TotalAmountWithTax | Type currency Properties Filter, Nillable, Sort Description Total adjusted price plus tax. | ## Associated Objects This object has the following associated objects. Unless it’s noted, associated objects are available in the same API version as this object. [WebCartAdjustmentGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. # WebCartHistory WebCartHistory represents the history of changes to the values in the fields of the WebCart object. For specific version information, see the documentation for WebCart. ## Supported Calls describeSObjects(), query, replicate, retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules For specific special access rules, if any, see the documentation for WebCart. ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name of the field that was changed. | | NewValue | Type anyType Properties Nillable, Sort Description New value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description Old value of the field that was changed. | | WebCartId | Type reference Properties Filter, Group, Sort Description The unique ID of the WebCart. | # WebLink Represents a custom link to a URL or Scontrol. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules - To create a custom link, the client application must be logged in with the “Customize Application” permission. - Customer Portal users can’t access this object. ## Fields | Field Name | Details | | --- | --- | | Availability | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the custom link. Limit is 1,000 characters. | | DisplayType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Type of display: button, link, or mass-action button. | | EncodingKey | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Encoding of parameters on the URL link. | | HasMenubar | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the popup window shows a menu bar (true) or not (false). | | HasScrollbars | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the popup window shows scroll bars (true) or not (false). | | HasToolbar | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the popup window shows browser toolbars (true) or not (false). Toolbars normally contain navigation buttons like Back, Forward, and Print. | | Height | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Height of the popup in pixels. | | IsProtected | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the object is protected (true) or not (false). Protected components that have been installed in other organizations can’t be linked to or referenced by components created in the subscriber organization. A developer can easily delete a protected component contained in a managed package in a future release of the package without worrying about failing installations. However, once a component is marked as unprotected and is released globally, the developer can’t delete it. | | IsResizable | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether users are allowed to resize the popup window (true) or not (false). | | LinkType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Type of link (S-control or URL). | | MasterLabel | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Master label for the link. Limit is 240 characters. This display value is the internal label that is not translated. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name to display on page. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. This field can’t be accessed unless the logged-in user has the Customize Application permission. | | OpenType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. How the custom link opens when clicked in a browser—NewWindow, Sidebar, or NoSidebar. | | PageOrSobjectType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Required. For standard objects, the name of the page on which to display the custom link. For custom objects, the name of the object. | | Position | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Location on the screen where the popup should open—TopLeft, FullScreen, or None. | | RequireRowSelection | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the custom link requires a row selection (true) or not (false). | | ScontrolId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the custom s-control object (Scontrol) to link to. Can include fields as tokens within the custom s-control object. Label is **Custom S-Control ID**. | | ShowsLocation | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the popup window shows the browser’s address bar containing the URL (true) or not (false). | | ShowsStatus | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Show the status bar at the bottom of the browser. | | Url | Type textarea Properties Create, Nillable, Update Description Required. URL of the page to link to. Can include fields as tokens within the URL. Limit: 1,024 KB. | | Width | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Width of the popup in pixels. | ## Usage Use this object to programmatically manage custom links, which allow client applications to integrate data with external URLs, an organization’s intranet, or other back-end office systems. A custom link can point to: - An external URL, such as www.google.com or your company's intranet. - A custom s-control, such as a Java applet or Active-X control. Custom links can include fields as tokens within the URL or custom s-control. #### See Also - [Scontrol](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scontrol.htm "A custom s-control, which is custom content that is hosted by the system but executed by the client application.") # WebLinkLocalization Represents the translated value of the field label for a custom link to a URL or s-control when the Translation Workbench is enabled for your organization. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules - Your organization must be using Professional, Enterprise, Developer, Unlimited, or Performance Edition and be enabled for the Translation Workbench. - To view this object, you must have the “View Setup and Configuration” permission. ## Fields | Field | Details | | --- | --- | | LanguageLocaleKey | Type picklist Properties Create, Filter, Nillable, Restricted picklist Description This field is available in API version 16.0 and earlier. It is the same as the Language field. | | Language | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description This field is available in API version 17.0 and later. The combined language and locale ISO code, which controls the language for labels displayed in an application. This picklist contains the following fully-supported languages: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. The following end-user only languages are available. - Arabic: ar - Bulgarian: bg - Croatian: hr - Czech: cs - English (UK): en\_GB - Greek: el - Hebrew: iw - Hungarian: hu - Indonesian: in - Polish: pl - Portuguese (European): pt\_PT - Romanian: ro - Slovak: sk - Slovenian: sl - Turkish: tr - Ukrainian: uk - Vietnamese: vi The following platform languages are available for organizations that use Salesforce exclusively as a platform. - Albanian: sq - Afrikaans: af - Amharic: am - Arabic (Algeria): ar\_DZ - Arabic (Bahrain): ar\_BH - Arabic (Egypt): ar\_EG - Arabic (Iraq): ar\_IQ - Arabic (Jordan): ar\_JO - Arabic (Kuwait): ar\_KW - Arabic (Lebanon): ar\_LB - Arabic (Libya): ar\_LY - Arabic (Morocco): ar\_MA - Arabic (Oman): ar\_OM - Arabic (Qatar): ar\_QA - Arabic (Saudi Arabia): ar\_SA - Arabic (Sudan): ar\_SD - Arabic (Syria): ar\_SY - Arabic (Tunisia): ar\_TN - Arabic (United Arab Emirates): ar\_AE - Arabic (Yemen): ar\_YE - Armenian: hy - Basque: eu - Bosnian: bs - Bengali: bn - Burmese: my - Catalan: ca - Chinese (Hong Kong): zh\_HK - Chinese (Singapore): zh\_SG - Chinese (Malaysia): zh\_MY - Dutch (Belgium): nl\_BE - English (Australia): en\_AU - English (Belgium): en\_BE - English (Canada): en\_CA - English (Cyprus): en\_CY - English (Germany): en\_DE - English (Hong Kong): en\_HK - English (India): en\_IN - English (Ireland): en\_IE - English (Israel): en\_IL - English (Malaysia): en\_MY - English (Malta): en\_MT - English (Netherlands): en\_NL - English (New Zealand): en\_NZ - English (Philippines): en\_PH - English (Singapore): en\_SG - English (South Africa): en\_ZA - English (United Arab Emirates): en\_AE - Estonian: et - Farsi: fa - French (Belgium): fr\_BE - French (Canada): fr\_CA - French (Luxembourg): fr\_LU - French (Morocco): fr\_MA - French (Switzerland): fr\_CH - Georgian: ka - German (Austria): de\_AT - German (Belgium): de\_BE - German (Luxembourg): de\_LU - German (Switzerland): de\_CH - Greek (Cyprus): el\_CY - Greenlandic: kl - Gujarati: gu - Hawaiian: haw - Haitian Creole: ht - Hindi: hi - Icelandic: is - Irish: ga - Italian (Switzerland): it\_CH - Kannada: kn - Kazakh: kk - Khmer: km - Latvian: lv - Lithuanian: lt - Luxembourgish: lb - Macedonian: mk - Malay: ms - Malayalam: ml - Maltese: mt - Marathi: mr - Montenegrin: sh\_ME - Romanian (Moldova): ro\_MD - Romansh: rm - Russian (Armenia): ru\_AM - Russian (Belarus): ru\_BY - Russian (Kazakhstan): ru\_KZ - Russian (Kyrgyzstan): ru\_KG - Russian (Lithuania): ru\_LT - Russian (Moldova): ru\_MD - Russian (Poland): ru\_PL - Russian (Ukraine): ru\_UA - Samoan: sm - Serbian (Cyrillic): sr - Serbian (Latin): sh - Spanish (Argentina): es\_AR - Spanish (Bolivia): es\_BO - Spanish (Chile): es\_CL - Spanish (Colombia): es\_CO - Spanish (Costa Rica): es\_CR - Spanish (Dominican Republic): es\_DO - Spanish (Ecuador): es\_EC - Spanish (El Salvador): es\_SV - Spanish (Guatemala): es\_GT - Spanish (Honduras): es\_HN - Spanish (Nicaragua): es\_NI - Spanish (Panama): es\_PA - Spanish (Paraguay): es\_PY - Spanish (Peru): es\_PE - Spanish (Puerto Rico): es\_PR - Spanish (United States): es\_US - Spanish (Uruguay): es\_UY - Spanish (Venezuela): es\_VE - Swahili: sw - Tagalog: tl - Tamil: ta - Te reo: mi - Telugu: te - Urdu: ur - Welsh: cy - Xhosa: xh - Zulu: zu The values in this field are not related to the default locale selection. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. | | Value | Type string Properties Create, Filter, Nillable, Sort, Update Description The actual translated label of the custom link. Label is **Translation**. | | WebLinkId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the WebLink that is being translated. | ## Usage Use this object to translate your custom links to URLs or s-controls into the different languages supported by Salesforce. Users with the Translation Workbench enabled can view custom link translations, but either the “Customize Application” or “Manage Translation” permission is required to create or update custom link translations. #### See Also - [CategoryNodeLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_categorynodelocalization.htm "When the Translation Workbench is enabled for your organization, the CategoryNodeLocalization object provides the translation of the label of a solution category.") - [ScontrolLocalization](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_scontrollocalization.htm "The translated value of the field label for an s-control.") # WebStore Represents a B2B or D2C store. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules You must: - Have CRUD read permission to access this object - Be a Salesforce admin with CRUD create permission to create a new record in this object ## Fields | Field | Details | | --- | --- | | CheckoutTimeToLive | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Amount of time in minutes that a B2B checkout stays active and doesn’t expire. If you use a Null value, your checkout never expires. If you use a 0 value, checkout is disabled. This field is available in API version 50.0 and later. | | CheckoutValidAfterDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description A timestamp in the default server timezone (GMT). All B2B checkouts that start before this date are considered expired. A Null value means that all checkouts are valid. Example format: 2020-07-14T14:27:00.000Z. This field is available in API version 50.0 and later. | | Country | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Two-digit ISO code of the store's country. Purchases can be shipped only to the country assigned to the store. This field is available in API version 55.0 and later. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The default value is USD. Possible values are: - USD—U.S. Dollar | | DefaultLanguage | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The primary supported language for your store. Possible values include: - da— Danish - de— German - en\_US— English - es— Spanish - en\_MX— Spanish (Mexico) - fi— Finnish - fr— French - it— Italian - ja— Japanese - ko— Korean - nl\_NL— Dutch - no— Norwegian - pt\_BR— Portuguese (Brazil) - ru— Russian - sv— Swedish - th— Thai - zh\_CN— Chinese (Simplified) - zh\_TW— Chinese (Traditional) | | DefaultTaxLocaleType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Tax type of the store. This field is available in API version 55.0 and later. Possible values include: - Gross— Prices include tax - Net— Prices don't include tax | | DefaultTaxPolicyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The default tax policy for the store. This field is a relationship field. This field is available in API version 56.0 and later. Relationship Name DefaultTaxPolicy Relationship Type Lookup Refers To TaxPolicy | | Description | Type textarea Properties Create, Nillable, Update Description Description of the store. | | ExternalReference | Type textarea Properties Nillable Description Identifies the instance of B2C Commerce. Format is <>@<>. This field is available in API version 54.0 and later. | | GuestBuyerProfileId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the GuestBuyerProfile associated with the store. GuestBuyerProfile determines what buyer groups are part of the profile. The guest buyer groups then determine the entitlements and pricing of products for the guest buyer. | | GuestCartTimeToLive | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The time that a guest cart is to remain valid before it expires. The default value is 168 hours (7 days), and the maximum value is 720 hours (30 days). This field is available in API version 52.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced and not viewed directly. | | LocationId | Type reference Properties Filter, Group, Nillible, Sort Description The location associated with the address. | | MaxValuesPerFacet | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The maximum number of values that can be added to a facet. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the catalog. | | OptionsAutoFacetingEnabled | Type boolean Properties Create, Filter, Update Description If enabled (True), the most relevant search facets are automatically returned, in addition to the configured search facets, in the product search results. If disabled (False), only the configured search facets are returned. The default is False.See [Add Product Search Filters (Facets).](https://help.salesforce.com/s/articleView?id=commerce.comm_search_add_filters.htm&type=5&language=en_US)for more information. This field is available in API version 50.0 or later. | | OptionsCartAsyncProcessingEnabled | Type boolean Properties Create, Filter, Update Description Indicates whether add-to-cart requests are processed asynchronously (True) or not (False). The default value is True. This field is available in API version 59.0 or later. | | OptionsCartCalculateEnabled | Type boolean Properties Create, Filter, Update Description Indicates whether the cart calculate extension is enabled (True) or not (False). The default value is False. This field is available in API version 59.0 or later. | | OptionsCartToOrderAutoCustomFieldMapping | Type boolean Properties Create, Filter, Update Description Indicates whether custom field mapping for cart and order objects is enabled (True) or not (False). The default value is True. This field is available in API version 57.0 or later. | | OptionsDuplicateCartItemsEnabled | Type boolean Properties Create, Filter, Update Description Indicates whether a cart can include multiple items with the same product ID (True) or not (False). The default value is False. This field is available in API version 59.0 or later. | | OptionsGuestBrowsingEnabled | Type boolean Properties Create, Filter, Update Description Indicates whether guest browsing is enabled for this store. Set the option to True to allow guest buyers access to products in the store. | | OptionsGuestCartEnabled | Type boolean Properties Create, Filter, Update Description Indicates whether guest cart access is enabled for a store created with an LWR template. Set the option to True to allow guest buyers access to products in the store. This field is available in API version 58.0 and later. | | OptionsGuestCheckoutEnabled | Type boolean Properties Create, Filter, Update Description Indicates whether guest checkout access is enabled for a store created with an LWR template. Set the option to True to allow guest buyers access to products in the store. This field is available in API version 58.0 and later. | | OptionsPreserveGuestCartEnabled | Type boolean Properties Create, Filter, Update Description Indicates whether cart contents are preserved when a guest logs in to the store. Set the option to True to preserve guest carts. This field is available in API version 60.0 and later. | | OptionsSkipAdditionalEntitlementCheckForSearch | Type boolean Properties Create, Filter, Update Description By default, user entitlement checks are run as part of a search index rebuild and again when product search results are returned. Skips the second check to promote faster search performance. Set the option to True to skip additional entitlement checks on a search. This field is available in API version 52.0 and later. | | OrderActivationStatus | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Status of the order. This field is available in API version 55.0 and later. Possible values are: - Activated - Draft | | OrderLifeCycleType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether order summaries are processed with Order Management features: - Managed— - Unmanaged— This field is available in API version 55.0 and later. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates the owner of the store. This field is available in API 53.0 or later. This is a relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaginationSize | Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Dimensions of the page. | | PricingStrategy | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: - LowestPrice— Best Price - Priority— Priority Price. The default value is LowestPrice. | | ProductGrouping | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Determines whether product variations are listed individually in search results or are represented by the parent product, which links to its children. Possible values are: - NoGrouping—Variations are listed individually in search results. - VariationParent—The parent product is returned in search results with a link to its children. The default value is VariationParent. This field is available in API version 52.0 and later. | | SortByPriceBookId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the price book used for the sorting rule. This field is available in API version 55.0 and later. This is a relationship field. Relationship Name SortByPriceBook Relationship Type Lookup Refers To Pricebook2 | | StrikethroughPricebookId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the strikethrough price book. | | SupportedCurrencies | Type textarea Properties Create, Defaulted on create, Nillable, Update Description Currencies supported in the store. | | SupportedLanguages | Type textarea Properties Create, Defaulted on create, Nillable, Update Description Languages supported in the store. | | Type | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Type of store that can be created. Possible values are: - B2B - B2C - B2CE - OMS The default value is B2B. | ## 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. [WebStoreEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 55.0) Change events are available for the object. #### See Also - [WebStoreNetwork](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstorenetwork.htm "Represents the relationship between a web store and an experience site. This object is available in API version 49.0 and later.") # WebstoreBuyerGroup Associates a webstore with a buyer group. Supports dynamically changing locales when buyers shop in orgs that are enabled for multiple languages and currencies. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | BuyerGroupId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The ID of the buyer group this record references. This field is a relationship field. Relationship Name BuyerGroup Relationship Type Lookup Refers To BuyerGroup | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of this record. | | WebStoreId | Type reference Properties Create, Filter, Group, Sort Description Required. ID of the webstore. This field is a relationship field. Relationship Name WebStore Relationship Type Lookup Refers To WebStore | ## Usage This object can support a localized buyer experience by associating a Market-enabled webstore with a buyer group, allowing shoppers to view their group entitlements, price books, and promotions in localized languages and currencies. ## 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. [WebstoreBuyerGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [WebstoreBuyerGroupFeed](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. [WebstoreBuyerGroupHistory](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. [WebstoreBuyerGroupOwnerSharingRule](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. [WebstoreBuyerGroupShare](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. # WebStoreCatalog Represents the collection of products associated with a store. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules You must have the B2B Commerce license and a CMS workspace to access product media. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: - GBP— British Pound - USD— U.S. Dollar The default value is USD. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the catalog. | | ProductCatalogId | Type reference Properties Create, Filter, Group, Sort Description The ID of the catalog, containing products. | | SalesStoreId | Type reference Properties Create, Filter, Group, Sort Description The ID of the store that the catalog is associated with. This field is unique within your org. | ## Associated Objects [WebStoreCatalogHistory](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. # WebStoreInventorySource Used to configure the inventory source for a webstore. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | DoesAllowGuestInventoryLevel | Type boolean Properties Create, Filter, Group, Sort, Update Description Indicates whether guest users can view a product’s inventory levels when guest checkout is disabled. | | InventoryCacheTtl | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Amount of time in seconds before cache expires. | | InventoryDimension | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies which field within inventory levels to use to determine availability. Possible values are AvailableToFulfill,AvailableToOrder,OnHand. | | IsBopisEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the location supports buy online, pick up in store. The default value is false. | | IsChkInvOnActiveCartEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the inventory is checked when a customer adds or edits an item in the active cart. If an admin wants to enable the inventory check feature for their store, they must set this value to true. The default value is true. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default inventory source value (true) or not (false). The default value is false. | | IsEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the default inventory source is active. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. | | LocationSourceExtRef | Type string Properties Group, Nillable Description The external reference identifier associated with the LocationSourceId. | | LocationSourceId | Type reference Properties Create, Filter, Group, Sort, Update Description The location ID or location group ID for this webstore. This field is a polymorphic relationship field. Relationship Name LocationSource Relationship Type Lookup Refers To Location, LocationGroup | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The source name for this entity. | | ReservationDurationInSeconds | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The amount of time in seconds that a reservation stays active and doesn’t expire. Required for implementations using Omnichannel Inventory. | | ShowGuestInventoryLevel | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Displays the inventory level to guest users, even when guest checkout is disabled. The default value is false. This field is available in API version 65.0 and later. | | WebStoreId | Type reference Properties Create, Filter, Group, Sort Description The unique store ID related to this inventory source. This field is a relationship field. Relationship Name WebStore Relationship Type Lookup Refers To WebStore | # WebStoreMessageContent Represents the assocation of a managed content message record in CMS to a web store, along with other attributes that specify the application and intent of the message content. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Special Access Rules This object is available only if a B2B Commerce or D2C Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether this message content is active (true) or not (false). The default value is false. | | ManagedContentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the managed content in CMS. This field is a relationship field. Relationship Name ManagedContent Refers To ManagedContent | | MessageApp | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The application type that uses the message content. Possible values are: - Email | | MessageUsage | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The usage type of the message content. Possible values are: - AbandonedCart - OrderConfirmation | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The autogenerated name of the message content. | | WebStoreId | Type reference Properties Create, Filter, Group, Sort Description The ID of the web store. This field is a relationship field. Relationship Name WebStore Relationship Type Master-detail Refers To WebStore (the master object) | # WebStoreNetwork Represents the relationship between a web store and an experience site. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules You must: - Have CRUD read permission to access this object - Be a Salesforce admin with CRUD create permission to create a new record in this object ## Fields | Field | Details | | --- | --- | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the web store network. | | NetworkId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the experience site associated with the web store. This field is a relationship field. Relationship Name Network Relationship Type Lookup Refers To Network | | WebStoreId | Type reference Properties Create, Filter, Group, Sort Description ID of the web store associated with the experience site. This field is a relationship field. Relationship Name WebStore Relationship Type Lookup Refers To WebStore | ## Usage After you copy web store data between a sandbox and production, or between sandboxes, you can programmatically associate the copy with a different site by updating the corresponding WebStoreNetwork record. You can even change the association while the store is active. The site must use a template that’s compatible with the web store type, and the site can’t be associated with a store. Otherwise, you can change the association only by editing the web store in the UI. #### See Also - [Network](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_network.htm "Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. Experience Cloud sites let you share information, records, and files with coworkers and stakeholders all in one place. This object is available in API version 26.0 and later.") - [WebStore](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstore.htm "Represents a B2B or D2C store. This object is available in API version 49.0 and later.") # WebStorePricebook Represents a store price book used in Lightning B2B Commerce. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the WebStorePricebook is active (true) or not (false). Default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the store price book record. | | Pricebook2Id | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the price book assigned to the store. | | WebStoreId | Type reference Properties Create, Filter, Group, Sort Description The ID of the store assigned to the price book. | ## Usage Use the WebStorePricebook object to assign price books to a store. When you assign a price book to a web store, any buyer who has access to the store can price products from the assigned price books. When a store or buyer has multiple price book assignments, including prices to the same product, the price is determined by the pricing strategy of the store. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WebStorePricebookFeed](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 this object. # WebStoreSearchProdSettings Search settings for a WebStore product search. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules You must have a B2B Commerce or D2C Commerce commerce license to create a web store. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description ISO code for the store’s currency. The default value is USD. Possible values are: - USD—U.S. Dollar The default value is USD. | | IsExcludedFromSearch | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the product is excluded from searches. The default value is false. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the search settings for the WebStore product search. | | ProductId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the product to search. This field is a relationship field. Relationship Name Product Relationship Type Lookup Refers To Product2 | | WebStoreId | Type reference Properties Create, Filter, Group, Sort Description ID of the Webstore to search. This field is a relationship field. Relationship Name WebStore Relationship Type Lookup Refers To WebStore | ## 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. [WebStoreSearchProdSettingsChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # WebStoreShare Represents a sharing entry on a B2B or D2C store. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(),, describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Your Salesforce admin can manage this object using standard Salesforce sharing rules and CRUD access for the WebStore. ## Fields | Field | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing allowed. Possible values are: - All—Owner - Edit—Read/Write - Read—Read Only | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent folder for the record. This field is a relationship field. Relationship Name Parent Refers To WebStore | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Possible values are: - ALMAssignmentSharing—Actionable List Member Sharing Rule - CompliantDataSharing—Compliant Data Sharing - GuestParentImplicit—Associated guest user sharing - GuestPersonImplicit—Associated Guest User Sharing - GuestRule—Guest User Sharing Rule - ImplicitChild—Account Sharing - ImplicitParent—Associated record owner or sharing - ImplicitPerson—Person Contact - LearningAssignment—Learning Assignment Share - LearningAssignmentImplicit—Learning Assignment Implicit Share - LearningItemAssignment—Learning Item Assignment Share - Manual—Manual Sharing - MfgTargetShare—Manufacturing Target Sharing Rule - ObligationAssigneeShare—Obligation Assignee Share - Owner - Rule—Sharing Rule - SharingRecordCollection—Record Collection - SurveyShare—Survey Sharing Rule - Team—Sales Team - Territory—Territory Assignment Rule - Territory2AssociationManual—Territory Manual - Territory2Forecast—Territory assignment for forecasting and reporting - Territory2SplitsForecast—Territory Splits Share - TerritoryManual—Territory Manual - TerritoryRule—Territory Sharing Rule | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the User. This field can’t be updated. This field is a polymorphic relationship field. Relationship Name UserOrGroup Refers To Group, User | # Wishlist Represents a buyer-created list of [WishlistItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_wishlistitem.htm "Represents an item on a Wishlist in a store built with B2B Commerce for Lightning. Available in API version 49.0 and later.")s in a store that’s built with B2B Commerce on Lightning. Available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The Wishlist object is available only if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the account that owns the Wishlist. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Possible values are: - USD—U.S. Dollar | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this Wishlist record. Name can be up to 255 characters. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user or group that owns the Wishlist. | | WebStoreId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the WebStore related to this Wishlist. | | WishlistProductCount | Type int Properties Filter, Group, Nillable, Sort Description The count of WishlistItems on this Wishlist. WishlistProductCount is a calculated field. | ## Associated Objects This object has the following associated objects. Unless it’s noted, associated objects are available in the same API version as this object. [WishlistOwnerSharingRule](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. [WishlistShare](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. ## Usage Notes - Wishlists aren’t included in any searches. #### See Also - [WishlistItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_wishlistitem.htm "Represents an item on a Wishlist in a store built with B2B Commerce for Lightning. Available in API version 49.0 and later.") # WishlistItem Represents an item on a Wishlist in a store built with B2B Commerce for Lightning. Available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The WishListItem object is available only if the B2B Commerce for Lightning license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ISO code for the currency that’s specified on the buyer’s account. Default value is USD.Possible values are: - USD—U.S. Dollar | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this WishlistItem record. Name can be up to 255 characters. | | Product2Id | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the product that is represented by the WishlistItem. | | WishlistId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent Wishlist of this WishlistItem. | #### See Also - [Wishlist](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_wishlist.htm "Represents a buyer-created list of WishlistItems in a store that’s built with B2B Commerce on Lightning. Available in API version 49.0 and later.") # WorkAccess Used to grant or restrict user access to give badge definitions. Each badge definition record must have one WorkAccess record. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Additional Considerations and Related Objects WorkAccess is not available through Schema Builder and is not customizable. A WorkAccess record is **required** for users to **Give** BadgeDefinitions. If a WorkAccess record is not created, BadgeDefinitions will not be available to users. The sharing of WorkAccess records is through WorkAccessShare. For each WorkBadgeDefinition record, you must create both a WorkAccess record (per WorkBadgeDefinition) and WorkAccessShare records for sharing to users or groups. ## Fields | Field Name | Details | | --- | --- | | AccessType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Define the type of Access given to user (“Give”). | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce unique ID for owner of Access record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentId | Type reference Properties Create, Filter, Group, Sort, Update Description Salesforce unique ID for BadgeDefinition record associated with this Access record. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To WorkBadgeDefinition | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkAccessChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [WorkAccessOwnerSharingRule](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkAccessShare](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. # WorkAccessShare Used to control Givers of WorkBadgeDefinition records. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Additional Considerations and Related Objects Related to [WorkAccess Object](https://docs.google.com/a/salesforce.com/document/d/11IkXSCNKBD_04YlyOPvWS94iyVeQ7zN98M03LdcW4eM/edit#bookmark=id.7idtv3rbjtcr). WorkAccess is the parent of WorkAccessShare. ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field Name | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description CRUD Access Level (picklist values: Read Only, Read/Write, Owner). | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID for WorkAccess record. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To WorkAccess | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Values can include: - Manual—The User or Group has access because a user with “All” access manually shared the WorkAccess with them. - Owner—The User is the owner of the WorkAccess or is in a role above the WorkAccess owner in the role hierarchy. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description User or Group ID for WorkAccess. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | # WorkBadge Represents information about who the badge was given to and which badge was given. A WorkBadge record is created for each recipient of a WorkBadgeDefinition. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Considerations and Related Objects WorkBadge is a lookup to WorkThanks. Each WorkBadge record must derive a SourceId from WorkThanks. There can be multiple WorkBadge records tied to a single WorkThanks record. ## Fields | Field Name | Details | | --- | --- | | DefinitionId | Type reference Properties Create, Filter, Group, Sort Description Required. Salesforce unique ID for the given WorkBadgeDefinition record given. This is a relationship field. Relationship Name Definition Relationship Type Lookup Refers To WorkBadgeDefinition | | Description | Type textarea Properties Nillable Description The description of the WorkBadgeDefinition. | | GiverId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the badge giver. Can’t be the same as RecipientId. This is a relationship field. Relationship Name Giver Relationship Type Lookup Refers To User | | ImageUrl | Type url Properties Filter, Group, Nillable, Sort Description The URL of the badge image. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkBadge. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkBadge. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | Message | Type textarea Properties Nillable Description The message accompanying the thanks badge. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the [community](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_network.htm "Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. Experience Cloud sites let you share information, records, and files with coworkers and stakeholders all in one place. This object is available in API version 26.0 and later.") that this WorkBadge is associated with. This field is available only if digital experiences is enabled in your org. | | RecipientId | Type reference Properties Create, Filter, Group, Sort Description Required. Salesforce unique ID for User who is the Recipient of Badge. Can’t be the same as GiverId This is a relationship field. Relationship Name Recipient Relationship Type Lookup Refers To User | | RewardId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce unique ID for Reward given with badge (if Reward Badge) | | SourceId | Type reference Properties Create, Filter, Group, Sort Description Salesforce unique ID for Thanks record referenced to this badge. This is a relationship field. Relationship Name Source Relationship Type Lookup Refers To WorkThanks | ## 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. [WorkBadgeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. # WorkBadgeDefinition Represents the attributes of a badge including the badge name, description, and image. Each WorkBadge record must have a lookup to a WorkBadgeDefinition since badge attributes (like badge name) are derived from the WorkBadgeDefinition object. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Considerations and Related Objects WorkBadgeDefinition has a field called ImageUrl that references a DocumentID. This is a required field for creating a Badge. To grant “giver” access to a WorkBadgeDefinition, you must also create the [WorkAccess](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workaccess.htm "Used to grant or restrict user access to give badge definitions. Each badge definition record must have one WorkAccess record.") (and the related WorkAccessShare records. Each WorkBadgeDefinition has an ImageUrl field that must be populated with a DocumentID of the Document record containing the badge image. ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Update Description Required. Limit: 4000 characters. The description of the badge and what it means to receive this badge. | | GivenBadgeCount | Type int Properties Filter, Group, Nillable, Sort Description The number of badges given per user or across all users. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field can’t be added in a list view or referenced in a formula field. | | ImageUrl | Type url Properties Create, Filter, Group, Sort, Update Description Required. This is the badge image that will be displayed in the UI. Use DocumentID or ImageURL. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents whether a WorkBadgeDefinition is active and available in the UI and API. | | IsCompanyWide | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents a special class of badges known as Company Badges. Company badges are visible to the entire company and visible in specific list view filters. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If this field is selected, everyone within the user’s network will be able to give the badge automatically. If this field is not selected, people with sharing must be added to the badge’s access list in order to give the badge. | | IsLimitPerUser | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the badge limit is per user (true) or across all users (false). The default value is false. | | IsRewardBadge | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the badge is a reward badge (true) or not (false). | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkBadgeDefinition. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkBadgeDefinition. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | LimitNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The badge limit per user or across all users. | | LimitStartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the badge limit. The date can be reset to the current date. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the Badge. **Label:** Badge Title. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the community that this WorkBadgeDefinition is associated with. This field is available only if digital experiences is enabled in your org. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce User ID for User who is the Owner of the WorkBadgeDefinition record (usually the creator of the record) This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RewardFundId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce unique ID for the WorkRewardFund that is associated with this WorkBadgeDefinition. WorkBadgeDefinition records with a RewardFundID indicate a Reward Badge. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkBadgeDefinitionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [WorkBadgeDefinitionFeed](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. [WorkBadgeDefinitionHistory](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. [WorkBadgeDefinitionOwnerSharingRule](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. [WorkBadgeDefinitionShare](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. # WorkCapacityAvailability Represents the available work capacity for a specific time and service territory. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AvailCapacityHours | Type double Properties Create, Filter, Nillable, Sort, Update Description The number of available capacity in hours in the time frame the user defined for a service territory. | | AvailCapacityMinutes | Type double Properties Create, Filter, Nillable, Sort, Update Description The number of available capacity in minutes in the time frame the user defined for a service territory. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The end date of the total available capacity. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service territory of the work capacity availability calculation. This field is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | StartDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the total available capacity. | | TimePeriod | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time period the user selected when creating the work capacity limit. The value is copied from the TimePeriod field of the WorkCapacityLimit object. Possible values are: - Day The default value is Day. | ## 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. [WorkCapacityAvailabilityFeed](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. [WorkCapacityAvailabilityShare](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. # WorkCapacityLimit Represents the capacity limit in a specific service territory for a workstream or for the whole service territory in a given period. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CapacityLimitRelaxation | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Defines the relaxation behavior that determines the limit override policy for this limit if the limit override policy is set per limit in Field Service Settings. If the limit override policy isn’t set per limit, this value is ignored. Valid strings are: - Empty value - no limit override - 0 - limit override starts at midnight on the day of service - Positive integer - limit override starts this number of hours after midnight. the maximum value is 23. - Negative integer - limit override starts this number of hours before midnight. The maximum value is 336. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the work capacity limit. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description End date of the work capacity limit. If no EndDate is set this work capacity limit is without an expiration date. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the work capacity limit is active or inactive. When creating a record, save the record, and then activate it. You can't update fields in an active record. The default value is false. | | IsFriday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Fridays. The default value is false. | | IsMonday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Mondays. The default value is false. | | IsSaturday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Saturdays. The default value is false. | | IsSunday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Sundays. The default value is false. | | IsSvcTerrOnlyLimit | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Apply this work capacity limit to the entire service territory. The default value is false. | | IsThursday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Thursdays. The default value is false. | | IsTuesday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Tuesdays. The default value is false. | | IsWednesday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Wednesdays. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. | | LimitationUnits | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Unit of the LimitationValue. Possible values are: - Hours - Percentage The default value is Hours. | | LimitationValue | Type double Properties Create, Filter, Sort, Update Description If the LimitationUnits is Hours, LimitationValue is the threshold that represents how many hours of total work capacity can be scheduled for a specific workstream in a service territory. Enter the number of hours for the daily limitation as a whole number. If the LimitationUnits is Percentage this threshold represents the percentage of the total work capacity that can be scheduled for a specific workstream in a service territory. Enter the percentage for the daily limitation as a whole number. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the creator of the work capacity limit. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the service territory of the work capacity workstream for which the limit is defined. This field is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description The start date of the Work Capacity Limit. | | SvcApptField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Work-specific criteria used to define the capacity limit for the workstream. The service appointment field is set for the organization when the first work capacity limit instance is created. Possible values are: - ServiceAppointment.AccountId - ServiceAppointment.ActualDuration—Actual duration (in minutes) - ServiceAppointment.Duration—Duration - ServiceAppointment.DurationInMinutes - ServiceAppointment.FSL\_\_Appointment\_Grade\_\_ce - ServiceAppointment.FSL\_\_Auto\_Schedule\_\_c - ServiceAppointment.FSL\_\_Duration\_In\_Minutes\_\_c—Scheduled duration - ServiceAppointment.FSL\_\_Emergency\_\_c - ServiceAppointment.FSL\_\_GanttColor\_\_c - ServiceAppointment.FSL\_\_GanttLabel\_\_c - ServiceAppointment.FSL\_\_InJeopardyReason\_\_c - ServiceAppointment.FSL\_\_InJeopardy\_\_c - ServiceAppointment.FSL\_\_IsFillInCandidate\_\_c - ServiceAppointment.FSL\_\_IsMultiDay\_\_c - ServiceAppointment.FSL\_\_Last\_Updated\_Epoch\_\_c - ServiceAppointment.FSL\_\_MDS\_Calculated\_length\_\_c—Multiday work calculated length - ServiceAppointment.FSL\_\_Pinned\_\_c - ServiceAppointment.FSL\_\_Prevent\_Geocoding\_For\_Chatter\_Actions\_\_c - ServiceAppointment.FSL\_\_Related\_Service\_\_c - ServiceAppointment.FSL\_\_Same\_Day\_\_c - ServiceAppointment.FSL\_\_Same\_Resource\_\_c - ServiceAppointment.FSL\_\_Schedule\_Mode\_\_c - ServiceAppointment.FSL\_\_Schedule\_over\_lower\_priority\_appointment\_\_c - ServiceAppointment.FSL\_\_Scheduling\_Policy\_Used\_\_c - ServiceAppointment.FSL\_\_Time\_Dependency\_\_c - ServiceAppointment.FSL\_\_UpdatedByOptimization\_\_c - ServiceAppointment.FSL\_\_Use\_Async\_Logic\_\_c - ServiceAppointment.FSL\_\_Virtual\_Service\_For\_Chatter\_Action\_\_c - ServiceAppointment.IsOffsiteAppointment - ServiceAppointment.Subject - ServiceAppointment.WorkTypeId—Work Type ID | | SvcApptFieldValDplyNm | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The workstream display name of SvcApptFieldValue. If SvcApptField is a lookup to a service appointment, SvcApptFieldValue is an ID and the display name describes the value for the user. | | SvcApptFieldValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of SvcApptField, the work-specific criteria of the capacity limit. | | TimePeriod | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Duration for defining the capacity limitation on the workstream in the service territory. Possible values are: - Day The default value is Day. | | WorkCapacityLimitNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Read-only. Auto populated, unique identifying number. | ## 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. [WorkCapacityLimitChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [WorkCapacityLimitFeed](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. [WorkCapacityLimitHistory](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. [WorkCapacityLimitShare](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. # WorkCapacityUsage Represents the capacity usage in a specific service territory for a workstream or for the whole service territory in a given period. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AvailCapacityHours | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description This value is copied from the AvailCapacityHours of the WorkCapacityAvailability object for the service territory on the same date. | | CapacityLimitRelaxation | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Defines the relaxation behavior that determines the limit override policy for this limit if the limit override policy is set per limit in Field Service Settings. If the limit override policy isn’t set per limit, this value is ignored. Valid strings are: - Empty value - no limit override - 0 - limit override starts at midnight on the day of service - Positive integer - limit override starts this number of hours after midnight. the maximum value is 23. - Negative integer - limit override starts this number of hours before midnight. The maximum value is 336. | | ConsumptionToLimitRatio | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort Description (Time consumed in hours / Limit in hours) \* 100 Note the following exceptions. - If a limit isn’t defined (-1) the ratio is -1 (even if consumption is 0 or higher). - If consumption is 0, and the limit is a number greater than 0, then the ration is 0. - If consumption is 0 and the limit is 0, the ration is 100% hard-coded. - If consumption is greater than 0 and the limit is 0, the ration is calculated as if the limit = 0.99 in order to get a result that’s higher than 100%. | | EndDate | Type date Properties Create, Filter, Group, Sort Description End date of the time period for which the capacity usage is accumulated. | | IsSvcTerrOnlyLimit | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Applies this work capacity limit to the entire service territory. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. | | LimitationPercentage | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort Description If the LimitationUnits is Percentage this value is copied from the LimitationValue field of the WorkCapacityLimit object. | | LimitationUnits | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Defines whether the limitation for the workstream in the service territory is in hours or as a percentage of all the available hours for all the workstreams for which limitations exist in the service territory on a specific day. Possible values are: - Hours - Percentage The default value is Hours. | | LimitationValue | Type double Properties Create, Filter, Sort Description The LimitationValue depends on the LimitationUnit. If the LimitationUnit is Hours the value is copied from LimitationValue in the WorkCapacityLimit object. If the LimitationUnit is Percentage, the percentage is calculated relative to the availability in the WorkCapacityAvailability object. | | OriginalLimit | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description If the limit value is changed after the work capacity usage was created, this parameter is the original value. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the service territory of the work capacity workstream for which usage is accumulated. This field is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | StartDate | Type date Properties Create, Filter, Group, Sort Description Start date of the time period for which the capacity usage is accumulated. | | SvcApptField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Work-specific criteria used to define the capacity limit for the workstream. Possible values are: - ServiceAppointment.AccountId - ServiceAppointment.ActualDuration—Actual duration (in minutes) - ServiceAppointment.Duration—Duration - ServiceAppointment.DurationInMinutes - ServiceAppointment.FSL\_\_Appointment\_Grade\_\_ce - ServiceAppointment.FSL\_\_Auto\_Schedule\_\_c - ServiceAppointment.FSL\_\_Duration\_In\_Minutes\_\_c—Scheduled duration - ServiceAppointment.FSL\_\_Emergency\_\_c - ServiceAppointment.FSL\_\_GanttColor\_\_c - ServiceAppointment.FSL\_\_GanttLabel\_\_c - ServiceAppointment.FSL\_\_InJeopardyReason\_\_c - ServiceAppointment.FSL\_\_InJeopardy\_\_c - ServiceAppointment.FSL\_\_IsFillInCandidate\_\_c - ServiceAppointment.FSL\_\_IsMultiDay\_\_c - ServiceAppointment.FSL\_\_Last\_Updated\_Epoch\_\_c - ServiceAppointment.FSL\_\_MDS\_Calculated\_length\_\_c—Multiday work calculated length - ServiceAppointment.FSL\_\_Pinned\_\_c - ServiceAppointment.FSL\_\_Prevent\_Geocoding\_For\_Chatter\_Actions\_\_c - ServiceAppointment.FSL\_\_Related\_Service\_\_c - ServiceAppointment.FSL\_\_Same\_Day\_\_c - ServiceAppointment.FSL\_\_Same\_Resource\_\_c - ServiceAppointment.FSL\_\_Schedule\_Mode\_\_c - ServiceAppointment.FSL\_\_Schedule\_over\_lower\_priority\_appointment\_\_c - ServiceAppointment.FSL\_\_Scheduling\_Policy\_Used\_\_c - ServiceAppointment.FSL\_\_Time\_Dependency\_\_c - ServiceAppointment.FSL\_\_UpdatedByOptimization\_\_c - ServiceAppointment.FSL\_\_Use\_Async\_Logic\_\_c - ServiceAppointment.FSL\_\_Virtual\_Service\_For\_Chatter\_Action\_\_c - ServiceAppointment.IsOffsiteAppointment - ServiceAppointment.Subject - ServiceAppointment.WorkTypeId—Work Type ID | | SvcApptFieldValDplyNm | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Workstream display name of SvcApptFieldValue. | | SvcApptFieldValue | Type string Properties Create, Filter, Group, Nillable, Sort Description Value of SvcApptField, the work-specific criteria of the capacity limit. | | TimeConsumedInHours | Type double Properties Create, Filter, Nillable, Sort Description Time consumed in hours by the workstream in the service territory for the defined period. This value is calculated by dividing TimeConsumedInMinutes by 60. | | TimeConsumedInMinutes | Type double Properties Create, Filter, Sort Description Time consumed in minutes by the workstream in the service territory for the defined period. | | TimePeriod | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Duration for defining the capacity limitation on the workstream in the service territory. Possible values are: - Day The default value is Day. | | WcuUniqueField1 | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Read-only. Auto populated, unique identifying number. | | WcuUniqueField2 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Read-only. Auto populated, unique identifying number. | | WorkCapacityUsageNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Read-only. Auto populated, unique identifying number. | ## 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. [WorkCapacityUsageFeed](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. [WorkCapacityUsageShare](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. # WorkCoaching Represents a single coaching relationship between two users. One of the users is defined as the coach and the other is defined as a coachee. WorkCoaching is feed-enabled so there is a private feed available to the coach and coachee. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | CoachId | Type reference Properties Create, Filter, Group, Sort, Update Description \[Required\] The coach in this 1:1 coaching relationship. | | CoachedId | Type reference Properties Create, Filter, Group, Sort, Update Description \[Required\] The user being coached in this 1:1 coaching relationship. | | IsInactive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the coaching relationship is Inactive (true) or not (false). | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this coaching relationship. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this coaching relationship. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, Sort, Update Description \[Required\] The record’s name. Max length is 255 characters. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the contact who owns the WorkCoaching record. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkCoachingFeed](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. [WorkCoachingHistory](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkCoachingOwnerSharingRule](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkCoachingShare](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. # WorkDemographic Represents the field values used to specify slices in the workload forecasting and capacity planning. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license. To view, create, edit, or delete records, the user must have the Workforce Engagement Analyst permission set. ## Fields | Field | Details | | --- | --- | | Channel | Type string Properties Filter, Group, Nillable, Sort Description The channel value. | | CustomWorkType | Type string Properties Filter, Group, Nillable, Sort Description Custom dimension value that the user can define other than the channel, region, and skill dimensions. | | GroupIdentifier | Type string Properties Create, Filter, Group, Nillable, Sort Description The group or queue associated to a slice when creating an Omni-based workload. | | JobProfileId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The foreign key to the JobProfile object. This is a relationship field. Relationship Name JobProfile Relationship Type Lookup Refers To JobProfile | | Region | Type string Properties Filter, Group, Nillable, Sort Description The region value. | | ServiceChannelId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The foreign key to the ServiceChannel object. This is a relationship field. Relationship Name ServiceChannel Relationship Type Lookup Refers To ServiceChannel | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The foreign key to the ServiceTerritory object. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | SkillSet | Type string Properties Filter, Group, Nillable, Sort Description The skill value. | # WorkFeedback Represents the answer to a question that a person was asked via a feedback request. Also used to store offered feedback without linking it to a particular question. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Considerations and Related Objects - Ownership is transferred to the requester on submit for certain types (ad-hoc feedback). - The record is read-only after the request that it’s linked to is set to Submitted. - You can’t link a feedback object to a request unless you are the recipient. - The question that the feedback is linked to must be part of the same question set that the request is linked to. ## Fields | Field Name | Details | | --- | --- | | Feedback | Type textarea Properties Create, Nillable, Update Description Contains either the free-form text of the answer, or the choice selected by the user. Max length is 65536. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the WorkFeedback record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkFeedback record. | | QuestionId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The question this answer applies to. When this feedback is linked to a request of an unsolicited type, the question ID is null. | | RequestId | Type reference Properties Create, Filter, Group, Sort Description The ID of the request this response belongs to, in case of offered feedback. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkFeedbackOwnerSharingRule](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. [WorkFeedbackShare](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. # WorkFeedbackQuestion Represents a free-form text type or multiple choice question within a set of questions. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | Choices | Type textarea Properties Create, Nillable, Update Description New-line separated list of valid choices for multiple choice questions. Maximum length is 1000 characters. | | Detail | Type textarea Properties Create, Nillable, Update Description Detailed instructions on how to answer the question. | | IsConfidentialAnswer | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Answers to questions marked confidential will not be shared with the subject of the review. This field applies only to performance summaries. | | IsOptional | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If this option is selected, the question is optional and isn’t required to be answered. This field applies only to performance summaries. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description A short description of the question, which can be used as a header for reports and Calibration. | | Number | Type int Properties Create, Filter, Group, Sort, Update Description The order of the question that is displayed within the question set, such as question number three in a question set that has five questions. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkFeedbackQuestion. | | QuestionSetId | Type reference Properties Create, Filter, Group, Sort, Update Description The question set this question is a part of. | | Text | Type textarea Properties Create, Update Description The body of the question. Max length is 16384 characters. | | Type | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Allows for either a free-form text answer or a multiple choice question defined by new-line separate choices in the ‘Choices’ field. Valid picklist values are: - MultipleChoice - FreeText - Rating | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkFeedbackQuestionOwnerSharingRule](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. [WorkFeedbackQuestionShare](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. # WorkFeedbackQuestionSet Represents a set of questions being asked. The question set is used to link all the individual requests where different recipients were asked the same set of questions on the same subject. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). In the WDC performance application, a question set defines the type of summaries and their due dates that will accompany the deployment of a specific performance summary cycle. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | DueDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date that this specific question set is expected to be submitted by the recipient. This field applies only to performance summaries. | | FeedbackType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The description of the collection of questions that are written in context to the type of recipient answering them, relative to the subject of the summary. This field applies only to performance summaries. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the question set. Maximum length is 225 characters. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkFeedbackQuestionSet. | | PerformanceCycleId | Type reference Properties Create, Filter, Group, Nillable, Sort Description If a question set is associated to a performance summary cycle, then that cycle ID is referenced in this field. This field applies only to performance summaries. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkFeedbackQuestionSetOwnerSharingRule](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. [WorkFeedbackQuestionSetShare](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. # WorkFeedbackRequest Represents a single feedback request on a subject or topic (question) to a single recipient in the feedback application. In the case of offered feedback, WorkFeedbackRequest represents feedback that is offered about a subject. In the performance application, WorkFeedbackRequest represents a request for feedback on a set of questions from a question set, on a subject—for the recipient to complete and submit. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Considerations and Related Objects - After a request’s state is changed to Submitted, fields can’t be changed, except for LastSharedDate and IsUnreadByOwner. - If LastRemindDate is updated, a reminder notification will be sent to the request’s recipient (only possible when request is in Draft state). - When a new request is created, a notification is sent to the recipient. - When a recipient of a request submits their feedback (Draft->Submitted), a notification will be sent to requester (except for offered feedback). - Requester cannot modify the subject of the question set after a request is created. - For offered feedback (to user, to manager, or both), the person who is offering feedback is both the creator of WorkFeedbackRequest as well as the recipient. ## Fields | Field Name | Details | | --- | --- | | AdHocFeedback | Type textarea Properties Create, Filter, Nillable, Sort Description The content of the feedback. | | AdHocQuestion | Type textarea Properties Create, Filter, Nillable, Sort Description The content of the feedback question. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the WorkFeedbackRequest. | | FeedbackRequestState | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The current state of the feedback request. Allowed picklist values are: - Draft - Submitted - Declined | | FeedbackType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Specifies the type of request. Picklist values that are used for performance summaries: - Unspecified - Peer Summary - Self Summary - Manager Summary - Skip Level Summary Picklist values that are used for feedback: - Personal - Unsolicited to User - Unsolicited to Manager - Unsolicited to User and Manager - On Topic The type of the feedback determines the sharing and visibility rules that are applied to answers. | | IsDeployed | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the feedback is part of a deployed performance summary cycle. | | IsShareWithSubject | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the feedback is shared with the summary subject. | | IsUnreadByOwner | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the submitted request has not been seen by the requester. | | IsUnsolicited | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the feedback request is unsolicited feedback offered to another user. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkFeedbackRequest. | | LastRemindDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last time a reminder was sent to the recipient of this draft request. | | LastSharedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last time this request was shared with another user or group. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkFeedbackRequest. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the WorkFeedbackRequest. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkFeedbackRequest. | | PerformanceCycleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Used by performance summaries to link to a summary cycle. This field applies only to performance summaries. | | QuestionSetId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Question set associated with the current request. | | RecipientId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description User asked to provide feedback on the subject. | | RelatedObjectId | Type reference Properties Create, Filter, Group, Nillable, Sort Description Specifies a record in the system that this feedback request is related to. Used by ad-hoc feedback to gather feedback in the context of an opportunity or WDC goal. Used by performance summaries to link to a summary cycle. | | SharingScope | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The users that see the feedback. SharingScope can have the following values: - Nobody - Subject - Manager - SubjectAndManager | | SubjectId | Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the user that this request (or offer) is about. | | SubmitFeedbackToId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the person this performance summary feedback request (and its respective answers) is shared with. It’s also the ID of the person who owns the requested subject’s manager summary request. This field applies only to performance summaries. | | SubmittedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last time (in case it was reopened by admin) this request was submitted by the recipient. This field applies only to performance summaries. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkFeedbackRequestFeed](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. [WorkFeedbackRequestOwnerSharingRule](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. [WorkFeedbackRequestShare](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. # WorkforceCapacity Represents the time series for actual or forecasted workforce allocation. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license. To view, create, edit, and delete records, the user must have the Workforce Engagement Analyst permission set. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Additional information about the planning. | | EndDateTime | Type dateTime Properties Create, Filter, Sort, Update Description The end date and time of the planning. | | IsOmni | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Derived from isOmni field on Workload object. Indicates that the workload is Omni-based. If workload is null, the field value defaults to false. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the plan. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PlanType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of capacity plan. Possible values are: - Intraday—The plan shows intraday management. - LongTerm—The plan predicts the required number of full-time employees (FTEs). - ShortTerm—The plan predicts the required number of shifts. This field is available in API version 54.0 and later. | | StartDateTime | Type dateTime Properties Create, Filter, Sort, Update Description The start date and time of the planning. | | TimeZone | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The time zone associated with the capacity plan. Possible values are the time zones supported by Workforce Engagement. This field is available in API version 56.0 and later. | | WorkloadId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The foreign key to the Workload object. This is a relationship field. Relationship Name Workload Relationship Type Lookup Refers To Workload | ## 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. [WorkforceCapacityOwnerSharingRule](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. [WorkforceCapacityShare](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. # WorkforceCapacityUnit Represents the number of resources allocated or needed for a specific set of work items at a timestamp within a specific duration. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license. To view, create, edit, or delete records, the user must have the Workforce Engagement Analyst permission set. ## Fields | Field | Details | | --- | --- | | AssignedTotalCount | Type double Properties Create, Filter, Nillable, Sort Description The number of shifts assigned at specific time period. | | AvailableTotalCount | Type double Properties Create, Filter, Nillable, Sort Description The total number of shifts scheduled at a specific time period. | | Capacity | Type double Properties Create, Filter, Nillable, Sort Description Staffing prediction for a capacity plan. This field is available in API version 54.0 and later. | | DateTime | Type dateTime Properties Create, Filter, Sort, Update Description The timestamp of the data point. | | IsOmni | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Derived from the isOmni field on WorkforceCapacity. Indicates that the workload is Omni-based. The default value is 'false'. | | IsShiftTemplateNonStandard | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift template that’s used at a specific time period is a non-standard shift. This field is available in API version 53.0 and later. The default value is false. | | JobProfileName | Type string Properties Filter, Group, Nillable, Sort Description The derived field from the WorkDemographic SkillSet field. | | MaxCount | Type int Properties Create, Filter, Group, Nillable, Sort Description The max number of resources allocated or needed at a specific time period. | | MeasureUnit | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The time interval (in minutes) used in capacity plans. Possible values are: - 43200—Monthly for long-term capacity plans. This value is available in API version 54.0 and later. - 10080—Weekly - 1440—Daily - 60—Hourly - 30—30 minutes. Reserved for future use. - 15—15 minutes. Reserved for future use. The default value is '1440'. | | OriginalTotalCount | Type int Properties Create, Filter, Group, Nillable, Sort Description The original total number of resources allocated or needed at specific time period calculated from the planning process. | | ResourceGap | Type int Properties Filter, Group, Nillable, Sort Description Represents the resource gap between the available and required resources. | | ServiceTerritoryName | Type string Properties Filter, Group, Nillable, Sort Description The derived field from the WorkDemographic Region field. | | ShiftTemplateDuration | Type double Properties Create, Filter, Nillable, Sort, Update Description The duration of the shift template that’s used at a specific time period. This field is available in API version 53.0 and later. | | ShiftTemplateDurationType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the duration of the shift template that’s used at a specific time period is in minutes or hours. This field is available in API version 53.0 and later. Possible values are: - H—Hours - M—Minutes The default value is H. | | ShiftTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the shift template that’s used at a specific time period. This field is available in API version 53.0 and later. This is a relationship field. Relationship Name ShiftTemplate Relationship Type Lookup Refers To ShiftTemplate | | ShiftTemplateJobProfile | Type string Properties Filter, Group, Nillable, Sort Description The job profile that relates to the shift template that’s used at a specific time period. This field is available in API version 53.0 and later. | | ShiftTemplateName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the shift template that’s used at a specific time period. This field is available in API version 53.0 and later. | | ShiftTemplateStartTime | Type time Properties Create, Filter, Nillable, Sort, Update Description The start time of the shift template that’s used at a specific time period. This field is available in API version 53.0 and later. | | TotalCount | Type int Properties Filter, Group, Nillable, Sort Description The total number of resources allocated or needed at specific time period. It represents the updated count after the adjustment. This value is the same as OriginalTotalCount if no adjustments were made. This is a calculated field. | | WorkDemographicId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The foreign key to WorkDemographic object. This is a relationship field. Relationship Name WorkDemographic Relationship Type Lookup Refers To WorkDemographic | | WorkforceCapacityId | Type reference Properties Create, Filter, Group, Sort Description The foreign key to WorkCapacity object. This is a relationship field. Relationship Name WorkforceCapacity Relationship Type Lookup Refers To WorkforceCapacity | # WorkGoal Represents the components of a goal, such as its description and associated metrics. This object has been deprecated as of API version 35.0. Use the [Goal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_goal.htm#sforce_api_objects_Goal "The Goal object represents the components of a goal such as its name, description, and status.") object to query information about WDC goals. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Related [WorkGoalCollaborator](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workgoalcollaborator.htm "Represents collaborators on a WorkGoal object. This doesn’t include WorkGoal followers, which is handled by Chatter Feed Follow functionality. This object has been deprecated as of API version 35.0. Use the Goal object to query information about WDC goals."), [WorkGoalLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workgoallink.htm "Represents the relationship between two goals (many to many relationship). This object has been deprecated as of API version 35.0. Use the GoalLink object to query information about the relationship between two WDC goals."), [WorkGoalFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customobject__feed.htm "Represents the feed, specifically posts and feed-tracked changes, on a custom object.") ## Fields | Field Name | Details | | --- | --- | | ActualValue | Type double Properties Create, Filter, Nillable, Sort, Update Description The actual value of the WorkGoal metric. Applicable only to WorkGoal objects of Type: Metric. | | ActualValueExternalUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Contains a URL that references WDC data synchronization for the actual value of a metric. Applicable only to WorkGoal objects of Type: Metric. | | CompletionDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The completion date of the goal. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Field-level security limits access to only administrators and owners by default, and only they can complete a goal. | | Description | Type textarea (max length 4000) Properties Create, Nillable, Update Description The description of the goal. | | DueDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the WorkGoal object is due (optional). Applicable only to WorkGoal objects of Type: Metric. | | FlaggedAs | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The progress of the WorkGoal object. Applicable only to WorkGoal objects of Type: Metric. Possible values: - On Track: Progress on the metric is on track. - Behind: Progress on the metric is behind schedule. - Postponed: The metric is postponed. - Critical: Progress on the metric is critical. | | ImageUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL for the goal image. The image must be stored in Documents and set as externally available. Applicable only to WorkGoal objects of Type: Goal. | | InitialValue | Type double Properties Create, Filter, Nillable, Sort, Update Description The initial value of the WorkGoal metric. Applicable only to WorkGoal objects of Type: Metric and MetricType: Progress or Percent. | | IsKeyCompanyGoal | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Used to indicate if the goal is a key company goal. Used for the Company Goal Showcase. Applicable only to WorkGoal objects of Type: Goal. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this goal. | | LastSyncDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time stamp that indicates when the actual value was last synced with the associated metrics report. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this goal. | | MetricType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of metric that is represented. (See values in the following list). Applies only to WorkGoal objects of Type: Metric. Possible values: - Progress: ActualValue / TargetValue as a percentage - Percent: the metric as a percentage only - YesNo: the completed / not completed metric as a milestone - Absolute: Deprecated | | MetricTypeDataSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies how the metric (ActualValue and CurrentValue) is updated. Applies only to WorkGoal objects of Type: Goal and Metric. Possible values: - Manual: indicates that the actual and target value of the metric is updated manually by the user - Rollup: indicates that the actual and target value of a goal is rolled up automatically by WDC Goals - DataSyncActualOnly: indicates that the actual value of the metric is linked to a Salesforce report | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the WorkGoal object. (Maximum length is 255.) | | OverallStatus | Type string Properties Filter, Group, Nillable, Sort Description The overall calculated status of the WorkGoal based on FlaggedAs and CompletionDate. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who owns the WorkGoal. | | ParentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the structural parent of the WorkGoal. For example, a goal that has a metric is represented by a WorkGoal of Type Metric, which has a parent of WorkGoal of Type Goal. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The root and the parent must be set to the parent goal for any child metrics. | | Progress | Type percent Properties Filter, Nillable, Sort Description Read Only. The overall progress of the WorkGoal. | | RootId | Type reference to a WorkGoal object Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the structural root of the WorkGoal. For example, a goal that has a metric is represented by a WorkGoal of Type Metric, which has a root of WorkGoal of Type Goal. | | State | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The state of the WorkGoal object. Applies only to WorkGoal objects of Type: Metric. Possible values: - Draft: the draft state for the WorkGoal - Published: published state for the WorkGoal - Archived: archived state for the WorkGoal (for example, goals that no longer apply) | | TargetValue | Type double Properties Create, Filter, Nillable, Sort, Update Description The target value of the WorkGoal. Applies only to WorkGoal objects of Type: Metric. | | Type | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of the WorkGoal object, used to differentiate between the components of a goal. (This field is used to represent components of a goal such as its description and associated metrics.) Possible values: - Goal: a goal - Metric: a metric (typically associated with goals) - Objective: an objective - KeyResult: a key result (typically associated with objectives - V2Mom: a V2MOM (pilot feature) - Vision: a vision (pilot feature — typically associated with V2MOM) - Value: a value (pilot feature - typically associated with V2MOM) - Method: a method (pilot feature - typically associated with V2MOM) - Obstacle: an obstacle (pilot feature - typically associated with V2MOM) - Measure: a measure (pilot feature - typically associated with a method) ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Administrators can rename goals and metrics to objectives and key results, respectively. If this preference is enabled, use the Type Objective or KeyResult. Otherwise, use the default Type Goal or KeyResult. | | Weight | Type double Properties Create, Filter, Nillable, Sort, Update Description The weight of the goal or metric. The sum of the weights should equal 100%. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkGoalFeed](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.") (API verison 35.0) Feed tracking is available for the object. [WorkGoalHistory](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkGoalOwnerSharingRule](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkGoalShare](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. # WorkGoalCollaborator Represents collaborators on a WorkGoal object. This doesn’t include WorkGoal followers, which is handled by Chatter Feed Follow functionality. This object has been deprecated as of API version 35.0. Use the [Goal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_goal.htm#sforce_api_objects_Goal "The Goal object represents the components of a goal such as its name, description, and status.") object to query information about WDC goals. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | InvitationDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date that a user was invited to become a collaborator (nill if the user was not invited). | | State | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the state of the collaborating user. Whether the user has not responded, joined, or declined collaboration. The possible values are: - PendingResponse: a user who was invited to collaborate but hasn’t joined or declined - Joined: a user who is collaborating on a goal (joined/commit) - Declined: a user who declined to collaborate on a goal | | UserId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The collaborating user. | | WorkGoalId | Type reference Properties Create, Filter, Group, Sort Description The WorkGoal object that this collaborator is a part of. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkGoalCollaboratorHistory](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). # WorkGoalCollaboratorHistory Represents the history of changes to the values in the fields in a WorkGoalCollaborator object. Access is read-only. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object has been deprecated as of API version 35.0. Use the [Goal](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_goal.htm#sforce_api_objects_Goal "The Goal object represents the components of a goal such as its name, description, and status.") object to query information about WDC goals in API version 35.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name of the standard or custom field. | | NewValue | Type anyType Properties Nillable, Sort Description New value of the modified field. | | OldValue | Type anyType Properties Nillable, Sort Description Previous value of the modified field. | | WorkGoalCollaboratorId | Type reference Properties Filter, Group, Sort Description ID of the WorkGoalCollaborator object that is associated with this history entry. | # WorkGoalHistory Represents the history of changes to the values in the fields of a WorkGoal. Access is read-only. This object has been deprecated as of API version 35.0. Use the GoalHistory object to query historical information for WDC goals. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Fields | Field Name | Details | | --- | --- | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | NewValue | Type Any Type Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type Any Type Properties Nillable, Sort Description The latest value of the field before it was changed. | | WorkGoalId | Type reference Properties Filter, Group, Sort Description ID of the Goal. Label is Goal ID. | # WorkGoalLink Represents the relationship between two goals (many to many relationship). This object has been deprecated as of API version 35.0. Use the [GoalLink](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_goallink.htm#sforce_api_objects_GoalLink "Represents the relationship between two goals. This is a many-to-many relationship, meaning that each goal can link to many other goals.") object to query information about the relationship between two WDC goals. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() , upsert() ## Fields | Field Name | Details | | --- | --- | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the WorkGoalLink is active (true) or not (false) | | LinkType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of link | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated name of the goal link | | SourceGoalId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the source WorkGoal object | | TargetGoalId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the target WorkGoal object | # WorkGoalShare Represents a sharing entry on a WorkGoal object. This object has been deprecated as of API version 35.0. Use the GoalShare object to query information about sharing for WDC goals. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. | Field Name | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the goal. The possible values are: - Read - Edit - All: This value is not valid when you create, update, or delete records This field must be set to an access level that is higher than the organization’s default access level for goals. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description ID of the WorkGoal object that is associated with this sharing entry. | | RowCause | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Owner—The User is the owner of the WorkGoal or is in a user role above the WorkGoal owner in the role hierarchy. - Manual—The User or Group has access, because a user with “All” access manually shared the WorkGoal with the user or group. - Rule—The User or Group has access via a WorkGoal sharing rule. - GuestRule—The User or Group has access via a WorkGoal guest user sharing rule. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that was given access to the goal. This field can’t be updated. | # WorkItem Represents a logical unit of work, such as a user story, task, or bug, used to track the progress of metadata and configuration data changes within a Lifecycle Center project. A work item moves through multiple development lifecycle stages until all development work is complete and the work item is part of the release pipeline. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AssignedToId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Lifecycle Center user assigned to this work item. Lifecycle Center uses this field only to display the user’s name in the UI. This is a relationship field. This field is a relationship field. Relationship Name AssignedTo Refers To User | | Description | Type textarea Properties Create, Nillable, Update Description A detailed description of the work item. Lifecycle Center uses this field only to display the description in the UI. | | DevelopmentApprovedById | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who approved the work item for promotion. This field is a relationship field. Relationship Name DevelopmentApprovedBy Refers To User | | DevelopmentEnvironmentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the development environment where this work item was developed. This field is a relationship field. Relationship Name DevelopmentEnvironment Refers To DevopsEnvironment | | DevopsPipelineStageId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the current pipeline stage associated with this work item. This field is a relationship field. Relationship Name DevopsPipelineStage Refers To DevopsPipelineStage | | DevopsProjectId | Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the Lifecycle Center project to which the work item belongs. This is a relationship field. This field is a polymorphic relationship field. Relationship Name DevopsProject Refers To DevopsProject | | IsDevelopmentApproved | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a team member has approved the work item for promotion. The default value is false. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastSyncDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time the work item feature branch was last synced with the source control repository. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description A unique identifier for the work item, typically using a WI- prefix. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of this work item. This is a relationship field. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User | | ParentWorkItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent work item, if this work item is a subtask of a larger unit of work This field is a relationship field. Relationship Name ParentWorkItem Refers To WorkItem | | RebaseBranchId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the branch used for rebase operations to resolve dependencies. This field is a relationship field. Relationship Name RebaseBranch Refers To SourceCodeRepositoryBranch | | RebaseStatusId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the DevopsRequestInfo record that tracks the rebase operation status. This field is a relationship field. Relationship Name RebaseStatus Refers To DevopsRequestInfo | | ReviewRemoteReference | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the change request for this work item in the source control system. In GitHub, a change request is called a pull request (PR) and the ID is the PR number. | | SourceCodeRepositoryBranchId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the feature branch in the source control repository where changes for this work item are stored. Lifecycle Center initially sets this value when the work item moves to IN\_PROGRESS. The value persists until the work item becomes part of a pipeline stage. This field is a relationship field. Relationship Name SourceCodeRepositoryBranch Refers To SourceCodeRepositoryBranch | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The current state of the work item in the release cycle. The default value is NEW. Possible values are: - NEW—The initial status upon creation; work hasn't yet started. - IN\_PROGRESS—Active development in the development environment. - IN\_REVIEW—Changes are committed and a pull request is created for team review. - READY\_TO\_PROMOTE—The work item is approved and is ready for promotion to the first pipeline stage. - PROMOTED—The work item is promoted to a pipeline stage. - MERGE\_CONFLICT—Indicates that the work item has conflicts that must be resolved before promotion. - NEVERED—The work item is inactive and won’t be promoted. - COMBINED—The work item was merged into another work item to resolve conflicts or dependencies. - CLOSED—Work is complete, fully tested, and promoted through the entire pipeline. The default value is NEW. | | Subject | Type string Properties Create, Filter, Group, Sort, Update Description A brief description or title of the work item. | ## Usage Use this object to track the progress of a task and the user assigned to it. You can develop and commit changes either within a connected development environment or by using your own external development tools. # WorkItemComponent Represents a metadata component or configuration data record that’s linked to a WorkItemComponentList record in a Lifecycle Center project. The record includes details such as the change type, metadata member, and change tracking information. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ChangeType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of change applied to the component or configuration data record. The default value is NEW. Possible values are: - CHANGE—An update to an existing component or configuration data record. - DATA—A configuration data record change. - DELETE—A destructive change that removes the component or configuration data record. - MANUAL—A component or configuration data record added manually by you. requiring manual deployment steps. - NEW—A new component or configuration data record. The default value is NEW. | | ChangedBy | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name or identifier of the user who made the change in the development environment. | | ChangedOn | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date an time when the change occurred. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. | | MemberName | Type string Properties Create, Filter, Group, Sort, Update Description The name of the metadata component or configuration data record. For example, MyCustomTrigger. | | MemberType | Type string Properties Create, Filter, Group, Sort, Update Description The type of metadata component. For example, ApexClass, CustomObject, or Layout. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique, automatically generated name of the work item component record. For example, WIC-XXXXXXXXX. | | NumberOfRecords | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of records included in the tracked change. | | VersionNumber | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The version number for the component or configuration data record. | | WorkItemComponentListId | Type reference Properties Create, Filter, Group, Sort Description The ID of the parent WorkItemComponentList record that this component belongs to. This is a relationship field. This field is a relationship field. Relationship Name WorkItemComponentList Relationship Type Master-detail Refers To WorkItemComponentList (the parent object) | #### See Also - [DevopsActivityLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsactivitylog.htm "Represents the history of activities performed within Lifecycle Center. The object provides visibility into the users, actions, and outcomes. This object is available in API version 67.0 and later.") - [DevopsEnvDeploymentMbr](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsenvdeploymentmbr.htm "Represents a metadata component or configuration data record included in a deployment to a Lifecycle Center pipeline environment. Use it to verify what was promoted or deployed. This object is available in API version 66.0 and later.") # WorkItemEvent Represents real-time notifications for work item status changes in a Lifecycle Center project. This object is available in API version 66.0 and later. ## Supported Calls create(), describeSObjects() ## Fields | Field | Details | | --- | --- | | EventUuid | Type string Properties Nillable Description The universally unique identifier (UUID) for the event. | | NewStatus | Type string Properties Create, Nillable Description The work item status after the lifecycle update, such as Ready to Promote or Promoted. | | OldStatus | Type string Properties Create, Nillable Description The work item status before the lifecycle update, such as In Progress. | | Project | Type string Properties Create, Nillable Description The ID of the project that contains the work item. | | ReplayId | Type string Properties Nillable Description The event bus replay ID. Subscribers can use this value to replay event messages within the retention window. | | WorkItemName | Type string Properties Create, Nillable Description The name of the work item. For example, WI-000001. | #### See Also - [WorkItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workitem.htm "Represents a logical unit of work, such as a user story, task, or bug, used to track the progress of metadata and configuration data changes within a Lifecycle Center project. A work item moves through multiple development lifecycle stages until all development work is complete and the work item is part of the release pipeline. This object is available in API version 67.0 and later.") - [DevopsActivityLog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsactivitylog.htm "Represents the history of activities performed within Lifecycle Center. The object provides visibility into the users, actions, and outcomes. This object is available in API version 67.0 and later.") - [DevopsRequestInfo](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_devopsrequestinfo.htm "Represents a specific request for a Lifecycle Center operation, such as a commit, deploy, promotion, rebase, or back sync, and tracks its overall status and outcome. This object is available in API version 66.0 and later.") # Workload Represents the time series for work item volume and average handle time from aggregation and forecasting processes. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org must have the Workforce Engagement license. To view, create, edit, or delete records, the user must have the Workforce Engagement Analyst permission set. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Additional information about the workload | | EndDateTime | Type dateTime Properties Create, Filter, Sort Description The end date and time of the time series represented by the Workload object. | | IsOmni | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates that the workload is Omni-based. The default value is 'false'. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The workload name. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the workload. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | StartDateTime | Type dateTime Properties Create, Filter, Sort Description The start date and time of the time series represented by the Workload object. | | TimeZone | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The time zone associated with the workload. Possible values are the time zones supported by Workforce Engagement. This field is available in API version 56.0 and later. | | WorkloadType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of the workload. Possible values are: - F—Forecasted - H—Historical - IH—Intraday History. This value is available in API version 55.0 and later. The default value is 'H'. | ## 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. [WorkloadOwnerSharingRule](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. [WorkloadShare](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. # WorkloadUnit Represents the number of work items and average handle time in a specific time interval. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules The org must have a Workforce Engagement license. To view, create, edit, and delete records, the user must have the Workforce Engagement Analyst permission set. ## Fields | Field | Details | | --- | --- | | AverageHandleTime | Type double Properties Filter, Nillable, Sort Description The average handle time at a specific period of time. | | Channel | Type string Properties Filter, Group, Nillable, Sort Description The channel value. | | CustomWorkType | Type string Properties Filter, Group, Nillable, Sort Description The derived field of WorkDemographic.CustomWorkType for the custom dimension value. | | DateTime | Type dateTime Properties Create, Filter, Sort, Update Description The timestamp of the single data point in the time series of the workload. | | IsOmni | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Derived from isOmni field in workload. Indicates that the workload is Omni-based The default value is 'false'. | | MeasureUnit | Type string Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The time interval (in minutes) used in the workload. Possible values are: - 43200—Monthly. Reserved for future use. - 10080—Weekly - 1440—Daily - 60—Hourly - 30—30 minutes. Reserved for future use. - 15—15 minutes. Reserved for future use. The default value is '1440'. | | Region | Type string Properties Filter, Group, Nillable, Sort Description The derived field from WorkDemographic.Region for the region value. | | SkillSet | Type string Properties Filter, Group, Nillable, Sort Description The derived field from WorkDemographic.SkillSet for the skill value. | | TotalCount | Type int Properties Create, Filter, Group, Sort Description The total number work items at a specific period of time. | | WorkDemographicId | Type reference Properties Create, Filter, Group, Sort, Update Description The foreign key to the WorkDemographic object. This is a relationship field. Relationship Name WorkDemographic Relationship Type Lookup Refers To WorkDemographic | | WorkloadId | Type reference Properties Create, Filter, Group, Sort Description The foreign key to the Workload object. This is a relationship field. Relationship Name Workload Relationship Type Lookup Refers To Workload | | WorkloadType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The derived field from Workload.WorkloadType to indicate the type of workload, for example, a history or forecast workload. Possible values are: - F—Forecasted - H—Historical The default value is 'H'. | # WorkOrder Represents field service work to be performed for a customer. This object is available in API version 36.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules - Work orders or Field Service must be enabled. - The following fields can’t be edited, regardless of your field-level security settings: - Discount - GrandTotal - IsGeneratedFromMaintenancePlan - RootWorkOrderId ## Fields | Field Name | Details | | --- | --- | | AccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the work order. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account | | Address | Type address Properties Filter, Nillable Description The compound form of the address where the work order is completed. | | AssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset associated with the work order. This is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | AssetWarrantyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset warranty term associated with the work order. This field is available in API version 50.0 and above. | | BusinessHoursId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The business hours associated with the work order. This is a relationship field. Relationship Name BusinessHours Relationship Type Lookup Refers To BusinessHours | | CaseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the work order. This is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where the work order is completed. Maximum length is 40 characters. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The contact associated with the work order. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the work order is completed. Maximum length is 80 characters. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. The label in the user interface is Currency ISO Code. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the work order. Try to include the steps needed to change the work order’s status to Completed. | | Discount | Type percent Properties Filter, Nillable, Sort Description Read only. The weighted average of the discounts on all line items in the work order. It can be any positive number up to 100. | | Duration | Type double Properties Create, Filter, Nillable, Sort, Update Description The estimated time required to complete the work order. Specify the duration unit in the Duration Type field. If the Duration field on a Work Order is null, it adopts the duration value from the Work Type object when the work type is updated or inserted. Work order duration and work order line item duration are independent of each other. If you want work order duration to automatically show the sum of the work order line items’ duration, replace the Duration field on work orders with a custom roll-up summary field. | | DurationInMinutes | Type double Properties Filter, Nillable, Sort Description The estimated duration in minutes. For internal use only. | | DurationType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of the duration: Minutes or Hours. | | EndDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the work order is completed. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the EndDate to 365 days after the StartDate. | | EntitlementId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The entitlement associated with the work order. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. | | GrandTotal | Type currency Properties Filter, Nillable, Sort Description Read only. The total price of the work order with tax added. | | IsClosed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the work order is closed (true) or open (false). | | IsGeneratedFromMaintenancePlan | Type boolean Properties Defaulted on create, Filter, Group, Sort Description (Read Only) Indicates that the work order was generated from a maintenance plan (true), rather than manually created (false). | | IsStopped | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a milestone is paused (true) or counting down (false). This field is available only if **Enable stopped time and actual elapsed time** is selected on the Entitlement Settings page. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the work order was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the work order was last viewed. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the work order is completed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. | | LineItemCount | Type int Properties Filter, Group, Nillable, Sort Description The number of work order line items in the work order. Its label in the user interface is Line Items. | | LocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location associated with the work order. For example, a work site. This is a relationship field. Relationship Name Location Relationship Type Lookup Refers To Location | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the work order is completed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. | | MaintenancePlanId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The maintenance plan associated with the work order. When the work order is auto-generated from a maintenance plan, this field automatically lists the related plan. | | MaintenanceWorkRuleId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the maintenance work rule that generated this work order. This field is available in API version 50.0 and above. | | MilestoneStatus | Type string Properties Group, Nillable, Sort Description Indicates the status of a milestone. This field is visible if an entitlement process is applied to a work order. | | MinimumCrewSize | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The minimum crew size allowed for a crew assigned to the work order. If you’re not using the Field Service managed package, this field serves as a suggestion rather than a rule. If you are using the managed package, the scheduling optimizer counts the number of service crew members on a service crew to determine whether it fits a work order’s minimum crew size requirement. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The work order’s assigned owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentWorkOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order’s parent work order, if it has one. Create a custom report to view a work order’s child work orders. This is a relationship field. Relationship Name ParentWorkOrder Relationship Type Lookup Refers To WorkOrder | | PostWorkSummary | Type textarea Properties Create, Nillable, Update Description The summary of a completed work order that’s either entered manually or created by an AI agent. | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code where the work order is completed. Maximum length is 20 characters. | | PreWorkBriefPromptTemplate | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the activated Pre-Work Brief prompt template. | | Pricebook2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The price book associated with the work order. Adding a price book to the work order lets you assign different price book entries to the work order’s line items. This is only available if Product2 is enabled. This is a relationship field. Relationship Name Pricebook2 Relationship Type Lookup Refers To Pricebook2 | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The priority of the work order. The picklist includes the following values, which can be customized: - Low - Medium - High - Critical | | ProductServiceCampaignId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product service campaign associated with the work order. | | ProductServiceCampaignItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product service campaign item associated with the work order. | | RecommendedCrewSize | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The recommended number of people on the service crew assigned to the work order. For example, you might have a Minimum Crew Size of 2 and a Recommended Crew Size of 3. | | ReturnOrderId | Type reference Properties Filter, Group, Nillable, Sort Description The return order associated with the work order. | | ReturnOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The return order line item associated with the work order. | | RootWorkOrderId | Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level work order in a work order hierarchy. Depending on where a work order lies in the hierarchy, its root could be the same as its parent. View a work order’s child work order in the Child Work Orders related list. This is a relationship field. Relationship Name RootWorkOrder Relationship Type Lookup Refers To WorkOrder | | ServiceAppointmentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of service appointments on the work order. | | ServiceContractId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service contract associated with the work order. | | ServiceDocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The template ID which sets the template for each service document for the Document Builder feature. | | ServiceReportLanguage | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language used for all service reports and service report previews created for the work order, its service appointments, and its work order line items and their service appointments. If the field is blank, service reports are generated in the default language in Salesforce of the person creating the report. To appear as an option in the ServiceReportLanguage field, a language must be set up in Translation Workbench or be one of Salesforce’s 18 [fully supported languages](https://help.salesforce.com/articleView?id=faq_getstart_what_languages_does.htm&type=5&language=en_US). Rich text fields and service report section names aren’t translated. | | ServiceReportTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service report template that the work order uses. If you don’t specify a service report template on a work order, it uses the service report template listed on its work type. If the work type doesn’t list a template or no work type is specified, the work order uses the default service report template. | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service territory where the work order is taking place. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | SlaExitDate | Type dateTime Properties Filter, Nillable, Sort Description The time that the work order exits the entitlement process. | | SlaStartDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time that the work order enters the entitlement process. You can update or reset the time if you have “Edit” permission on work orders. | | StartDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the work order goes into effect. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the StartDate to the date when the Status changes to In Progress. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the work order is completed. Maximum length is 80 characters. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the work order. The picklist includes the following values, which can be customized: - New—Work order was created, but there hasn’t yet been any activity. - In Progress—Work has begun. - On Hold—Work is paused. - Completed—Work is complete. - Cannot Complete—Work could not be completed. - Closed—All work and associated activity is complete. - Canceled—Work is canceled, typically before any work began. Changing a work order’s status does not affect the status of its work order line items or associated service appointments. | | StatusCategory | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each Status value falls into. The Status Category field has eight default values: seven values which are identical to the default Status values, and a None value for statuses without a status category. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Waiting for Response value, you may decide that it belongs in the On Hold category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) | | StopStartDate | Type dateTime Properties Filter, Nillable, Sort Description Indicates when the milestone was paused. The label in the user interface is Stopped Since. | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name where the work order is completed. | | Subject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The subject of the work order. Try to describe the nature and purpose of the job to be completed. For example, “Annual On-Site Well Maintenance.” Maximum length is 255 characters. | | Subtotal | Type currency Properties Filter, Nillable, Sort Description Read only. The total of the work order line items’ subtotals before discounts and taxes are applied. | | SuggestedMaintenanceDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The suggested date that the work order is completed. When the work order is auto-generated from a maintenance plan, this field is automatically populated based on the maintenance plan’s settings. | | Tax | Type currency Properties Create, Filter, Nillable, Sort, Update Description The total tax on the work order. You can enter a number with or without the currency symbol and use up to two decimal places. For example, in a work order whose total price is $100, enter $10 to apply a 10% tax. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description Read only. The total of the work order line items’ prices. This value has discounts applied but not tax. | | WorkOrderNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An eight-digit, auto-generated number that identifies the work order. | | WorkTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work type associated with the work order. When a work type is selected, the work order automatically inherits the work type’s Duration, Duration Type, and required skills. If the Duration field for the work type is null, enter the duration value. This is a relationship field. Relationship Name WorkType Relationship Type Lookup Refers To WorkType | ## 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. [WorkOrderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [WorkOrderFeed](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. [WorkOrderHistory](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. [WorkOrderOwnerSharingRule](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. [WorkOrderShare](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. # WorkOrderHistory Represents the history of changes made to tracked fields on a work order. This object is available in API version 36.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules Work orders or Field Service must be enabled in your organization, and field tracking for work order fields must be configured. ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The value of the field before it was changed. | | WorkOrderId | Type reference Properties Filter, Group, Sort Description ID of the work order being tracked. The history is displayed on the detail page for this record. This is a relationship field. Relationship Name WorkOrder Relationship Type Lookup Refers To WorkOrder | # WorkOrderLineItem Represents a subtask on a work order in field service. This object is available in API version 36.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Work orders or Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | Address | Type address Properties Filter, Nillable Description The compound form of the address where the line item is completed. | | AssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset associated with the work order line item. The asset is not automatically inherited from the parent work order. This is a relationship field. Relationship Name Asset Relationship Type Lookup Refers To Asset | | AssetWarrantyId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset warranty term associated with the work order line item. This field is available in API version 50.0 and above. | | City | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where the line item is completed. Maximum length is 40 characters. | | Country | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the line item is completed. Maximum length is 80 characters. | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. The label in the user interface is Currency ISO Code. | | Description | Type textarea Properties Create, Nillable, Update Description The description of the work order line item. Try to describe the steps needed to mark the line item Completed. | | Discount | Type percent Properties Create, Filter, Nillable, Sort, Update Description The percent discount to apply to the line item. You can enter a number with or without the percent symbol, and you can use up to two decimal places. | | Duration | Type double Properties Create, Filter, Nillable, Sort, Update Description The estimated time required to complete the line item. Specify the duration unit in the Duration Type field. If the Duration field on a Work Order is null, it adopts the duration value from the Work Type object when the work type is updated or inserted. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Work order duration and work order line item duration are independent of each other. If you want work order duration to automatically show the sum of the work order line items’ duration, replace the Duration field on work orders with a custom roll-up summary field. | | DurationInMinutes | Type double Properties Filter, Nillable, Sort Description The estimated duration in minutes. For internal use only. | | DurationType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of the duration: Minutes or Hours. | | EndDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the line item is completed. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the EndDate to 365 days after the StartDate. | | GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | IsClosed | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the line item has been closed. Changing the line item’s status to Closed causes this checkbox to be selected in the user interface (sets IsClosed to true). ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip Use this field to report on closed versus open work order line items. | | IsGeneratedFromMaintenancePlan | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Identifies whether the work order line item is generated from a maintenance plan. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the line item was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the line item was last viewed. | | Latitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the line item is completed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | LineItemNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number that identifies the work order line item. Each work order’s line items start at 1. | | ListPrice | Type currency Properties Filter, Nillable, Sort Description The price of the line item (product) as listed in its corresponding price book entry. If a price book entry isn’t specified, the list price defaults to zero. | | LocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A location associated with the work order line item. For example, a work site. This is a relationship field. Relationship Name Location Relationship Type Lookup Refers To Location | | Longitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the line item is completed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This field is available in the API only. | | MaintenancePlanId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The maintenance plan associated with the work order line item. | | MaintenanceWorkRuleId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the maintenance work rule that generated this line item. This field is available in API version 50.0 and above. | | MinimumCrewSize | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The minimum crew size allowed for a crew assigned to the line item. If you’re not using the Field Service managed package, this field serves as a suggestion rather than a rule. If you are using the managed package, the scheduling optimizer counts the number of service crew members on a service crew to determine whether it fits a work order line item’s minimum crew size requirement. | | OrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order associated with the line item. For example, you may need to order replacement parts before you can complete the line item. This is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order | | ParentWorkOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The line item’s parent work order line item, if it has one. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip Create a custom report to view a line item’s child line items. This is a relationship field. Relationship Name ParentWorkOrderLineItem Relationship Type Lookup Refers To WorkOrderLineItem | | PostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code where the line item is completed. Maximum length is 20 characters. | | PricebookEntryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The price book entry (product) associated with the line item. The label in the user interface is Product. This field’s lookup search only returns products that are included in the work order’s price book. This is a relationship field. Relationship Name PricebookEntry Relationship Type Lookup Refers To PricebookEntry | | Priority | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The priority of the line item. The picklist includes the following values, which can be customized: - Low - Medium - High - Critical | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description (Read only) The product associated with the price book entry. This field is not available in the user interface. For best results, use the PricebookEntryId field in any custom code or layouts. This is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2 | | ProductServiceCampaignId | Type reference Properties Filter, Group, Nillable, Sort Description The product service campaign associated with the work order line item. | | ProductServiceCampaignItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product service campaign item associated with the work order line item. | | Quantity | Type double Properties Create, Filter, Nillable, Sort, Update Description Number of units of the line item included in the associated work order. | | RecommendedCrewSize | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The recommended number of people on the service crew assigned to the line item. For example, you might have a Minimum Crew Size of 2 and a Recommended Crew Size of 3. | | ReturnOrderId | Type reference Properties Filter, Group, Nillable, Sort Description The return order associated with the work order line item. | | ReturnOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The return order line item associated with the work order line item. | | RootWorkOrderLineItemId | Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level line item in a work order line item hierarchy. Depending on where a line item lies in the hierarchy, its root could be the same as its parent. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note View a line item’s child line items in the Child Work Order Line Items related list. This is a relationship field. Relationship Name RootWorkOrderLineItem Relationship Type Lookup Refers To WorkOrderLineItem | | ServiceAppointmentCount | Type int Properties Filter, Group, Nillable, Sort Description The number of service appointments on the work order line item. | | ServiceDocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The template ID which sets the template for each service document for the Document Builder feature. | | ServiceReportTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service report template that the line item uses. If you don’t specify a service report template on a work order line item, it uses the service report template listed on its work type. If the work type doesn’t list a template or no work type is specified, the line item uses the default service report template. | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service territory where the line item is completed. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | StartDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the line item goes into effect. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the StartDate to the date when the Status changes to In Progress. | | State | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the line item is completed. Maximum length is 80 characters. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the line item. The picklist includes the following values, which can be customized: - New—Line item was created, but there hasn’t yet been any activity. - In Progress—Work has begun. - On Hold—Work is paused. - Completed—Work is complete. - Cannot Complete—Work could not be completed. - Closed—All work and associated activity is complete. - Canceled—Work is canceled, typically before any work began. | | StatusCategory | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each Status value falls into. The Status Category field has eight default values: seven values which are identical to the default Status values, and a None value for statuses without a status category. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Waiting for Response value, you may decide that it belongs in the On Hold category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) | | Street | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name where the line item is completed. | | Subject | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A word or phrase describing the line item. | | Subtotal | Type currency Properties Filter, Nillable, Sort Description (Read only) The line item’s unit price multiplied by the quantity. | | SuggestedMaintenanceDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when maintenance work is planned. | | TotalPrice | Type currency Properties Filter, Nillable, Sort Description Read only. The line item’s subtotal with discounts applied. | | UnitPrice | Type currency Properties Create, Filter, Nillable, Sort, Update Description Initially, the unit price for a work order line item is the line item’s list price from the price book, but you can change it. | | WorkOrderId | Type reference Properties Create, Filter, Group, Sort Description The line item’s parent work order. Because work order line items must be associated with a work order, this is a required field. This is a relationship field. Relationship Name WorkOrder Relationship Type Lookup Refers To WorkOrder | | WorkTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work type associated with the line item. When a work type is selected, the line item automatically inherits the work type’s Duration, Duration Type, and required skills. If the Duration field for the work type is null, enter the duration value. This is a relationship field. Relationship Name WorkType Relationship Type Lookup Refers To WorkType | ## Usage A work order line item is a child record of a work order. It represents a specific subtask on a work order. For example, suppose a customer purchased a truck from you. The truck is represented as an asset in your Salesforce org. After some time, the truck needs both headlight bulbs replaced. Here’s one way that you can use work orders and work order line items to track the repair. 1. Create a work order named “Replace Headlight Bulbs” from the asset record detail page. 2. Add three work order line items to the work order: “Replace Left Headlight Bulb,” “Replace Right Headlight Bulb,” and “Test Headlights.” 3. Assign the work order to a technician via a queue. 4. As the technician completes each line item, he or she marks the item Completed. 5. When all the line items are complete, the technician marks the work order Completed. ## 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. [WorkOrderLineItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [WorkOrderLineItemFeed](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. [WorkOrderLineItemHistory](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. # WorkOrderLineItemHistory Represents the history of changes made to tracked fields on a work order line item. This object is available in API version 36.0 and later. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules Work orders or Field Service must be enabled in your organization, and field tracking for work order line item fields must be configured. ## Fields | Field Name | Details | | --- | --- | | DataType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Data type of the field that was changed. | | Field | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. | | NewValue | Type anyType Properties Nillable, Sort Description The new value of the field that was changed. | | OldValue | Type anyType Properties Nillable, Sort Description The value of the field before it was changed. | | WorkOrderLineItemId | Type reference Properties Filter, Group, Sort Description ID of the work order line item being tracked. The history is displayed on the detail page for this record. This is a relationship field. Relationship Name WorkOrderLineItem Relationship Type Lookup Refers To WorkOrderLineItem | # WorkOrderLineItemStatus Represents a possible status of a work order line item in field service. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description The API name of the status value. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the status value is the default status on work orders. Only one status value can be the default. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The label for the picklist value that appears in the UI. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description The value’s position in the drop-down list of values in the UI. | | StatusCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status category that the value corresponds to. The Status Category field has seven values which are identical to the default Status values. | ## Usage The Status field on work order line items comes with the following values: - New—Line item was created, but there hasn’t yet been any activity. - In Progress—Work has begun. - On Hold—Work is paused. - Completed—Work is complete. - Cannot Complete—Work could not be completed. - Closed—All work and associated activity is complete. - Canceled—Work is canceled, typically before any work began. The WorkOrderLineItemStatus object corresponds to the Status field. Adding a value to the Status field—for example, Canceled By Customer—creates a work order line item status record, and vice versa. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Work order line items also come with a StatusCategory field whose values are identical to the default Status values. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Customer Absent value, you may decide that it belongs in the Cannot Complete category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) # WorkOrderShare Represents a sharing entry on a work order. This object is available in API version 36.0 and later. You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Work orders or Field Service must be enabled in your organization. External users can’t access this object. ## Fields | Field Name | Details | | --- | --- | | AccessLevel | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the work order. The possible values are: - Read - Edit - All (This value isn’t valid for create or update calls.) Set to an access level that is at least equal to the organization’s default work order access level. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The work order associated with the sharing entry. This is a relationship field. Relationship Name Parent Relationship Type Lookup Refers To WorkOrder | | RowCause | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: - Manual—The User or Group has access because a user with “All” access manually shared the work order. - Owner—The User is the owner of the work order. - Rule—The User or Group has access via a work order sharing rule. - GuestRule—The User or Group has access via a work order guest user sharing rule. - LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. | | UserOrGroupId | Type reference Properties Create, Filter, Group, Sort Description (Read Only) ID of the user or group that has access to the work order. This is a polymorphic relationship field. Relationship Name UserOrGroup Relationship Type Lookup Refers To Group, User | # WorkOrderStatus Represents a possible status of a work order in field service. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description The API name of the status value. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the status value is the default status on work orders. Only one status value can be the default. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description The label for the picklist value that appears in the UI. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description The value’s position in the drop-down list of values in the UI. | | StatusCode | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status category that the value corresponds to. The Status Category field has seven values which are identical to the default Status values. | ## Usage The Status field on work orders comes with the following values: - New—Work order was created, but there hasn’t yet been any activity. - In Progress—Work has begun. - On Hold—Work is paused. - Completed—Work is complete. - Cannot Complete—Work could not be completed. - Closed—All work and associated activity is complete. - Canceled—Work is canceled, typically before any work began. The WorkOrderStatus object corresponds to the Status field. Adding a value to the Status field—for example, Canceled By Customer—creates a work order status record, and vice versa. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note Work orders also come with a StatusCategory field whose values are identical to the default Status values. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Customer Absent value, you may decide that it belongs in the Cannot Complete category. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US) # WorkPerformanceCycle Represents feedback that is gathered to assess the performance of a specific set of employees. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | ActivityFrom | Type date Properties Create, Filter, Group, Sort, Update Description The date that you want to start filtering the WDC objects to help requesters create accurate summaries. The start of the evaluation period. | | ActivityTo | Type date Properties Create, Filter, Group, Sort, Update Description The date that you want to stop filtering the WDC objects to help requesters create accurate summaries. The end of the evaluation period. | | CurrentTask | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The current task that the performance summary cycle is engaged in, including deploying and sharing. | | LastManagerRequestsSharedDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when all manager requests are set to be shared. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkPerformanceCycle. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkPerformanceCycle. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the performance summary cycle that employees will participate in. This name is created by the administrator and is visible on all respective notifications and in the UI. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkPerformanceCycle. | | State | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The state that the performance summary cycle is in. Available pick list values: - Setup: The summary is in draft. - In Progress: The summary is deployed and people are answering the questions that were created. - Finished: The summary is no longer in progress. - Error: The summary encountered an error. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkPerformanceCycleFeed](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. [WorkPerformanceCycleHistory](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. [WorkPerformanceCycleOwnerSharingRule](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. [WorkPerformanceCycleShare](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. # WorkPlan Represents a work plan for a work order or work order line item. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the work plan. | | ExecutionOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The order in which the work plan is executed. Only positive values or null are supported. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the work plan. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who created the work plan. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ParentRecordId | Type reference Properties Create, Filter, Group, Sort Description The ID of the work order, work order line item, or change request that the work plan is associated with. Available in API version 54.0 and later. This field is a polymorphic relationship field. Relationship Name ParentRecord Relationship Type Lookup Refers To ChangeRequest, WorkOrder, WorkOrderLineItem | | ParentRecordType | Type string Properties Filter, Group, Nillable, Sort Description Describes whether the parent record is a work order, work order line item, or change request. Available in API version 54.0 and later. | | WorkOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The ID of the work order. Relationship Name WorkOrder Relationship Type Lookup Refers To WorkOrder | | WorkOrderLineItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the work order line item. Relationship Name WorkOrderLineItem Relationship Type Lookup Refers To WorkOrderLineItem | | WorkPlanTemplateId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the work plan template record. Available in API version 54.0 and later. This field is a relationship field. Relationship Name WorkPlanTemplate Relationship Type Lookup Refers To WorkPlanTemplate | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [WorkPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. Available in API version 54.0 and later. [WorkPlanFeed](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. [WorkPlanHistory](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. [WorkPlanOwnerSharingRule](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. [WorkPlanShare](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. # WorkPlanSelectionRule Represents a rule that selects a work plan for a work order or work order line item. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | AssetId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the asset. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the selection rule. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether this selection rule is active (true) or not (false). Default is false. Label is Active. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | LocationId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the location. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner. | | Product2Id | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the product. Label is Product. | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service territory. | | WorkPlanSelectionRuleNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated number of the work plan selection rule, for example, WPSR-0001. | | WorkPlanTemplateId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The ID of the work plan template. | | WorkTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the work type. | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [WorkPlanSelectionRuleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [WorkPlanSelectionRuleFeed](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. [WorkPlanSelectionRuleHistory](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. [WorkPlanSelectionRuleOwnerSharingRule](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. [WorkPlanSelectionRuleShare](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. # WorkPlanTemplate Represents a template for a work plan. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the work plan template. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether the specific template is available for application (true) or not (false). Default is false. Label is Active. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The user-defined name of the work plan template. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner who created the work plan template. | | RelativeExecutionOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The relative execution order for sorting the work plan when it’s applied to the work order or work order line item. Only positive integers are supported. | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [WorkPlanTemplateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [WorkPlanTemplateFeed](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. [WorkPlanTemplateHistory](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. [WorkPlanTemplateOwnerSharingRule](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. [WorkPlanTemplateShare](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. # WorkPlanTemplateEntry Represents an object that associates a work step template with a work plan template. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | ExecutionOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The sequence number of when this entry is executed. Only positive values are supported. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | WorkPlanTemplateEntryNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated number of the work plan template entry, for example, WPTE-0001. | | WorkPlanTemplateId | Type reference Properties Create, Filter, Group, Sort Description Required. The ID of the work plan template. | | WorkStepTemplateId | Type reference Properties Create, Filter, Group, Sort, Update Description Required. The ID of the work step template. | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [WorkPlanTemplateEntryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [WorkPlanTemplateEntryFeed](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. [WorkPlanTemplateEntryHistory](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. # WorkReward Used to store reward codes tied to a Reward Fund. Reward Funds must have at least one WorkReward record. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules You must have the Reward permission enabled in order to use the Rewards feature, including WorkRewardFund and WorkReward. ## Additional Considerations and Related Objects WorkReward is a lookup to WorkRewardFund. WorkRewardFund must have at least one WorkReward record to be available for use. Each WorkBadge record with a RewardId indicates a reward badge given to a Recipient. ## Fields | Field Name | Details | | --- | --- | | Code | Type string Properties Create, Filter, Group, Sort, Update Description Represents a singe reward code tied to a RewardFundId. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents the User ID of Owner of WorkReward record | | RecipientId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce User ID for User associated with this WorkReward record. | | RedemptionDisclaimer | Type textarea Properties Nillable Description The disclaimer information about the WorkReward. | | RedemptionInfo | Type textarea Properties Nillable Description The instructions for redeeming the WorkReward. | | RedemptionUrl | Type textarea Properties Nillable Description The URL for redeeming the WorkReward. | | RewardFundId | Type reference Properties Create, Filter, Group, Sort, Update Description Salesforce unique ID for WorkRewardFund record that is associated with WorkReward record. | | RewardFundTypeId | Type reference Properties Create, Filter, Group, Sort, Update Description Salesforce unique ID of the WorkRewardFundType associated with the WorkReward. | | Value | Type double Properties Filter, Nillable, Sort Description The value of the WorkReward. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkRewardHistory](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkRewardOwnerSharingRule](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkRewardShare](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. # WorkRewardFund Represents a Reward Fund and describes the Reward Fund attributes. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To use the Rewards feature, including WorkRewardFund and WorkReward, you must have the Reward permission enabled. To create Rewards, the user must have Create on WorkRewardFund, which is not a standard permission. ## Additional Considerations and Related Objects WorkReward is a lookup to WorkRewardFund. WorkRewardFund must have at least one WorkReward record available. Each WorkBadgeDefinition with a RewardFundId is a “Reward Badge.” ## Fields | Field Name | Details | | --- | --- | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the WorkRewardFund is active (true) or not (false). | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkRewardFund. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkRewardFund. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the Reward Fund. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce unique ID of User who is the Owner of the WorkRewardFund record. | | RewardFundTypeId | Type reference Properties Create, Filter, Group, Sort, Update Description Salesforce unique ID of the WorkRewardFundType that is associated with the WorkRewardFund. | | TotalCodeCount | Type int Properties Filter, Group, Nillable, Sort Description Total reward codes that are available in the WorkRewardFund. Derived from WorkReward records that are associated with the WorkRewardFund. | | Type | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description RewardType of the WorkRewardFund. Default is Amazon.com. | | UsedCodeCount | Type int Properties Filter, Group, Nillable, Sort Description Total reward codes that are used in the WorkRewardFund. Derived from the total assigned WorkReward records that are associated with the WorkRewardFund. | | Value | Type currency Properties Create, Filter, Sort, Update Description Value of each of the reward codes in the WorkRewardFund. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkRewardFundFeed](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. [WorkRewardFundHistory](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkRewardFundOwnerSharingRule](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkRewardFundShare](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. # WorkRewardFundType Represents the type of WorkRewardFund object. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | CreditSystem | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The credit system that is used by the WorkRewardFundType object (gift codes or points). If points are selected, the reward message will not consider the CurrencyCode field. | | CurrencyCode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency code of the WorkRewardFundType | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the WorkRewardFundType is active and available in the UI | | IsPredefined | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the WorkRewardFundType is predefined (true) or not (false) | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkRewardFundType. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkRewardFundType. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the WorkRewardFundType | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the WorkRewardFundType owner | | RedemptionDisclaimer | Type textarea Properties Create, Nillable, Update Description The redemption disclaimer text for the WorkRewardFundType | | RedemptionInfo | Type textarea Properties Create, Nillable, Update Description Redemption text for the WorkRewardFundType | | RedemptionUrl | Type textarea Properties Create, Nillable, Update Description The URL that’s linked to the redemption | | UploadCodeColumn | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The column where the reward code is contained in the CSV file. The upload uses the second value by default. | | UploadValueColumn | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The column where the reward value is contained in the CSV file. The upload uses the third column by default. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkRewardFundTypeFeed](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. [WorkRewardFundTypeHistory](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkRewardFundTypeOwnerSharingRule](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. The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see [Phased WDC (legacy Work.com) Feature Retirement](https://help.salesforce.com/s/articleView?id=000356306&type=1&language=en_US). [WorkRewardFundTypeShare](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. # WorkStep Represents a work step in a work plan. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | ActionDefinition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The platform action that the work step executes. The possible values are the names of the flow and quick actions configured in your org. To launch Lightning Web Components from Work Steps, you must use QuickAction on the action definition. | | ActionType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of platform action that the work step is associated with. Possible values are: - Flow - QuickAction | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the work step. | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time the work step ends. The value must be greater than or equal to StartTime. | | ExecutionOrder | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The order in which the work step is executed. Only positive integer values or null are supported. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The user-defined name of the work step. | | PausedFlowInterviewId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The auto-populated ID of the flow interview paused by a user. | | ProcessType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The flow process type launched from the work step. Possible values are: - DataCaptureFlow—Data Capture Flow - DiscoveryFrameworkFlow—Discovery Framework Data Capture Flow (Beta) - FieldServiceMobileFlow—Field Service Mobile Flow The default value is DataCaptureFlow. | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time the work step starts. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The customizable status of the work order. Every status must be mapped to a status category, but there can be status categories not mapped to a status. Possible values are: - Completed - In Progress - New - Not Applicable - Paused | | StatusCategory | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each status value belongs to. Each default status category is mapped to the corresponding default status. If you create a custom status, you must indicate which status category it belongs to. To learn which processes reference StatusCategory, see [How are Status Categories Used?](https://help.salesforce.com/articleView?id=service.fs_status_categories.htm&type=5&language=en_US). Possible values are: - Completed - InProgress - New - NotApplicable - Paused | | WorkOrderId | Type reference Properties Filter, Group, Sort Description The ID of the work order. | | WorkOrderLineItemId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the work order line item. | | WorkPlanExecutionOrder | Type int Properties Filter, Group, Nillable, Sort Description The ID of the plan execution order. | | WorkPlanId | Type reference Properties Create, Filter, Group, Sort Description The ID of the work plan. | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [WorkStepChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [WorkStepFeed](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. [WorkStepHistory](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. # WorkStepStatus Represents a picklist for a status category on a work step. This object is available in API version 52.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | ApiName | Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the work step status. | | IsDefault | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Controls whether this status is the default value of the picklist of the corresponding status category (true) or not (false). Default is false. | | MasterLabel | Type string Properties Filter, Group, Nillable, Sort Description Required. The label of the work step status. | | SortOrder | Type int Properties Filter, Group, Nillable, Sort Description Required. The order in which the work step statuses are displayed in the status category's picklist. | | StatusCode | Type picklist Properties Required. Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status category that this status belongs to. Possible values are: - Completed - InProgress - New - NotApplicable - Paused | # WorkStepTemplate Represents a template for a work step. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field | Details | | --- | --- | | ActionDefinition | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The platform action that the work step executes. The possible values are the names of the flow and quick actions configured in your org. | | ActionType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of platform action that the work step is associated with. Possible values are: - Flow - QuickAction | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the work step template. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether this work step template is active true or not false. Default is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The user-defined name of the work step template. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner who created the work step template. | ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. [WorkStepTemplateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [WorkStepTemplateFeed](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. [WorkStepTemplateHistory](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. [WorkStepTemplateOwnerSharingRule](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. [WorkStepTemplateShare](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. # WorkThanks Represents the source and message of a thanks post. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Additional Considerations and Related Objects WorkBadge is a lookup to WorkThanks. Each WorkBadge record must derive a SourceId from WorkThanks. ## Fields | Field Name | Details | | --- | --- | | FeedItemId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the FeedItem related to the thanks badge. This is a relationship field. Relationship Name FeedItem Relationship Type Lookup Refers To FeedItem | | GiverId | Type reference Properties Create, Filter, Group, Sort Description Salesforce user ID for the giver of the Thanks record. This is a relationship field. Relationship Name Giver Relationship Type Lookup Refers To User | | Message | Type textarea Properties Create Description Required. Message associated with the Thanks record. | | NetworkId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the community that this WorkThanks is associated with. This field is available only if digital experiences is enabled in your org. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce user ID for the owner of the badge record (typically the same user as the giver of the record). This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkThanksChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [WorkThanksOwnerSharingRule](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. [WorkThanksShare](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. # WorkType Represents a type of work to be performed in Field Service and Lightning Scheduler. Work types are templates that can be applied to work order or work order line items. This object is available in API version 38.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | Description | Type textarea Properties Create, Nillable, Update Description The description of the work type. Try to add details about the task or tasks that this work type represents. | | DurationType | Type picklist Properties Create, Filter, Group, Defaulted on create, Restricted picklist, Sort, Update Description The unit of the Estimated Duration: Minutes or Hours. | | EstimatedDuration | Type double Properties Create, Filter, Sort, Update Description The estimated length of the work. The estimated duration is in minutes or hours based on the value selected in the Duration Type field. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the work type was last modified. Its label in the user interface is Last Modified Date. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date when the work type was last viewed by the current user. | | MinimumCrewSize | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The minimum crew size allowed for a crew assigned to the work. Work orders and work order line items inherit their work type’s minimum crew size. If you’re not using the Field Service managed package, this field serves as a suggestion rather than a rule. If you are using the managed package, the scheduling optimizer counts the number of service crew members on a service crew to determine whether it fits the minimum crew size requirement. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the work type. Try to use a name that helps users quickly understand the type of work orders that can be created from the work type. For example, “Annual Refrigerator Maintenance” or “Valve Replacement.” | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The work type’s owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RecommendedCrewSize | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The recommended number of people on the service crew assigned to the work. For example, you might have a Minimum Crew Size of 2 and a Recommended Crew Size of 3. Work orders and work order line items inherit their work type’s recommended crew size. | | SaDocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The document template ID. If ServiceDocumentTemplateId isn’t specified, this document template ID determines which service document template is used for service documents generated from a service appointment. The ID is 15 to 18 characters long. | | ServiceReportTemplateId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service report template associated with the work type. When users create service reports from a work order or work order line item that uses this work type, the reports use this template. | | ShouldAutoCreateSvcAppt | Type boolean Properties Create, Filter, Group, Defaulted on create, Sort, Update Description Select this option to have a service appointment automatically created on work orders and work order line items that use the work type. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - By default, the Due Date on auto-created service appointments is seven days after the created date. Admins can adjust this offset from the Field Service Settings page in Setup. - If a work type with the Auto-Create Service Appointment option selected is added to an existing work order or work order line item, a service appointment is only created for the work order or work order line item if it doesn’t yet have one. - If someone updates an existing work type by selecting the Auto-Create Service Appointment option, service appointments aren’t created on work orders and work order line items that were already using the work type. | | WoDocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The document template ID. If ServiceDocumentTemplateId isn’t specified, this document template ID determines which service document template is used for service documents generated from a work order. The ID is 15 to 18 characters long. | | WoliDocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The document template ID. If ServiceDocumentTemplateId isn’t specified, this document template ID determines which service document template is used for service documents generated from a work order line item. The ID is 15 to 18 characters long. | ## Usage Adding a work type to a work order or work order line item causes the record to inherit the work type’s duration values and required skills and products. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note - If needed, you can update the duration values and required skills and products on a work order or work order line item after they’re inherited from the work type. - If a work order or work order line item already has required skills or products, associating it with a work type doesn’t cause it to inherit the work type’s requirements. - If a work order or work order line item already has a duration value in its Duration field, associating it with a work type doesn’t cause it to inherit the work type’s duration value. - Customizations to required skills or products, such as validation rules or Apex triggers, are not carried over from work types to work orders and work order line items. ## 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. [WorkTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [WorkTypeFeed](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. [WorkTypeHistory](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. [WorkTypeOwnerSharingRule](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. [WorkTypeShare](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. # WorkTypeGroup Represents a grouping of work types used to categorize types of appointments available in Lightning Scheduler, or to define scheduling limits in Field Service. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | AdditionalInformation | Type multipicklist Properties Create, Filter, Nillable, Update Description Additional information about the types of appointments this work type group represents. | | Description | Type textarea Properties Create, Nillable, Update Description A description of this work type group. | | GroupType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The category of this work type group. Possible values are: - Capacity—A group of work types used to define a work capacity limit in Field Service. - Default—A non-capacity group of work types used in Lightning Scheduler. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this work type group can be used for appointment scheduling or work capacity limits. A work type can belong to only one active work type group of type Capacity. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the current user last viewed a record related to this object. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this object. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of this work type group. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who created this record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkTypeGroupFeed](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. [WorkTypeGroupHistory](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. [WorkTypeGroupOwnerSharingRule](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. [WorkTypeGroupShare](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. # WorkTypeGroupMember Represents the relationship between a work type and the work type group it belongs to. This object is available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the current user last viewed a record related to this object. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this object. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Autogenerated number identifying the work type group membership. It uses the format ########. | | WorkTypeGroupId | Type reference Properties Create, Filter, Group, Sort Description The ID of the work type group that this record belongs to. This is a relationship field. Relationship Name WorkTypeGroup Relationship Type Lookup Refers To WorkTypeGroup | | WorkTypeId | Type reference Properties Create, Filter, Group, Sort Description The ID of the work type that this record corresponds to. This is a relationship field. Relationship Name WorkType Relationship Type Lookup Refers To WorkType | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [WorkTypeGroupMemberFeed](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. [WorkTypeGroupMemberHistory](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.