Lead Lists

Manage collections of leads within campaigns.

Tools (8)

list_lead_lists

Full name: campaignstack_list_lead_lists

lead_lists:read Read-only Idempotent

List all lead lists in a campaign with lead count per list. Returns type (set or query) and source for each list. Use the returned leadListId values with campaignstack_get_lead_list or campaignstack_add_leads_to_list. Use campaignstack_list_campaigns to find valid campaign IDs.

Parameters

Name	Type	Required	Default	Description
campaignId	string	Yes	—	(min length: 1)

---

get_lead_list

Full name: campaignstack_get_lead_list

lead_lists:read Read-only Idempotent

Get a lead list by ID with details and optionally paginated leads. Set includeLeads to true to get the leads in the list. If the lead list is not found, use campaignstack_list_lead_lists to find valid IDs.

Parameters

Name	Type	Required	Default	Description
leadListId	string	Yes	—	(min length: 1)
includeLeads	boolean	No	false
limit	integer	No	20	(min: 1, max: 100)
cursor	string	No	—

---

create_lead_list

Full name: campaignstack_create_lead_list

lead_lists:write

Create a new static lead list in a campaign. Optionally add leads by providing leadRefs. Each leadRef needs leadSource (default ‘global’) and leadId. Use campaignstack_list_campaigns to find valid campaign IDs and campaignstack_search_leads to find lead IDs.

Parameters

Name	Type	Required	Default	Description
campaignId	string	Yes	—	(min length: 1)
name	string	Yes	—	(min length: 1)
leadRefs	object[]	No	—

---

add_leads_to_list

Full name: campaignstack_add_leads_to_list

lead_lists:write Idempotent

Add leads to an existing lead list. Idempotent — leads already in the list are skipped. Each leadRef needs leadSource (default ‘global’) and leadId. Returns the count of newly added leads and already-present leads. Use campaignstack_list_lead_lists to find lead list IDs and campaignstack_search_leads to find lead IDs.

Parameters

Name	Type	Required	Default	Description
leadListId	string	Yes	—	(min length: 1)
leadRefs	object[]	Yes	—

---

update_lead_list

Full name: campaignstack_update_lead_list

lead_lists:write Idempotent

Update a lead list: rename it and/or update its query predicate. Setting a query converts the list to query type. Use campaignstack_list_lead_lists to find valid lead list IDs.

Parameters

Name	Type	Required	Default	Description
leadListId	string	Yes	—	(min length: 1)
name	string	No	—	(min length: 1)
query	object	No	—

---

remove_lead_list

Full name: campaignstack_remove_lead_list

lead_lists:write Destructive

Permanently delete a lead list. This is destructive and cannot be undone. Use campaignstack_list_lead_lists to find valid lead list IDs.

Parameters

Name	Type	Required	Default	Description
leadListId	string	Yes	—	(min length: 1)

---

create_query_lead_list

Full name: campaignstack_create_query_lead_list

lead_lists:write

Create a dynamic query-type lead list in a campaign. Query lists dynamically resolve their members from included/excluded lists and filter rules. Use campaignstack_list_campaigns to find campaign IDs and campaignstack_list_lead_lists to find lead list IDs for include/exclude refs.

Parameters

Name	Type	Required	Default	Description
campaignId	string	Yes	—	(min length: 1)
name	string	Yes	—	(min length: 1)
query	object	Yes	—

---

remove_leads_from_list

Full name: campaignstack_remove_leads_from_list

lead_lists:write Destructive Idempotent

Remove specific leads from a lead list. Each leadRef needs leadSource (default ‘global’) and leadId. Returns the count of leads actually removed. Use campaignstack_get_lead_list with includeLeads=true to see current leads.

Parameters

Name	Type	Required	Default	Description
leadListId	string	Yes	—	(min length: 1)
leadRefs	object[]	Yes	—

---