Lead Gen & CRM has a distinct API organization. This article will detail the methods listed within the Lead Gen & CRM API, related to Lists.
| Administrators | ✓ | |
| Company Managers | ||
| Marketing Managers | ||
| Sales Managers | ||
| Salespersons | ||
| Jr. Salespersons |
This article provides specific method content about Lead Gen & CRM's API. However, given the size and scope of the API, information is broken up and is contained in different articles. Each article focuses on a specific function of Lead Gen & CRM's API. Additional API information can be found in the following articles:
getListTags | Returns a tag list for lists. | |||||
| Params | Name | Type | Is Required | |||
| none |
Optional | |||||
| Return Data | Name | Type | ||||
| getAllgetListTagss |
list<listTag> | |||||
| hasMore |
boolean | |||||
createLists | Create a static mailing list. | |||||
| Params | Name | Type | Is Required | |||
| name | string |
Required | ||||
| description | string |
Optional | ||||
| Return Data | Name | Type | ||||
| status |
boolean<true/false> | |||||
| id |
int | |||||
deleteList | Specify a list of Lists to be deleted by ID. | |||||
| Params | Name | Type | Is Required | |||
| objects | list<id> |
Required | ||||
| Return Data | Name | Type | ||||
| deletes |
list<deleteResult> | |||||
getActiveLists | Returns a list of active Lists. | |||||
| Params | Name | Type | Is Required | |||
| where |
hash Required: none Optional: id |
Required | ||||
| limit |
int |
Optional | ||||
| offset |
int |
Optional | ||||
| Return Data | Name | Type | ||||
| activeList |
list<List> | |||||
updateList | Updates an existing list. | |||||
| Params | Name | Type | Is Required | |||
| id |
int |
Required | ||||
| name |
string |
Optional | ||||
| description |
string |
Optional | ||||
| Return Data | Name | Type | ||||
| updates |
list<UpdateResult> | |||||
addListMember | Adds a lead to a list | |||||
| Params | Name | Type | Is Required | |||
| listID |
int |
Required | ||||
| memberID |
int |
Required | ||||
| Return Data | Name | Type | ||||
| creates |
list<createResult> | |||||
addListMemberEmailAddress | Add a member to a mailing list using their email address. | |||||
| Params | Name | Type | Is Required | |||
| listID |
int |
Required | ||||
| emailAddress |
string |
Required | ||||
| Return Data | Name | Type | ||||
| create |
list<CreateResult> | |||||
addListMembers | Specify a list of leads by id and lists for managing memberships in bulk. Each call can handle up to 500 associations. | |||||
| Params | Name | Type | Is Required | |||
| objects |
list<listID, memberID> |
Required | ||||
| Return Data | Name | Type | ||||
| creates |
list<createResult> | |||||
addListMembersEmailAddress | Specify a list of leads by email address and lists for managing memberships in bulk. Each call can handle up to 500 associations. | |||||
| Params | Name | Type | Is Required | |||
| objects |
list<listID, emailAddress> |
Required | ||||
| Return Data | Name | Type | ||||
| creates |
list<createResult> | |||||
getContactListMemberships | Get the lists that a particular contact is a member of. | |||||
| Params | Name | Type | Is Required | |||
| where |
hash Required: contactID Optional: none |
Required | ||||
| Return Data | Name | Type | ||||
| listMember |
list<ListMember> | |||||
getEmailSend | Retrieve all aggregate data for an email job. | |||||
| Params | Name | Type | Is Required | |||
| where |
hash Required: sendID Optional: none |
Required | ||||
| Return Data | Name | Type | ||||
| EmailSend |
list<EmailSend> | |||||
getListMemberships | Get the lists that a particular contact is a member of by email address. | |||||
| Params | Name | Type | Is Required | |||
| emailAddress |
string |
Required | ||||
| Return Data | Name | Type | ||||
| ListMembership |
list<ListMembership> | |||||
removeListMember | Removes a lead from a list. | |||||
| Params | Name | Type | Is Required | |||
| where |
hash Required: listID,contactID Optional: none |
Required | ||||
| Return Data | Name | Type | ||||
| updates |
list<updateResult> | |||||
removeListMemberEmailAddress | Remove a member from a mailing list using their email address. | |||||
| Params | Name | Type | Is Required | |||
| listID |
int |
Required | ||||
| emailAddress |
string |
Required | ||||
| Return Data | Name | Type | ||||
| deletes |
list<deleteResult> | |||||
removeListMembers | Specify a list of leads by id and lists for managing memberships in bulk. Each call can handle up to 500 updates. | |||||
| Params | Name | Type | Is Required | |||
| objects |
list<listID, memberID> |
Required | ||||
| Return Data | Name | Type | ||||
| updates |
list<updateResult> | |||||
removeListMembersEmailAddress | Specify a list of leads by email address and lists for managing memberships in bulk. Each call can handle up to 500 updates. | |||||
| Params | Name | Type | Is Required | |||
| objects |
list<listID, emailAddress> |
Required | ||||
| Return Data | Name | Type | ||||
| updates |
list<updateResult> | |||||
removeListMembersAll | Removes all members from a static list that were not manually added. Code is the HTTP code representing the status of the request and the Message is the accompanying description of the code. | |||||
| Params | Name | Type | Is Required | |||
| id |
int |
Required | ||||
| Return Data | Name | Type | ||||
| result |
code, message | |||||
getListMembers | Returns the active members for a specific list. | |||||
| Params | Name | Type | Is Required | |||
| where |
hash Required: id Optional: none |
Required | ||||
| limit |
int |
Optional | ||||
| offset |
int |
Optional | ||||
| Return Data | Name | Type | ||||
| fields |
list<List> | |||||
getLeadListMemberships | Gets the list id's for each member Id. A max of 100 leads per request | |||||
| Params | Name | Type | Is Required | |||
| memberIDs |
list<MemberID> |
Required | ||||
| Return Data | Name | Type | ||||
| getWhereIns |
list<ListID> | |||||
getLeadListMemberships | Get the members of a list that are "removed", "unsubscribed" or "hardbounced". If none of these are supplied via the flag parameter then it will default to "removed". | |||||
| Params | Name | Type | Is Required | |||
| where |
hash Required: id Optional: flag |
Required | ||||
| limit |
int |
Optional | ||||
| offset |
int |
Optional | ||||
| Return Data | Name | Type | ||||
| getWherelistLeadMembers |
list<RemovedListMember> | |||||
Copyright © 2026 · All Rights Reserved · Constant Contact · Privacy Center