campaignactivity EntityType
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Description: Task performed, or to be performed, by a user for planning or running a campaign.
Entity Set path:[organization URI]/api/data/v8.2/campaignactivities
Base Type: activitypointer EntityType
Display Name: Campaign Activity
Primary Key: activityid
Primary Name Attribute: subject
Properties
Lookup Properties
Single-valued navigation properties
Collection-valued navigation properties
Operations bound to campaignactivity
Operations using the campaignactivity entity type.
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
Name |
Type |
Details |
|---|---|---|
activityadditionalparams |
Edm.String |
Description: Additional information provided by the external application as JSON. For internal use only. Inherited from: activitypointer EntityType |
activityid |
Edm.Guid |
Description: Unique identifier of the activity. Display Name: Campaign Activity Inherited from: activitypointer EntityType |
activitytypecode |
Edm.String |
Description: Type of activity. Display Name: Activity Type Read-only property Inherited from: activitypointer EntityType |
actualcost |
Edm.Decimal |
Description: Type the actual cost of the campaign activity. The value entered is rolled up to the related campaign in the total cost calculations. Display Name: Actual Cost |
actualcost_base |
Edm.Decimal |
Description: Shows the Actual Cost 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: Actual Cost (Base) Read-only property |
actualdurationminutes |
Edm.Int32 |
Description: Actual duration of the activity in minutes. Display Name: Actual Duration Inherited from: activitypointer EntityType |
actualend |
Edm.DateTimeOffset |
Description: Actual end time of the activity. Display Name: Actual End Inherited from: activitypointer EntityType |
actualstart |
Edm.DateTimeOffset |
Description: Actual start time of the activity. Display Name: Actual Start Inherited from: activitypointer EntityType |
budgetedcost |
Edm.Decimal |
Description: Type the allocated budget of the campaign activity for estimated versus actual cost reporting. 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 |
category |
Edm.String |
Description: Type a category to identify the campaign activity type, such as new business development or customer retention, to tie the campaign activity to a business group or function. Display Name: Category |
channeltypecode |
Edm.Int32 |
Description: Select how communications for this activity will be sent, such as phone, letter, fax, or email. Default Options: 1 : Phone Display Name: Channel |
community |
Edm.Int32 |
Description: Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only. Inherited from: activitypointer EntityType |
createdon |
Edm.DateTimeOffset |
Description: Date and time when the activity was created. Display Name: Created On Read-only property Inherited from: activitypointer EntityType |
deliverylastattemptedon |
Edm.DateTimeOffset |
Description: Date and time when the delivery of the activity was last attempted. Read-only property Inherited from: activitypointer EntityType |
deliveryprioritycode |
Edm.Int32 |
Description: Priority of delivery of the activity to the email server. Inherited from: activitypointer EntityType |
description |
Edm.String |
Description: Description of the activity. Display Name: Description Inherited from: activitypointer EntityType |
donotsendonoptout |
Edm.Boolean |
Description: Select whether to override the opt-out settings on leads, contacts, and accounts for the members of the target marketing lists of the campaign activity. If No is selected, marketing materials will be sent to members who have opted out. Default Options: 1 : Yes Display Name: Exclude Members Who Opt Out |
exchangeitemid |
Edm.String |
Description: The message id of activity which is returned from Exchange Server. Inherited from: activitypointer EntityType |
exchangerate |
Edm.Decimal |
Description: Exchange rate for the currency associated with the activitypointer with respect to the base currency. Display Name: Exchange Rate Read-only property Inherited from: activitypointer EntityType |
exchangeweblink |
Edm.String |
Description: Shows the web link of Activity of type email. Inherited from: activitypointer EntityType |
excludeifcontactedinxdays |
Edm.Int32 |
Description: Type the minimum number of days that must be passed before a marketing list member can be contacted in a campaign again. The campaign activity will not be applied to members contacted within the specified time period. Display Name: No. of Days |
ignoreinactivelistmembers |
Edm.Boolean |
Description: Select whether inactive marketing list members will be excluded from the campaign activity distribution. Default Options: 1 : Yes Display Name: Ignore Inactive Marketing List Members |
importsequencenumber |
Edm.Int32 |
Description: Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
instancetypecode |
Edm.Int32 |
Description: Type of instance of a recurring series. Read-only property Inherited from: activitypointer EntityType |
isbilled |
Edm.Boolean |
Description: Information regarding whether the activity was billed as part of resolving a case. Default Options: 1 : Yes Display Name: Is Billed Inherited from: activitypointer EntityType |
ismapiprivate |
Edm.Boolean |
Description: For internal use only. Inherited from: activitypointer EntityType |
isregularactivity |
Edm.Boolean |
Description: Information regarding whether the activity is a regular activity type or event type. Default Options: 1 : Yes Display Name: Is Regular Activity Read-only property Inherited from: activitypointer EntityType |
isworkflowcreated |
Edm.Boolean |
Description: Information regarding whether the activity was created from a workflow rule. Default Options: 1 : Yes Display Name: Is Workflow Created Inherited from: activitypointer EntityType |
lastonholdtime |
Edm.DateTimeOffset |
Description: Contains the date and time stamp of the last on hold time. Inherited from: activitypointer EntityType |
leftvoicemail |
Edm.Boolean |
Description: Left the voice mail Inherited from: activitypointer EntityType |
modifiedon |
Edm.DateTimeOffset |
Description: Date and time when activity was last modified. Display Name: Modified On Read-only property Inherited from: activitypointer EntityType |
onholdtime |
Edm.Int32 |
Description: Shows how long, in minutes, that the record was on hold. Read-only property Inherited from: activitypointer EntityType |
overriddencreatedon |
Edm.DateTimeOffset |
Description: Date and time that the record was migrated. Display Name: Record Created On |
postponeactivityprocessinguntil |
Edm.DateTimeOffset |
Description: For internal use only. Read-only property Inherited from: activitypointer EntityType |
prioritycode |
Edm.Int32 |
Description: Priority of the activity. Default Options: 0 : Low Display Name: Priority Inherited from: activitypointer EntityType |
processid |
Edm.Guid |
Description: Unique identifier of the Process. Display Name: Process Inherited from: activitypointer EntityType |
scheduleddurationminutes |
Edm.Int32 |
Description: Scheduled duration of the activity, specified in minutes. Display Name: Scheduled Duration Inherited from: activitypointer EntityType |
scheduledend |
Edm.DateTimeOffset |
Description: Scheduled end time of the activity. Display Name: Scheduled End Inherited from: activitypointer EntityType |
scheduledstart |
Edm.DateTimeOffset |
Description: Scheduled start time of the activity. Display Name: Scheduled Start Inherited from: activitypointer EntityType |
senton |
Edm.DateTimeOffset |
Description: Date and time when the activity was sent. Read-only property Inherited from: activitypointer EntityType |
seriesid |
Edm.Guid |
Description: Uniqueidentifier specifying the id of recurring series of an instance. Read-only property Inherited from: activitypointer EntityType |
sortdate |
Edm.DateTimeOffset |
Description: Shows the date and time by which the activities are sorted. Inherited from: activitypointer EntityType |
stageid |
Edm.Guid |
Description: Unique identifier of the Stage. Display Name: Process Stage Inherited from: activitypointer EntityType |
statecode |
Edm.Int32 |
Description: Status of the activity. Default Options: 0 : Open Display Name: Status Inherited from: activitypointer EntityType |
statuscode |
Edm.Int32 |
Description: Reason for the status of the activity. Default Options: 1 : Proposed Display Name: Status Reason Inherited from: activitypointer EntityType |
subcategory |
Edm.String |
Description: Type a subcategory to identify the campaign activity type and relate the activity to a specific product, sales region, business group, or other function. Display Name: Sub-Category |
subject |
Edm.String |
Description: Subject associated with the activity. Display Name: Subject Inherited from: activitypointer EntityType |
timezoneruleversionnumber |
Edm.Int32 |
Description: For internal use only. Display Name: Time Zone Rule Version Number Inherited from: activitypointer EntityType |
traversedpath |
Edm.String |
Description: For internal use only. Display Name: Traversed Path Inherited from: activitypointer EntityType |
typecode |
Edm.Int32 |
Description: Select the type of campaign activity to indicate the purpose of the activity. Default Options: 1 : Research Display Name: Type |
utcconversiontimezonecode |
Edm.Int32 |
Description: Time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code Inherited from: activitypointer EntityType |
versionnumber |
Edm.Int64 |
Description: Version number of the activity. Display Name: Version Number Read-only property Inherited from: activitypointer EntityType |
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 |
Unique identifier of the user who created the activity. |
|
_createdonbehalfby_value |
Unique identifier of the delegate user who created the activitypointer. |
|
_modifiedby_value |
Unique identifier of user who last modified the activity. |
|
_modifiedonbehalfby_value |
Unique identifier of the delegate user who last modified the activitypointer. |
|
_ownerid_value |
Unique identifier of the user or team who owns the activity. |
|
_owningbusinessunit_value |
Unique identifier of the business unit that owns the activity. |
|
_owningteam_value |
Unique identifier of the team that owns the activity. |
|
_owninguser_value |
Unique identifier of the user that owns the activity. |
|
_regardingobjectid_value |
Unique identifier of the object with which the activity is associated. |
|
_sendermailboxid_value |
Unique identifier of the mailbox associated with the sender of the email message. |
|
_serviceid_value |
Unique identifier of an associated service. |
|
_slaid_value |
Choose the service level agreement (SLA) that you want to apply to the case record. |
|
_slainvokedid_value |
Last SLA that was applied to this case. This field is for internal use only. |
|
_transactioncurrencyid_value |
Unique identifier of the currency associated with the activitypointer. |
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 |
|---|---|---|
activityid_activitypointer |
activity_pointer_campaignactivity |
|
createdby |
lk_activitypointer_createdby |
|
createdby_campaignactivity |
lk_campaignactivity_createdby |
|
createdonbehalfby |
lk_activitypointer_createdonbehalfby |
|
createdonbehalfby_campaignactivity |
lk_campaignactivity_createdonbehalfby |
|
modifiedby |
lk_activitypointer_modifiedby |
|
modifiedby_campaignactivity |
lk_campaignactivity_modifiedby |
|
modifiedonbehalfby |
lk_activitypointer_modifiedonbehalfby |
|
modifiedonbehalfby_campaignactivity |
lk_campaignactivity_modifiedonbehalfby |
|
ownerid |
owner_activitypointers |
|
owningbusinessunit |
business_unit_activitypointer |
|
owningbusinessunit_campaignactivity |
business_unit_campaignactivity_activities |
|
owningteam |
team_activity |
|
owningteam_campaignactivity |
team_campaignactivity |
|
owninguser |
user_activity |
|
owninguser_campaignactivity |
user_campaignactivity |
|
regardingobjectid_account |
Account_ActivityPointers |
|
regardingobjectid_bookableresourcebooking |
bookableresourcebooking_ActivityPointers |
|
regardingobjectid_bookableresourcebookingheader |
bookableresourcebookingheader_ActivityPointers |
|
regardingobjectid_bulkoperation |
BulkOperation_ActivityPointers |
|
regardingobjectid_campaign |
Campaign_ActivityPointers |
|
regardingobjectid_campaign_campaignactivity |
Campaign_CampaignActivities |
|
regardingobjectid_campaignactivity |
CampaignActivity_ActivityPointers |
|
regardingobjectid_contact |
Contact_ActivityPointers |
|
regardingobjectid_contract |
Contract_ActivityPointers |
|
regardingobjectid_entitlement |
entitlement_ActivityPointers |
|
regardingobjectid_entitlementtemplate |
entitlementtemplate_ActivityPointers |
|
regardingobjectid_incident |
Incident_ActivityPointers |
|
regardingobjectid_invoice |
Invoice_ActivityPointers |
|
regardingobjectid_knowledgearticle |
KnowledgeArticle_ActivityPointers |
|
regardingobjectid_knowledgebaserecord |
KnowledgeBaseRecord_ActivityPointers |
|
regardingobjectid_lead |
Lead_ActivityPointers |
|
regardingobjectid_new_interactionforemail |
new_interactionforemail_ActivityPointers |
|
regardingobjectid_opportunity |
Opportunity_ActivityPointers |
|
regardingobjectid_quote |
Quote_ActivityPointers |
|
regardingobjectid_salesorder |
SalesOrder_ActivityPointers |
|
sendermailboxid |
activitypointer_sendermailboxid_mailbox |
|
serviceid |
service_activity_pointers |
|
sla_activitypointer_sla |
manualsla_activitypointer |
|
slainvokedid_activitypointer_sla |
sla_activitypointer |
|
stageid_processstage |
processstage_campaignactivities |
|
transactioncurrencyid |
TransactionCurrency_ActivityPointer |
|
transactioncurrencyid_campaignactivity |
transactioncurrency_campaignactivity |
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 |
|---|---|---|
activity_campaignresponse |
originatingactivityid_activitypointer |
|
activity_pointer_activity_mime_attachment |
objectid_activitypointer |
|
activity_pointer_appointment |
activityid_activitypointer |
|
activity_pointer_BulkOperation |
activityid_activitypointer |
|
activity_pointer_BulkOperation_logs |
bulkoperationid_activitypointer |
|
activity_pointer_campaignactivity |
activityid_activitypointer |
|
activity_pointer_campaignresponse |
activityid_activitypointer |
|
activity_pointer_email |
activityid_activitypointer |
|
activity_pointer_fax |
activityid_activitypointer |
|
activity_pointer_incident_resolution |
activityid_activitypointer |
|
activity_pointer_letter |
activityid_activitypointer |
|
activity_pointer_opportunity_close |
activityid_activitypointer |
|
activity_pointer_order_close |
activityid_activitypointer |
|
activity_pointer_phonecall |
activityid_activitypointer |
|
activity_pointer_quote_close |
activityid_activitypointer |
|
activity_pointer_recurringappointmentmaster |
activityid_activitypointer |
|
activity_pointer_service_appointment |
activityid_activitypointer |
|
activity_pointer_socialactivity |
activityid_activitypointer |
|
activity_pointer_task |
activityid_activitypointer |
|
activitypointer_activity_parties |
activityid_activitypointer |
|
ActivityPointer_AsyncOperations |
regardingobjectid_activitypointer |
|
ActivityPointer_BulkDeleteFailures |
regardingobjectid_activitypointer |
|
ActivityPointer_CampaignActivityItems |
campaignactivityid |
|
activitypointer_connections1 |
record1id_activitypointer |
|
activitypointer_connections2 |
record2id_activitypointer |
|
ActivityPointer_QueueItem |
objectid_activitypointer |
|
campaignactivity_activity_parties |
activityid_campaignactivity |
|
campaignactivity_activityparties |
partyid_campaignactivity |
|
CampaignActivity_ActivityPointers |
regardingobjectid_campaignactivity |
|
CampaignActivity_Annotation |
objectid_campaignactivity |
|
CampaignActivity_Appointments |
regardingobjectid_campaignactivity_appointment |
|
CampaignActivity_AsyncOperations |
regardingobjectid_campaignactivity |
|
CampaignActivity_BulkDeleteFailures |
regardingobjectid_campaignactivity |
|
CampaignActivity_BulkOperations |
regardingobjectid_campaignactivity_bulkoperation |
|
campaignactivity_connections1 |
record1id_campaignactivity |
|
campaignactivity_connections2 |
record2id_campaignactivity |
|
CampaignActivity_Emails |
regardingobjectid_campaignactivity_email |
|
CampaignActivity_Faxes |
regardingobjectid_campaignactivity_fax |
|
CampaignActivity_Letters |
regardingobjectid_campaignactivity_letter |
|
CampaignActivity_Phonecalls |
regardingobjectid_campaignactivity_phonecall |
|
CampaignActivity_QueueItem |
objectid_campaignactivity |
|
CampaignActivity_RecurringAppointmentMasters |
regardingobjectid_campaignactivity_recurringappointmentmaster |
|
CampaignActivity_SyncErrors |
regardingobjectid_campaignactivity_syncerror |
|
CampaignActivity_Tasks |
regardingobjectid_campaignactivity_task |
|
campaignactivitylist_association |
campaignactivitylist_association |
|
campaignactivitysalesliterature_association |
campaignactivitysalesliterature_association |
|
CreatedActivity_BulkOperationLogs |
createdobjectid_activitypointer |
|
slakpiinstance_activitypointer |
regarding_activitypointer |
Operations bound to campaignactivity
The following operations are bound to the campaignactivity entity type.
Name |
Bound to |
|---|---|
Entity |
Operations using the campaignactivity entity type.
The following operations use the campaignactivity entity type in a parameter or return type.
Name |
How used |
Description |
|---|---|---|
CampaignActivity Parameter |
Adds an item to a campaign activity. |
|
entity Parameter |
Creates a bulk operation that distributes a campaign activity. |
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