List and Field Methods

Overview

The List and Field methods provide you with the ability to search, add, edit and delete Lists and their Fields. Lists (also called Contact Lists) contain your system's Contacts, and Fields contain the details about them. Lists are created for different purposes, so they may have the same or different Fields. For example, you might have a Purchaser List that includes a text array for items the Contact has purchased and a Newsletter Subscriber List with a Weekly Summary checkbox.

When you create a List using the API, it only has a few user Fields (as well as several metadata Fields). You can add Fields afterwards using addField.

List and Field Methods

• addField

  Adds a new Field to a List.

• addList

  Creates a new Contact List.

• clearList

  Deletes all Contacts in a List.

• countFields

  Counts the number of Fields in a List that match the search criteria.

• countLists

  Counts the number of Lists that match the search criteria.

• deleteField

  Deletes a Field from a List.

• deleteList

  Deletes a List and all of its Contacts.

• editField

  Edits a Field in a List.

• editList

  Edits a List.

• getFieldById

  Returns details for a specific Field in a List.

• getFolderIdForField

  Returns the Folder ID for a File type Field in a List.

• getListById

  Returns details for a specific List.

• getTimezoneList

  Returns the list of preferred Olson timezones used in the system.

• searchFields

  Returns the Fields in the List that match the search criteria.

• searchLists

  Returns the Lists that match the search criteria.

• setFieldFolderId

  Sets the File Folder ID for a File type Field in a List.