{ "sections": [ "title", "description", "fields", "special_access_rules", "usage", "associated_objects", "wsdl_segment", "field_reference" ], "title": "Campaign - Data API", "description": "Represents and tracks a marketing campaign, such as a direct mail promotion, webinar, or trade show.", "fields_columns": [ "type", "properties", "description", "relationship_name", "relationship_type", "refers_to" ], "fields": { "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": "Name of the campaign. Limit: is 80 characters.", "required": true }, "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." } }, "special_access_rules": "Customer Portal users can't access this object.", "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.\n\nClient applications can create, update, delete, and query Attachment records associated with a campaign via the API.\n\nThe 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.", "associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **CampaignChangeEvent (API version 44.0)**: Change events are available for the object.\n- **CampaignFeed (API version 18.0)**: Feed tracking is available for the object.\n- **CampaignHistory (API version 40.0)**: History is available for tracked fields of the object.\n- **CampaignOwnerSharingRule**: Sharing rules are available for the object.\n- **CampaignShare**: Sharing is available for the object.", "wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```", "field_reference": { "ActualCost": { "field_label": "Actual Cost in Campaign", "type": "currency", "precision": "18", "scale": "0" }, "AmountAllOpportunities": { "field_label": "Value Opportunities in Campaign", "type": "currency", "precision": "18", "scale": "0" }, "AmountWonOpportunities": { "field_label": "Value Won Opportunities in Campaign", "type": "currency", "precision": "18", "scale": "0" }, "BudgetedCost": { "field_label": "Budgeted Cost in Campaign", "type": "currency", "precision": "18", "scale": "0" }, "CampaignImageId": { "field_label": "Content Document ID", "type": "reference", "length": "18" }, "CampaignMemberRecordTypeId": { "field_label": "Record Type ID", "type": "reference", "length": "18" }, "CreatedById": { "field_label": "Created By ID", "type": "reference", "length": "18" }, "CreatedDate": { "field_label": "Created Date", "type": "datetime" }, "CurrencyIsoCode": { "field_label": "Currency ISO Code", "type": "picklist", "length": "3" }, "Description": { "field_label": "Description", "type": "textarea", "length": "32000" }, "EndDate": { "field_label": "End Date", "type": "date" }, "ExpectedResponse": { "field_label": "Expected Response (%)", "type": "percent", "precision": "10", "scale": "2" }, "ExpectedRevenue": { "field_label": "Expected Revenue in Campaign", "type": "currency", "precision": "18", "scale": "0" }, "Id": { "field_label": "Campaign ID", "type": "id", "length": "18" }, "IsActive": { "field_label": "Active", "type": "boolean" }, "IsDeleted": { "field_label": "Deleted", "type": "boolean" }, "LastActivityDate": { "field_label": "Last Activity", "type": "date" }, "LastModifiedById": { "field_label": "Last Modified By ID", "type": "reference", "length": "18" }, "LastModifiedDate": { "field_label": "Last Modified Date", "type": "datetime" }, "LastReferencedDate": { "field_label": "Last Referenced Date", "type": "datetime" }, "LastViewedDate": { "field_label": "Last Viewed Date", "type": "datetime" }, "Name": { "field_label": "Name", "type": "string", "length": "80" }, "NumberOfContacts": { "field_label": "Contacts in Campaign", "type": "int", "digits": "9" }, "NumberOfConvertedLeads": { "field_label": "Converted Leads in Campaign", "type": "int", "digits": "9" }, "NumberOfLeads": { "field_label": "Leads in Campaign", "type": "int", "digits": "9" }, "NumberOfOpportunities": { "field_label": "Opportunities in Campaign", "type": "int", "digits": "9" }, "NumberOfResponses": { "field_label": "Responses in Campaign", "type": "int", "digits": "9" }, "NumberOfWonOpportunities": { "field_label": "Won Opportunities in Campaign", "type": "int", "digits": "9" }, "NumberSent": { "field_label": "Num Sent in Campaign", "type": "double", "precision": "18", "scale": "0" }, "OwnerId": { "field_label": "Owner ID", "type": "reference", "length": "18" }, "ParentId": { "field_label": "Parent Campaign ID", "type": "reference", "length": "18" }, "StartDate": { "field_label": "Start Date", "type": "date" }, "Status": { "field_label": "Status", "type": "picklist", "length": "255" }, "SystemModstamp": { "field_label": "System Modstamp", "type": "datetime" }, "Type": { "field_label": "Type", "type": "picklist", "length": "255" } }, "field_reference_columns": [ "field_label", "type", "precision", "scale", "length", "digits" ] }