Campaign

Represents and tracks a marketing campaign, such as a direct mail promotion, webinar, or trade show.

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search()

  • Customer Portal users can’t access this object.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The amount of money spent to run the campaign. Label is Actual Cost in Campaign.
  • 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.
  • 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.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 61.0
  • 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: relationship
  • Refers to: Brief
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Amount of money budgeted for the campaign. Label is Budgeted Cost in Campaign.

  • Type: reference

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

  • Introduced: API version 29.0

  • Relationship name: BusinessHours

  • Relationship type: relationship

  • Refers to: BusinessHours

  • Type: reference

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

  • Introduced: API version 65.0

  • Relationship name: BusinessUnit

  • Relationship type: relationship

  • Refers to: BusinessUnit

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 42.0
  • Description: ID of the campaign image. Only available to orgs with Partner Community licenses and Digital Experience enabled or orgs that have installed the Direct Marketing Managed package.
  • Relationship name: CampaignImage
  • Relationship type: relationship
  • Refers to: ContentDocument

  • Type: reference

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

  • Introduced: API version 17.0

  • Description:

    The record type ID for CampaignMember records associated with the campaign.

    This is a relationship field.

  • Relationship name: CampaignMemberRecordType

  • Relationship type: relationship

  • Refers to: RecordType

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 57.0

  • Relationship name: CampaignTemplate

  • Relationship type: relationship

  • Refers to: CampaignTemplate

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Description of the campaign. Limit: 32 KB. Only the first 255 characters display in reports.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Ending date for the campaign. Responses received after this date are still counted.
  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Percentage of responses you expect to receive for the campaign.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Amount of money you expect to generate from the campaign.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 14.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 11.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 11.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 14.0
  • Description: Calculated field for the total amount of money budgeted for the campaigns in a campaign hierarchy. Label isTotal Budgeted Cost in Hierarchy.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 14.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 11.0
  • Description: Calculated field for the number of contacts associated with the campaign hierarchy. Label is Total Contacts in Hierarchy.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 11.0
  • Description: Calculated field for the number of converted leads from the campaign in a campaign hierarchy. Label is Converted Leads in Hierarchy.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 63.0
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 11.0
  • Description: Calculated field for the number of leads from the campaign in a campaign hierarchy. Label is Leads in Hierarchy.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 11.0
  • Description: Calculated field for the number of opportunities related to the campaign in a campaign hierarchy. Label is Opportunities in Hierarchy.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 63.0
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 11.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 11.0
  • Description: The number of closed or won opportunities associated with the campaign. Label is Won Opportunities in Hierarchy.
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 14.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 43.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 43.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 42.0
  • 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.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether this campaign is active (true) or not (false). The default value is false. The label is Active.
  • Default value: false

  • 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.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Required. Name of the campaign. Limit: is 80 characters.
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: Number of contacts associated with the campaign. Label is Total Contacts.
  • 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.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 63.0
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: The number of leads associated with the campaign. Label is Leads in Campaign.
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: The number of opportunities associated with the campaign. Label is Opportunities in Campaign.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 63.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: The number of closed or won opportunities associated with the campaign. Label is Won Opportunities in Campaign.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The number of individuals targeted by the campaign. For example, the number of emails sent. Label is Num Sent.

  • Type: reference

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

  • Introduced: API version 11.0

  • Description:

    ID of the parent Campaign record, if any.

    This is a relationship field.

  • Relationship name: Parent

  • Relationship type: relationship

  • Refers to: Campaign

  • Type: reference

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

  • Introduced: API version 29.0

  • Relationship name: SlaProcess

  • Relationship type: relationship

  • Refers to: SlaProcess

  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 63.0
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Starting date for the campaign.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Status of the campaign, for example, Planned, In Progress. Limit: 40 characters.

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 49.0

  • 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: Tenant

  • Relationship type: relationship

  • Refers to: PardotTenant

  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 43.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 43.0
  • 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.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Type of campaign, for example, Direct Mail or Referral Program. Limit: 40 characters.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 41.0
  • 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.
  • Type: int
  • Properties: Filter, Group, Sort
  • Introduced: API version 42.0
  • 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.

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.

The main constituent of a campaign is a CampaignMember. You will commonly need to update campaigns with CampaignMember.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.