Update contact

The UpdateContact method can be used to updatee a contact within the dotMailer system.

Guidance Notes

The information used will replace any existing information for the contact being updated.

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
contact	contact	This is the contact object. Either the Contact Id or the email address is required.	partially required

Return values

None.

Error responses

ERROR_CONTACT_INVALID
ERROR_CONTACT_NOT_FOUND
ERROR_CONTACT_SUPPRESSED
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/UpdateContact"

Example of use in C# .NET

/// <summary>
/// This method can be used to update a contact within your dotMailer account. 
/// </summary>
public void UpdateContact()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Console.WriteLine("UpdateContact");
    Console.WriteLine("-------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // create a new contact object
        // in a real world situation, the contact would probably been loaded
        // from the web service
        //
        com.apiconnector.APIContact contact = new com.apiconnector.APIContact();
 
        // populate the contact
        contact.ID = 1;
        contact.AudienceType = com.apiconnector.ContactAudienceTypes.B2M;
        contact.Email = "joe.smith@example.com";
 
        // this user is a plain text only kind of user
        contact.EmailType = com.apiconnector.ContactEmailTypes.PlainText;
 
        contact.Notes = "Some notes go here";
        contact.OptInType = com.apiconnector.ContactOptInTypes.Single;
 
        // update the contact via the web service
        api.UpdateContact(username, password, contact);
 
        Console.WriteLine("Contact 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/UpdateContact"
<?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>
    <UpdateContact xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <contact>
        <ID>int</ID>
        <Email>string</Email>
        <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
        <DataFields>
          <Keys>
            <string>string</string>
            <string>string</string>
          </Keys>
          <Values>
            <anyType />
            <anyType />
          </Values>
        </DataFields>
        <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
        <EmailType>PlainText or Html</EmailType>
        <Notes>string</Notes>
      </contact>
    </UpdateContact>
  </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>
    <UpdateContactResponse xmlns="http://apiconnector.com" />
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Update contact

The UpdateContact method can be used to updatee a contact within the dotMailer system.

Guidance Notes

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: