Overview

Skill Level: Any

Prerequisites

If the database is a Restricted database on something other than the Email column, you must include all unique key columns with their corresponding name-value pairs. If your database is a Flexible database, one or more columns that serve as Sync Fields must be specified to look up the contact.

CAUTION: Removing a recipient from a database also removes all tracking for mailings sent to the recipient and cannot be undone.

Step-by-step

  1. Syntax of the request and response XML for RemoveRecipient

    Operation <RemoveRecipient>
    Elements LIST_ID Unique ID of the database or Contact List from which to remove contact.
      EMAIL Email address of the contact to remove. Required only if the database is restricted only on the Email column, of if the Email column is a composite key of a Restricted database.
      COLUMN  

    XML nodes that define the column name and value that is used to look up a contact in a database or Contact List. You must include all unique key columns with their corresponding name-value pairs when using this operation on a database restricted on a column other than Email. If your database is a Flexible database, one or more columns that serve as Sync Fields must be specified to look up the contact.

     

    Note: If more than one contact is found matching the lookup columns, all contacts are removed.
      Child Element Name Specifies the name of a field that is either part of the unique key for Restricted databases, or a sync field for Flexible databases.
        Value Specifies the value for the field.
    Example for a Restricted
    database with only Email as the key.
    <Envelope>
      <Body>
        <RemoveRecipient>
          <LIST_ID>10000</LIST_ID>
          <EMAIL>somebody@domain.com</EMAIL>
        </RemoveRecipient>
      </Body>
    </Envelope>
    
    Example
    for a
    Restricted
    database
    with
    Customer
    Id and
    Account
    Number
    as keys.
    <Envelope>
      <Body>
        <RemoveRecipient>
          <LIST_ID>10000</LIST_ID>
          <COLUMN>
            <NAME>Customer Id</NAME>
            <VALUE>123-45-6789</VALUE>
          </COLUMN>
          <COLUMN>
            <NAME>Account Number</NAME>
            <VALUE>555</VALUE>
          </COLUMN>
        </RemoveRecipient>
      </Body>
    </Envelope>
    
    Example
    for a
    Restricted
    database
    with
    Email,
    Customer
    Id, and
    Account
    Number
    as keys.
    <Envelope>
      <Body>
        <RemoveRecipient>
          <LIST_ID>10000</LIST_ID>
          <EMAIL>someone@domain</EMAIL>
          <COLUMN>
            <NAME>Customer Id</NAME>
            <VALUE>00054</VALUE>
          </COLUMN>
          <COLUMN>
            <NAME>Account Number</NAME>
            <VALUE>62364</VALUE>
          </COLUMN>
        </RemoveRecipient>
      </Body>
    </Envelope>
    
    Example
    for a
    Flexible
    database
    with
    Customer
    Number
    used as a
    sync field.
    <Envelope>
      <Body>
        <RemoveRecipient>
          <LIST_ID>10000</LIST_ID>
          <COLUMN>
            <NAME>Customer Number</NAME>
            <VALUE>6789</VALUE>
          </COLUMN>
        </RemoveRecipient>
      </Body>
    </Envelope>
    
    Example
    for an
    Flexible
    database
    to target a specific
    Email that
    shares an
    Account
    Number
    with other
    records.
    Here
    Account
    Number is used as a sync field.  
    <Envelope>
      <Body>
        <RemoveRecipient>
          <LIST_ID>10000</LIST_ID>
          <EMAIL>somebody@domain.com</EMAIL>
          <COLUMN>
            <NAME>Account Number</NAME>
            <VALUE>6789</VALUE>
          </COLUMN>
        </RemoveRecipient>
      </Body>
    </Envelope>
    
    Response <RESULT>
    Elements SUCCESS True if successful.
      ORGANIZATION_ID Identifies your Watson Campaign Automation Organization.
    Example
    <Envelope>
      <Body>
        <RESULT>
          <SUCCESS>TRUE</SUCCESS>
        </RESULT>
        <ORGANIZATION_ID>
          1dcd49d-108b594203d-f528764d648fb129b32c21fbca0cb8d6
        </ORGANIZATION_ID>
      </Body>
    </Envelope>

Join The Discussion

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