Campaign Entity Reference

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.

Added by: Marketing Solution

Messages

Message Web API Operation SDK Assembly
AddItemCampaign AddItemCampaign Action AddItemCampaignRequest
AddItemCampaignActivity AddItemCampaignActivity Action AddItemCampaignActivityRequest
Assign PATCH [org URI]/api/data/v9.0/campaigns(campaignid)
Update ownerid property.
AssignRequest
CopyCampaign CopyCampaign Action CopyCampaignRequest
Create POST [org URI]/api/data/v9.0/campaigns
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/campaigns(campaignid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
RemoveItemCampaign RemoveItemCampaign Action RemoveItemCampaignRequest
RemoveItemCampaignActivity RemoveItemCampaignActivity Action RemoveItemCampaignActivityRequest
Retrieve GET [org URI]/api/data/v9.0/campaigns(campaignid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/campaigns
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/campaigns(campaignid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/campaigns(campaignid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Campaigns
DisplayCollectionName Campaigns
DisplayName Campaign
EntitySetName campaigns
IsBPFEntity False
LogicalCollectionName campaigns
LogicalName campaign
OwnershipType UserOwned
PrimaryIdAttribute campaignid
PrimaryNameAttribute name
SchemaName Campaign

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ActualEnd

Property Value
DateTimeBehavior UserLocal
Description Enter the date when the campaign was closed or completed.
DisplayName Actual End Date
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName actualend
RequiredLevel None
Type DateTime

ActualStart

Property Value
DateTimeBehavior UserLocal
Description Enter the actual start date and time for the campaign.
DisplayName Actual Start Date
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName actualstart
RequiredLevel None
Type DateTime

BudgetedCost

Property Value
Description Type the amount budgeted for the campaign to define a limit for how much you can spend.
DisplayName Budget Allocated
IsValidForForm True
IsValidForRead True
LogicalName budgetedcost
MaxValue 1000000000000
MinValue 0
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

CampaignId

Property Value
Description Unique identifier of the campaign.
DisplayName Campaign
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName campaignid
RequiredLevel SystemRequired
Type Uniqueidentifier

CodeName

Property Value
Description Type a number or other tracking code to identify the campaign. If no value is entered, a code will be generated automatically.
DisplayName Campaign Code
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName codename
MaxLength 32
RequiredLevel None
Type String

Description

Property Value
Description Type additional information to describe the campaign, such as the products or services offered or the targeted audience.
DisplayName Description
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

EmailAddress

Property Value
Description The primary email address for the entity.
DisplayName Email Address
FormatName Email
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName emailaddress
MaxLength 100
RequiredLevel None
Type String

EntityImage

Added by: Active Solution Solution

Property Value
Description The default image for the entity.
DisplayName Entity Image
IsPrimaryImage False
IsValidForForm False
IsValidForRead True
LogicalName entityimage
MaxHeight 144
MaxWidth 144
RequiredLevel None
Type Image

ExpectedResponse

Property Value
Description Type the expected response rate for the campaign as a full number between 0 and 100.
DisplayName Expected Response Percentage
Format None
IsValidForForm True
IsValidForRead True
LogicalName expectedresponse
MaxValue 100
MinValue 0
RequiredLevel None
Type Integer

ExpectedRevenue

Property Value
Description Type the expected revenue for the campaign for return on investment projections and post-campaign reporting.
DisplayName Estimated Revenue
IsValidForForm True
IsValidForRead True
LogicalName expectedrevenue
MaxValue 1000000000000
MinValue 0
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsTemplate

Property Value
Description Select whether the campaign is a template that can be copied when you create future campaigns.
DisplayName Template
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName istemplate
RequiredLevel None
Type Boolean

IsTemplate Options

Value Label
1 Yes
0 No

DefaultValue: False

Message

Property Value
Description Type the promotional message or marketing copy for the campaign.
DisplayName Message
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName message
MaxLength 256
RequiredLevel None
Type String

Name

Property Value
Description Type a name for the campaign so that it is identified correctly in lists.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 128
RequiredLevel SystemRequired
Type String

Objective

Property Value
Description Type the objective of the campaign, including products, services, discounts, and pricing.
DisplayName Offer
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName objective
MaxLength 2000
RequiredLevel None
Type Memo

OtherCost

Property Value
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.
DisplayName Miscellaneous Costs
IsValidForForm True
IsValidForRead True
LogicalName othercost
MaxValue 1000000000000
MinValue 0
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Added by: Active Solution Solution

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

PriceListId

Property Value
Description Choose the price list associated with this item to make sure the products associated with the campaign are offered at the correct prices.
DisplayName Price List
IsValidForForm True
IsValidForRead True
LogicalName pricelistid
RequiredLevel None
Targets pricelevel
Type Lookup

ProcessId

Property Value
Description Contains the id of the process associated with the entity.
DisplayName Process Id
IsValidForForm False
IsValidForRead True
LogicalName processid
RequiredLevel None
Type Uniqueidentifier

PromotionCodeName

Property Value
Description Type a promotional code to track sales related to the campaign or allow customers to redeem a discount offer.
DisplayName Promotion Code
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName promotioncodename
MaxLength 128
RequiredLevel None
Type String

ProposedEnd

Property Value
DateTimeBehavior UserLocal
Description Enter the date when the campaign is scheduled to end.
DisplayName Proposed End Date
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName proposedend
RequiredLevel None
Type DateTime

ProposedStart

Property Value
DateTimeBehavior UserLocal
Description Enter the date when the campaign is scheduled to start.
DisplayName Proposed Start Date
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName proposedstart
RequiredLevel None
Type DateTime

StageId

Property Value
Description Contains the id of the stage where the entity is located.
DisplayName (Deprecated) Stage Id
IsValidForForm False
IsValidForRead True
LogicalName stageid
RequiredLevel None
Type Uniqueidentifier

StateCode

Property Value
Description Shows the status of the campaign. By default, campaigns are active and can't be deactivated.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Active 0 Active
1 Inactive 6 Inactive

StatusCode

Property Value
Description Select the campaign's status.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

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

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName transactioncurrencyid
RequiredLevel ApplicationRequired
Targets transactioncurrency
Type Lookup

TraversedPath

Property Value
Description 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.
DisplayName (Deprecated) Traversed Path
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName traversedpath
MaxLength 1250
RequiredLevel None
Type String

TypeCode

Property Value
Description Select the type of the campaign.
DisplayName Campaign Type
IsValidForForm True
IsValidForRead True
LogicalName typecode
RequiredLevel None
Type Picklist

TypeCode Options

Value Label
1 Advertisement
2 Direct Marketing
3 Event
4 Co-branding
5 Other

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

BudgetedCost_Base

Property Value
Description Value of the Budget Allocated in base currency.
DisplayName Budget Allocated (Base)
IsValidForForm True
IsValidForRead True
LogicalName budgetedcost_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

EntityImage_Timestamp

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimage_timestamp
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

EntityImage_URL

Property Value
Description
DisplayName
FormatName Url
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entityimage_url
MaxLength 200
RequiredLevel None
Type String

EntityImageId

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimageid
RequiredLevel None
Type Uniqueidentifier

ExchangeRate

Added by: Active Solution Solution

Property Value
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.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

ExpectedRevenue_Base

Property Value
Description Value of the Estimated Revenue in base currency.
DisplayName Estimated Revenue (Base)
IsValidForForm True
IsValidForRead True
LogicalName expectedrevenue_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OtherCost_Base

Property Value
Description Value of the Miscellaneous Costs in base currency.
DisplayName Miscellaneous Costs (Base)
IsValidForForm True
IsValidForRead True
LogicalName othercost_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

OwnerIdName

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

PriceListName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName pricelistname
MaxLength 100
RequiredLevel SystemRequired
Type String

TotalActualCost

Property Value
Description Shows the sum of the amounts entered in the Total Cost of Campaign Activities and Miscellaneous Costs fields.
DisplayName Total Cost of Campaign
IsValidForForm True
IsValidForRead True
LogicalName totalactualcost
MaxValue 1000000000000
MinValue 0
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

TotalActualCost_Base

Property Value
Description Value of the Total Cost of Campaign in base currency.
DisplayName Total Cost of Campaign (Base)
IsValidForForm True
IsValidForRead True
LogicalName totalactualcost_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

TotalCampaignActivityActualCost

Property Value
Description Shows the sum of the values entered in the Actual Cost field on all campaign activities related to the campaign.
DisplayName Total Cost of Campaign Activities
IsValidForForm True
IsValidForRead True
LogicalName totalcampaignactivityactualcost
MaxValue 1000000000000
MinValue 0
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

TotalCampaignActivityActualCost_Base

Property Value
Description Value of the Total Cost of Campaign Activities in base currency.
DisplayName Total Cost of Campaign Activities (Base)
IsValidForForm True
IsValidForRead True
LogicalName totalcampaignactivityactualcost_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

Campaign_ActivityPointers

Added by: System Solution Solution

Same as activitypointer entity Campaign_ActivityPointers Many-To-One relationship.

Property Value
ReferencingEntity activitypointer
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Campaign_ActivityPointers
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Campaign_SyncErrors

Added by: System Solution Solution

Same as syncerror entity Campaign_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

campaign_activity_parties

Added by: System Solution Solution

Same as activityparty entity campaign_activity_parties Many-To-One relationship.

Property Value
ReferencingEntity activityparty
ReferencingAttribute partyid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName campaign_activity_parties
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Campaign_DuplicateMatchingRecord

Added by: System Solution Solution

Same as duplicaterecord entity Campaign_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Campaign_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Campaign_DuplicateBaseRecord

Added by: System Solution Solution

Same as duplicaterecord entity Campaign_DuplicateBaseRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Campaign_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Campaign_AsyncOperations

Added by: System Solution Solution

Same as asyncoperation entity Campaign_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Campaign_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Campaign_MailboxTrackingFolder

Added by: System Solution Solution

Same as mailboxtrackingfolder entity Campaign_MailboxTrackingFolder Many-To-One relationship.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_MailboxTrackingFolder
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_ProcessSessions

Added by: System Solution Solution

Same as processsession entity Campaign_ProcessSessions Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Campaign_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Campaign_BulkDeleteFailures

Added by: System Solution Solution

Same as bulkdeletefailure entity Campaign_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Campaign_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

campaign_principalobjectattributeaccess

Added by: System Solution Solution

Same as principalobjectattributeaccess entity campaign_principalobjectattributeaccess Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName campaign_principalobjectattributeaccess
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Campaign_Appointments

Added by: System Solution Solution

Same as appointment entity Campaign_Appointments Many-To-One relationship.

Property Value
ReferencingEntity appointment
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_Appointments
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_Emails

Added by: System Solution Solution

Same as email entity Campaign_Emails Many-To-One relationship.

Property Value
ReferencingEntity email
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_Emails
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_Faxes

Added by: System Solution Solution

Same as fax entity Campaign_Faxes Many-To-One relationship.

Property Value
ReferencingEntity fax
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_Faxes
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_Letters

Added by: System Solution Solution

Same as letter entity Campaign_Letters Many-To-One relationship.

Property Value
ReferencingEntity letter
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_Letters
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_Phonecalls

Added by: System Solution Solution

Same as phonecall entity Campaign_Phonecalls Many-To-One relationship.

Property Value
ReferencingEntity phonecall
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_Phonecalls
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_Tasks

Added by: System Solution Solution

Same as task entity Campaign_Tasks Many-To-One relationship.

Property Value
ReferencingEntity task
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_Tasks
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_RecurringAppointmentMasters

Added by: System Solution Solution

Same as recurringappointmentmaster entity Campaign_RecurringAppointmentMasters Many-To-One relationship.

Property Value
ReferencingEntity recurringappointmentmaster
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_RecurringAppointmentMasters
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

campaign_SocialActivities

Added by: System Solution Solution

Same as socialactivity entity campaign_SocialActivities Many-To-One relationship.

Property Value
ReferencingEntity socialactivity
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_SocialActivities
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

campaign_connections1

Added by: System Solution Solution

Same as connection entity campaign_connections1 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record1id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_connections1
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

campaign_connections2

Added by: System Solution Solution

Same as connection entity campaign_connections2 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record2id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_connections2
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Campaign_Annotation

Added by: System Solution Solution

Same as annotation entity Campaign_Annotation Many-To-One relationship.

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_Annotation
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_CampaignActivities

Same as campaignactivity entity Campaign_CampaignActivities Many-To-One relationship.

Property Value
ReferencingEntity campaignactivity
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_CampaignActivities
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_CampaignResponses

Same as campaignresponse entity Campaign_CampaignResponses Many-To-One relationship.

Property Value
ReferencingEntity campaignresponse
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_CampaignResponses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

campaign_leads

Same as lead entity campaign_leads Many-To-One relationship.

Property Value
ReferencingEntity lead
ReferencingAttribute campaignid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_leads
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Marketing
Label:
Order: 130
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

campaign_IncidentResolutions

Added by: Service Solution

Same as incidentresolution entity campaign_IncidentResolutions Many-To-One relationship.

Property Value
ReferencingEntity incidentresolution
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_IncidentResolutions
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Campaign_ServiceAppointments

Added by: Service Solution

Same as serviceappointment entity Campaign_ServiceAppointments Many-To-One relationship.

Property Value
ReferencingEntity serviceappointment
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Campaign_ServiceAppointments
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: RemoveLink
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

campaign_OpportunityCloses

Added by: Sales Solution

Same as opportunityclose entity campaign_OpportunityCloses Many-To-One relationship.

Property Value
ReferencingEntity opportunityclose
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_OpportunityCloses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

campaign_OrderCloses

Added by: Sales Solution

Same as orderclose entity campaign_OrderCloses Many-To-One relationship.

Property Value
ReferencingEntity orderclose
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_OrderCloses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

campaign_QuoteCloses

Added by: Sales Solution

Same as quoteclose entity campaign_QuoteCloses Many-To-One relationship.

Property Value
ReferencingEntity quoteclose
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_QuoteCloses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

campaign_opportunities

Added by: Marketing Sales Solution

Same as opportunity entity campaign_opportunities Many-To-One relationship.

Property Value
ReferencingEntity opportunity
ReferencingAttribute campaignid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_opportunities
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Sales
Label:
Order: 130
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

campaign_orders

Added by: Marketing Sales Solution

Same as salesorder entity campaign_orders Many-To-One relationship.

Property Value
ReferencingEntity salesorder
ReferencingAttribute campaignid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_orders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

campaign_quotes

Added by: Marketing Sales Solution

Same as quote entity campaign_quotes Many-To-One relationship.

Property Value
ReferencingEntity quote
ReferencingAttribute campaignid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_quotes
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

campaign_msdyn_bookingalerts

Added by: Active Solution Solution

Same as msdyn_bookingalert entity campaign_msdyn_bookingalerts Many-To-One relationship.

Property Value
ReferencingEntity msdyn_bookingalert
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_msdyn_bookingalerts
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

campaign_msdyn_approvals

Added by: Active Solution Solution

Same as msdyn_approval entity campaign_msdyn_approvals Many-To-One relationship.

Property Value
ReferencingEntity msdyn_approval
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName campaign_msdyn_approvals
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_campaign_createdby

Added by: System Solution Solution

See systemuser Entity lk_campaign_createdby One-To-Many relationship.

lk_campaign_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_campaign_createdonbehalfby One-To-Many relationship.

lk_campaign_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_campaign_modifiedby One-To-Many relationship.

lk_campaign_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_campaign_modifiedonbehalfby One-To-Many relationship.

SystemUser_Campaigns

Added by: System Solution Solution

See systemuser Entity SystemUser_Campaigns One-To-Many relationship.

team_Campaigns

Added by: System Solution Solution

See team Entity team_Campaigns One-To-Many relationship.

BusinessUnit_Campaigns

Added by: System Solution Solution

See businessunit Entity BusinessUnit_Campaigns One-To-Many relationship.

processstage_campaigns

Added by: System Solution Solution

See processstage Entity processstage_campaigns One-To-Many relationship.

transactioncurrency_campaign

Added by: System Solution Solution

See transactioncurrency Entity transactioncurrency_campaign One-To-Many relationship.

PriceList_Campaigns

Added by: Product Management Solution

See pricelevel Entity PriceList_Campaigns One-To-Many relationship.

Many-To-Many Relationships

Relationship details provided where the Campaign entity is the first entity in the relationship. Listed by SchemaName.

campaigncampaign_association

IntersectEntityName: campaignitem

Entity 1

Property Value
IntersectAttribute campaignid
IsCustomizable False
LogicalName campaign
NavigationPropertyName campaigncampaign_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Entity 2

Property Value
LogicalName campaign
IntersectAttribute entityid
NavigationPropertyName campaigncampaign_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

campaignproduct_association

IntersectEntityName: campaignitem

Entity 1

Property Value
IntersectAttribute campaignid
IsCustomizable False
LogicalName campaign
NavigationPropertyName campaignproduct_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Entity 2

Property Value
LogicalName product
IntersectAttribute entityid
NavigationPropertyName campaignproduct_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

campaignlist_association

IntersectEntityName: campaignitem

Entity 1

Property Value
IntersectAttribute campaignid
IsCustomizable False
LogicalName campaign
NavigationPropertyName campaignlist_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Entity 2

Property Value
LogicalName list
IntersectAttribute entityid
NavigationPropertyName campaignlist_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

campaignsalesliterature_association

IntersectEntityName: campaignitem

Entity 1

Property Value
IntersectAttribute campaignid
IsCustomizable False
LogicalName campaign
NavigationPropertyName campaignsalesliterature_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Entity 2

Property Value
LogicalName salesliterature
IntersectAttribute entityid
NavigationPropertyName campaignsalesliterature_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
campaign EntityType