The Watson Campaign Automation XML API library provides an efficient mechanism to accomplish many automation and integration tasks.

See the Developer content for detailed information about API requests and responses and the Test Harness, which includes the Appendix IBM Endpoints (IBM API Endpoints).

To access tutorials directly, click here

.

Feature

The XML API interface defines standard XML requests and responses for the following functions:

Session Management

  • User Login
  • User Logout

Database Management

  • Add a Contact
  • Double Opt-In a Contact
  • Update a Contact
  • Opt out a Contact
  • Select Contact Details

Contact List Management

  • Import to a database
  • Export from a database
  • Remove a Contact
  • Get a List of databases
  • Get database details
  • Create a Contact List
  • Add a Contact to a Contact List
  • Create a Query of a database
  • Create a Query of a database by using Behavioral Query Criteria
  • Create a Query of a database – Call Examples from Behavioral Criteria
  • Create a Query of a database by using Multiple Query Expressions
  • Create a Query of a database by using Time Based Operators
  • Create a Query of a database by using Universal Behavior Criteria
  • Create a Query of a database by using Relational Table Criteria
  • Create a Query of a database by using Profile Criteria
  • Calculate the Current® Contacts for a Query
  • Add a Contact to a program
  • Get Contact Mailing Details
  • Purge Data
  • Set a Column Value
  • Relational Table Management

    • Create a Relational Table
    • Associate Relational Data with Contacts in a database
    • Insert and Update Records in a Relational Table
    • Delete Records from a Relational Table
    • Import to a Relational Table
    • Export from a Relational Table
    • Purge Data from a Relational Table
    • Delete a Relational Table

    Template and Mailing Management

    • Send a Mailing to a Contact
    • Forward Mailing to a Friend
    • Preview a Mailing Before Sending
    • Schedule a Mailing
    • Get a List of Mailing Templates
    • Export a Mailing Template
    • Get Automated Message Group Details

    Dynamic Content

    • Add a Dynamic Content Ruleset
    • Import a Dynamic Content Ruleset
    • Export a Dynamic Content Ruleset
    • List Dynamic Content Rulesets for a Mailing
    • Get Dynamic Content Ruleset Details
    • Replace a Dynamic Content Ruleset
    • Validate a Dynamic Content Ruleset
    • Delete a Dynamic Content Ruleset

    Reporting

    • Export Raw Contact Events
    • Get Report ID by Date
    • Get Sent Mailings for an Org
    • Get Sent Mailings for a User
    • Get Sent Mailings for a database
    • Get Aggregate Tracking Metrics for a Mailing
    • Get Aggregate Tracking Metrics for an Org
    • Get Aggregate Tracking Metrics for a User
    • Export Web Tracking Events

    Miscellaneous

    • List Contact Mailings
    • Get Status of a Data Job
    • Delete a Data Job
    • Get Folder Path of a Folder or Object