campaign EntityType

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
crmbaseentity
Display Name
Campaign
Primary Key
campaignid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
actualend Edm.DateTimeOffset

Enter the date when the campaign was closed or completed.

Display Name: Actual End Date

actualstart Edm.DateTimeOffset

Enter the actual start date and time for the campaign.

Display Name: Actual Start Date

budgetedcost Edm.Decimal

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

Value of the Budget Allocated in base currency.

Display Name: Budget Allocated (Base)

Read Only
campaignid Edm.Guid

Unique identifier of the campaign.

Display Name: Campaign

codename Edm.String

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

Date and time when the record was created.

Display Name: Created On

Read Only
description Edm.String

Type additional information to describe the campaign, such as the products or services offered or the targeted audience.

Display Name: Description

emailaddress Edm.String

The primary email address for the entity.

Display Name: Email Address

entityimage Edm.Binary

The default image for the entity.

Display Name: Entity Image

entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid
Read Only
exchangerate Edm.Decimal

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
expectedresponse Edm.Int32

Type the expected response rate for the campaign as a full number between 0 and 100.

Display Name: Expected Response Percentage

expectedrevenue Edm.Decimal

Type the expected revenue for the campaign for return on investment projections and post-campaign reporting.

Display Name: Estimated Revenue

expectedrevenue_base Edm.Decimal

Value of the Estimated Revenue in base currency.

Display Name: Estimated Revenue (Base)

Read Only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

istemplate Edm.Boolean

Select whether the campaign is a template that can be copied when you create future campaigns.

Display Name: Template

Default Options
Value Label
1 Yes
0 No
message Edm.String

Type the promotional message or marketing copy for the campaign.

Display Name: Message

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

Type a name for the campaign so that it is identified correctly in lists.

Display Name: Name

objective Edm.String

Type the objective of the campaign, including products, services, discounts, and pricing.

Display Name: Offer

othercost Edm.Decimal

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

Value of the Miscellaneous Costs in base currency.

Display Name: Miscellaneous Costs (Base)

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

processid Edm.Guid

Contains the id of the process associated with the entity.

Display Name: Process Id

promotioncodename Edm.String

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

Enter the date when the campaign is scheduled to end.

Display Name: Proposed End Date

proposedstart Edm.DateTimeOffset

Enter the date when the campaign is scheduled to start.

Display Name: Proposed Start Date

stageid Edm.Guid

Contains the id of the stage where the entity is located.

Display Name: Stage Id

statecode Edm.Int32

Shows the status of the campaign. By default, campaigns are active and can't be deactivated.

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Select the campaign's status.

Display Name: Status Reason

Default Options
Value Label
0 Proposed
1 Ready To Launch
2 Launched
3 Completed
4 Canceled
5 Suspended
6 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

totalactualcost Edm.Decimal

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
totalactualcost_base Edm.Decimal

Value of the Total Cost of Campaign in base currency.

Display Name: Total Cost of Campaign (Base)

Read Only
totalcampaignactivityactualcost Edm.Decimal

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
totalcampaignactivityactualcost_base Edm.Decimal

Value of the Total Cost of Campaign Activities in base currency.

Display Name: Total Cost of Campaign Activities (Base)

Read Only
traversedpath Edm.String

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: Traversed Path

typecode Edm.Int32

Select the type of the campaign.

Display Name: Campaign Type

Default Options
Value Label
1 Advertisement
2 Direct Marketing
3 Event
4 Co-branding
5 Other
utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

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

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_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 systemuser lk_campaign_createdby
createdonbehalfby systemuser lk_campaign_createdonbehalfby
modifiedby systemuser lk_campaign_modifiedby
modifiedonbehalfby systemuser lk_campaign_modifiedonbehalfby
ownerid principal owner_campaigns
owningbusinessunit businessunit BusinessUnit_Campaigns
owningteam team team_Campaigns
owninguser systemuser SystemUser_Campaigns
pricelistid pricelevel PriceList_Campaigns
stageid_processstage processstage processstage_campaigns
transactioncurrencyid transactioncurrency 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 activityparty partyid_campaign
Campaign_ActivityPointers activitypointer regardingobjectid_campaign
Campaign_Annotation annotation objectid_campaign
Campaign_Appointments appointment regardingobjectid_campaign_appointment
Campaign_AsyncOperations asyncoperation regardingobjectid_campaign
Campaign_BulkDeleteFailures bulkdeletefailure regardingobjectid_campaign
Campaign_CampaignActivities campaignactivity regardingobjectid_campaign_campaignactivity
Campaign_CampaignResponses campaignresponse regardingobjectid_campaign_campaignresponse
campaign_connections1 connection record1id_campaign
campaign_connections2 connection record2id_campaign
Campaign_DuplicateBaseRecord duplicaterecord baserecordid_campaign
Campaign_DuplicateMatchingRecord duplicaterecord duplicaterecordid_campaign
Campaign_Emails email regardingobjectid_campaign_email
Campaign_Faxes fax regardingobjectid_campaign_fax
campaign_IncidentResolutions incidentresolution regardingobjectid_campaign_incidentresolution
campaign_leads lead campaignid
Campaign_Letters letter regardingobjectid_campaign_letter
Campaign_MailboxTrackingFolder mailboxtrackingfolder regardingobjectid_campaign
campaign_msdyn_approvals msdyn_approval regardingobjectid_campaign_msdyn_approval
campaign_msdyn_bookingalerts msdyn_bookingalert regardingobjectid_campaign_msdyn_bookingalert
campaign_opportunities opportunity campaignid
campaign_OpportunityCloses opportunityclose regardingobjectid_campaign_opportunityclose
campaign_OrderCloses orderclose regardingobjectid_campaign_orderclose
campaign_orders salesorder campaignid
Campaign_Phonecalls phonecall regardingobjectid_campaign_phonecall
campaign_principalobjectattributeaccess principalobjectattributeaccess objectid_campaign
Campaign_ProcessSessions processsession regardingobjectid_campaign
campaign_QuoteCloses quoteclose regardingobjectid_campaign_quoteclose
campaign_quotes quote campaignid
Campaign_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_campaign_recurringappointmentmaster
Campaign_ServiceAppointments serviceappointment regardingobjectid_campaign_serviceappointment
campaign_SocialActivities socialactivity regardingobjectid_campaign_socialactivity
Campaign_SyncErrors syncerror regardingobjectid_campaign_syncerror
Campaign_Tasks task regardingobjectid_campaign_task
campaigncampaign_association campaign campaigncampaign_association_referenced
campaigncampaign_association_referenced campaign campaigncampaign_association
campaignlist_association list campaignlist_association
campaignproduct_association product campaignproduct_association
campaignsalesliterature_association salesliterature campaignsalesliterature_association

Operations

The following operations can be used with the campaign entity type.

Name Binding
AddItemCampaign Entity
AddItemCampaignActivity Not Bound
CopyCampaign Entity
GrantAccess Not Bound
ModifyAccess Not Bound
RemoveItemCampaign Entity
RemoveItemCampaignActivity Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the campaign entity type.

Name Description
Marketing Dynamics 365 workload for marketing and enterprise.
Marketing Sales For internal use only.

See also