SendTimeOptimisedCampaign

Sends a specified campaign to one or more address books, segments or contacts at the most appropriate time based upon their previous opens

This method sends a specified campaign to as many address books, segments or contacts as you choose at the most appropriate time based upon their previous opens. It allows you to send to a single contact if you wish.

Please note that this method doesn't add to your allotted total calls in a 24 hour period.

SOAP action: http://apiconnector.com/v2/ApiService/SendTimeOptimisedCampaign

πŸ“˜

Input and output parameters

The input and output parameters for this method are:

Input parameters

  • CampaignId - required; integer
  • AddressBookIds - optional; array of integers
    • integer
  • ContactIds - optional; array of integers
    • integer

Output parameters

  • SendTimeOptimisedCampaignResult
    • Id - GUID
    • CampaignId - integer
    • AddressBooks - array of integers
      • integer
    • ContactIds - array of integers
      • integer
    • SendDate - dateTime
    • SplitTestOptions
      • TestMetric - string ('Opens', 'Clicks')
      • TestPercentage - integer
      • TestPeriodHours - integer
    • Status - string ('NotSent', 'Scheduled', 'Sending', 'Sent', 'Cancelled')

Example

using (var client = new ApiServiceClient())
{
	client.ClientCredentials.UserName.UserName = "username";
	client.ClientCredentials.UserName.Password = "password";

	// Note: You can send to AddressBookIds OR ContactIds, not both at the same time
	var campaignSend = new ApiCampaignSend
	{
	    CampaignId = 1,
	    AddressBookIds = new[] { 1, 2, 3 },
	    ContactIds = new[] { 1, 2, 3 }
	};
	var updatedCampaignSend = client.SendTimeOptimisedCampaign(campaignSend);
}