Introduction to the Application Programming Interface (API)

ListManager allows administrators to access and manipulate the database tables using SOAP (Simple Object Access Protocol) 1.4.2 SOAP provides a way to communicate between applications running on different operating systems, with different technologies and programming languages. SOAP is a key element of Microsoft's .NET architecture for future Internet application development. SOAP provides a higher-level interface to database information so that no knowledge of database query protocols is required.

ListManager's API can be invoked from any language with SOAP support, including:

.NET

Perl

Java

Php

Tcl

Examples of ListManager's functions in different languages are available in your ListManager's soap directory:

http://yourlistmanagerurl/soap

Or, you may navigate to Utilities: Other: Programming API.

To use the ListManager API effectively, it is important to understand the information stored in each table column. Many functions require modification of record fields in order to work properly. It is also important to understand the possible side effects of modifying these fields. For example, if you set a member’s 'MemberType' attribute to 'unsub', then that member’s record may be deleted if the list is set up to purge unsubscribed members.