Overview

Skill Level: Beginner

Prerequisites

This interface exports contact data from a database, query, or contact list. Watson Campaign Automation exports the results to a CSV file, then adds that file to the FTP account associated with the current session. You can copy the results file to Stored Files in Watson Campaign Automation.

Note: If the database is a Double Opt‐in database, Watson Campaign Automation only exports confirmed contacts. In addition, the database security settings that allow you to use this operation are, by default, disabled for all Double Opt‐In databases.

Step-by-step

  1. Syntax of the request and response SOAP for ExportList

    Operation <ExportList>  
    Elements LIST_ID

    Unique identifier for the database, query, or contact list Watson campaign Automation is exporting. 

      EMAIL Optional

    If specified, this email address receives notification when the job is complete.

      EXPORT_TYPE

    Specifies which contacts to export. Valid values are:

    ALL – export entire database.

    OPT_IN – export only currently opted‐in contacts.

    OPT_OUT – export only currently opted‐out contacts.

    UNDELIVERABLE – export only contacts who are currently marked as undeliverable.

     

      EXPORT_FORMAT

    Specifies the format (file type) for the exported data. Valid values are:

    CSV – create a comma‐separated values file

    TAB – create a tab‐separated values file

    PIPE – create a pipe‐separated values file 

     

      FILE_ENCODING Optional

    Defines the encoding of the exported file. Supported values are:

    utf‐8

    iso‐8859‐1

    If not specified, Watson Campaign Automation uses the Organization default encoding.

      ADD_TO_STORED_FILES Optional

    Use the ADD_TO_STORED_FILES parameter to write the output to the Stored Files folder within Watson Campaign Automation.

    If you omit the ADD_TO_STORED_FILES parameter, Watson Campaign Automation will move exported files to the download directory of the user’s FTP space.

      DATE_START Optional Specifies the beginning boundary of information to export (relative to the last modified date). If time is included, it must be in 24‐hour format.
      DATE_END Optional Specifies the ending boundary of information to export (relative to the last modified date). If time is included, it must be in 24‐hour format.
    Example
    <soapenv:Envelope 
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ses="SilverpopApi:EngageService.SessionHeader" xmlns:user="SilverpopApi:EngageService.ListMgmt.UserActions"> <soapenv:Header> <ses:sessionHeader> <ses:sessionid>50F4F411A048A4DDA159ABE2954E4610</ses:sessionid> </ses:sessionHeader> </soapenv:Header> <soapenv:Body> <user:ExportList> <user:LIST_ID>24872</user:LIST_ID> <user:EXPORT_TYPE>ALL</user:EXPORT_TYPE> <user:EXPORT_FORMAT>CSV</user:EXPORT_FORMAT> <user:ADD_TO_STORED_FILES/> <user:DATE_START>07/01/2009 12:12:11</user:DATE_START> <user:DATE_END>08/01/2009 14:14:11</user:DATE_END> </user:ExportList> </soapenv:Body> </soapenv:Envelope> </pre

      

    Response <RESULT>  
    Elements SUCCESS True if successful. 
      JOB_ID Identifies the Watson Campaign Automation Background Job created and scheduled for this import. 
      FILE_PATH Identifies the file name of the exported file. 
    Example
    <envelope:Envelope xmlns="SilverpopApi:EngageService.ListMgmt.UserActions"
      xmlns:envelope="http://schemas.xmlsoap.org/soap/envelope/">
      <envelope:Header/>
      <envelope:Body>
        <RESULT>
          <SUCCESS>TRUE</SUCCESS>
          <JOB_ID>502733</JOB_ID>
          <FILE_PATH>/download/A Test List ‐ All ‐ Jul 16 2009 09‐42‐00 PM.CSV</FILE_PATH>
        </RESULT>
      </envelope:Body>
    </envelope:Envelope>

      

Join The Discussion

Your email address will not be published. Required fields are marked *