Resubscribe contact

The ResubscribeContact method resubscribes a previously unsubscribed contact.

Guidance Notes

Resubscribes will often result in an email challenge being sent to the contact, giving the contact the opportunity to decline the resubcribe. The wording of this email is fixed, although it's possible to add a company logo to it via dotMailer (Contacts > Advanced Options > Resubscribe Settings). If a contact is added to an address book, any address book suppressions for that individual contact will be automatically cleared, regardless of the status transition that happened. For contacts who are challenged, the number of attempts to resubscribe that contact is limited. If you attempt to repeatadly call this method for challenged contacts, your calls will be suppressed.

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
APIContact	Contact object	The contact you wish to resubscribe. Any custom data in this object will be added as well.	required
addressBookID	int	The book to add the contact to (if the contact is challenged, they'll only be added after responding to the challenge).	required
preferredLocale	RFC3066-compatible string	The locale of the contact (such as en-GB or en-US). If the one supplied isn't available in dotMailer, it will fall back to en-GB.	required
returnUrlToUseIfChallenged	string	If the contact is challenged before being permitted to resubscribe, this is the page they'll end up on if they successfully complete the resubscribe.	required

Return values

result

ContactAdded, ContactChallenged or ContactCannotBeUnsuppressed

Error responses

ERROR_ADDRESSBOOK_NOT_FOUND
ERROR_ADDRESSBOOK_NOTWRITABLE
ERROR_APIUSAGE_EXCEEDED
ERROR_CONTACT_INVALID
ERROR_CONTACT_TOOMANY
ERROR_DATAFIELD_NOTFOUND
ERROR_INVALID_EMAIL
ERROR_INVALID_LOGIN
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/ResubscribeContact"

Example of use in C# .NET

public void ResubscribeContact()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int addressBookId = 1;
    const string locale = "en-US";
    const string returnURL = "http://example.com/thankyou.html";
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
    try
    {
        com.apiconnector.APIContact contact = new com.apiconnector.APIContact();
        contact.Email = "changedMyMind@example.com";
        api.ResubscribeContact(username, password, contact, addressBookId, locale, returnURL);
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);
    }
}

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/ResubscribeContact"
<?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>
    <ResubscribeContact 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>
      <addressBookId>int</addressBookId>
      <preferredLocale>string</preferredLocale>
      <returnUrlToUseIfChallenged>string</returnUrlToUseIfChallenged>
    </ResubscribeContact>
  </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>
    <ResubscribeContactResponse xmlns="http://apiconnector.com">
      <ResubscribeContactResult>ContactAdded or ContactChallenged or ContactCannotBeUnsuppressed</ResubscribeContactResult>
    </ResubscribeContactResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates