BulkLoadContactsWithOptions

The BulkLoadContactsWithOptions method takes in the same set of parameters as the BulkLoadContacts method with an additional WSBulkLoadOptions collection. This collection contains a Boolean flag allowing users to suppress the notification emails sent by the system containing the results of the executed import. When the SuppressEmailNotifications flag is set to false, the BulkLoadContactsWithOptions method behaves in the same way as the BulkLoadContacts method. When the SuppressEmailNotifications flag is set to true, the BulkLoadContactsWithOptions method will import the supplied contacts, but will not send the system’s standard import notification emails.

<< Back to Method List

SOAP 1.1 Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

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/BulkLoadContactsWithOptions"

<?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>
    <BulkLoadContactsWithOptions xmlns="http://webservices.listrak.com/v31/">
      <ListID>int</ListID>
      <WSImportDirectives>
        <ImportTypeEnum>AddSubscribers or AddSubscribersAndProfileData or RemoveSubscribers or UpdateSubscribers</ImportTypeEnum>
        <ImportProfileTypeEnum>NotDefined or Update or Append or Overwrite</ImportProfileTypeEnum>
        <FileName>string</FileName>
        <HasColumnNames>boolean</HasColumnNames>
        <FileDelimiter>string</FileDelimiter>
        <TextQualifier>string</TextQualifier>
      </WSImportDirectives>
      <fileMappings>
        <WSFileMappings>
          <AttributeID>int</AttributeID>
          <DefaultValue>string</DefaultValue>
          <FileColumn>int</FileColumn>
          <IsEmailAddressColumn>boolean</IsEmailAddressColumn>
        </WSFileMappings>
        <WSFileMappings>
          <AttributeID>int</AttributeID>
          <DefaultValue>string</DefaultValue>
          <FileColumn>int</FileColumn>
          <IsEmailAddressColumn>boolean</IsEmailAddressColumn>
        </WSFileMappings>
      </fileMappings>
      <ImportFileStream>base64Binary</ImportFileStream>
      <WSBulkLoadOptions>
        <SuppressEmailNotifications>boolean</SuppressEmailNotifications>
      </WSBulkLoadOptions>
    </BulkLoadContactsWithOptions>
  </soap:Body>
</soap:Envelope>

SOAP 1.1 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>
    <BulkLoadContactsWithOptionsResponse xmlns="http://webservices.listrak.com/v31/">
      <BulkLoadContactsWithOptionsResult>int</BulkLoadContactsWithOptionsResult>
    </BulkLoadContactsWithOptionsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 Request

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

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>
    <BulkLoadContactsWithOptions xmlns="http://webservices.listrak.com/v31/">
      <ListID>int</ListID>
      <WSImportDirectives>
        <ImportTypeEnum>AddSubscribers or AddSubscribersAndProfileData or RemoveSubscribers or UpdateSubscribers</ImportTypeEnum>
        <ImportProfileTypeEnum>NotDefined or Update or Append or Overwrite</ImportProfileTypeEnum>
        <FileName>string</FileName>
        <HasColumnNames>boolean</HasColumnNames>
        <FileDelimiter>string</FileDelimiter>
        <TextQualifier>string</TextQualifier>
      </WSImportDirectives>
      <fileMappings>
        <WSFileMappings>
          <AttributeID>int</AttributeID>
          <DefaultValue>string</DefaultValue>
          <FileColumn>int</FileColumn>
          <IsEmailAddressColumn>boolean</IsEmailAddressColumn>
        </WSFileMappings>
        <WSFileMappings>
          <AttributeID>int</AttributeID>
          <DefaultValue>string</DefaultValue>
          <FileColumn>int</FileColumn>
          <IsEmailAddressColumn>boolean</IsEmailAddressColumn>
        </WSFileMappings>
      </fileMappings>
      <ImportFileStream>base64Binary</ImportFileStream>
      <WSBulkLoadOptions>
        <SuppressEmailNotifications>boolean</SuppressEmailNotifications>
      </WSBulkLoadOptions>
    </BulkLoadContactsWithOptions>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.2 Response

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>
    <BulkLoadContactsWithOptionsResponse xmlns="http://webservices.listrak.com/v31/">
      <BulkLoadContactsWithOptionsResult>int</BulkLoadContactsWithOptionsResult>
    </BulkLoadContactsWithOptionsResponse>
  </soap12:Body>
</soap12:Envelope>