MCP Sequencer tools - Salesfinity Docs

The Sequencer is in early access. These tools work for teams that use it. These tools run the Salesfinity Sequencer from an AI assistant. They are grouped the same way as the Sequencer operations in the API reference, and each tool calls the operation linked under its name, so that page is the full contract for responses and errors. The behavior every tool shares, including timeouts and rate-limit retries, is on the tool reference.

Writes name who is acting. An API key identifies a team, not a person, and the Sequencer records who did what, so writes take a user_id that must be an active team member. get_team lists them. On list_sequencer_tasks and get_sequencer_task_summary, user_id is instead a filter on the assignee.
Some writes reach people. Enabling a sequence with an email step lets it send, and completing a manual_email task sends that email. There is deliberately no bulk complete.
Preview before you enroll. preview_sequencer_enrolment shows who would be added and who would be refused, and changes nothing. preview_sequencer_policy does the same for a draft rule set.
Bulk tools keep going. The bulk tools handle each ID on its own, so one refusal does not stop the rest. Read the failed (or, for bulk_create_sequencer_tasks, skipped) list in the response.
A retry the server makes is safe; a repeated call is not deduplicated. Every POST except the three previews carries an Idempotency-Key, and the server’s one automatic retry after a rate limit reuses it, so that retry cannot act twice. When the assistant calls a tool again, for example after a timeout, the request has a new key: check what happened with a read first.
The tools build interval sequences. create_sequencer_step and update_sequencer_step set delays with interval_seconds and cannot give a step a fixed date.
Not the CRM sequences tools. get_sequences and get_sequence_by_id list sequence names seen on call logs from an external CRM. See CRM Sequences.

Sequences

list_sequencer_sequences

List the team’s Sequencer sequences, with filters and pagination. Calls GET /v2/sequencer/sequences.

Parameter	Type	Required	Description
`enabled`	string	No	Only sequences that are on, or only those that are off. One of `true`, `false`
`sequence_type`	string	No	`interval` steps fire a delay after the previous one; `date` steps fire on a fixed date.
`tag`	string	No	Only sequences carrying this tag.
`owner`	string	No	Only sequences authored by this team member
`search`	string	No	Case-insensitive match on the name
`page`	number	No	Page number, 1-based.
`limit`	number	No	Results per page, 1–100.

create_sequencer_sequence

Create a sequence. It starts disabled and has no steps: add steps with create_sequencer_step, then turn it on with enable_sequencer_sequence. Calls POST /v2/sequencer/sequences.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member authoring the sequence. Must be an active member of the team.
`name`	string	Yes	Sequence name, 1–200 characters
`description`	string	No	Up to 2,000 characters
`tags`	string[]	No	Up to 20 tags, each up to 50 characters
`sequence_type`	string	No	`interval` (the default) fires each step a delay after the previous one; `date` fires each step on a fixed date, which these tools cannot set. One of `interval`, `date`

get_sequencer_sequence

Get one Sequencer sequence with its counters. Calls GET /v2/sequencer/sequences/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	Sequence id

update_sequencer_sequence

Change a sequence’s settings. Steps are changed with the step tools, not here. Only the sequence’s author or a team admin may do this. Calls PATCH /v2/sequencer/sequences/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character sequence id.
`user_id`	string	Yes	Team member making the change. Must be the sequence’s author or a team admin.
`name`	string	No	Sequence name, 1–200 characters
`description`	string	No	Up to 2,000 characters
`tags`	string[]	No	Up to 20 tags, each up to 50 characters
`sequence_type`	string	No	`interval` (the default) fires each step a delay after the previous one; `date` fires each step on a fixed date, which these tools cannot set. One of `interval`, `date`
`policy`	string,null	No	Rules-of-engagement policy ID. `null` detaches the sequence, which then follows the team default
`throttle_max_adds_per_day`	number	No	Most new enrollments per owner per day, 0 or more
`throttle_capacity`	number	No	Most live enrollments per owner, 0 or more
`throttle_paused`	boolean	No	Refuse new enrollments without turning the sequence off
`transactional`	boolean	No	Bypasses the suppression list at enrollment. Only for mail the recipient asked for
`track_opens`	boolean	No	Track email opens. Default: `true`
`track_links`	boolean	No	Track link clicks. Default: `true`
`primary_reply_action`	string	No	What happens to an enrollment when the prospect replies. One of `finish` (the default), `continue`, `pause`
`primary_reply_pause_duration`	number	No	Seconds to pause for when `primary_reply_action` is `pause`; the enrollment then resumes on its own. Omit, or send 0, to pause until someone resumes it
`schedule`	object	No	Sending window. Omit it to use the team’s default window. When you send it, send all five fields, or the call is refused with 400: `timezone_source` (one of `prospect`, `account`: whose local time the window uses); `timezone` (string: IANA timezone, used when the prospect has none); `days_of_week` (number[]: 1 to 7 distinct days, 0 is Sunday); `start_hour` and `end_hour` (number: 0–23, `end_hour` greater than `start_hour`)
`email_account_ids`	number[]	No	Numeric mailbox IDs to send from, up to 100. Omit to send from the mailboxes assigned to the sequence’s author, or from the team’s shared mailboxes if the author has none

delete_sequencer_sequence

Permanently delete a sequence. Refused with 409 while any enrollment is pending, active or paused: finish or move them first. Turning the sequence off does not help, because that pauses its enrollments. Calls DELETE /v2/sequencer/sequences/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character sequence id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

add_contacts_to_sequencer_sequence

Add 1–500 contacts to a sequence, synchronously. A success response does not mean everyone was added: always read the skipped array, which lists each person refused and why. For more than 500 people, use start_sequencer_enrolment_run. Calls POST /v2/sequencer/sequences/{id}/contacts.

Parameter	Type	Required	Description
`id`	string	Yes	Sequence id
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`owner_id`	string	No	Who owns the enrollments and receives their tasks. Must be an active team member. Defaults to `user_id`
`prospects`	object[]	Yes	1–500 prospects. Each needs `contact` (an existing contact ID), `email` (matched against the team’s contacts, and created if absent) or `linkedin_username` (a handle, not a URL). Optional: `first_name`, `last_name`, `account` (company name), `title`, `timezone`, `phone_number`, `phone_type` (one of `mobile`, `direct`, `office`) and `custom_fields` (up to 100, each with `label`, `value` and an optional `type`)

get_sequencer_sequence_analytics

Enrollment counts by state, plus engagement counters, for one sequence. Calls GET /v2/sequencer/sequences/{id}/analytics.

Parameter	Type	Required	Description
`id`	string	Yes	24-character sequence id.

list_sequencer_engagement_people

The people behind one analytics tile: who opened, who replied, who bounced. Calls GET /v2/sequencer/sequences/{id}/analytics/people.

Parameter	Type	Required	Description
`id`	string	Yes	Sequence id
`metric`	string	Yes	Which tile to list the people behind. `contacted` counts people, not sends. One of `delivered`, `opened`, `clicked`, `replied`, `bounced`, `opted_out`, `failed`, `scheduled`, `contacted`
`page`	number	No	Page number, 1-based.
`limit`	number	No	Results per page.

list_sequencer_enrolment_attempts

Who was not added to a sequence, and why. The first place to look when a batch added fewer people than expected. Calls GET /v2/sequencer/sequences/{id}/enrollment-attempts.

Parameter	Type	Required	Description
`id`	string	Yes	Sequence id
`reason`	string	No	Only refusals of this kind. One of `policy`, `suppressed`, `already_enrolled`, `throttle_capacity`, `throttle_daily`, `contact_not_found`, `other`. `policy` is a rules-of-engagement refusal and `suppressed` an opt-out or bounce.
`page`	number	No	Page number, 1-based.
`limit`	number	No	Results per page.

enable_sequencer_sequence

Turn a sequence on. Refused with 422 if it has no steps, or if it has an email step and none of the mailboxes it sends from can send: its own email_account_ids, otherwise its author’s assigned mailboxes, otherwise the team’s shared ones. Calls POST /v2/sequencer/sequences/{id}/enable.

Parameter	Type	Required	Description
`id`	string	Yes	24-character sequence id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

disable_sequencer_sequence

Turn a sequence off. Every live enrollment pauses; turning it on again picks them back up. Calls POST /v2/sequencer/sequences/{id}/disable.

Parameter	Type	Required	Description
`id`	string	Yes	24-character sequence id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

duplicate_sequencer_sequence

Copy a sequence and its steps. The copy starts disabled and has no enrollments. Calls POST /v2/sequencer/sequences/{id}/duplicate.

Parameter	Type	Required	Description
`id`	string	Yes	24-character sequence id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`name`	string	No	Name for the copy, 1–200 characters. Defaults to the original’s name with a suffix

Steps

list_sequencer_steps

List the steps of a sequence, in order. Calls GET /v2/sequencer/sequences/{sequence_id}/steps.

Parameter	Type	Required	Description
`sequence_id`	string	Yes	24-character sequence id.

create_sequencer_step

Add a step to the end of a sequence. An auto_email step sends itself; manual_email, call and task steps create a task for the enrollment’s owner. The tool sets delays with interval_seconds only and cannot give a step a fixed date, so build date sequences with the REST operation, which takes date. It also leaves out new_thread, task_priority and task_autoskip_delay; set those afterwards with update_sequencer_step. Calls POST /v2/sequencer/sequences/{sequence_id}/steps.

Parameter	Type	Required	Description
`sequence_id`	string	Yes	24-character sequence id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`step_type`	string	Yes	`auto_email` sends itself; the other three create a task for the owning rep. One of `auto_email`, `manual_email`, `call`, `task`
`interval_seconds`	number	No	Delay in seconds from the previous step, or from enrollment for the first step
`display_name`	string	No	Step name, up to 200 characters
`task_note`	string	No	Shown to the rep on the resulting task. Up to 2,000 characters
`templates`	object[]	No	Email steps only. 1–10 templates, picked between by weight. Fields: `template` (string: template ID); `weight` (number: default 1)

reorder_sequencer_steps

Renumber a sequence’s steps. Send every step ID in the order you want. Refused with 409 while any enrollment is live, because renumbering would change the step each prospect is on. Calls PUT /v2/sequencer/sequences/{sequence_id}/steps/reorder.

Parameter	Type	Required	Description
`sequence_id`	string	Yes	24-character sequence id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`step_ids`	string[]	Yes	Every step ID in the sequence, in the new order. 1–50 IDs

get_sequencer_step

One step of a sequence, with its delay, type and templates. Calls GET /v2/sequencer/sequences/{sequence_id}/steps/{step_id}.

Parameter	Type	Required	Description
`sequence_id`	string	Yes	24-character sequence id.
`step_id`	string	Yes	24-character step id.

update_sequencer_step

Change a step in place. Its position is changed with reorder_sequencer_steps, not here. Like create_sequencer_step, it cannot set a fixed date. Calls PATCH /v2/sequencer/sequences/{sequence_id}/steps/{step_id}.

Parameter	Type	Required	Description
`sequence_id`	string	Yes	24-character sequence id.
`step_id`	string	Yes	24-character step id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`step_type`	string	No	`auto_email` sends itself; the other three create a task for the owning rep. One of `auto_email`, `manual_email`, `call`, `task`
`interval_seconds`	number	No	Delay in seconds from the previous step
`display_name`	string	No	Step name, up to 200 characters
`new_thread`	boolean	No	Email steps: start a new thread rather than replying on the existing one
`task_note`	string	No	Shown to the rep on the resulting task. Up to 2,000 characters
`task_priority`	string	No	Priority of the tasks the step creates. One of `high`, `medium`, `low`
`task_autoskip_delay`	number	No	Seconds after the due date at which an untouched task is skipped and the sequence moves on
`templates`	object[]	No	Email steps only. 1–10 templates, picked between by weight. Fields: `template` (string: template ID); `weight` (number: default 1)

delete_sequencer_step

Remove a step from a sequence. Refused with 409 while any enrollment is active or paused; turning the sequence off does not lift this, because it pauses enrollments. To restructure a sequence people are in, duplicate it, edit the copy and move them with move_sequencer_enrollments. Calls DELETE /v2/sequencer/sequences/{sequence_id}/steps/{step_id}.

Parameter	Type	Required	Description
`sequence_id`	string	Yes	24-character sequence id.
`step_id`	string	Yes	24-character step id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

Templates

list_sequencer_templates

List the team’s reusable email templates. Calls GET /v2/sequencer/templates.

Parameter	Type	Required	Description
`archived`	boolean	No	Only archived templates, or only live ones.
`tag`	string	No	Only templates carrying this tag.
`search`	string	No	Case-insensitive match on the template name.
`page`	number	No	Page number, 1-based.
`limit`	number	No	Results per page.

create_sequencer_template

Create a reusable email template. Email steps reference templates by id and pick between them by weight. Calls POST /v2/sequencer/templates.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member authoring the template. Must be an active member of the team.
`name`	string	Yes	Template name, 1–200 characters
`subject`	string	Yes	1–500 characters. Supports merge fields, e.g. `{{first_name}}`
`body_html`	string	Yes	HTML, up to 100,000 characters. Merge fields resolve against the contact; `{{custom.<label>}}` resolves a custom field by its label, case-insensitively
`tags`	string[]	No	Up to 20 tags, each up to 50 characters

get_sequencer_template

One template, with its body and engagement counters. Calls GET /v2/sequencer/templates/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character template id.

update_sequencer_template

Edit a template. Changes apply to every step already using it, including steps in sequences that are running now. Calls PATCH /v2/sequencer/templates/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character template id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`name`	string	No	Template name, 1–200 characters
`subject`	string	No	1–500 characters. Supports merge fields, e.g. `{{first_name}}`
`body_html`	string	No	HTML, up to 100,000 characters. Merge fields resolve against the contact; `{{custom.<label>}}` resolves a custom field by its label, case-insensitively
`tags`	string[]	No	Up to 20 tags, each up to 50 characters
`archived`	boolean	No	Archived templates stay usable by steps already pointing at them

delete_sequencer_template

Delete a template. Refused with 409 while any step uses it; archive it with update_sequencer_template instead. Only the template’s author can delete it. Calls DELETE /v2/sequencer/templates/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character template id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

preview_sequencer_template

Render a template’s subject and body with merge fields resolved. Changes nothing. Calls POST /v2/sequencer/templates/{id}/preview.

Parameter	Type	Required	Description
`id`	string	Yes	24-character template id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`contact`	string	No	Render against this contact. Without it, a sample contact is used

Enrollments

list_sequencer_enrollments

List enrollments: which step each contact is on and who owns them. Calls GET /v2/sequencer/enrollments.

Parameter	Type	Required	Description
`sequence`	string	No	Only enrollments in this sequence.
`contact`	string	No	Only enrollments for this contact.
`state`	string	No	`finished`, `bounced`, `opted_out` and `failed` are terminal; the rest still hold the contact’s one live slot in the sequence. One of `pending`, `active`, `paused`, `finished`, `bounced`, `opted_out`, `failed`
`pending_reason`	string	No	Only enrollments a rule is holding for approval. One of `approval`
`user`	string	No	Only enrollments owned by this team member.
`page`	number	No	Page number, 1-based.
`limit`	number	No	Results per page.

bulk_finish_sequencer_enrollments

Finish (un-enroll) up to 500 enrollments at once. Like finish_sequencer_enrollment, this is how people leave a sequence; there is no delete. Each ID is handled on its own, so one refusal does not stop the rest: the response counts ok and lists each failed ID with its reason. Calls POST /v2/sequencer/enrollments/bulk/finish.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`ids`	string[]	Yes	1–500 enrollment IDs
`note`	string	No	Accepted, but finishing records no note

bulk_approve_sequencer_enrollments

Release up to 500 enrollments a rule is holding for approval. Each ID is handled on its own, so one refusal does not stop the rest: the response counts ok and lists each failed ID with its reason. Calls POST /v2/sequencer/enrollments/bulk/approve.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`ids`	string[]	Yes	1–500 enrollment IDs
`note`	string	No	Recorded against each approval, up to 500 characters

bulk_reject_sequencer_enrollments

Refuse up to 500 held enrollments. Each is finished without being contacted, and the decision is recorded. Each ID is handled on its own, so one refusal does not stop the rest: the response counts ok and lists each failed ID with its reason. Calls POST /v2/sequencer/enrollments/bulk/reject.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`ids`	string[]	Yes	1–500 enrollment IDs
`note`	string	No	Recorded against each rejection, up to 500 characters

bulk_reassign_sequencer_enrollments

Hand up to 500 enrollments to another rep. Their open tasks move with them. Each ID is handled on its own, so one refusal does not stop the rest: the response counts ok and lists each failed ID with its reason. Calls POST /v2/sequencer/enrollments/bulk/reassign.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`ids`	string[]	Yes	1–500 enrollment IDs
`note`	string	No	Recorded on each enrollment’s timeline, up to 500 characters
`owner_id`	string	Yes	Team member to hand the enrollments to. Must be a member of the team

move_sequencer_enrollments

Move up to 500 contacts into another sequence. Each is enrolled in the target first and finished in the original only if that succeeded, so nobody is left out of both. The new enrollments are owned by user_id, not by their previous owners. Each ID is handled on its own, so one refusal does not stop the rest: the response counts ok and lists each failed ID with its reason. Calls POST /v2/sequencer/enrollments/bulk/move.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`ids`	string[]	Yes	1–500 enrollment IDs
`note`	string	No	Accepted, but not recorded
`sequence`	string	Yes	Sequence to move them into

sequencer_account_action

Finish or pause every enrollment at one company: the “we just booked a meeting there, stop emailing the rest” case. Send dry_run: true first to see how many people it would touch. Calls POST /v2/sequencer/enrollments/bulk/account.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`contact`	string	No	A contact ID at the company. Identify the account with at least one of `contact`, `domain` or `company_name`
`domain`	string	No	Company domain, e.g. `acme.com`
`company_name`	string	No	Company name
`action`	string	Yes	One of `finish`, `pause`
`scope`	string	Yes	`sequence` limits it to one sequence; `team` covers every sequence the team runs. One of `sequence`, `team`
`sequence`	string	No	Required when `scope` is `sequence`
`days`	number	No	Pause length in days, 1–365, when `action` is `pause`
`reason`	string	No	Up to 500 characters
`dry_run`	boolean	No	Return how many would be affected, and change nothing

get_sequencer_enrollment

Get one enrollment: state, current step, when the next step is due, owner. Calls GET /v2/sequencer/enrollments/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character enrollment id.

list_sequencer_enrollment_events

The timeline for one enrollment: sends, opens, replies, task activity, rule decisions. Calls GET /v2/sequencer/enrollments/{id}/events.

Parameter	Type	Required	Description
`id`	string	Yes	24-character enrollment id.
`type`	string	No	Only events of this type, such as `email_sent`, `opened`, `replied`, `task_completed` or `policy_applied`. The operation’s page lists every type.
`page`	number	No	Page number, 1-based.
`limit`	number	No	Results per page.

pause_sequencer_enrollment

Pause one enrollment. Open tasks are hidden until it resumes. Calls POST /v2/sequencer/enrollments/{id}/pause.

Parameter	Type	Required	Description
`id`	string	Yes	24-character enrollment id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`pause_reason`	string	No	Recorded on the enrollment and its timeline. Up to 200 characters
`resume_at`	string	No	ISO 8601. The enrollment resumes itself then. Must be in the future and at most 365 days ahead

resume_sequencer_enrollment

Lift a pause and pick the sequence back up. Calls POST /v2/sequencer/enrollments/{id}/resume.

Parameter	Type	Required	Description
`id`	string	Yes	24-character enrollment id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

finish_sequencer_enrollment

Finish (un-enroll) one enrollment. This is how you remove someone from a sequence; there is no delete. The timeline survives and the contact can be enrolled again later. Calls POST /v2/sequencer/enrollments/{id}/finish.

Parameter	Type	Required	Description
`id`	string	Yes	24-character enrollment id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

retry_sequencer_enrollment

The only way out of the failed state. Calls POST /v2/sequencer/enrollments/{id}/retry.

Parameter	Type	Required	Description
`id`	string	Yes	24-character enrollment id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

reassign_sequencer_enrollment

Hand one enrollment, and by default its open tasks, to another rep. Calls POST /v2/sequencer/enrollments/{id}/reassign.

Parameter	Type	Required	Description
`id`	string	Yes	24-character enrollment id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`owner_id`	string	Yes	Team member to hand the enrollment to. Must be a member of the team
`include_open_tasks`	boolean	No	Move the enrollment’s open tasks to the new owner too. Default: `true`; send `false` to leave them where they are
`note`	string	No	Recorded on the enrollment’s timeline, up to 500 characters

approve_sequencer_enrollment

Release an enrollment a rule is holding for approval, so the sequence can start for that contact. Find held enrollments with list_sequencer_enrollments and pending_reason: approval. Calls POST /v2/sequencer/enrollments/{id}/approve.

Parameter	Type	Required	Description
`id`	string	Yes	24-character enrollment id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`note`	string	No	Recorded against the approval, up to 1,000 characters

reject_sequencer_enrollment

Refuse a held enrollment. The contact is finished without being contacted, and the decision is recorded on the timeline. Calls POST /v2/sequencer/enrollments/{id}/reject.

Parameter	Type	Required	Description
`id`	string	Yes	24-character enrollment id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`note`	string	No	Recorded against the rejection, up to 1,000 characters

Enrollment runs

preview_sequencer_enrolment

Dry run: who would be added to a sequence, who would be excluded, and why. Costs nothing and changes nothing. Run it before adding people; its preview_id lets start_sequencer_enrolment_run confirm exactly that set. Calls POST /v2/sequencer/enrollment-runs/preview.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`sequence`	string	Yes	The sequence to enroll into.
`source`	object	Yes	Who to enroll. Fields: `kind` (one of `contacts`, `contact_list`, `rows`, `preview`); `contacts` (string[]: contact IDs, required when `kind` is `contacts`); `contact_list` (string: list ID, required when `kind` is `contact_list`); `prospects` (object[]: required when `kind` is `rows`; each takes the fields listed under `add_contacts_to_sequencer_sequence`); `preview_id` (string: from a preview, required when `kind` is `preview`)

start_sequencer_enrolment_run

Enroll up to 5,000 people asynchronously. Run preview_sequencer_enrolment first, then pass its preview_id with source.kind set to preview to confirm exactly that set. For 500 or fewer, add_contacts_to_sequencer_sequence is synchronous and simpler. Follow progress with get_sequencer_enrolment_run. Calls POST /v2/sequencer/enrollment-runs.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`sequence`	string	Yes	The sequence to enroll into
`owner_id`	string	No	Who owns the resulting enrollments. Defaults to `user_id`
`source`	object	Yes	Who to enroll, up to 5,000 people. There is no file upload: parse a CSV and send its rows. Fields: `kind` (one of `contacts` for existing contact IDs, `contact_list` for a Salesfinity list, `rows` for inline prospects, `preview` to confirm a preview’s set); `contacts` (string[]: contact IDs, required when `kind` is `contacts`); `contact_list` (string: list ID, required when `kind` is `contact_list`); `prospects` (object[]: required when `kind` is `rows`; each takes the fields listed under `add_contacts_to_sequencer_sequence`); `preview_id` (string: from a preview, required when `kind` is `preview`)
`force_include`	string[]	No	Prospect keys from a preview to add despite a rule blocking them. They are held for approval, not waved through

list_sequencer_enrolment_runs

Recent enrollment runs for one sequence, newest first. Returns a plain array, not a paginated envelope, so runs older than limit cannot be reached here. Calls GET /v2/sequencer/enrollment-runs.

Parameter	Type	Required	Description
`sequence`	string	Yes	Runs are always scoped to one sequence
`limit`	number	No	How many runs to return, 1–25. Default: 10

get_sequencer_enrolment_run

Progress and outcome of one run: considered, enrolled, skipped and held, with a sample of the skips and why. Calls GET /v2/sequencer/enrollment-runs/{run_id}.

Parameter	Type	Required	Description
`run_id`	string	Yes	Run id, `enroll_` followed by 24 hexadecimal characters, e.g. `enroll_9c1f4e2a7b3d5c6e8f0a1b2c`.

cancel_sequencer_enrolment_run

Stop a run from adding anyone else. It is not an undo: whoever is already enrolled stays enrolled, so finish them with bulk_finish_sequencer_enrollments to reverse it. Calls POST /v2/sequencer/enrollment-runs/{run_id}/cancel.

Parameter	Type	Required	Description
`run_id`	string	Yes	Run id, `enroll_` followed by 24 hexadecimal characters, e.g. `enroll_9c1f4e2a7b3d5c6e8f0a1b2c`.
`user_id`	string	No	Optional here, because cancelling is recorded against the team rather than a person

Tasks

list_sequencer_tasks

The rep task queue the Sequencer produces, including one-off tasks. Use action: call for the call queue. Calls GET /v2/sequencer/tasks.

Parameter	Type	Required	Description
`user_id`	string	No	Assignee to filter by, or `all` for the whole team. Defaults to `all`. A filter, not the acting user
`state`	string	No	`pending` is the working queue. `held` means the enrollment is paused. The rest are terminal. One of `pending`, `held`, `completed`, `skipped`, `expired`, `cancelled`
`action`	string	No	Use `call` to fetch the call queue. One of `call`, `manual_email`, `generic`, `linkedin_connect`, `linkedin_message`, `linkedin_view`, `linkedin_interact`, `meeting`, `sms`
`sequence`	string	No	Only tasks belonging to this sequence.
`origin`	string	No	Sequence tasks (`sequence`) or a rep’s own to-dos (`one_off`).
`contact`	string	No	Only tasks for this contact.
`priority`	string	No	Only tasks in this priority band. One of `high`, `medium`, `low`
`overdue`	boolean	No	Only tasks whose due date has passed.
`due_before`	string	No	ISO 8601
`due_after`	string	No	ISO 8601
`search`	string	No	Matches the contact behind the task.
`sort`	string	No	Applied server-side across the whole result set, not just the page you asked for. One of `due`, `priority`, `action`, `prospect`, `company`, `sequence`, `last_activity`
`direction`	string	No	`asc` (the default) or `desc`. With `sort=priority`, `asc` puts high priority first. Ignored by `due`, which is always oldest-first. One of `asc`, `desc`
`page`	number	No	Page number, 1-based.
`limit`	number	No	Results per page, 1–100. Default: 25

create_sequencer_task

Create a one-off task for a contact, not tied to any sequence. Calls POST /v2/sequencer/tasks.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`contact`	string	Yes	Contact ID the task is about
`action`	string	Yes	What the rep has to do. One of `call`, `manual_email`, `generic`, `linkedin_connect`, `linkedin_message`, `linkedin_view`, `linkedin_interact`, `meeting`, `sms`
`due_at`	string	Yes	ISO 8601. Must be in the future, allowing 5 minutes for clock skew, and at most 365 days ahead
`assignee_id`	string	No	Team member who gets the task. Defaults to `user_id`
`priority`	string	No	One of `high`, `medium`, `low`. Default: `medium`
`subject`	string	No	Subject line, for a `manual_email` task. Up to 998 characters
`note`	string	No	Up to 2,000 characters

get_sequencer_task_summary

Counts for the overdue / today / this week / later buckets. Calls GET /v2/sequencer/tasks/summary.

Parameter	Type	Required	Description
`user_id`	string	No	Assignee to summarize, or `all` for the whole team. Defaults to `all`.
`today_ends`	string	No	ISO 8601. End of the rep’s local “today”. Supply it yourself: only you know the rep’s timezone
`week_ends`	string	No	ISO 8601. End of the caller’s local “this week”.

get_sequencer_account_coverage

For the accounts you name, which buying-committee seats the team’s contacts at each account fill. Every contact on the team at the account counts, whether or not it is in a sequence. Calls GET /v2/sequencer/tasks/account-coverage.

Parameter	Type	Required	Description
`account_keys`	string	No	Comma-separated normalized company names, as on a task’s `contact.account_key`, e.g. `acme,globex`. Up to 100

materialize_sequencer_call_list

Rebuild a rep’s Sequencer dial list from their pending call tasks, at most 200 per call. It writes, and runs in the background: the result says how many rows the list should hold (expected), not what has landed yet. Calls POST /v2/sequencer/tasks/materialize-call-list.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`assignee_id`	string	No	Whose dial list to fill. Defaults to `user_id`

bulk_create_sequencer_tasks

Create one standalone task per contact, for up to 500 contacts. Contacts that are not on the team, or whose task cannot be created, come back in skipped with a reason. Calls POST /v2/sequencer/tasks/bulk.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`contacts`	string[]	Yes	One task per contact ID. 1–500
`action`	string	Yes	What the rep has to do. One of `call`, `manual_email`, `generic`, `linkedin_connect`, `linkedin_message`, `linkedin_view`, `linkedin_interact`, `meeting`, `sms`
`due_at`	string	Yes	ISO 8601. Must be in the future, allowing 5 minutes for clock skew, and at most 365 days ahead
`priority`	string	No	One of `high`, `medium`, `low`. Default: `medium`
`assignee_id`	string	No	Team member who gets the tasks. Defaults to `user_id`
`subject`	string	No	Subject line, for a `manual_email` task. Up to 998 characters
`note`	string	No	Up to 2,000 characters

bulk_skip_sequencer_tasks

Skip up to 500 tasks. Skipping still advances the sequence. There is deliberately no bulk complete: completing a manual_email task sends a real email, so complete those one at a time. Each task is handled on its own: the response counts ok and lists each failed ID with its reason. Calls POST /v2/sequencer/tasks/bulk/skip.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`ids`	string[]	Yes	1–500 task IDs
`reason`	string	No	Up to 200 characters

bulk_snooze_sequencer_tasks

Move the due date of up to 500 tasks. Each task’s auto-skip deadline moves by the same amount. Each task is handled on its own: the response counts ok and lists each failed ID with its reason. Calls POST /v2/sequencer/tasks/bulk/snooze.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`ids`	string[]	Yes	1–500 task IDs
`due_at`	string	Yes	ISO 8601, at most 365 days ahead. Must still be in the future when each task is processed; a task processed after it has passed fails with `due_at must be in the future`. Applies to every task in `ids`

bulk_reassign_sequencer_tasks

Hand up to 500 tasks to another rep. Call tasks also move between dial lists. Each task is handled on its own: the response counts ok and lists each failed ID with its reason. Calls POST /v2/sequencer/tasks/bulk/reassign.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`ids`	string[]	Yes	1–500 task IDs
`assignee_id`	string	Yes	The team member to hand the tasks to
`note`	string	No	Up to 500 characters

get_sequencer_task

One task with its contact, sequence and step. Calls GET /v2/sequencer/tasks/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character task id.

update_sequencer_task

Change a one-off task. A sequence task takes its shape from its step: snooze it, or finish the enrollment, instead. Calls PATCH /v2/sequencer/tasks/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character task id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`due_at`	string	No	ISO 8601. Must be in the future, allowing 5 minutes for clock skew, and at most 365 days ahead
`priority`	string	No	One of `high`, `medium`, `low`
`subject`	string	No	Subject line, for a `manual_email` task. Up to 998 characters
`note`	string	No	Up to 2,000 characters

delete_sequencer_task

Cancel a one-off task. It moves to cancelled rather than being destroyed, so its history survives. Calls DELETE /v2/sequencer/tasks/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character task id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

list_sequencer_task_events

The timeline for one task, newest first. For a one-off task this is the only way to reach its history. Returns at most 200 events and takes no pagination; for a sequenced prospect, use list_sequencer_enrollment_events, which is paged. Calls GET /v2/sequencer/tasks/{id}/events.

Parameter	Type	Required	Description
`id`	string	Yes	24-character task id.

complete_sequencer_task

Complete a task and advance the sequence. For a manual_email task this sends a real email, so confirm the subject and body with the user first; the task stays pending until the send is confirmed. Calls POST /v2/sequencer/tasks/{id}/complete.

Parameter	Type	Required	Description
`id`	string	Yes	24-character task id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`call_log`	string	No	For a `call` task: the call log it was resolved by. Must belong to your team
`note`	string	No	Up to 2,000 characters
`subject`	string	No	`manual_email` only. Up to 998 characters
`body`	string	No	`manual_email` only. HTML, up to 20,000 characters. Sends a real email

skip_sequencer_task

Skip a task. The sequence still advances. Calls POST /v2/sequencer/tasks/{id}/skip.

Parameter	Type	Required	Description
`id`	string	Yes	24-character task id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`reason`	string	No	Up to 200 characters

snooze_sequencer_task

Move a task’s due date. Its auto-skip deadline moves by the same amount. Calls POST /v2/sequencer/tasks/{id}/snooze.

Parameter	Type	Required	Description
`id`	string	Yes	24-character task id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`due_at`	string	Yes	ISO 8601. Must be in the future, with no allowance for clock skew (`due_at must be in the future`), and at most 365 days ahead

reassign_sequencer_task

Hand one task to another rep. A call task also moves out of the old rep’s dial list and into the new one. Calls POST /v2/sequencer/tasks/{id}/reassign.

Parameter	Type	Required	Description
`id`	string	Yes	24-character task id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`assignee_id`	string	Yes	The team member to hand the task to
`note`	string	No	Up to 500 characters

Suppression

list_sequencer_suppression

The team’s do-not-contact list, checked when someone is enrolled and again before every email is sent. Calls GET /v2/sequencer/suppression.

Parameter	Type	Required	Description
`type`	string	No	Only entries of this kind. One of `email`, `domain`, `phone`
`reason`	string	No	Only entries added for this reason. One of `unsubscribed`, `bounced`, `complained`, `manual`, `dnc`
`page`	number	No	Page number, 1-based.
`limit`	number	No	Results per page.

create_sequencer_suppression

Add an address, domain or phone number to the do-not-contact list. Calls POST /v2/sequencer/suppression.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`type`	string	Yes	`domain` suppresses every address at that domain. One of `email`, `domain`, `phone`
`value`	string	Yes	The email address, domain or phone number, matching `type`. Up to 320 characters, stored normalized so matching is case-insensitive
`reason`	string	No	Why it is suppressed. One of `unsubscribed`, `bounced`, `complained`, `manual`, `dnc`. Default: `manual`

import_sequencer_suppression

Add up to 1000 suppression entries at once. A value already on the list is left unchanged, reason included. Calls POST /v2/sequencer/suppression/import.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`entries`	object[]	Yes	1–1,000 entries per request. Fields: `type` (one of `email`, `domain`, `phone`; `domain` suppresses every address at that domain); `value` (string: up to 320 characters, stored normalized, so matching is case-insensitive); `reason` (one of `unsubscribed`, `bounced`, `complained`, `manual`, `dnc`; default `manual`)

delete_sequencer_suppression

Remove one entry from the suppression list, so that address or domain can be contacted again. Calls DELETE /v2/sequencer/suppression/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character suppression entry id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

Policies

get_sequencer_policy_catalog

The conditions and actions a rule can be built from, and which scopes each is valid in. Read this before writing a policy: the vocabulary is live, not fixed in the API. Calls GET /v2/sequencer/policies/catalog. Takes no parameters.

preview_sequencer_policy

Replay an unsaved rule set against the team’s recent enrollments and report what it would have done. Run it before saving: a rule that is too broad silently blocks every enrollment team-wide, and this is the cheapest way to find out. Calls POST /v2/sequencer/policies/preview.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`rules`	object[]	No	Up to 100 rules. Each has `name`, an `action` (`type` and `params`), a `scope` of 1–4 entries, and either a `condition` (`type` and `params`) or a `condition_group`. Read `get_sequencer_policy_catalog` for the valid types

list_sequencer_policies

The team’s rules of engagement: what may be enrolled and what happens at each step. Calls GET /v2/sequencer/policies. Takes no parameters.

create_sequencer_policy

Create a rules-of-engagement policy. Preview the rules first. Calls POST /v2/sequencer/policies.

Parameter	Type	Required	Description
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`name`	string	Yes	Policy name, 1–120 characters
`description`	string	No	Up to 2,000 characters
`rules`	object[]	No	Up to 100 rules. Each has `name`, an `action` (`type` and `params`), a `scope` of 1–4 entries, and either a `condition` (`type` and `params`) or a `condition_group`. Read `get_sequencer_policy_catalog` for the valid types
`outcome_rules`	object[]	No	Up to 50. Each has `name`, an `outcome` and 1–10 `actions`. Outcomes come from the catalog
`crm_refresh_hours`	number	No	How stale a cached CRM snapshot may be, in hours, before a CRM-backed rule refreshes it. 1–168. Default: 24

get_sequencer_policy

One policy with its rules and outcome rules, and whether it is the team default. Calls GET /v2/sequencer/policies/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character policy id.

update_sequencer_policy

Edit a policy. The change applies at once to every sequence using it, so preview the rules first. Calls PATCH /v2/sequencer/policies/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character policy id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.
`name`	string	No	Policy name, 1–120 characters
`description`	string	No	Up to 2,000 characters
`rules`	object[]	No	Up to 100 rules. Each has `name`, an `action` (`type` and `params`), a `scope` of 1–4 entries, and either a `condition` (`type` and `params`) or a `condition_group`. Read `get_sequencer_policy_catalog` for the valid types
`outcome_rules`	object[]	No	Up to 50. Each has `name`, an `outcome` and 1–10 `actions`. See Rules of engagement
`crm_refresh_hours`	number	No	How stale a cached CRM snapshot may be, in hours, before a CRM-backed rule refreshes it. 1–168

delete_sequencer_policy

Delete a policy. Refused with 409 while it is the team default or any sequence uses it. Calls DELETE /v2/sequencer/policies/{id}.

Parameter	Type	Required	Description
`id`	string	Yes	24-character policy id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

set_default_sequencer_policy

Make a policy the team default. Every sequence that does not name its own policy follows it, so this changes behavior across the team at once. Calls POST /v2/sequencer/policies/{id}/default.

Parameter	Type	Required	Description
`id`	string	Yes	24-character policy id.
`user_id`	string	Yes	Team member id this acts as. Must be an active member of the team.

Settings

get_sequencer_settings

Team-level defaults: the shared mailbox pool, default sending schedule, warmup defaults, unsubscribe wording, reply classifications and the buying-committee map. Provider secrets are never returned. Calls GET /v2/sequencer/settings. Takes no parameters.

list_sequencer_mailboxes

Sending mailboxes with health and capacity. A sequence with an email step can be turned on only when a mailbox it sends from is ready. Calls GET /v2/sequencer/email-accounts.

Parameter	Type	Required	Description
`status`	string	No	`ready` can send now; `not_connecting` failed SMTP or IMAP on the last check; `paused` was paused on purpose; `out_of_pool` is neither in the shared pool nor assigned to a rep, so nothing sends from it. One of `ready`, `not_connecting`, `paused`, `out_of_pool`
`search`	string	No	Match on the mailbox address or sender name.
`page`	number	No	Page number, 1-based.
`limit`	number	No	Results per page, 1–200.

get_sequencer_mailbox

Health, warmup and sending limits for one mailbox. Credentials are never returned. Calls GET /v2/sequencer/email-accounts/{id}.

Parameter	Type	Required	Description
`id`	number	Yes	Numeric mailbox ID from `list_sequencer_mailboxes`. Mailbox IDs come from the sending provider, so they are numbers, not 24-character IDs

​Sequences

​list_sequencer_sequences

​create_sequencer_sequence

​get_sequencer_sequence

​update_sequencer_sequence

​delete_sequencer_sequence

​add_contacts_to_sequencer_sequence

​get_sequencer_sequence_analytics

​list_sequencer_engagement_people

​list_sequencer_enrolment_attempts

​enable_sequencer_sequence

​disable_sequencer_sequence

​duplicate_sequencer_sequence

​Steps

​list_sequencer_steps

​create_sequencer_step

​reorder_sequencer_steps

​get_sequencer_step

​update_sequencer_step

​delete_sequencer_step

​Templates

​list_sequencer_templates

​create_sequencer_template

​get_sequencer_template

​update_sequencer_template

​delete_sequencer_template

​preview_sequencer_template

​Enrollments

​list_sequencer_enrollments

​bulk_finish_sequencer_enrollments

​bulk_approve_sequencer_enrollments

​bulk_reject_sequencer_enrollments

​bulk_reassign_sequencer_enrollments

​move_sequencer_enrollments

​sequencer_account_action

​get_sequencer_enrollment

​list_sequencer_enrollment_events

​pause_sequencer_enrollment

​resume_sequencer_enrollment

​finish_sequencer_enrollment

​retry_sequencer_enrollment

​reassign_sequencer_enrollment

​approve_sequencer_enrollment

​reject_sequencer_enrollment

​Enrollment runs

​preview_sequencer_enrolment

​start_sequencer_enrolment_run

​list_sequencer_enrolment_runs

​get_sequencer_enrolment_run

​cancel_sequencer_enrolment_run

​Tasks

​list_sequencer_tasks

​create_sequencer_task

​get_sequencer_task_summary

​get_sequencer_account_coverage

​materialize_sequencer_call_list

​bulk_create_sequencer_tasks

​bulk_skip_sequencer_tasks

​bulk_snooze_sequencer_tasks

​bulk_reassign_sequencer_tasks

​get_sequencer_task

​update_sequencer_task

​delete_sequencer_task

​list_sequencer_task_events

​complete_sequencer_task

​skip_sequencer_task

​snooze_sequencer_task

​reassign_sequencer_task

​Suppression

​list_sequencer_suppression

​create_sequencer_suppression

​import_sequencer_suppression

​delete_sequencer_suppression

​Policies

​get_sequencer_policy_catalog

​preview_sequencer_policy

​list_sequencer_policies

​create_sequencer_policy

​get_sequencer_policy

​update_sequencer_policy