Update campaign

The UpdateCampaign method can be used to update a specified campaign and can be useful if you need to make changes to any settings or content to the campaign before it is sent.

Guidance Notes

The campaign will be validated before being saved to ensure it includes an unsubscribe link.

This method can only be used to update a campaign that has not yet been sent. It cannot be used to update the campaign status.

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
campaign	campaign	This is the campaign object; it can be used to set properties relating to the campaign you are creating.	partially required

The following elements of the campaign object are required:

fromName	string	The name that the email campaign should appear to be from.	required
htmlContent	string	The contents of the HTML email; this will be validated before saving and must contain an unsubscribe link (http://$UNSUB$).	required
id	id	The system generated ID for the campaign. This must be for a campaign that already exists and has not yet been sent (or scheduled to be sent).	required
name	string	The name of the campaign as it appears in your account; this is not directly exposed to the end recipient and may be different to the subject line. (The name is used in Google Analytics campaign tagging so should be kept recipient friendly.)	required
plaintextContent	string	The contents of the Plain Text email; this will be validated before saving and must contain an unsubscribe link (http://$UNSUB$).	required
replyAction	Unset or WebMailForward or Webmail or Delete	What should be done with replies received to the campaign.	required
replyToAddress	string	If the reply action is set to WebMailForward, what email address they should be forwarded to.	partially required
status		The status of the campaign.	Must not be specified
subject	string	The subject line of the email.	required

Return values

None.

Error responses

ERROR_CAMPAIGN_INVALID
ERROR_CAMPAIGN_NOT_FOUND
ERROR_CAMPAIGN_READONLY
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/UpdateCampaign"

Example of use in C# .NET

/// <summary>
/// This method can be used to update a specified campaign and can be useful
/// if you need to make changes to any settings or content to the campaign before it is sent. 
/// </summary>
public void UpdateCampaignÂ () 
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Console.WriteLine("UpdateCampaign");
    Console.WriteLine("--------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // we need a campaign to modify - in a real world example
        // a campaign object would probably be loaded from the 
        // web service
        //
        // The campaign must not have been sent
        //
        com.apiconnector.APICampaign campaign = new com.apiconnector.APICampaign();
 
        // Create some html and plaintext content
        StringBuilder htmlSb = new StringBuilder();
        htmlSb.Append("<b>This is a test from the API (html) </b>");
 
        // the html content must contain http://$UNSUB or the call will fail
        htmlSb.Append("<p><a href=\"http://$UNSUB$\">Unsubscribe</a></p>");
 
        StringBuilder plainSb = new StringBuilder();
        plainSb.Append("This is a test from the API (plaintext)");
 
        // the plaintext content must contain $UNSUB or the call will fail
        plainSb.Append("$UNSUB$");
    
        // populate the campaign object
        campaign.Id = 980827;
        campaign.FromName = "Test dotMailer API";
        campaign.Name = "Test API Demo";
        campaign.HTMLContent = htmlSb.ToString();
        campaign.PlaintextContent = plainSb.ToString();
        campaign.ReplyAction = com.apiconnector.ReplyActions.Unset;
        campaign.ReplyToAddress = "joe.smith@example.com";
        campaign.Status = com.apiconnector.CampaignStatus.NotSet;
        campaign.Subject = "dotMailer API Demo Test Campaign";
 
        // get the web service to update our campaign
        api.UpdateCampaign(username, password, campaign);
 
        Console.WriteLine("Campaign updated");
    }
    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/UpdateCampaign"
<?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>
    <UpdateCampaign xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaign>
        <FromName>string</FromName>
        <HTMLContent>string</HTMLContent>
        <Id>int</Id>
        <Name>string</Name>
        <PlaintextContent>string</PlaintextContent>
        <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
        <ReplyToAddress>string</ReplyToAddress>
        <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or RequiresSMSApproval or Triggered</Status>
        <Subject>string</Subject>
      </campaign>
    </UpdateCampaign>
  </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>
    <UpdateCampaignResponse xmlns="http://apiconnector.com" />
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates