enroll_by_segment
Enroll every contactable lead carrying one exact segment tag into an outreach sequence — one call, no pasted address list. Same server-side safety re-validation as the Leads tab Enroll button and enroll_leads_in_sequence (do-not-contact, archived, and inactive leads are excluded and reported, never enrolled); already-enrolled leads are left untouched. By default it also SKIPS leads currently mid-flight in another sequence so a segment blast cannot double-touch someone. Use when the operator says "enroll/email everyone in ". Enrolling causes the sequencer to DRAFT emails into the review queue — nothing is sent without human approval in Review drafts. Report ONLY what this tool returns; never claim sends or scheduling beyond it. This tool never sends email and never touches drafts.
Routing: CRM/sales → enroll a whole segment / everyone with this tag into a sequence → use this
[write-tier — first use may require a manager's approval; a from-now-on approval makes future calls seamless, a just-once approval re-asks next time.]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Optional — max leads to enroll in this call (default 500, which is also the hard ceiling). | |
| sequence | Yes | The sequence to enroll into — its name or id (from list_sequences). Own-company sequences and system defaults are valid. | |
| companyId | Yes | FreedomOS company id to act within (you must be a member). Required for company-scoped tools. | |
| segment_tag | Yes | Exact segment tag token from crm_leads.source, e.g. 'csv:free-trial'. No substring matching — must match a live tag exactly (see list_segments). | |
| exclude_active | No | Optional — skip leads that already have a queued/active enrollment in ANOTHER sequence, so a segment blast does not double-touch them. Default true. |