|
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.
|
j