API reference
Help CenterCommunityDevelopersAcademyStatus

Update a contact - UpdateRecipient

Update a contact in an existing 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.

To look up a contact in a database without a Unique Identifier, you must specify one or more Sync Fields.

📘

When adding/updating records in your organization’s CRM List...

You can specify whether to sync the contact to your CRM system by passing a COLUMN element with a NAME “CRM Enable Sync” and VALUE of “Yes” or “No”. If you do not include this column, the organization’s default setting will be used.

You can also specify whether the individual is a Lead or Contact by passing a COLUMN element with a NAME “CRM Contact Type” and VALUE of “Lead”, "Contact", or “Other”. If you do not include this column, the individual will be designated a Lead.

Elements (Required)

LIST_ID - The database ID that the contact resides.

SYNC_FIELDS - Required if the database has no Unique Identifier. Used to lookup a contact in a database that has no Unique Identifier defined. Include a SYNCFIELD element for each column that defines a unique contact. _Note: If more than one contact is found matching the lookup columns, the oldest contact will be updated.
SYNC_FIELD - XML nodes defining the column name and value of the unique identifier fields. Each node must have a Name tag and a Value tag.
NAME - Defines the field name
VALUE - Defines the field value

COLUMN - XML nodes defining the column name and value. Note: Each node must have a Name tag and a Value tag. If the database has a key that is not Email, Unique key columns must also be part of the submission with column names and values. If changing a value of one of the SYNC_FIELDS, the new value should be included as a COLUMN node.
Standard child name-value pair:
NAME - Defines the field name
VALUE - Defines the field value

Optional COLUMN child name-value pair to subscribe a previously opted-out contact. Do not use for normal use:
NAME - OPT_OUT
VALUE - False

Elements (Optional)

OLD_EMAIL - The old email address for the contact.

SEND_AUTO_REPLY - If the database has an associated autoresponder and the SENDAUTO_REPLY element is set to _True, Acoustic Campaign sends a confirmation when the contact is added to the database.

ALLOW_HTML - If true, Acoustic Campaign interprets—and properly renders—HTML markup within a value in the text field. The default value is false, which converts HTML tags to character entity references (and tags will display as literal characters in the field).

VISITOR_ID - Allows specifying a visitor key to associate a contact to a previously unknown visitor when using the Web Tracking feature.

<Envelope>
  <Body>
    <UpdateRecipient>
      <LIST_ID>85628</LIST_ID>
      <CREATED_FROM>2</CREATED_FROM>
      <OLD_EMAIL>[email protected]</OLD_EMAIL>
      <COLUMN>
        <NAME>CustomerId</NAME>
        <VALUE>123-45-6789</VALUE>
      </COLUMN>
      <COLUMN>
        <NAME>EMAIL</NAME>
        <VALUE>[email protected]</VALUE>
      </COLUMN>
      <COLUMN>
        <NAME>Street_Address</NAME>
        <VALUE>123New Street</VALUE>
      </COLUMN>
      <SNOOZE_SETTINGS>
        <SNOOZED>true</SNOOZED>
        <RESUME_SEND_DATE>03/15/2015</RESUME_SEND_DATE>
      </SNOOZE_SETTINGS>
    </UpdateRecipient>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <UpdateRecipient>
      <LIST_ID>85628</LIST_ID>
      <CREATED_FROM>2</CREATED_FROM>
      <OLD_EMAIL>[email protected]</OLD_EMAIL>
      <COLUMN>
        <NAME>OPT_OUT</NAME>
        <VALUE>false</VALUE>
      </COLUMN>
      <COLUMN>
        <NAME>CustomerId</NAME>
        <VALUE>123-45-6789</VALUE>
      </COLUMN>
      <COLUMN>
        <NAME>EMAIL</NAME>
        <VALUE>[email protected]</VALUE>
      </COLUMN>
      <COLUMN>
        <NAME>Street_Address</NAME>
        <VALUE>123NewStreet</VALUE>
      </COLUMN>
    </UpdateRecipient>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <UpdateRecipient>
      <LIST_ID>85628</LIST_ID>
      <CREATED_FROM>2</CREATED_FROM>
      <SYNC_FIELDS>
        <SYNC_FIELD>
          <NAME>EMAIL</NAME>
          <VALUE>[email protected]</VALUE>
        </SYNC_FIELD>
        <SYNC_FIELD>
          <NAME>CustomerId</NAME>
          <VALUE>123-45-6789</VALUE>
        </SYNC_FIELD>
      </SYNC_FIELDS>
      <COLUMN>
        <NAME>EMAIL</NAME>
        <VALUE>[email protected]</VALUE>
      </COLUMN>
      <COLUMN>
        <NAME>Street_Address</NAME>
        <VALUE>123NewStreet</VALUE>
      </COLUMN>
    </UpdateRecipient>
  </Body>
</Envelope>

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

Elements (Results)

SUCCESS - True if successful; False if not.

RecipientId - Updated contact ID

ORGANIZATION_ID - Your Acoustic Campaign organization

VISITOR_ASSOCIATION - Optional Indicates whether the specified Visitor ID is valid and was associated to a profile.