CampaignActivity entity messages and methods
Applies To: Dynamics CRM 2013
A campaign activity represents a step in a campaign with owner, partner, budget, timelines, and other information. Campaign activities can be created for planning and running a campaign. The schema name for this entity is CampaignActivity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.
The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.
Message |
Description |
|---|---|
Adds an item to a campaign activity. |
|
Assigns a campaign activity to another user or team. |
|
Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the CampaignActivity entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information. |
|
Creates a campaign activity. The campaign activity entity must have a valid parent campaign set as the CampaignActivity.RegardingObjectId. You can also call the IOrganizationService.Create method. |
|
Deletes a campaign activity. You can also call the IOrganizationService.Delete method. |
|
Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the CampaignActivity entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information. |
|
Creates the appropriate activity for each member in the list for the specified campaign activity. |
|
Shares a campaign activity with another security principal (user or team). |
|
Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings. |
|
Changes the access rights for a campaign activity previously shared with another security principal (user or team). |
|
Removes an item from a campaign activity. |
|
Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data. |
|
Retrieves a campaign activity. You can also call the IOrganizationService.Delete method. |
|
Retrieves a collection of campaign activities. You can also call the IOrganizationService.RetrieveMultiple method. |
|
Retrieves the access the specified security principal (user or team) has to a campaign activity. |
|
Retrieves the security principals (users or teams) that have access to an account, and their access rights to a campaign activity. |
|
Removes all access to a campaign activity for the specified security principal (user or team). |
|
Sets the state of a campaign activity. If you are using early bound types, use the CampaignActivityState enumeration to set the possible states. For a list of the state values, refer to the CampaignActivity entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information. |
|
Updates a campaign activity. You can also call the IOrganizationService.Update method. |
See Also
Campaign entities
CampaignActivity entity privileges
CampaignResponse entity messages and methods