API reference
Help CenterCommunityDevelopersAcademyStatus

Add a contact to a contact list - AddContactToContactList

Adds one new contact to an Acoustic Campaign contact list.

You can add a contact to a contact list with either a contact ID or the key fields from a database. You can use the Add a Contact - AddRecipient, UpdateRecipient, or SelectRecipientData calls to obtain a contact ID.

When providing key fields to add a contact to a restricted database, you must include all unique key columns with their corresponding value pairs. However, with a flexible database, you can specify one or more to look up the contact.

When Acoustic Campaign processes a contact in the database in the following ways:

  • If the contact is found and does not yet exist in the contact list, they are added.
  • If the contact is found and exists in the contact list, they are not added.
  • If more than one contact is found matching the sync fields for a flexible list, an error messages returns.
  • If the contact is not found, an error message returns.

Elements (Required)

CONTACT_LIST_ID - The ID of the contact list you are adding the new contact.

CONTACT_ID - The ID of the contact you are adding to the contact list.

COLUMN - The XML nodes defining the column name and value used to look up a contact in a database.
NAME - A child of COLUMN that contains the field name.

🚧

CONTACT_ID or COLUMN elements

You must include either CONTACT_ID or the COLUMN elements to your call. If you provide the CONTACT_ID, any COLUMN elements are ignored.

<Envelope>
  <Body>
    <AddContactToContactList>
      <CONTACT_LIST_ID>85628</CONTACT_LIST_ID>
      <CONTACT_ID>15674222</CONTACT_ID>
    </AddContactToContactList>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <AddContactToContactList>
      <CONTACT_LIST_ID>85628</CONTACT_LIST_ID>
      <COLUMN>
        <NAME>CustomerId</NAME>
        <VALUE>123-45-6789</VALUE>
      </COLUMN>
      <COLUMN>
        <NAME>First_Name</NAME>
        <VALUE>Joe</VALUE>
      </COLUMN>
      <COLUMN>
        <NAME>Last_Name</NAME>
        <VALUE>Smith</VALUE>
      </COLUMN>
    </AddContactToContactList>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
    </RESULT>
  </Body>
</Envelope>

Elements (Results)

SUCCESS - True if successful, False if not.