Overview

Skill Level: Any

Step-by-step

  1. Syntax of the request and response SOAP for AddContactToContactList

    This interface adds one new contact to a Contact List. If the contact is not yet in your database, they may be added using the AddRecipient operation (see the “Add a Contact” section).

    The contact may be added to the Contact List by providing either a Contact Id or the key fields from the Database. The Contact Id can be obtained from the RecipientId element in the response of the following operations: AddRecipient, UpdateRecipient, and SelectRecipientData.

    If providing key fields and your database has a key other than Email, you must include all unique key columns with their corresponding name/value pairs. If using a database that has no Unique Identifier defined, one or more columns must be specified in order to look up the contact.

    Upon looking up the contact in the database using the Contact Id or key fields, Watson Campaign Automation will process the contact as follows:

    • If the contact is found and does not yet exist in the Contact List, they will be added.
    • If the contact is found and already exists in the Contact List, they will be not be added.
    • If more than one contact is found matching the Sync Fields for a non‚Äźkeyed list, an error message will be returned.
    • If the contact is not found, an error message will be returned.
    Operation  <AddContactToContactList>     
    Elements  CONTACT_LIST_ID The ID of the Contact List to which you are adding the contact.   
      CONTACT_ID  Optional  The ID of the contact being added to the Contact List. Either a
    CONTACT_ID or COLUMN elements must be provided. If
    CONTACT_ID is provided, any COLUMN elements will be ignored. 
      COLUMN  Optional

    Required if the database has a key other than Email or no Unique
    Identifier and Contact Id is not provided. XML nodes defining the
    column name and value used to look up a contact in a database.
    Ignored for regular email key databases.

    Note: Unique key columns
    must be part of the submission with column names and values. 

      Child Element  Name  Contains the field name. 
        Value  Contains the field value. 
    Example with
    Contact Id 
    <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:sil=”SilverpopApi:EngageService.SessionHeader”
    xmlns:sil1=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <soapenv:Header>
    <sil:sessionHeader>
    <sil:sessionid>530655D8BFFAC1DAFA448051DFDA6391</sil:sessionid>
    </sil:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <sil1:AddContactToContactList>
    <sil1:CONTACT_LIST_ID>131145</sil1:CONTACT_LIST_ID>
    <sil1:CONTACT_ID>23476503</sil1:CONTACT_ID>
    </sil1:AddContactToContactList>
    </soapenv:Body>
    </soapenv:Envelope> 
       
    Example with
    COLUMN
    elements 
    <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:sil=”SilverpopApi:EngageService.SessionHeader”
    xmlns:sil1=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <soapenv:Header>
    <sil:sessionHeader>
    <sil:sessionid>530655D8BFFAC1DAFA448051DFDA6391</sil:sessionid>
    </sil:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <sil1:AddContactToContactList>
    <sil1:CONTACT_LIST_ID>131145</sil1:CONTACT_LIST_ID>
    <sil1:COLUMN>
    <sil1:NAME>SSN</sil1:NAME>
    <sil1:VALUE>123‚Äź45‚Äź6789</sil1:VALUE>
    </sil1:COLUMN>
    <sil1:COLUMN>
    <sil1:NAME>First_Name</sil1:NAME>
    <sil1:VALUE>Joe</sil1:VALUE>
    </sil1:COLUMN>
    <sil1:COLUMN>
    <sil1:NAME>Last_Name</sil1:NAME>
    <sil1:VALUE>Smith</sil1:VALUE>
    </sil1:COLUMN>
    </sil1:AddContactToContactList>
    </soapenv:Body>
    </soapenv:Envelope> 
       
    Response  <RESULT>     
    Elements SUCCESS  True if successful.   
    Example¬† <envelope:Envelope xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body xmlns=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <RESULT>
    <SUCCESS>true</SUCCESS>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope> 
       

Join The Discussion

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