campaign EntityType
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Description: 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/v8.2/campaigns
Base Type: crmbaseentity EntityType
Display Name: Campaign
Primary Key: campaignid
Primary Name Attribute: name
Properties
Lookup Properties
Single-valued navigation properties
Collection-valued navigation properties
Operations bound to campaign
Operations using the campaign entity type.
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
Name |
Type |
Details |
|---|---|---|
actualend |
Edm.DateTimeOffset |
Description: Enter the date when the campaign was closed or completed. Display Name: Actual End Date |
actualstart |
Edm.DateTimeOffset |
Description: Enter the actual start date and time for the campaign. Display Name: Actual Start Date |
budgetedcost |
Edm.Decimal |
Description: Type the amount budgeted for the campaign to define a limit for how much you can spend. Display Name: Budget Allocated |
budgetedcost_base |
Edm.Decimal |
Description: Shows the Budget Allocated field converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area. Display Name: Budget Allocated (Base) Read-only property |
campaignid |
Edm.Guid |
Description: Unique identifier of the campaign. Display Name: Campaign |
codename |
Edm.String |
Description: 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 |
createdon |
Edm.DateTimeOffset |
Description: Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options. Display Name: Created On Read-only property |
description |
Edm.String |
Description: Type additional information to describe the campaign, such as the products or services offered or the targeted audience. Display Name: Description |
entityimage |
Edm.Binary |
Description: The default image for the entity. Display Name: Entity Image |
entityimage_timestamp |
Edm.Int64 |
Description: Read-only property |
entityimage_url |
Edm.String |
Description: Read-only property |
entityimageid |
Edm.Guid |
Description: For internal use only. Display Name: Entity Image Id Read-only property |
exchangerate |
Edm.Decimal |
Description: 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 Read-only property |
expectedresponse |
Edm.Int32 |
Description: Type the expected response rate for the campaign as a full number between 0 and 100. Display Name: Expected Response Percentage |
expectedrevenue |
Edm.Decimal |
Description: Type the expected revenue for the campaign for return on investment projections and post-campaign reporting. Display Name: Estimated Revenue |
expectedrevenue_base |
Edm.Decimal |
Description: Shows the estimated revenue converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area. Display Name: Expected Revenue (Base) Read-only property |
importsequencenumber |
Edm.Int32 |
Description: Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
istemplate |
Edm.Boolean |
Description: Select whether the campaign is a template that can be copied when you create future campaigns. Default Options: 1 : Yes Display Name: Template |
message |
Edm.String |
Description: Type the promotional message or marketing copy for the campaign. Display Name: Message |
modifiedon |
Edm.DateTimeOffset |
Description: Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options. Display Name: Modified On Read-only property |
name |
Edm.String |
Description: Type a name for the campaign so that it is identified correctly in lists. Display Name: Name |
objective |
Edm.String |
Description: Type the objective of the campaign, including products, services, discounts, and pricing. Display Name: Offer |
othercost |
Edm.Decimal |
Description: 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 |
othercost_base |
Edm.Decimal |
Description: Shows the Miscellaneous Costs field converted to the system's default base currency for reporting purposes. The calculations use the exchange rate specified in the Currencies area. Display Name: Miscellaneous Costs (Base) Read-only property |
overriddencreatedon |
Edm.DateTimeOffset |
Description: Date and time that the record was migrated. Display Name: Record Created On |
processid |
Edm.Guid |
Description: Shows the ID of the process. Display Name: Process |
promotioncodename |
Edm.String |
Description: Type a promotional code to track sales related to the campaign or allow customers to redeem a discount offer. Display Name: Promotion Code |
proposedend |
Edm.DateTimeOffset |
Description: Enter the date when the campaign is scheduled to end. Display Name: Proposed End Date |
proposedstart |
Edm.DateTimeOffset |
Description: Enter the date when the campaign is scheduled to start. Display Name: Proposed Start Date |
stageid |
Edm.Guid |
Description: Shows the ID of the stage. Display Name: Process Stage |
statecode |
Edm.Int32 |
Description: Shows the status of the campaign. By default, campaigns are active and can't be deactivated. Default Options: 0 : Active Display Name: Status |
statuscode |
Edm.Int32 |
Description: Select the campaign's status. Default Options: 0 : Proposed Display Name: Status Reason |
timezoneruleversionnumber |
Edm.Int32 |
Description: For internal use only. Display Name: Time Zone Rule Version Number |
totalactualcost |
Edm.Decimal |
Description: Shows the sum of the amounts entered in the Total Cost of Campaign Activities and Miscellaneous Costs fields. Display Name: Total Cost of Campaign Read-only property |
totalactualcost_base |
Edm.Decimal |
Description: Shows the Total Cost of Campaign field converted to the system's default base currency for reporting purposes. The calculations use the exchange rate specified in the Currencies area. Display Name: Total Cost of Campaign (Base) Read-only property |
totalcampaignactivityactualcost |
Edm.Decimal |
Description: 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 Read-only property |
totalcampaignactivityactualcost_base |
Edm.Decimal |
Description: Shows the Total Cost of Campaign Activities field converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area. Display Name: Total Cost of Campaign Activities (Base) Read-only property |
traversedpath |
Edm.String |
Description: For internal use only. Display Name: Traversed Path |
typecode |
Edm.Int32 |
Description: Select the type of the campaign. Default Options: 1 : Advertisement Display Name: Campaign Type |
utcconversiontimezonecode |
Edm.Int32 |
Description: Time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code |
versionnumber |
Edm.Int64 |
Description: Version number of the campaign. Display Name: Version Number Read-only property |
Lookup Properties
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 |
|---|---|---|
_createdby_value |
createdby |
Shows who created the record. |
_createdonbehalfby_value |
createdonbehalfby |
Shows who created the record on behalf of another user. |
_modifiedby_value |
modifiedby |
Shows who last updated the record. |
_modifiedonbehalfby_value |
modifiedonbehalfby |
Shows who created the record on behalf of another user. |
_ownerid_value |
ownerid |
Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user. |
_owningbusinessunit_value |
owningbusinessunit |
Shows the business unit that the record owner belongs to. |
_owningteam_value |
owningteam |
Unique identifier of the team who owns the campaign. |
_owninguser_value |
owninguser |
Unique identifier of the user who owns the campaign. |
_pricelistid_value |
pricelistid |
Choose the price list associated with this item to make sure the products associated with the campaign are offered at the correct prices. |
_transactioncurrencyid_value |
transactioncurrencyid |
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.
Name |
Type |
Partner |
|---|---|---|
createdby |
lk_campaign_createdby |
|
createdonbehalfby |
lk_campaign_createdonbehalfby |
|
modifiedby |
lk_campaign_modifiedby |
|
modifiedonbehalfby |
lk_campaign_modifiedonbehalfby |
|
ownerid |
owner_campaigns |
|
owningbusinessunit |
BusinessUnit_Campaigns |
|
owningteam |
team_Campaigns |
|
owninguser |
SystemUser_Campaigns |
|
pricelistid |
PriceList_Campaigns |
|
stageid_processstage |
processstage_campaigns |
|
transactioncurrencyid |
transactioncurrency_campaign |
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.
Name |
Type |
Partner |
|---|---|---|
campaign_activity_parties |
partyid_campaign |
|
Campaign_ActivityPointers |
regardingobjectid_campaign |
|
Campaign_Annotation |
objectid_campaign |
|
Campaign_Appointments |
regardingobjectid_campaign_appointment |
|
Campaign_AsyncOperations |
regardingobjectid_campaign |
|
Campaign_BulkDeleteFailures |
regardingobjectid_campaign |
|
Campaign_CampaignActivities |
regardingobjectid_campaign_campaignactivity |
|
Campaign_CampaignResponses |
regardingobjectid_campaign_campaignresponse |
|
campaign_connections1 |
record1id_campaign |
|
campaign_connections2 |
record2id_campaign |
|
Campaign_DuplicateBaseRecord |
baserecordid_campaign |
|
Campaign_DuplicateMatchingRecord |
duplicaterecordid_campaign |
|
Campaign_Emails |
regardingobjectid_campaign_email |
|
Campaign_Faxes |
regardingobjectid_campaign_fax |
|
campaign_leads |
campaignid |
|
Campaign_Letters |
regardingobjectid_campaign_letter |
|
campaign_opportunities |
campaignid |
|
campaign_orders |
campaignid |
|
Campaign_Phonecalls |
regardingobjectid_campaign_phonecall |
|
campaign_quotes |
campaignid |
|
Campaign_RecurringAppointmentMasters |
regardingobjectid_campaign_recurringappointmentmaster |
|
Campaign_ServiceAppointments |
regardingobjectid_campaign_serviceappointment |
|
Campaign_SyncErrors |
regardingobjectid_campaign_syncerror |
|
Campaign_Tasks |
regardingobjectid_campaign_task |
|
campaigncampaign_association |
campaigncampaign_association_referenced |
|
campaigncampaign_association_referenced |
campaigncampaign_association |
|
campaignlist_association |
campaignlist_association |
|
campaignproduct_association |
campaignproduct_association |
|
campaignsalesliterature_association |
campaignsalesliterature_association |
Operations bound to campaign
The following operations are bound to the campaign entity type.
Name |
Bound to |
|---|---|
Entity |
|
Entity |
Operations using the campaign entity type.
The following operations use the campaign entity type in a parameter or return type.
Name |
How used |
Description |
|---|---|---|
entity Parameter |
Adds an item to a campaign. |
|
Campaign Parameter |
Adds an item to a campaign. |
|
entity Parameter |
Copies a campaign. |
|
ReturnType |
Copies a campaign. |
|
SourceCampaignId Parameter |
Qualifies a lead and create account, contact, and opportunity records that are linked to the originating lead record. |
See Also
Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright