lead_groups_write
Create, fill, rename, or delete lead groups by assigning existing leads or adding new ones, with optional permanent lead deletion when removing a group.
Instructions
Create, fill, rename or delete a lead group. Group names are stored lowercase. Actions: create (groupName + leads: new lead objects, e.g. [{ userName, userPhone, userEmail }] — a group exists only while it has leads), assign_leads (groupName + leadIds: move EXISTING leads into the group; groupName "all" removes them from any group), rename (groupName + newGroupName: moves every lead to the new name), delete (groupName: by default the leads are kept and just ungrouped; deleteLeads=true permanently deletes every lead in the group).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | compact (default) = light mode: long text is cut and bulky blobs are replaced by a size marker. full = complete API response. | |
| leads | No | For create: new leads to add to the group. | |
| action | Yes | ||
| agentId | Yes | ||
| leadIds | No | For assign_leads: ids of existing leads. | |
| groupName | Yes | ||
| deleteLeads | No | For delete. Default false (leads are kept). | |
| newGroupName | No | For rename. |