Share your API sample code

Our API enables you to share data and information between dotMailer and for example your CRM system, your marketing database, or your website.

We often get asked for sample code to get our dotMailer users started with the APIs so we've started the dotMailer Sample Code Gallery.

We're starting to collect samples of how to integrate the dotMailer API in various languages and we always need more! If you think you can improve what we have here, or have a sample in a language or framework we don't have yet please send us a copy! We'd be delighted to add it. Please get in touch if you have any code samples you'd like to share with us.

Sample code can be find on the page for each API method. We have sample code for C# for all methods, and for many others, we also have VB.NET and PHP.

Don't see what you want?

Join the dotMailer user community forums for additional support from API users and someone will be able to help you!

Example of use in C#

/// <summary>
/// Adds a contact to an address book
/// </summary>
public void AddContactToAddressBook() 
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int addressBookId = 1;  // ID of the target address book
 
    Console.WriteLine("AddContactToAddressBook");
    Console.WriteLine("-----------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // we need a new contact
        com.apiconnector.APIContact contact = new com.apiconnector.APIContact();
        
        // populate the contact
        contact.AudienceType = com.apiconnector.ContactAudienceTypes.B2B;
 
        // populate the data fields
        contact.DataFields = new com.apiconnector.ContactDataFields();
        contact.DataFields.Keys = new string[3];
        contact.DataFields.Values = new object[3];
 
        contact.DataFields.Keys[0] = "FIRSTNAME";
        contact.DataFields.Values[0] = "John";
        contact.DataFields.Keys[1] = "LASTNAME";
        contact.DataFields.Values[1] = "Smith";
        contact.DataFields.Keys[2] = "POSTCODE";
        contact.DataFields.Values[2] = "IP4 1XU";
        
 
        // email address
        contact.Email = "joe.smith@example.com";
 
        contact.EmailType =  com.apiconnector.ContactEmailTypes.PlainText;
        contact.Notes = "This is a test only email";
        contact.OptInType = com.apiconnector.ContactOptInTypes.Single;
 
        // This method will create the contact required if it doesn't already exist within the dotMailer system,
        // so we don't have to call CreateContact as a prerequisite.
        // 
        // This method will also overwrite an existing contact, with the information provided here.
        //
        // This method will fail if you try to add a contact to the "Test" or "All Contacts" address books.
        //
        com.apiconnector.APIContact newContact = api.AddContactToAddressBook(username, password, contact, addressBookId);
 
        // Did we get something back from the API ?
        if (newContact != null)
        {
            Console.WriteLine("Contact added to address book {0} -> {1}", newContact.ID, addressBookId);
        }
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);                
    }
 
    Console.WriteLine();
}

Example of use in VB.NET

''' <summary>
''' Adds a contact to an address book
''' </summary>
Public Sub AddContactToAddressBook()
    Const username As String = "apiuser-XXXXXXXXXXXX@apiconnector.com"
    Const password As String = "password"
    Const addressBookId As Integer = 1
    ' ID of the target address book
    Console.WriteLine("AddContactToAddressBook")
    Console.WriteLine("-----------------------")
    ' Get an instance to the web reference
    Dim api As New com.apiconnector.API()
    Try
	' we need a new contact
	Dim contact As New com.apiconnector.APIContact()
	' populate the contact
	contact.AudienceType = com.apiconnector.ContactAudienceTypes.B2B
	' populate the data fields
	contact.DataFields = New com.apiconnector.ContactDataFields()
	contact.DataFields.Keys = New String(2) {}
	contact.DataFields.Values = New Object(2) {}
	contact.DataFields.Keys(0) = "FIRSTNAME"
	contact.DataFields.Values(0) = "John"
	contact.DataFields.Keys(1) = "LASTNAME"
	contact.DataFields.Values(1) = "Smith"
	contact.DataFields.Keys(2) = "POSTCODE"
	contact.DataFields.Values(2) = "IP4 1XU"
	' email address
	contact.Email = "joe.smith@example.com"
	contact.EmailType = com.apiconnector.ContactEmailTypes.PlainText
	contact.Notes = "This is a test only email"
	contact.OptInType = com.apiconnector.ContactOptInTypes.[Single]
	' This method will create the contact required if it doesn't already exist within the dotMailer system,
	' so we don't have to call CreateContact as a prerequisite.
	' 
	' This method will also overwrite an existing contact, with the information provided here.
	'
	' This method will fail if you try to add a contact to the "Test" or "All Contacts" address books.
	'
	Dim newContact As com.apiconnector.APIContact = api.AddContactToAddressBook(username, password, contact, addressBookId)
	' Did we get something back from the API ?
	If newContact IsNot Nothing Then
	    Console.WriteLine("Contact added to address book {0} -> {1}", newContact.ID, addressBookId)
	End If
    Catch ex As SoapException
	' catch any soap issues/errors from the web service
	Console.WriteLine("Error -> {0}", ex.Message)
    End Try
    Console.WriteLine()
End Sub

Example of use in PHP

<?php
  $username = "APIUsernameHere"; //Your API username
  $password = "***********";  //your API password
  $client = new SoapClient("http://apiconnector.com/api.asmx?WSDL"); //Instantiate the Soap client
  
  //We will add a new contact, testemail@test.co.uk , and populate the firstname, lastname and age datafields
  
  
  
  $addressbookid=469226;
  $email = "testemail@test.co.uk";
  $AudienceType="B2B";
  $OptInType="Single";
  $EmailType="Html";
  $FirstName = "John";
  $LastName="Test";
  $Age = 35;
  $notes = "This is an API test contact" ;
  
  $keys = array("FIRSTNAME","LASTNAME","AGE");
  $var1 = new SoapVar($FirstName,XSD_STRING,"string","http://www.w3.org/2001/XMLSchema"); //Create an instance of SoapVar for each one of the values
  $var2 = new SoapVar($LastName,XSD_STRING,"string","http://www.w3.org/2001/XMLSchema");
  $var3 = new SoapVar($Age,XSD_INT,"int","http://www.w3.org/2001/XMLSchema");
  $values = array($var1,$var2,$var3);
  $Datafields = array ('Keys'=>$keys,'Values'=>$values);
  $contact = array ("Email"=>$email,"AudienceType"=>$AudienceType,"OptInType"=>$OptInType,"EmailType"=>$EmailType,"ID"=>-1,"DataFields"=>$Datafields,"Notes"=>$notes);
  $params = array ("username"=>$username,"password"=>$password,"contact"=>$contact,"addressbookId"=>$addressbookid);
  return $client->AddContactToAddressbook($params);
  
  
?>

Call us on 020 8662 2762 to get your API switched on.

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Share your API sample code

Don't see what you want?

Example of use in C#

Example of use in VB.NET

Example of use in PHP

Get started with dotMailer: