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. Call this when the user asks what lists a campaign has, or to find a leadListId before calling campaignstack_get_lead_list or campaignstack_add_leads_to_list. It reports counts only, not who is in a list: campaignstack_get_lead_list with includeLeads does that. 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 paginated leads when includeLeads is true. Call this when the user asks who is in a list, or before adding or removing leads. Metadata and members only, not campaign performance: use campaignstack_get_campaign_metrics for that. 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 with leadRefs (leadSource default ‘global’, leadId). Call this for a named, fixed group of leads. For a list that stays current against a rule instead, use campaignstack_create_query_lead_list. 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 counts added and already-present. Call this to add named people to a list that already exists: campaignstack_create_lead_list makes a new one. 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

Rename a lead list and/or update its query predicate. Setting a query converts the list to query type. Call this to rename a list or change what a query list matches. For a static list’s membership, use campaignstack_add_leads_to_list or campaignstack_remove_leads_from_list instead. 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

Delete a lead list. This cannot be undone, and a workflow drawing its leads from that list has nothing to draw from afterwards. The leads themselves are not deleted; they stay in the workspace and in any other list. Call this only when the user names the list and says to delete it. To take individual people out, use campaignstack_remove_leads_from_list. Use campaignstack_list_lead_lists to find 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: members resolve from included/excluded lists and filter rules on a recurring cadence, not a fixed set. Call this for a list that stays current against a rule. For a fixed group of named people, use campaignstack_create_lead_list instead. 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

Remove specific leads from a lead list. Each leadRef needs leadSource (default ‘global’) and leadId. Returns the count removed. Call this to take named people out of a list, not delete the list itself: campaignstack_remove_lead_list does that; the leads themselves are unaffected. 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	—

---