Create, change or delete a candidate segment
manage_segment[Candidates] action save (create without id, update with id; name, description, kind, and rules: the same {match, rules} list_candidates takes, as an object or a JSON string), delete, or add_members / remove_members of a static segment (candidate ids). Fields left out keep their value. list_candidates takes the same rules and returns the candidates they match, without saving anything. Sends nothing to candidates. Deleting cannot be undone.
Every argument in full, with examples: get_tool_reference.
Tool 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": {
"action": "<action>"
},
"name": "manage_segment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | save: dynamic (members are the candidates matching the rules at any time) or static (a fixed list). Required when creating; cannot change. | |
| name | No | save: the name (1 to 120 characters). Required when creating; kept when left out on a change. | |
| rules | No | save: the rules of a dynamic segment, or the first members of a new static one (an object, or the same JSON as a string), checked by the database (the candidate search of list_candidates takes the same rules and shows their matches without saving). | |
| action | Yes | save: create (no segment_id) or change (segment_id) a segment; delete: delete it; add_members / remove_members: change the members of a static segment. | |
| llm_model | No | Your model id, e.g. "claude-opus-4-8"; "unknown" if unsure. For analytics. | |
| segment_id | No | Segment id (a segment `id` from list_segments). Required for every action except creating. | |
| description | No | save: a description (at most 500 characters); null or empty clears it; kept when left out on a change. | |
| merchant_id | No | Optional company to act in. Admins and sub-merchant operators only; other callers always use their token's company. | |
| candidate_ids | No | Candidate ids (the `id` of a list_candidates row). add_members / remove_members: the candidates to add or remove (required). | |
| conversation_id | No | The conversation_id this server returned earlier in this conversation, unchanged, including after later user messages. Omit it if you have none. Recorded for the server developer's analytics. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| added | No | ||
| action | Yes | ||
| created | No | ||
| deleted | No | ||
| removed | No | ||
| segment | No | ||
| segment_id | Yes | ||
| _mcp_instructions | No | Server-issued metadata for this conversation. |