Container for campaign activities and responses, sales literature, products, and lists to create, plan, execute, and track the results of a specific marketing campaign through its life.
- Entity Set Path
- [organization URI]/api/data/v9.0/campaigns
- Base Type
- Display Name
- Primary Key
- Primary Key Attribute
- Operations Supported
- POST GET PATCH DELETE
Properties represent fields of data stored in the entity.Some properties are read-only.
Enter the date when the campaign was closed or completed.
Display Name: Actual End Date
Enter the actual start date and time for the campaign.
Display Name: Actual Start Date
Type the amount budgeted for the campaign to define a limit for how much you can spend.
Display Name: Budget Allocated
Value of the Budget Allocated in base currency.
Display Name: Budget Allocated (Base)
Unique identifier of the campaign.
Display Name: Campaign
Type a number or other tracking code to identify the campaign. If no value is entered, a code will be generated automatically.
Display Name: Campaign Code
Date and time when the record was created.
Display Name: Created On
Type additional information to describe the campaign, such as the products or services offered or the targeted audience.
Display Name: Description
The primary email address for the entity.
Display Name: Email Address
The default image for the entity.
Display Name: Entity Image
Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
Display Name: Exchange Rate
Type the expected response rate for the campaign as a full number between 0 and 100.
Display Name: Expected Response Percentage
Type the expected revenue for the campaign for return on investment projections and post-campaign reporting.
Display Name: Estimated Revenue
Value of the Estimated Revenue in base currency.
Display Name: Estimated Revenue (Base)
Sequence number of the import that created this record.
Display Name: Import Sequence Number
Select whether the campaign is a template that can be copied when you create future campaigns.
Display Name: Template
Type the promotional message or marketing copy for the campaign.
Display Name: Message
Date and time when the record was modified.
Display Name: Modified On
Type a name for the campaign so that it is identified correctly in lists.
Display Name: Name
Type the objective of the campaign, including products, services, discounts, and pricing.
Display Name: Offer
Type the sum of any miscellaneous campaign costs not included in the campaign activities to make sure the actual cost of the campaign is calculated correctly.
Display Name: Miscellaneous Costs
Value of the Miscellaneous Costs in base currency.
Display Name: Miscellaneous Costs (Base)
Date and time that the record was migrated.
Display Name: Record Created On
Contains the id of the process associated with the entity.
Display Name: Process Id
Type a promotional code to track sales related to the campaign or allow customers to redeem a discount offer.
Display Name: Promotion Code
Enter the date when the campaign is scheduled to end.
Display Name: Proposed End Date
Enter the date when the campaign is scheduled to start.
Display Name: Proposed Start Date
Contains the id of the stage where the entity is located.
Display Name: (Deprecated) Stage Id
Shows the status of the campaign. By default, campaigns are active and can't be deactivated.
Display Name: Status
Select the campaign's status.
Display Name: Status Reason
For internal use only.
Display Name: Time Zone Rule Version Number
Display Name: TmpRegardingObjectId
Shows the sum of the amounts entered in the Total Cost of Campaign Activities and Miscellaneous Costs fields.
Display Name: Total Cost of Campaign
Value of the Total Cost of Campaign in base currency.
Display Name: Total Cost of Campaign (Base)
Shows the sum of the values entered in the Actual Cost field on all campaign activities related to the campaign.
Display Name: Total Cost of Campaign Activities
Value of the Total Cost of Campaign Activities in base currency.
Display Name: Total Cost of Campaign Activities (Base)
A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.
Display Name: (Deprecated) Traversed Path
Select the type of the campaign.
Display Name: Campaign Type
Time zone code that was in use when the record was created.
Display Name: UTC Conversion Time Zone Code
Display Name: Version Number
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.
|Name||Single-valued navigation property||Description|
Shows who created the record.
Shows who created the record on behalf of another user.
Shows who last updated the record.
Shows who created the record on behalf of another user.
Unique identifier for the business unit that owns the record
Unique identifier for the team that owns the record.
Unique identifier for the user that owns the record.
Choose the price list associated with this item to make sure the products associated with the campaign are offered at the correct prices.
Choose the local currency for the record to make sure budgets are reported in the correct currency.
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
The following operations can be used with the campaign entity type.
The following solutions include the campaign entity type.
|Marketing||Dynamics 365 workload for marketing and enterprise.|
|Marketing Patch||Patch for Dynamics 365 workload for marketing and enterprise.|
|Marketing Patch 05/2019||Patch from 05/2019 for Dynamics 365 workload for marketing and enterprise.|
|Marketing Sales||For internal use only.|