campaign EntityType

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.0/campaigns

Base Type: crmbaseentity EntityType

Display Name: Campaign

Primary Key: campaignid

Primary Name Attribute: name

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 not writable.

Name Type Details

_createdby_value

Edm.Guid

Description: Shows who created the record.

Computed property

Read-only property

_createdonbehalfby_value

Edm.Guid

Description: Shows who created the record on behalf of another user.

Computed property

Read-only property

_modifiedby_value

Edm.Guid

Description: Shows who last updated the record.

Computed property

Read-only property

_modifiedonbehalfby_value

Edm.Guid

Description: Shows who created the record on behalf of another user.

Computed property

Read-only property

_ownerid_value

Edm.Guid

Description: 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

Edm.Guid

Description: Shows the business unit that the record owner belongs to.

Computed property

Read-only property

_owningteam_value

Edm.Guid

Description: Unique identifier of the team who owns the campaign.

Computed property

Read-only property

_owninguser_value

Edm.Guid

Description: Unique identifier of the user who owns the campaign.

Computed property

Read-only property

_pricelistid_value

Edm.Guid

Description: Choose the price list associated with this item to make sure the products associated with the campaign are offered at the correct prices.

Computed property

Read-only property

_transactioncurrencyid_value

Edm.Guid

Description: Choose the local currency for the record to make sure budgets are reported in the correct currency.

Computed property

Read-only property

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 CRM 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
0 : No

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 CRM 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
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Select the campaign's status.

Default Options:

0 : Proposed
1 : Ready To Launch
2 : Launched
3 : Completed
4 : Canceled
5 : Suspended
6 : Inactive

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
2 : Direct Marketing
3 : Event
4 : Co-branding
5 : Other

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

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced.

Name Type Partner

createdby

systemuser EntityType

lk_campaign_createdby

createdonbehalfby

systemuser EntityType

lk_campaign_createdonbehalfby

modifiedby

systemuser EntityType

lk_campaign_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_campaign_modifiedonbehalfby

ownerid

principal EntityType

owner_campaigns

owningbusinessunit

businessunit EntityType

BusinessUnit_Campaigns

owningteam

team EntityType

team_Campaigns

owninguser

systemuser EntityType

SystemUser_Campaigns

pricelistid

pricelevel EntityType

PriceList_Campaigns

transactioncurrencyid

transactioncurrency EntityType

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 EntityType

partyid_campaign

Campaign_ActivityPointers

activitypointer EntityType

regardingobjectid_campaign

Campaign_Annotation

annotation EntityType

objectid_campaign

Campaign_Appointments

appointment EntityType

regardingobjectid_campaign_appointment

Campaign_AsyncOperations

asyncoperation EntityType

regardingobjectid_campaign

Campaign_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_campaign

Campaign_CampaignActivities

campaignactivity EntityType

regardingobjectid_campaign_campaignactivity

Campaign_CampaignResponses

campaignresponse EntityType

regardingobjectid_campaign_campaignresponse

campaign_connections1

connection EntityType

record1id_campaign

campaign_connections2

connection EntityType

record2id_campaign

Campaign_DuplicateBaseRecord

duplicaterecord EntityType

baserecordid_campaign

Campaign_DuplicateMatchingRecord

duplicaterecord EntityType

duplicaterecordid_campaign

Campaign_Emails

email EntityType

regardingobjectid_campaign_email

Campaign_Faxes

fax EntityType

regardingobjectid_campaign_fax

campaign_leads

lead EntityType

campaignid

Campaign_Letters

letter EntityType

regardingobjectid_campaign_letter

campaign_opportunities

opportunity EntityType

campaignid

campaign_orders

salesorder EntityType

campaignid

Campaign_Phonecalls

phonecall EntityType

regardingobjectid_campaign_phonecall

campaign_quotes

quote EntityType

campaignid

Campaign_RecurringAppointmentMasters

recurringappointmentmaster EntityType

regardingobjectid_campaign_recurringappointmentmaster

Campaign_ServiceAppointments

serviceappointment EntityType

regardingobjectid_campaign_serviceappointment

Campaign_Tasks

task EntityType

regardingobjectid_campaign_task

campaigncampaign_association

campaign EntityType

campaignlist_association

list EntityType

campaignlist_association

campaignproduct_association

product EntityType

campaignproduct_association

campaignsalesliterature_association

salesliterature EntityType

campaignsalesliterature_association

Operations bound to campaign

The following operations are bound to the campaign entity type.

Name Bound to

AddItemCampaign Action

Entity

CopyCampaign Action

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

AddItemCampaign Action

entity Parameter

Adds an item to a campaign.

AddItemCampaign Action

Campaign Parameter

Adds an item to a campaign.

CopyCampaign Action

entity Parameter

Copies a campaign.

CopyCampaign Action

ReturnType

Copies a campaign.

関連項目

他のリソース

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 CRM 2016 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.