Export (0) Print
Expand All

Campaign entity messages and methods

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

A campaign represents a 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. The schema name for this entity is Campaign. 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 tools folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

 

Message Description

AddItemCampaignRequest

Adds an item to a campaign.

AssignRequest

Assigns a campaign to another user or team.

AssociateRequest

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 Campaign entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

CopyCampaignRequest

Copies the information from one campaign to another, and optionally, creates a campaign template.

CreateRequest

Creates a campaign. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a campaign. You can also call the IOrganizationService.Delete method.

DisassociateRequest

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 Campaign entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

GrantAccessRequest

Shares a campaign with another security principal (user or team).

InitializeFromRequest

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.

ModifyAccessRequest

Changes the access rights for a campaign previously shared with another security principal (user or team).

RemoveItemCampaignRequest

Removes an item from a campaign.

RetrieveDuplicatesRequest

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.

RetrieveRequest

Retrieves a campaign. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of campaigns. You can also call the IOrganizationService.RetrieveMultiple method.

RetrievePrincipalAccessRequest

Retrieves the access that the specified security principal (user or team) has to a campaign.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves the security principals (users or teams) that have access to a campaign, together with their access rights to the campaign.

RevokeAccessRequest

Removes all access to a campaign for the specified security principal (user or team).

SetStateRequest

Sets the state of a campaign. If you are using early bound types, use the CampaignState enumeration to set the possible states. For a list of the state values, refer to the campaign entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

UpdateRequest

Updates a campaign. You can also call the IOrganizationService.Update method.

See Also

Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.
Show:
© 2014 Microsoft