List Management

Generate List Key

To access list management API methods, in addition to your authentication parameters, a mandatory parameter "listkey" is to be used. The listkey represents the mailing list you're trying to access.

From the Navigation toolbar, choose Contacts and select Manage Lists.
In Lists page, click the Mailing list for which you'd like to generate the list key.
Click Setup and scroll down to view the List Key.
Copy the List key.

Listed out in the table are the various API methods and their purposes for list management through API.

Method Name	Purpose
getmailinglists	To fetch the mailing list and list details.
getlistadvanceddetails	To fetch the list based advanced details.
getlistcontacts	To get the contacts based on status.
getallcontactfields	To fetch contact fields to get profile information of contacts.
getsegmentdetails	To fetch the segment details.
getsegmentcontacts	To fetch the segment contacts.
updatelistdetails	To edit mailing list's name and allow sign-up form.
deletemailinglist	To delete the mailing list.
totalcontacts	To view all the contacts in a mailing list
listsubscribe	To add contacts (one at a time) and custom fields to a list (private and public list).
listunsubscribe	To unsubscribe the user from a list.
contactdonotmail	To move a contact to Do-Not-Mail registry.
addlistandcontacts	To add new list and contacts in the list.
addlistcontactsinbulk	To add contacts in existing list.
createcustomfield	To create custom fields for contacts.
createmergetags	To create merge tags.