API reference
Help CenterCommunityDevelopersAcademyStatus

Retrieve contact information - SelectRecipientData

Retrieves information about a contact in an Acoustic Campaign database.

📘

Database specifications

  • 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 does not have a defined Unique Identifier, you must specify one or more columns to look up the contact.

Elements (Required)

LIST_ID - The ID of the database where the contact belongs. If you specify a contact list instead of a database, the system determines if the contact is in the contact list. It it is, the database columns return.

EMAIL - The contact email address to look up. If you use a regular email key database, a node must exist for the Email column.

Elements (Optional)

RETURN_CONTACT_LISTS - Determines if all the contact lists a contact belongs should be returned. The valid values are True or False.

COLUMN - This element and its children are ignored for regular email key databases. However, it is required for databases with a key other than Email or no Unique Identifier. These elements look up a contact in a database.
Note: If more than one contact matches the lookup columns, the oldest contact returns.
Name - A child of COLUMN that specifies the field name of the unique key for a database.
Value - A child of COLUMN that specifies the field value for the field name of the unique key for the database.

VISITOR_KEY - Use this element to retrieve a contact record for a known site visitor to personalize their web experience and the content presented to them.
You can provide the visitor key with a LIST_ID to look up a contact. Key fields are not required when you pass the visitor key. The visitor key is available in the Web Tracking cookie stored in a contact’s browser settings.

📘

Note:

If you provide both the Recipient ID and the Visitor Key, the Recipient ID is used to look up a contact.

<Envelope>
  <Body>
    <SelectRecipientData>
    <LIST_ID>45654</LIST_ID>
    <EMAIL>[email protected]</EMAIL>
    <COLUMN>
      <NAME>Customer Id</NAME>
      <VALUE>123-45-6789</VALUE>
    </COLUMN>
  </SelectRecipientData>
 </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <EMAIL>[email protected]</EMAIL>
      <Email>[email protected]</Email>
      <RecipientId>33439394</RecipientId>
      <EmailType>0</EmailType>
      <LastModified>6/25/04 3:29 PM</LastModified>
      <CreatedFrom>1</CreatedFrom>
      <OptedIn>6/25/04 3:29 PM</OptedIn>
      <OptedOut/>
      <COLUMNS>
        <COLUMN>
          <NAME>Fname</NAME>
          <VALUE>Somebody</VALUE>
        </COLUMN>
        <COLUMN>
          <NAME>Lname</NAME>
          <VALUE>Special</VALUE>
        </COLUMN>
      </COLUMNS>
    </RESULT>
  </Body>
</Envelope>

Elements (Results)

SUCCESS - True if successful, False if not.

EMAIL - Email address for the contact.

Email - Email address for the contact. Note: Email is included twice in the response.

RecipientId - Internal unique ID for each contact.

EmailType - The value indicating the preferred email type for the contact: 0 (HTML), 1 (Text), or 2 (AOL).

LastModified - Last time the contact record was modified.

CreatedFrom - The value indicating how Acoustic Campaign added the contact to the system: 0 (Imported from a database), 1 (Manually added), 2 (Opted-in), or 3 (Created from a tracking database).

OptedIn - Contact's opt-in date, if applicable.

OptedOut - Contact's opt-out date, if applicable.

ORGANIZATION_ID - Identifies your Acoustic Campaign organization.

CONTACT_LISTS - If the RETURN_CONTACT_LISTS is True in the request, this parent node is included in the response with a child element for each contact list the contact belongs.
CONTACT_LIST_ID - A child element of CONTACT_LISTS that is the ID of a contact list the contact belongs.

COLUMNS - The XML nodes defining user-created column name and value.
COLUMN - A child element of COLUMNS that contains the Name and Value children elements.
Name - Specifies the field name.
Value - Specifies the field value.

Decode recipient IDs

If you have an encoded recipient ID and you want to find out who that person is, you can run the following API call. Use the email address given to you from the output of the first SelectRecipientData API call. Then, call SelectRecipientData API again with the email to get back the decoded recipient ID.

<Envelope>
   <Body>
      <SelectRecipientData>
         <LIST_ID>12345</LIST_ID>
         <ENCODED_RECIPIENT_ID>ABC123abc123</ENCODED_RECIPIENT_ID>
      </SelectRecipientData>
   </Body>
</Envelope>

List_ID - The list that the encoded individual is opted into.
Encoded_Recipient_ID - The encoded ID. This tag is used instead of the EMAIL tag.

📘

By default, jsessionid is not required. You cannot run more than one encoded recipient at a time.