SetContact

The SetContact method attempts to subscribe or update a contact to the specified list with the provided profile data and external events. This method is designed for transactional use. It allows users to subscribe/update individual contacts on their lists and trigger external events for that specific contact. For non-transactional usage and high volume subscribes/updates, use the BulkLoadContacts(WithOptions) and ConductorBulkLoadAndTriggerContacts(WithOptions) methods.

TheSetContact method takes in a WSContact object containing the contact’s email address, ListID, profile data (as a list of AttributeID and Value pairs), a profile update type (NotDefined, Update, Append, Overwrite), and a comma-delimited list of ExternalEventIDs. The AttributeIDs, ExternalEventIDs, and ListIDs can be found in the application’s “API ID Information” page under the “Support & Information” tab.

If the specified email address is already subscribed to the provided ListID, that contact’s profile information is updated/appended/overwritten as requested, and the specified external events (if any) are raised for that contact. If the contact is not already subscribed to the provided ListID, the contact is subscribed with the given profile data and the external events (if any) are raised for that contact.

The SetContact method returns one of the following results: SuccessContactSubscribed, FailedContactBanned, FailedContactSuppressed, FailedContactAlreadySubscribed, FailedContactUnSubscribed, FailedContactPendingConfirmation, FailedContactRequiresConfirmation, FailedContactInvalidEmailAddress, ContactalreadySubscribedProfileUpdated.

<< Back to Method List

POST /v31/IntegrationService.asmx HTTP/1.1
Host: webservices.listrak.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservices.listrak.com/v31/SetContact"

<?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:Header>
    <WSUser xmlns="http://webservices.listrak.com/v31/">
      <UserName>string</UserName>
      <Password>string</Password>
    </WSUser>
  </soap:Header>
  <soap:Body>
    <SetContact xmlns="http://webservices.listrak.com/v31/">
      <WSContact>
        <EmailAddress>string</EmailAddress>
        <ListID>int</ListID>
        <ContactProfileAttribute>
          <AttributeID>int</AttributeID>
          <Value>string</Value>
        </ContactProfileAttribute>
        <ContactProfileAttribute>
          <AttributeID>int</AttributeID>
          <Value>string</Value>
        </ContactProfileAttribute>
      </WSContact>
      <ProfileUpdateType>NotDefined or Update or Append or Overwrite</ProfileUpdateType>
      <ExternalEventIDs>string</ExternalEventIDs>
      <OverrideUnsubscribe>boolean</OverrideUnsubscribe>
    </SetContact>
  </soap:Body>
</soap:Envelope>

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>
    <SetContactResponse xmlns="http://webservices.listrak.com/v31/">
      <SetContactResult>SuccessContactSubscribed or FailedContactBanned or FailedContactSuppressed or FailedContactAlreadySubscribed or FailedContactUnSubscribed or FailedContactPendingConfirmation or FailedContactRequiresConfirmation or FailedContactInvalidEmailAddress or ContactAlreadySubscribedProfileUpdated or FailedContactNotSubscribedProfileNotUpdated</SetContactResult>
    </SetContactResponse>
  </soap:Body>
</soap:Envelope>

POST /v31/IntegrationService.asmx HTTP/1.1
Host: webservices.listrak.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <WSUser xmlns="http://webservices.listrak.com/v31/">
      <UserName>string</UserName>
      <Password>string</Password>
    </WSUser>
  </soap12:Header>
  <soap12:Body>
    <SetContact xmlns="http://webservices.listrak.com/v31/">
      <WSContact>
        <EmailAddress>string</EmailAddress>
        <ListID>int</ListID>
        <ContactProfileAttribute>
          <AttributeID>int</AttributeID>
          <Value>string</Value>
        </ContactProfileAttribute>
        <ContactProfileAttribute>
          <AttributeID>int</AttributeID>
          <Value>string</Value>
        </ContactProfileAttribute>
      </WSContact>
      <ProfileUpdateType>NotDefined or Update or Append or Overwrite</ProfileUpdateType>
      <ExternalEventIDs>string</ExternalEventIDs>
      <OverrideUnsubscribe>boolean</OverrideUnsubscribe>
    </SetContact>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SetContactResponse xmlns="http://webservices.listrak.com/v31/">
      <SetContactResult>SuccessContactSubscribed or FailedContactBanned or FailedContactSuppressed or FailedContactAlreadySubscribed or FailedContactUnSubscribed or FailedContactPendingConfirmation or FailedContactRequiresConfirmation or FailedContactInvalidEmailAddress or ContactAlreadySubscribedProfileUpdated or FailedContactNotSubscribedProfileNotUpdated</SetContactResult>
    </SetContactResponse>
  </soap12:Body>
</soap12:Envelope>