ToolsSearch & Enrichment

Update lead group

Rename a lead group and archive/restore it.

Tool: update_lead_group

Naming a draft promotes it to saved; archived groups leave listings but keep their members and every lead's data untouched. NOT for: enrichment columns → add_data_points; membership → add_leads_to_group / mark_leads; the search query → re-run the search op with the same lead_group_id.

Parameters

ParamTypeRequiredDescription
lead_group_idstring (slug or UUID)yesThe group to update.
namestringnoNew display name (non-empty). Naming a draft promotes it to saved.
archivedbooleannotrue retires the group (leaves listings; members and lead data untouched); false restores it.

Pass at least one of name / archived.

Enrichment columns are declared with add_data_points, not here.

NOT for membership (add_leads_to_group / mark_leads) or the search query (re-run the search op with the same lead_group_id).

Sample request

{
  "lead_group_id": "ceo-prospects-0010",
  "name": "CEO outbound — renamed"
}

On this page