Newer Version Available

This content describes an older version of this product. View Latest

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.

This information applies only to Customizable Campaign Influence and not to Campaign Influence 1.0.

Note

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.
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
  • 3: First Touch
  • 4: Last Touch
  • 5: Even Distribution
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%.