Update segment group
update_segment_groupTool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"group_id": "<group_id>"
},
"name": "update_segment_group"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | 'single' or 'multi'; omit to leave unchanged. | |
| name | No | New name; omit to leave unchanged. | |
| criteria | No | The classify scope to track — {agent_ids, senders}, the campaign (agent_tasks) ids and teammate emails, each null = all. A provided object REPLACES the whole stored scope (an axis you leave out becomes all), so pass the current value of any axis you keep; omit the object to leave it unchanged. New people in this scope are tagged automatically and classify reuses it, so change it to re-target what the segment tracks. | |
| group_id | Yes | The segment group to edit (from list_segment_groups). | |
| description | No | New one-line description; omit to leave unchanged. | |
| on_behalf_of | No | A teammate's email, or an agency client's from list_agency_clients, to run this call in that account: their agents, settings, connected accounts, and credits. Omit it to act on your own account. |