Overview

Skill Level: Any

Prerequisites

This interface retrieves the information about a contact in a database.

If your database has a key other than Email, you must include all unique key columns with their corresponding name/value pairs.

If your database has no Unique Identifier defined, one or more columns must be specified in order to look up the contact.

Step-by-step

  1. Syntax of the request and response SOAP for SelectRecipientData

    Operation <SelectRecipientData>    
    Elements LIST_ID ID of the database to which the contact belongs. If a Contact List is specified instead of a database, the system will determine whether the contact is in the Contact List. If the contact is found, their database columns will be returned.  
      EMAIL The contact email address to look up. Note: If using a regular email key database, a node must exist for the Email column.  
      RETURN_CONTACT_LISTS Optional Indicates whether to return all Contact Lists which the contact belongs to. Valid values are:
    true
    false
      COLUMN Optional Required if the database has a key other than Email or no Unique Identifier. XML nodes defining the column name and value used to look up a contact in a database. Ignored for regular email key databases. Note: Unique key columns
    must be part of the submission with column names and values. Note: If more than one contact is found matching
    the lookup columns, the oldest contact will be returned.
      Child Elements Name Specifies the field name of the unique key for the database.
        Value Specifies the field value for the field name of the unique key for the database.
    Example <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
    xmlns:rec=”SilverpopApi:EngageService.ListMgmt.RecipientActions”>
    <soapenv:Body>
    <rec:SelectRecipientData>
    <rec:LIST_ID>24872</rec:LIST_ID>
    <rec:EMAIL>somebody@domain.com</rec:EMAIL>
    </rec:SelectRecipientData>
    </soapenv:Body>
    </soapenv:Envelope>
       
    Response <RESULT>    
    Elements SUCCESS True if successful.  
      EMAIL Email address for the contact.  
      Email Email address for the contact. Note: At the time of this writing, email is included twice in the response.  
      RecipientId Internal unique ID for each contact.  
      EmailType Value indicating the preferred email type for the selected contact.
    0 – HTML
    1 – Text
    2 – AOL
     
      LastModified Last time the contact record was modified.  
      CreatedFrom Value indicating the way in which Watson Campaign Automation added the selected contact to the system.
    0 – Imported from a database
    1 – Manually added
    2 – Opted in
    3 – Created from tracking database
     
      OptedIn Contact’s opt‐in date, if applicable.  
      OptedOut Contact’s opt‐out date, if applicable.  
      ORGANIZATION_ID Identifies your Watson Campaign Organization.  
      CONTACT_LISTS If the RETURN_CONTACT_LISTS is ‘true’ in the request, this parent node will be
    included in the response. It will contain a child element for each Contact List the contact belongs to.
     
      Child Elements CONTACT_LIST_ID Id of a Contact List which the contact belongs to.
      COLUMNS XML nodes defining the user‐created column name and value.  
    Child Elements COLUMN    
      Child Element Name Specifies the field name.
        Value Specifies the field value.
    Example <envelope:Envelope xmlns=”SilverpopApi:EngageService.ListMgmt.RecipientActions”
    xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body>
    <RESULT>
    <SUCCESS>TRUE</SUCCESS>
    <EMAIL>somebody@domain.com</EMAIL>
    <Email>somebody@domain.com</Email>
    <RecipientId>48691782</RecipientId>
    <EmailType>0</EmailType>
    <LastModified>7/16/09 8:47 PM</LastModified>
    <CreatedFrom>2</CreatedFrom>
    <OptedIn>6/22/09 8:47 AM</OptedIn>
    <OptedOut/>
    <COLUMNS>
    <COLUMN>
    <NAME>First_Name</NAME>
    <VALUE>Somebody2</VALUE>
    </COLUMN>
    <COLUMN>
    <NAME>Locale</NAME>
    <VALUE/>
    </COLUMN>
    </COLUMNS>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope>
       

Join The Discussion

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