Getting started with the SDK


Applies To: Dynamics Marketing

This section provides initial pointers to help you get started with the Microsoft Dynamics Marketing SDK. Before you use the SDK, you should review the Microsoft Dynamics Marketing 2016 Update Readme.

Download the SDK package

Before you start, download the Dynamics Marketing SDK package. In addition to the documentation, this download package includes the assemblies needed for development, all sample code found in the documentation, and other resources. The assemblies and sample code can be found in the SDK.msi part of the download.

To start the SDK package download, click Download. If the File Download dialog box appears, do one of the following:

  • To start the download immediately, click Run.

  • To copy the download to your computer to view at a later time, click Save.

Install the SDK

  1. Open the downloaded file.

  2. Accept the license terms and choose Next.

  3. Choose Browse and specify the folder location to install the SDK in.

  4. Choose Next.

After the installation, you’ll see the following files and folders in the location that you specified:

  • LicenseTerms.docx: Contains software license terms for the SDK.

  • Bin folder: Contains the assemblies that you need for developing applications with Dynamics Marketing.

  • Sample code folder: Contains sample codes that demonstrate the features available with Microsoft Dynamics Marketing. More information: Quick start with sample code

Authenticate queues

The Dynamics Marketing SDK uses the Microsoft Azure Service Bus and the request/response functionality to communicate between Dynamics Marketing and external systems.

Dynamics Marketing provides authentication via service bus queue security. The administrator uses the data integration services to create the two service bus queues as part of the Site configuration and integration settings. The administrator owns the service bus and the queues and uses the certificate to grant permissions to the SDK service to communicate with SDK queues. Client applications must be authenticated and granted access to the service bus queues before they start using the SDK. Permissions can be granted to the client application using various types of authentication mechanisms. More information: Service Bus Queues, Topics, and Subscriptions, and Service Bus Authentication and Authorization with the Access Control Service

Configure Dynamics Marketing to communicate through queues

Before you can use SDK services, you need to configure Dynamics Marketing to communicate through queues. The queue manages SDK requests that come in to, and responses that go out from, Dynamics Marketing.

For information about how to configure Dynamics Marketing to communicate through queues see the "SDK service settings" section of Configure the SDK and Dynamics CRM Connector.

Authorize queues

Before you start making calls to the SDK service, you need to provide permissions to the service for reading or writing to the available entities. The request queue and response queue communicate marketing list, email messages, company, lead, contacts, external entities, categories, events, marketing results, and custom fields. All calls to the entities will be delivered using the same request queue. If access to the queues isn’t enabled, all requests to the queue will be ignored.

To enable SDK services and set permissions to message types or groups:

  1. Navigate to Home > Settings > Administrator > Integration Options.

  2. In SDK Service Settings,

    1. Select Enable to enable the SDK gateway.

    2. Assign permissions to queues:

      • Select Read to allow read operations for respective entities.

      • Select Write to allow write operations for respective entities.

  3. Choose Submit or Save.


The current Azure Management Portal doesn’t allow you to view the configuration of the “Require Session” flag. To see the flag, query the QueueDescription class, or use the Service Bus Explorer or a similar tool.

Next steps

See Also

Assembly included in the Microsoft Dynamics Marketing SDK
Quick start with sample code
Developer overview of Microsoft Dynamics Marketing
Sample code
Web service and assembly reference
Site configuration and integration settings