Send campaign to contact

The SendCampaignToContact method can be used to send a campaign from your dotMailer account to a specific contact.

Guidance Notes

If you need to send to multiple contacts, we suggest you use SendCampaignToAddressBooksWithProgress.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
campaignId	id	The ID number of the campaign you wish to send.	required
contactId	int	The ID of the contact you want to send the campaign to.	required
sendDate	dateTime	The date and time you wish the campaign to be sent (server time).	required

Return values

None.

Error responses

ERROR_CONTACT_INVALID
ERROR_CONTACT_NOT_FOUND
ERROR_CONTACT_SUPPRESSED
ERROR_CAMPAIGN_INVALID
ERROR_CAMPAIGN_NOT_FOUND
ERROR_CAMPAIGN_SENDNOTPERMITTED
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/SendCampaignToContact"

Example of use in C# .NET

/// <summary>
/// This method can be used to send a campaign to an individual contact.
/// </summary>
public void SendCampaignToContact()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int campaignId = 1;
    const int contactId = 1;
 
    Console.WriteLine("SendCampaignToContact");
    Console.WriteLine("--------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // we want the campaign to be sent 5 minutes from now (remember the web service expects UTC time)
        DateTime sendDate = DateTime.UtcNow + new TimeSpan(0, 0, 5, 0);
 
        // instruct the web service to send the campaign
        api.SendCampaignToContact(username, password, campaignId, contactId, sendDate);
 
        // if we are still here, then the method was successful
        Console.WriteLine("Campaign {0} was sent to contact {1}", campaignId, contactId);
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);
    }
 
    Console.WriteLine();
}

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/SendCampaignToContact"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendCampaignToContact xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <contactid>int</contactid>
      <sendDate>dateTime</sendDate>
    </SendCampaignToContact>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendCampaignToContactResponse xmlns="http://apiconnector.com" />
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Send campaign to contact

The SendCampaignToContact method can be used to send a campaign from your dotMailer account to a specific contact.

Guidance Notes

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: