Overview

Skill Level: Any

Prerequisites

This interface updates a contact in an existing database. Use of the optional OPT_OUT child element allows this operation to add a currently opted‚Äźout contact back into the database. If your database has a key other than Email, you must include all unique key columns with their corresponding name/value pairs.

If updating contacts in a database that has no Unique Identifier defined, one or more Sync Fields must be specified in order to look up the contact.

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.

When adding/updating records in your organization‚Äôs CRM List, you can specify whether the individual is a Lead or Contact by passing a COLUMN element with a NAME “CRM Contact Type” and VALUE of “Lead” or “Other”. If you do not include this column, the individual will be designated a Lead.

Step-by-step

  1. Syntax of the request and response SOAP for UpdateRecipient

    Operation <UpdateRecipient>      
    Elements LIST_ID The ID of the database to which the contact resides in.    
      OLD_EMAIL Optional Old email address for the contact.  
      SEND_AUTOREPLY Optional If the database has an autoresponder associated with it and the SEND_AUTO_REPLY element is set to true, Watson Campaign Automation sends the confirmation when the contact is added to the database.  
    ¬† ALLOW_HTML Optional If true, Watson Campaign Automation will interpret‚ÄĒand properly render‚ÄĒHTML markup within a value in the text field. The default value is false, which will convert HTML tags to character entity references (and tags will display as literal characters in the field). ¬†
      VISITOR_ID Optional Allows specifying a visitor key to associate a contact to a previously unknown visitor when using the Web Tracking feature.  
      SYNC_FIELDS Optional Required if the database has no Unique Identifier. Used to look up a contact in a database that has no Unique Identifier defined. Include a SYNC_FIELD 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.  
      Child Element 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.
     
        Child Element 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.
       
    ¬† Optional Child Element NAME OPT_OUT Use this name‚Äźvalue pair only to subscribe a
    previously opted out contact. For normal usage,
    omit this name‚Äźvalue pair.
        VALUE False  
      Child Element NAME Defines the field name.  
        VALUE Contains the field value.  
    Example 1
    with normal
    usage
    <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
    xmlns:rec=”SilverpopApi:EngageService.ListMgmt.RecipientActions”>
    <soapenv:Body>
    <rec:UpdateRecipient>
    <rec:LIST_ID>24872</rec:LIST_ID>
    <rec:OLD_EMAIL>somebody@domain.com</rec:OLD_EMAIL>
    <rec:COLUMN>
    <rec:NAME>EMAIL</rec:NAME>
    <rec:VALUE>somebody@domain.com</rec:VALUE>
    </rec:COLUMN>
    <rec:COLUMN>
    <rec:NAME>First_Name</rec:NAME>
    <rec:VALUE>Somebody2</rec:VALUE>
    </rec:COLUMN>
    </rec:UpdateRecipient>
    </soapenv:Body>
    </soapenv:Envelope>
         
    Example 2
    with
    resubscribe
    <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
    xmlns:rec=”SilverpopApi:EngageService.ListMgmt.RecipientActions”>
    <soapenv:Body>
    <rec:UpdateRecipient>
    <rec:LIST_ID>24872</rec:LIST_ID>
    <rec:OLD_EMAIL>somebody@domain.com</rec:OLD_EMAIL>
    <rec:COLUMN>
    <rec:NAME>EMAIL</rec:NAME>
    <rec:VALUE>somebody@domain.com</rec:VALUE>
    </rec:COLUMN>
    <rec:COLUMN>
    <rec:NAME>OPT_OUT</rec:NAME>
    <rec:VALUE>false</rec:VALUE>
    </rec:COLUMN>
    </rec:UpdateRecipient>
    </soapenv:Body>
    </soapenv:Envelope>
         
    Example 3
    with Sync
    Fields
    <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:sil=”SilverpopApi:EngageService.SessionHeader”
    xmlns:sil1=”SilverpopApi:EngageService.ListMgmt.RecipientActions”>
    <soapenv:Header>
    <sil:sessionHeader>
    <sil:sessionid>B5D9B1C28186E876B9E2ECB6C036AC2F</sil:sessionid>
    </sil:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <sil1:UpdateRecipient>
    <sil1:LIST_ID>24872</sil1:LIST_ID>
    <sil1:OLD_EMAIL>shamilton@silverpop.com</sil1:OLD_EMAIL>
    <sil1:SEND_AUTOREPLY>false</sil1:SEND_AUTOREPLY>
    <sil1:ALLOW_HTML>true</sil1:ALLOW_HTML>
    <sil1:COLUMN>
    <sil1:NAME>Age</sil1:NAME>
    <sil1:VALUE>5</sil1:VALUE>
    </sil1:COLUMN>
    <sil1:SYNC_FIELDS>
    <sil1:SYNC_FIELD>
    <sil1:NAME>Email</sil1:NAME>
    <sil1:VALUE>shamilton@silverpop.com</sil1:VALUE>
    </sil1:SYNC_FIELD>
    <sil1:SYNC_FIELD>
    <sil1:NAME>Customer_Number</sil1:NAME>
    <sil1:VALUE>56498771</sil1:VALUE>
    </sil1:SYNC_FIELD>
    </sil1:SYNC_FIELDS>
    </sil1:UpdateRecipient>
    </soapenv:Body>
    </soapenv:Envelope>
         
    Response <RESULT>      
    Elements SUCCESS True if successful.    
      Recipient ID ID of the updated contact.    
      ORGANIZATION_ID Identifies your Watson Campaign Automation Organization.    
      VISITOR_ASSOCIATION Optional Indicates whether the specified Visitor ID is valid and was
    associated to a profile.
     
    Example <envelope:Envelope xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body xmlns=”SilverpopApi:EngageService.ListMgmt.RecipientActions”>
    <RESULT>
    <SUCCESS>true</SUCCESS>
    <RecipientId>28052753</RecipientId>
    <ORGANIZATION_ID>1dcd49d‚Äź108b594203df528764d624db129b32c21fbca0cb8d6
    </ORGANIZATION_ID>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope>
         

Join The Discussion

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