Overview

Skill Level: Any

Prerequisites

This interface adds one new contact to an existing database. If your database has a key other than Email, you must include all unique key columns with their corresponding name/value pairs. If adding and/or 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 AddRecipient

    Operation <AddRecipient>      
    Elements LIST_ID The ID of the database to which you are adding the contact.    
      CREATED_FROM Value indicating the way in which you are adding the contact to the system. Values
    include:
    0 ‚Äď Imported from a database
    1 ‚Äď Added manually
    2 ‚Äď Opted in
    3 ‚Äď Created from tracking database
       
      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.
     
      UPDATE_IF_FOUND Optional If the UPDATE_IF_FOUND element is set to true, attempting to add a contact with a duplicate key will result in an update to their record. If
    the database has no Unique Identifier and UPDATE_IF_FOUND is set to true, attempting to add a contact with duplicate SYNC_FIELDS will
    result in an update to the record.
     
    ¬† ALLOW_HTML Optional If ALLOW_HTML is set to true, Watson Campaign Automation will interpret‚ÄĒand properly
    render‚ÄĒHTML within a value in the text field. The default value is false and will convert HTML tags to character entity references (and tags display as literal characters in the text field).
     
      SYNC_FIELDS Optional Required if the database has no Unique Identifier and UPDATE_IF_FOUND is set to true. Used to look up a contact in a database that has no Unique Identifier defined. Include a SYNC_FIELD element for each database 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 fields will be ignored if the database has a key.
     
      VISITOR_ID Optional Allows specifying a visitor key to associate a contact to a previously unknown visitor when using the Web Tracking feature.  
      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 for fields being added or updated.
    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.
       
      Child Element Name Defines the field name. The name of the Email column must be EMAIL. The name of the email type column must be EMAIL_TYPE  
        Value Contains the field value.  
    Example 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:AddRecipient>
    <rec:LIST_ID>24872</rec:LIST_ID>
    <rec:CREATED_FROM>1</rec:CREATED_FROM>
    <rec:UPDATE_IF_FOUND>true</rec:UPDATE_IF_FOUND>
    <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>Somebody</rec:VALUE>
    </rec:COLUMN>
    </rec:AddRecipient>
    </soapenv:Body>
    </soapenv:Envelope>
         
    Example 2
    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:AddRecipient>
    <sil1:LIST_ID>80750</sil1:LIST_ID>
    <sil1:CREATED_FROM>1</sil1:CREATED_FROM>
    <sil1:SEND_AUTOREPLY>false</sil1:SEND_AUTOREPLY>
    <sil1:UPDATE_IF_FOUND>true</sil1:UPDATE_IF_FOUND>
    <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:AddRecipient>
    </soapenv:Body>
    </soapenv:Envelope>
         
    Response <RESULT>      
    Elements SUCCESS True if successful.    
      RecipientId ID of added or updated contact.    
      ORGANIZATION_ID Identifies your Watson Campaign 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>2261663731</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 *