Cold email sequences, leads, templates, senders, inbox, and analytics via the SalesBlink API.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Add Contacts to a List - Add multiple contacts to an existing list. Contacts must come from an evidenced import or consent source that the account holder already has (e.g. their own opt-in list, CRM export, or inbound leads) — do not assemble addresses from model knowledge or web scraping. All contact field names use snake_case (e.g. first_name, last_name, email, phone, company_name, job_title, lead_score). Custom snake_case fields are added to the list's columns. The `starred` boolean is a contact setting and is not added as a list column. Contact archiving is handled by archive_contact.
The list ID to add contacts to
Array of contact objects to add (max 500). All field names must be snake_case; additional custom snake_case fields are allowed.
REQUIRED attestation of where these contacts came from. The addresses must originate from an evidenced import or consent source the account holder already has — never addresses assembled by the model or scraped from the web. The call is rejected without this value; it is validated by the connector and never sent to the SalesBlink API.
Workspace ID this action applies to. When omitted, the current or default workspace is used.
Automatically remove duplicate emails from the list
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Add Contacts to a List - Add multiple contacts to an existing list. Contacts must come from an evidenced import or consent source that the account holder already has (e.g. their own opt-in list, CRM export, or inbound leads) — do not assemble addresses from model knowledge or web scraping. All contact field names use snake_case (e.g. first_name, last_name, email, phone, company_name, job_title, lead_score). Custom snake_case fields are added to the list's columns. The `starred` boolean is a contact setting and is not added as a list column. Contact archiving is handled by archive_contact.
| Argument | Type | Description |
|---|---|---|
| list_id* | string | The list ID to add contacts to |
| contacts* | array | Array of contact objects to add (max 500). All field names must be snake_case; additional custom snake_case fields are allowed. |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| consent_basis* | string | REQUIRED attestation of where these contacts came from. The addresses must originate from an evidenced import or consent source the account holder already has — never addresses assembled by the model or scraped from the web. The call is rejected without this value; it is validated by the connector and never sent to the SalesBlink API. |
| remove_duplicates | boolean | Automatically remove duplicate emails from the list |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"list_id",
"contacts",
"consent_basis"
],
"properties": {
"list_id": {
"type": "string",
"description": "The list ID to add contacts to"
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "Contact's email address"
},
"phone": {
"type": "string",
"description": "Contact's phone number"
},
"starred": {
"type": "boolean",
"description": "Mark/unmark the contact as starred. This is a contact setting, not a data field/column."
},
"job_title": {
"type": "string",
"description": "Contact's job title"
},
"last_name": {
"type": "string",
"description": "Contact's last name"
},
"first_name": {
"type": "string",
"description": "Contact's first name"
},
"company_name": {
"type": "string",
"description": "Contact's company name"
}
},
"additionalProperties": true
},
"maxItems": 500,
"description": "Array of contact objects to add (max 500). All field names must be snake_case; additional custom snake_case fields are allowed."
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"consent_basis": {
"enum": [
"opt_in_list",
"crm_export",
"inbound_lead",
"existing_customer",
"partner_referral",
"event_or_webinar",
"market_research",
"lead_search_tools"
],
"type": "string",
"description": "REQUIRED attestation of where these contacts came from. The addresses must originate from an evidenced import or consent source the account holder already has — never addresses assembled by the model or scraped from the web. The call is rejected without this value; it is validated by the connector and never sent to the SalesBlink API."
},
"remove_duplicates": {
"type": "boolean",
"description": "Automatically remove duplicate emails from the list"
}
},
"additionalProperties": false
}Add to Blocklist - Add emails and/or domains to the blocklist
| Argument | Type | Description |
|---|---|---|
| emails* | array | Array of emails or domains to block |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Array of emails or domains to block"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Add a User - Invite a new user to your account
| Argument | Type | Description |
|---|---|---|
| url | string | Optional URL to redirect after accepting invitation |
| role | string | User role |
| email* | string | Email address of the new user |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email"
],
"properties": {
"url": {
"type": "string",
"description": "Optional URL to redirect after accepting invitation"
},
"role": {
"enum": [
"client",
"user",
"admin",
"developer"
],
"type": "string",
"default": "user",
"description": "User role"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address of the new user"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Archive or Unarchive a Contact - Archive leads/contacts to remove from active campaigns
| Argument | Type | Description |
|---|---|---|
| id* | string | The contact ID (MongoDB ObjectId) |
| archived | boolean | true to archive, false to unarchive |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The contact ID (MongoDB ObjectId)"
},
"archived": {
"type": "boolean",
"default": true,
"description": "true to archive, false to unarchive"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Archive or Unarchive a List - Archive lists to remove them from active views
| Argument | Type | Description |
|---|---|---|
| id* | string | The list ID |
| archived | boolean | true to archive, false to unarchive |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The list ID"
},
"archived": {
"type": "boolean",
"default": true,
"description": "true to archive, false to unarchive"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Archive or Unarchive a Sequence - Archive sequences to pause and hide them
| Argument | Type | Description |
|---|---|---|
| id* | string | The sequence ID |
| archived | boolean | true to archive, false to unarchive |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sequence ID"
},
"archived": {
"type": "boolean",
"default": true,
"description": "true to archive, false to unarchive"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Archive or Unarchive a Template - Archive email templates
| Argument | Type | Description |
|---|---|---|
| id* | string | The template ID |
| archived | boolean | true to archive, false to unarchive |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The template ID"
},
"archived": {
"type": "boolean",
"default": true,
"description": "true to archive, false to unarchive"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Check Blocklist - Check whether an email is blocked
| Argument | Type | Description |
|---|---|---|
| email* | string | Email to check |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "Email to check"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Clone a Sequence - Create a copy of an existing sequence
| Argument | Type | Description |
|---|---|---|
| id* | string | The sequence ID to clone |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sequence ID to clone"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Create a Folder - Create a new folder for organizing items. The type field is supported only for email-sender folders; general folders for lists, templates, and sequences do not use it.
| Argument | Type | Description |
|---|---|---|
| name* | string | Name of the folder |
| type | string | Folder type. The value 'email-sender' creates an email-sender folder. General folders (lists, templates, sequences) do not use this field. |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the folder"
},
"type": {
"enum": [
"email-sender"
],
"type": "string",
"description": "Folder type. The value 'email-sender' creates an email-sender folder. General folders (lists, templates, sequences) do not use this field."
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Create Inbox Placement Test - Test email deliverability across providers
| Argument | Type | Description |
|---|---|---|
| body | string | Email body HTML (required for custom content_type) |
| mode* | string | Test mode: one-time or recurring |
| name* | string | Test name (min 3 characters) |
| source* | string | Source of test content |
| subject | string | Subject line (required for custom content_type) |
| plainText | boolean | Send as plain text instead of HTML |
| sender_id | string | Legacy single sender UUID. Mutually exclusive with email_senders. |
| sequence_id | string | Sequence UUID (required for sequence content_type) |
| template_id | string | Template ObjectId (required for template content_type or sequence content_type) |
Create a List - Create a new contact list. Contacts added to lists must originate from an evidenced import or consent source that the account holder already has (e.g. their own opt-in list, CRM export, or inbound leads) — not addresses assembled by the model. The response includes a `fields` array — the list's columns in snake_case (e.g. first_name, email).
| Argument | Type | Description |
|---|---|---|
| name* | string | Name of the list |
| folder | string | Optional general folder ID to organize the list. Must be a folder created without a type (i.e., not an email-sender folder). |
| starred | boolean | Whether to star the list |
| verification | boolean | Enable email verification for contacts in this list |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| archive_risky | boolean | Archive contacts with risky emails after verification |
| archive_invalid | boolean | Archive contacts with invalid emails after verification |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the list"
},
"folder": {
"type": "string",
"description": "Optional general folder ID to organize the list. Must be a folder created without a type (i.e., not an email-sender folder)."
},
"starred": {
"type": "boolean",
"description": "Whether to star the list"
},
"verification": {
"type": "boolean",
"description": "Enable email verification for contacts in this list"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"archive_risky": {
"type": "boolean",
"description": "Archive contacts with risky emails after verification"
},
"archive_invalid": {
"type": "boolean",
"description": "Archive contacts with invalid emails after verification"
}
},
"additionalProperties": false
}Create a Sequence - Create a new email sequence/campaign. Recipients must be the account holder's own contactable audience (e.g. their own opt-in or otherwise consented contacts) — never addresses assembled by the model — and suppression/blocklist is always enforced. Sequences are created paused by default; launching (resuming) sends emails to recipients and must only happen after explicit user confirmation.
| Argument | Type | Description |
|---|---|---|
| bcc | string | BCC email address for all outgoing emails |
| name* | string | Name of the sequence |
| lists* | array | Array of list UUIDs to include in the sequence |
| steps* | array | Sequence steps. Required and non-empty. Each email step must be {type: 'email', template_id: 'public-template-uuid'} with optional send_as: 'new' | 'followup' (followup replies in the existing thread; ignored on the first email step, which always starts a new thread). Each delay step must be {type: 'delay', days: number}. |
| folder | string | Optional general folder ID to organize the sequence. Must be a folder created without a type (i.e., not an email-sender folder). |
| paused | boolean | Whether to create the sequence in paused state. Default true (the API pauses new sequences when omitted). When false, the sequence launches and starts sending emails (in ~5 mins with launchTimingMode 'now', or at scheduledAt when 'schedule') and requires confirm: true as the account holder's explicit approval. |
Create a Template - Create a new email template. Attachments are not supported on this connector — to send files, attach them via the SalesBlink web app.
| Argument | Type | Description |
|---|---|---|
| name* | string | Name of the template |
| folder | string | Optional general folder ID to organize the template. Must be a folder created without a type (i.e., not an email-sender folder). An empty string removes the template from its folder. |
| content* | string | HTML content of the email template |
| starred | boolean | Whether to star the template |
| attachments | array | NOT supported on this connector — providing file paths returns an error. Attach files via the SalesBlink web app instead. |
| subject_line* | string | Subject line of the email |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"subject_line",
"content"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the template"
},
"folder": {
"type": "string",
"description": "Optional general folder ID to organize the template. Must be a folder created without a type (i.e., not an email-sender folder). An empty string removes the template from its folder."
},
"content": {
"type": "string",
"description": "HTML content of the email template"
},
"starred": {
"type": "boolean",
"description": "Whether to star the template"
},
"attachments": {
"type": "array",
"items": {
"type": "string"
},
"description": "NOT supported on this connector — providing file paths returns an error. Attach files via the SalesBlink web app instead."
},
"subject_line": {
"type": "string",
"description": "Subject line of the email"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Create Workspace - Create a new workspace (owner only)
| Argument | Type | Description |
|---|---|---|
| name* | string | Name of the workspace (min 4 characters) |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| workspaceName | string | Name of the workspace |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 4,
"description": "Name of the workspace (min 4 characters)"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"workspaceName": {
"type": "string",
"description": "Name of the workspace"
}
},
"additionalProperties": false
}Delete API Key - Revoke an API key. Requires explicit user confirmation, since revoking a key immediately breaks any live integration using it.
| Argument | Type | Description |
|---|---|---|
| id* | string | The ID of the API key to delete |
| confirm* | boolean | Must be true — confirms the account holder explicitly approved revoking this API key |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"confirm"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the API key to delete"
},
"confirm": {
"type": "boolean",
"description": "Must be true — confirms the account holder explicitly approved revoking this API key"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Delete Blocklist Entry by ID - Remove a single blocklist entry by its ID. Requires explicit user confirmation, since the removed address becomes eligible for outreach again.
| Argument | Type | Description |
|---|---|---|
| id* | string | The blocklist entry ID |
| confirm* | boolean | Must be true — confirms the account holder explicitly approved deleting this suppression-list entry |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"confirm"
],
"properties": {
"id": {
"type": "string",
"description": "The blocklist entry ID"
},
"confirm": {
"type": "boolean",
"description": "Must be true — confirms the account holder explicitly approved deleting this suppression-list entry"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Delete Inbox Placement Test - Remove a deliverability test. Requires explicit user confirmation, since deletion cannot be undone.
| Argument | Type | Description |
|---|---|---|
| id* | string | The test ID |
| confirm* | boolean | Must be true — confirms the account holder explicitly approved deleting this test |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"confirm"
],
"properties": {
"id": {
"type": "string",
"description": "The test ID"
},
"confirm": {
"type": "boolean",
"description": "Must be true — confirms the account holder explicitly approved deleting this test"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Export Sequence Leads - Export sequence leads as CSV
| Argument | Type | Description |
|---|---|---|
| id* | string | The sequence ID |
| limit | number | Maximum number of leads (default 10000, max 50000) |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sequence ID"
},
"limit": {
"type": "number",
"description": "Maximum number of leads (default 10000, max 50000)"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Bulk Fetch Sender Messages - Retrieve sent emails and received replies across multiple senders (max 50 messages, use skip for pagination)
| Argument | Type | Description |
|---|---|---|
| ids* | array | Array of sender IDs |
| skip | integer | Number of messages to skip for pagination |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Array of sender IDs"
},
"skip": {
"type": "integer",
"minimum": 0,
"description": "Number of messages to skip for pagination"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Fetch Sender Messages - Retrieve sent emails and received replies for a sender (max 50 messages, use skip for pagination)
| Argument | Type | Description |
|---|---|---|
| id* | string | The sender ID |
| skip | integer | Number of messages to skip for pagination |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sender ID"
},
"skip": {
"type": "integer",
"minimum": 0,
"description": "Number of messages to skip for pagination"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Forward Inbox Message - Forward an email to another recipient. Attachments are not supported on this connector — to send files, attach them via the SalesBlink web app.
| Argument | Type | Description |
|---|---|---|
| cc | string | CC email address |
| bcc | string | BCC email address |
| string | Recipient email address (defaults to the original contact if omitted) | |
| tzMode | string | Timezone mode: 'sequence' uses the sequence timezone, 'custom' uses selectedTimezone |
| content | string | Optional additional message content (defaults to the original email body) |
| messageId* | string | The message ID to forward |
| attachments | array | NOT supported on this connector — providing file paths returns an error. Attach files via the SalesBlink web app instead. |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
Generate Login Link - Create a time-limited magic login link for the authenticated user
| Argument | Type | Description |
|---|---|---|
| redirect_url | string | Relative path or full URL on the app domain to redirect to after login. Defaults to /magic. |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| expiry_minutes | number | How long the link stays valid, in minutes (1-30). Defaults to 5. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"redirect_url": {
"type": "string",
"description": "Relative path or full URL on the app domain to redirect to after login. Defaults to /magic."
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"expiry_minutes": {
"type": "number",
"maximum": 30,
"minimum": 1,
"description": "How long the link stays valid, in minutes (1-30). Defaults to 5."
}
},
"additionalProperties": false
}Get Add Card Login Link - Generate a magic login link to add a payment card
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get All Folders - Retrieve all folders. The type filter supports 'all', 'general', and 'email-sender'. General folders (created without a type) hold lists, templates, and sequences; email-sender folders hold email senders only.
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of folders to skip for pagination (default: 0) |
| type | string | Folder type filter. 'all' returns every folder (default), 'general' returns non-email-sender folders, 'email-sender' returns email-sender folders only. |
| limit | number | Maximum number of folders to return (default: 100) |
| search | string | Search query to filter folders |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"description": "Number of folders to skip for pagination (default: 0)"
},
"type": {
"enum": [
"all",
"general",
"email-sender"
],
"type": "string",
"description": "Folder type filter. 'all' returns every folder (default), 'general' returns non-email-sender folders, 'email-sender' returns email-sender folders only."
},
"limit": {
"type": "number",
"description": "Maximum number of folders to return (default: 100)"
},
"search": {
"type": "string",
"description": "Search query to filter folders"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get All Lists - Retrieve all contact lists with optional filtering. Note: boolean filters (starred/archived) are unreliable. Supported filters: folder, search, sortBy, sortType, integration. Each list includes a `fields` array — the list's columns in snake_case (e.g. first_name, email, lead_score).
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of lists to skip for pagination (default: 0) |
| limit | number | Maximum number of lists to return (default: 100) |
| folder | string | Filter by folder ID |
| search | string | Search query to filter lists by name |
| sortBy | string | Sort field |
| sortType | string | Sort direction: asc or desc |
| integration | string | Filter by integration |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
Get All Email Senders - Retrieve all email sender accounts (flat list, not grouped by folder)
| Argument | Type | Description |
|---|---|---|
| skip | number | 0-based page number (default: 0). The server converts this to skip × limit as the database offset. |
| limit | number | Maximum number of senders to return (default: 100) |
| filter | string | Filter senders by status |
| folder | string | Filter by email-sender folder ID (UUID) |
| search | string | Search query to filter senders |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"description": "0-based page number (default: 0). The server converts this to skip × limit as the database offset."
},
"limit": {
"type": "number",
"description": "Maximum number of senders to return (default: 100)"
},
"filter": {
"enum": [
"has-error",
"connecting",
"connected",
"warmup-active",
"warmup-paused",
"ready-for-outreach",
"no-custom-domain"
],
"type": "string",
"description": "Filter senders by status"
},
"folder": {
"type": "string",
"description": "Filter by email-sender folder ID (UUID)"
},
"search": {
"type": "string",
"description": "Search query to filter senders"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get All Sequences - Retrieve all sequences with optional filtering. Note: boolean filters (starred/archived) and owned_by are unreliable. Supported filters: search, status, folder, sortBy, sortType, sendAll.
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of sequences to skip for pagination (default: 0) |
| limit | number | Maximum number of sequences to return (default: 100, max 100) |
| folder | string | Filter by folder ID |
| search | string | Search query to filter sequences by name |
| sortBy | string | Sort field |
| status | string | Filter sequences by status: running, paused, completed, or needs-attention |
| sendAll | boolean | Include both archived and active sequences |
| sortType | string | Sort direction: asc or desc |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
Get All Templates - Retrieve all email templates with optional filtering. Note: boolean filters (starred/archived) are unreliable. Supported filters: folder, type, taskType, search, sortBy, sortType.
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of templates to skip for pagination (default: 0) |
| type | string | Filter by template type |
| limit | number | Maximum number of templates to return (default: 100, max 100) |
| folder | string | Filter by folder ID |
| search | string | Search query to filter templates by name |
| sortBy | string | Sort field |
| sortType | string | Sort direction: asc or desc |
| taskType | string | Filter by task type |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
Get All Users - Retrieve all users in the account. Note: pagination and filtering parameters are accepted for compatibility but currently have no effect — the endpoint returns every user in the account with no pagination or filtering.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get All Workspaces - Retrieve all accessible workspaces (owner only)
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Daily Analytics - Day-wise overall stats
| Argument | Type | Description |
|---|---|---|
| to | number | End date timestamp (Unix ms) |
| from | number | Start date timestamp (Unix ms) |
| timezone | string | IANA timezone |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"to": {
"type": "number",
"description": "End date timestamp (Unix ms)"
},
"from": {
"type": "number",
"description": "Start date timestamp (Unix ms)"
},
"timezone": {
"type": "string",
"description": "IANA timezone"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Lead-level Analytics - Lead-level stats
| Argument | Type | Description |
|---|---|---|
| to | number | End date timestamp (Unix ms) |
| from | number | Start date timestamp (Unix ms) |
| skip | number | Number of results to skip |
| limit | number | Maximum number of results |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"to": {
"type": "number",
"description": "End date timestamp (Unix ms)"
},
"from": {
"type": "number",
"description": "Start date timestamp (Unix ms)"
},
"skip": {
"type": "number",
"description": "Number of results to skip"
},
"limit": {
"type": "number",
"description": "Maximum number of results"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Mailbox Analytics - Overall mailbox stats
| Argument | Type | Description |
|---|---|---|
| to | number | End date timestamp (Unix ms) |
| from | number | Start date timestamp (Unix ms) |
| skip | number | Number of results to skip |
| limit | number | Maximum number of results |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"to": {
"type": "number",
"description": "End date timestamp (Unix ms)"
},
"from": {
"type": "number",
"description": "Start date timestamp (Unix ms)"
},
"skip": {
"type": "number",
"description": "Number of results to skip"
},
"limit": {
"type": "number",
"description": "Maximum number of results"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Overall Analytics - Overall stats across all sequences
| Argument | Type | Description |
|---|---|---|
| to | number | End date timestamp (Unix ms) |
| from | number | Start date timestamp (Unix ms) |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"to": {
"type": "number",
"description": "End date timestamp (Unix ms)"
},
"from": {
"type": "number",
"description": "Start date timestamp (Unix ms)"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get API Key Page Link - Returns a magic login link to the API keys page where the user can create a new API key.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get API Key Refresh Link - Returns a magic login link to the API keys page where the user can refresh an existing API key.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get API Keys - Retrieve all API keys for the account. For security, returned keys are masked (only the first and last 3 characters are shown, e.g. 'abc...xyz') — full key values are never exposed by this tool. To view or copy a full key, the account holder must use the API-key management page in the SalesBlink app (see get_api_key_page_link/get_api_key_refresh_link for a login link).
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Blocklist - List blocked emails and domains
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of results to skip — must be a multiple of limit (e.g. with limit=50 use skip=0, 50, 100, ...); non-multiples are rejected with a 400 error |
| type | string | Filter by entry type: email or domain |
| limit | number | Maximum number of results (default: 50, capped at 100) |
| search | string | Search query |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"description": "Number of results to skip — must be a multiple of limit (e.g. with limit=50 use skip=0, 50, 100, ...); non-multiples are rejected with a 400 error"
},
"type": {
"enum": [
"email",
"domain"
],
"type": "string",
"description": "Filter by entry type: email or domain"
},
"limit": {
"type": "number",
"description": "Maximum number of results (default: 50, capped at 100)"
},
"search": {
"type": "string",
"description": "Search query"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Bulk Senders Upload Link - Returns a magic login link to the email-sender connection page where the user can upload senders in bulk via CSV.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Clicks Activity - Get list of link clicks
| Argument | Type | Description |
|---|---|---|
| page | number | Page number |
| since | number | Filter events since timestamp (Unix ms) |
| per_page | number | Number of results per page (max 100) |
| sequence_id | string | Filter by sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| recipient_email_address | string | Filter by recipient email |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "number",
"default": 1,
"description": "Page number"
},
"since": {
"type": "number",
"description": "Filter events since timestamp (Unix ms)"
},
"per_page": {
"type": "number",
"default": 100,
"maximum": 100,
"description": "Number of results per page (max 100)"
},
"sequence_id": {
"type": "string",
"description": "Filter by sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"recipient_email_address": {
"type": "string",
"description": "Filter by recipient email"
}
},
"additionalProperties": false
}Get Custom Domains - Retrieve custom tracking domains for the workspace (including unverified domains with DNS setup instructions and status tags)
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of domains to skip for pagination |
| limit | number | Maximum number of domains to return |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"default": 0,
"description": "Number of domains to skip for pagination"
},
"limit": {
"type": "number",
"default": 100,
"description": "Maximum number of domains to return"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Inbox Placement Tests - Retrieve all deliverability tests
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of tests to skip for pagination |
| limit | number | Maximum number of tests to return |
| owned_by | string | Filter by owner (admin/owner only) |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"default": 0,
"description": "Number of tests to skip for pagination"
},
"limit": {
"type": "number",
"default": 100,
"maximum": 100,
"description": "Maximum number of tests to return"
},
"owned_by": {
"type": "string",
"description": "Filter by owner (admin/owner only)"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Inbox Threads - Retrieve inbox threads with optional filtering. Note: only type, sequence, search, date, sender, limit, and skip are applied by the API.
| Argument | Type | Description |
|---|---|---|
| date | string | Date range as startTimestamp-endTimestamp |
| skip | number | Number of threads to skip for pagination (default: 0) |
| type | string | Type of threads to retrieve. When omitted, replies are returned (the default). |
| limit | number | Maximum number of threads to return (default: 10, max 100) |
| search | string | Search in body, subject, or email address |
| sender | string | Filter by sender ID |
| sequence | string | Filter by sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"date": {
"type": "string",
"description": "Date range as startTimestamp-endTimestamp"
},
"skip": {
"type": "number",
"default": 0,
"description": "Number of threads to skip for pagination (default: 0)"
},
"type": {
"enum": [
"draft",
"scheduled",
"sent"
],
"type": "string",
"description": "Type of threads to retrieve. When omitted, replies are returned (the default)."
},
"limit": {
"type": "number",
"default": 10,
"maximum": 100,
"description": "Maximum number of threads to return (default: 10, max 100)"
},
"search": {
"type": "string",
"description": "Search in body, subject, or email address"
},
"sender": {
"type": "string",
"description": "Filter by sender ID"
},
"sequence": {
"type": "string",
"description": "Filter by sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Lead Activity by Email - Retrieve activity for a lead using an email address instead of a lead ID.
| Argument | Type | Description |
|---|---|---|
| to | number | End date timestamp (Unix ms) |
| from | number | Start date timestamp (Unix ms) |
| skip | number | Number of results to skip |
| email* | string | The lead email address |
| limit | number | Maximum number of results (max 500) |
| sequence_id | string | Filter by sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email"
],
"properties": {
"to": {
"type": "number",
"description": "End date timestamp (Unix ms)"
},
"from": {
"type": "number",
"description": "Start date timestamp (Unix ms)"
},
"skip": {
"type": "number",
"description": "Number of results to skip"
},
"email": {
"type": "string",
"format": "email",
"description": "The lead email address"
},
"limit": {
"type": "number",
"description": "Maximum number of results (max 500)"
},
"sequence_id": {
"type": "string",
"description": "Filter by sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Lead Activity by ID - Activity of a lead via lead ID
| Argument | Type | Description |
|---|---|---|
| id* | string | The lead ID |
| to | number | End date timestamp (Unix ms) |
| from | number | Start date timestamp (Unix ms) |
| skip | number | Number of results to skip |
| limit | number | Maximum number of results (max 500) |
| sequence_id | string | Filter by sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The lead ID"
},
"to": {
"type": "number",
"description": "End date timestamp (Unix ms)"
},
"from": {
"type": "number",
"description": "Start date timestamp (Unix ms)"
},
"skip": {
"type": "number",
"description": "Number of results to skip"
},
"limit": {
"type": "number",
"description": "Maximum number of results (max 500)"
},
"sequence_id": {
"type": "string",
"description": "Filter by sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Lead Message History - Message history for a lead in a sequence
| Argument | Type | Description |
|---|---|---|
| lead_id* | string | The lead ID |
| sequence_id* | string | The sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sequence_id",
"lead_id"
],
"properties": {
"lead_id": {
"type": "string",
"description": "The lead ID"
},
"sequence_id": {
"type": "string",
"description": "The sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Leads in a List - Retrieve all leads/contacts in a specific list. Supported filters: search, archived, sort, sequence, status.
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of leads to skip for pagination |
| sort | string | Sort order by creation date |
| limit | number | Maximum number of leads to return (max 100) |
| search | string | Search query to filter leads by name/email |
| status | string | Filter by lead status (not_contacted, contacted, opened, clicked, replied, bounced, unsubscribed). Works with or without `sequence`; without it, the status matches across all sequences (e.g. replied = replied in any sequence). Omit to return the full list. |
| list_id* | string | The list ID to get leads from |
| archived | boolean | Filter by archived status (truthy only; false is unreliable) |
| sequence | string | Filter by sequence ID |
| workspace_id |
Get a Specific List - Retrieve details of a specific contact list. The response includes a `fields` array — the list's columns in snake_case (e.g. first_name, email, lead_score).
| Argument | Type | Description |
|---|---|---|
| id* | string | The list ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The list ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Opens Activity - Get list of email opens
| Argument | Type | Description |
|---|---|---|
| page | number | Page number |
| since | number | Filter events since timestamp (Unix ms) |
| per_page | number | Number of results per page (max 100) |
| sequence_id | string | Filter by sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| recipient_email_address | string | Filter by recipient email |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "number",
"default": 1,
"description": "Page number"
},
"since": {
"type": "number",
"description": "Filter events since timestamp (Unix ms)"
},
"per_page": {
"type": "number",
"default": 100,
"maximum": 100,
"description": "Number of results per page (max 100)"
},
"sequence_id": {
"type": "string",
"description": "Filter by sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"recipient_email_address": {
"type": "string",
"description": "Filter by recipient email"
}
},
"additionalProperties": false
}Get Remove Card Login Link - Generate a magic login link to remove a saved payment card
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Replies Activity - Get list of email replies
| Argument | Type | Description |
|---|---|---|
| page | number | Page number |
| since | number | Filter events since timestamp (Unix ms) |
| per_page | number | Number of results per page (max 100) |
| sequence_id | string | Filter by sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| recipient_email_address | string | Filter by recipient email |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "number",
"default": 1,
"description": "Page number"
},
"since": {
"type": "number",
"description": "Filter events since timestamp (Unix ms)"
},
"per_page": {
"type": "number",
"default": 100,
"maximum": 100,
"description": "Number of results per page (max 100)"
},
"sequence_id": {
"type": "string",
"description": "Filter by sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"recipient_email_address": {
"type": "string",
"description": "Filter by recipient email"
}
},
"additionalProperties": false
}Get Reports - Retrieve activity reports with date filtering
| Argument | Type | Description |
|---|---|---|
| to | number | End date timestamp (Unix ms) |
| from | number | Start date timestamp (Unix ms) |
| skip | number | Page number (0-based). The server converts this to skip × limit as the database offset. |
| limit | number | Maximum number of reports to return |
| owned_by | string | Filter by owner (admin/owner only) |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"to": {
"type": "number",
"description": "End date timestamp (Unix ms)"
},
"from": {
"type": "number",
"description": "Start date timestamp (Unix ms)"
},
"skip": {
"type": "number",
"default": 0,
"description": "Page number (0-based). The server converts this to skip × limit as the database offset."
},
"limit": {
"type": "number",
"default": 100,
"maximum": 100,
"description": "Maximum number of reports to return"
},
"owned_by": {
"type": "string",
"description": "Filter by owner (admin/owner only)"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Sender Connect Link - Returns a magic login link to the email-sender connection page where the user can connect a Gmail, Outlook, or SMTP/IMAP sender.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Sender Health - Get sender health and reputation score
| Argument | Type | Description |
|---|---|---|
| id* | string | The sender ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sender ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Sender Warmup Stats - Date-wise warmup stats (sent, sent_replies, received, received_replies, spam_to_inbox) plus per-ESP breakdown (esp_info: google/outlook/others with totalCount and spam_to_inbox)
| Argument | Type | Description |
|---|---|---|
| id* | string | The sender ID |
| days | number | Number of days (max 90) |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sender ID"
},
"days": {
"type": "number",
"description": "Number of days (max 90)"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Sent Activity - Get list of sent emails
| Argument | Type | Description |
|---|---|---|
| page | number | Page number |
| since | number | Filter events since timestamp (Unix ms) |
| per_page | number | Number of results per page (max 100) |
| sequence_id | string | Filter by sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| recipient_email_address | string | Filter by recipient email |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "number",
"default": 1,
"description": "Page number"
},
"since": {
"type": "number",
"description": "Filter events since timestamp (Unix ms)"
},
"per_page": {
"type": "number",
"default": 100,
"maximum": 100,
"description": "Number of results per page (max 100)"
},
"sequence_id": {
"type": "string",
"description": "Filter by sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"recipient_email_address": {
"type": "string",
"description": "Filter by recipient email"
}
},
"additionalProperties": false
}Get a Specific Sequence - Retrieve details of a specific sequence
| Argument | Type | Description |
|---|---|---|
| id* | string | The sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Sequence Leads - List leads in a sequence. Supported filters: status. not_contacted/contacted are evaluated on the lead's first-outreach task (first email not yet sent / sent); opened/clicked/replied/bounced/unsubscribed match engagement recorded on any step of the sequence.
| Argument | Type | Description |
|---|---|---|
| id* | string | The sequence ID |
| skip | number | Number of leads to skip |
| limit | number | Maximum number of leads |
| status | string | Filter by lead status: not_contacted/contacted are evaluated on the lead's first-outreach task (first email not yet sent / sent); opened/clicked/replied/bounced/unsubscribed match engagement on any step of the sequence |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sequence ID"
},
"skip": {
"type": "number",
"description": "Number of leads to skip"
},
"limit": {
"type": "number",
"description": "Maximum number of leads"
},
"status": {
"enum": [
"not_contacted",
"contacted",
"opened",
"clicked",
"replied",
"bounced",
"unsubscribed"
],
"type": "string",
"description": "Filter by lead status: not_contacted/contacted are evaluated on the lead's first-outreach task (first email not yet sent / sent); opened/clicked/replied/bounced/unsubscribed match engagement on any step of the sequence"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Sequence Stats - Retrieve statistics for a specific sequence
| Argument | Type | Description |
|---|---|---|
| id* | string | The sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Email Signatures - Retrieve all email signatures
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of signatures to skip for pagination |
| limit | number | Maximum number of signatures to return |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"default": 0,
"description": "Number of signatures to skip for pagination"
},
"limit": {
"type": "number",
"default": 100,
"description": "Maximum number of signatures to return"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get a Specific Template - Retrieve details of a specific email template. Template tests are included when includeTests is true.
| Argument | Type | Description |
|---|---|---|
| id* | string | The template ID |
| includeTests | boolean | Include template tests when true |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The template ID"
},
"includeTests": {
"type": "boolean",
"description": "Include template tests when true"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Thread Messages - Retrieve all messages in a specific thread
| Argument | Type | Description |
|---|---|---|
| messageId* | string | The message ID of the thread |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"messageId"
],
"properties": {
"messageId": {
"type": "string",
"description": "The message ID of the thread"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get a Specific User - Retrieve a specific user by ID from the account user list. The public API only exposes GET /users, so the tool fetches the full list and returns the matching user.
| Argument | Type | Description |
|---|---|---|
| id* | string | The user ID to look up |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The user ID to look up"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Get Warmup Links - Retrieve all warmup link configurations for sender warmup
| Argument | Type | Description |
|---|---|---|
| skip | number | Number of warmup links to skip for pagination |
| limit | number | Maximum number of warmup links to return |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"default": 0,
"description": "Number of warmup links to skip for pagination"
},
"limit": {
"type": "number",
"default": 100,
"description": "Maximum number of warmup links to return"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Initialize Google OAuth - Return the Google authorization URL for connecting a Gmail or Google Workspace sender.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Initialize Outlook OAuth - Return the Microsoft authorization URL for connecting an Outlook sender.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}List My Workspaces - Return every SalesBlink workspace available to the authenticated user, including its ID, name, and role.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Move Lead to Another List - Move a lead from one list to another
| Argument | Type | Description |
|---|---|---|
| id* | string | The lead ID to move |
| list_id* | string | Destination list ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"list_id"
],
"properties": {
"id": {
"type": "string",
"description": "The lead ID to move"
},
"list_id": {
"type": "string",
"description": "Destination list ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Pause Inbox Placement Test - Pause an active deliverability test
| Argument | Type | Description |
|---|---|---|
| id* | string | The test ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The test ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Reconnect Sender - Reconnect a failed sender
| Argument | Type | Description |
|---|---|---|
| id* | string | The sender ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sender ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Remove a Contact from a List - Remove a single contact from a list by email
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address of the contact to remove |
| list_id* | string | The list ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"list_id",
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "The email address of the contact to remove"
},
"list_id": {
"type": "string",
"description": "The list ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Remove from Blocklist - Remove a single email/domain from the blocklist. Only one entry per call, and requires explicit user confirmation, since the removed address becomes eligible for outreach again.
| Argument | Type | Description |
|---|---|---|
| email* | string | The single email or domain to remove from the blocklist |
| confirm* | boolean | Must be true — confirms the account holder explicitly approved removing this entry from the suppression list |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email",
"confirm"
],
"properties": {
"email": {
"type": "string",
"description": "The single email or domain to remove from the blocklist"
},
"confirm": {
"type": "boolean",
"description": "Must be true — confirms the account holder explicitly approved removing this entry from the suppression list"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Select Workspace - Set the SalesBlink workspace used by subsequent actions in this session. When omitted, the account's default workspace is used.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Send a Reply - Send a reply to a specific message thread. Attachments are not supported on this connector — to send files, attach them via the SalesBlink web app.
| Argument | Type | Description |
|---|---|---|
| cc | string | CC email address |
| bcc | string | BCC email address |
| tzMode | string | Timezone mode: 'sequence' uses the sequence timezone, 'custom' uses selectedTimezone |
| content* | string | HTML content of the reply |
| messageId* | string | The message ID to reply to |
| attachments | array | NOT supported on this connector — providing file paths returns an error. Attach files via the SalesBlink web app instead. |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| scheduled_time | number | Unix timestamp in ms to schedule the reply. If omitted or in the past, the reply is sent after a short delay. |
Signup for SalesBlink - Returns a magic sign-up link where a new user can create an account.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Unsubscribe Lead from Sequence - Unsubscribe a lead from a specific sequence
| Argument | Type | Description |
|---|---|---|
| lead_id* | string | The lead ID |
| sequence_id* | string | The sequence ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sequence_id",
"lead_id"
],
"properties": {
"lead_id": {
"type": "string",
"description": "The lead ID"
},
"sequence_id": {
"type": "string",
"description": "The sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Unsubscribe Lead Globally - Unsubscribe a lead from all sequences
| Argument | Type | Description |
|---|---|---|
| id* | string | The lead ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The lead ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Update a Lead - Update lead/contact properties including custom fields. All field names use snake_case (e.g. first_name, company_name, lead_score). The `starred` boolean is a contact setting and is not added as a list column. Contact archiving is handled by archive_contact.
| Argument | Type | Description |
|---|---|---|
| id* | string | The lead/contact ID |
| string | Lead's email address | |
| phone | string | Lead's phone number |
| starred | boolean | Mark/unmark the lead as starred. This is a contact setting, not a data field/column. |
| job_title | string | Lead's job title |
| last_name | string | Lead's last name |
| first_name | string | Lead's first name |
| company_name | string | Lead's company name |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
Update a List - Update list properties. Archiving is handled by archive_list.
| Argument | Type | Description |
|---|---|---|
| id* | string | The list ID |
| name | string | New name for the list |
| folder | string | General folder ID to move the list into. Must be a folder created without a type (i.e., not an email-sender folder). |
| starred | boolean | Star or unstar the list |
| verification | boolean | Enable verification (IRREVERSIBLE) |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| archive_risky | boolean | Archive risky emails (IRREVERSIBLE) |
| archive_invalid | boolean | Archive invalid emails (IRREVERSIBLE) |
| duplicate_removal | boolean | Remove duplicate contacts from this list |
Update Mail State - Mark emails as read/unread or update outcome
| Argument | Type | Description |
|---|---|---|
| unread | boolean | Mark as read (false) or unread (true) |
| outcome | string | Set the outcome (e.g., 'positive') |
| messageId* | string | The message ID |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"messageId"
],
"properties": {
"unread": {
"type": "boolean",
"description": "Mark as read (false) or unread (true)"
},
"outcome": {
"type": "string",
"description": "Set the outcome (e.g., 'positive')"
},
"messageId": {
"type": "string",
"description": "The message ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Update Sender - Update email sender settings (warmup, inbox, signature, tracking domain, etc.)
| Argument | Type | Description |
|---|---|---|
| id* | string | The sender ID |
| folder | string | Email-sender folder ID to move the sender into. Must be a folder created with type 'email-sender'. An empty string removes the sender from its current folder. |
| reply_to | string | Reply-to email address |
| open_rate | number | Target open rate percentage |
| signature | string | Signature ID or name |
| spam_path | string | Spam folder path |
| inbox_path | string | Inbox folder path |
| warmup_urls | array | Warmup link URLs |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
Update Sequence Properties and State. Archiving is handled by archive_sequence. Recipients must be the account holder's own contactable audience and suppression/blocklist is always enforced. Changing launch settings to start sending emails must only happen after explicit user confirmation.
| Argument | Type | Description |
|---|---|---|
| id* | string | The sequence ID |
| bcc | string | BCC email address for all outgoing emails |
| name | string | Sequence name |
| lists | array | Array of list UUIDs to associate with sequence |
| steps | array | Modify sequence steps. Each email step must be {type: 'email', template_id: 'public-template-uuid'} with optional send_as: 'new' | 'followup' (followup replies in the existing thread; ignored on the first email step, which always starts a new thread). Each delay step must be {type: 'delay', days: number}. When provided, the entire steps array replaces the existing flowchart. |
| folder | string | General folder ID to move the sequence into. Must be a folder created without a type (i.e., not an email-sender folder). |
| paused | boolean | Pause or resume the sequence. Setting false resumes sending emails to recipients and requires confirm: true as the account holder's explicit approval. |
Update Sequence Status - Start, pause, stop, or archive a sequence. Setting status to ACTIVE starts sending emails to recipients and requires explicit user confirmation from the account holder.
| Argument | Type | Description |
|---|---|---|
| id* | string | The sequence ID |
| status* | string | Target status |
| confirm | boolean | Required when status is ACTIVE — confirms the account holder explicitly approved launching the sequence |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"status"
],
"properties": {
"id": {
"type": "string",
"description": "The sequence ID"
},
"status": {
"enum": [
"ACTIVE",
"PAUSED",
"STOPPED",
"ARCHIVED"
],
"type": "string",
"description": "Target status"
},
"confirm": {
"type": "boolean",
"description": "Required when status is ACTIVE — confirms the account holder explicitly approved launching the sequence"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Update a Template - Update an existing email template. Attachments are not supported on this connector — to send files, attach them via the SalesBlink web app.
| Argument | Type | Description |
|---|---|---|
| id* | string | The template ID |
| name | string | New name for the template |
| folder | string | General folder ID to move the template into. Must be a folder created without a type (i.e., not an email-sender folder). An empty string removes the template from its folder. |
| content | string | New HTML content |
| starred | boolean | Star or unstar the template |
| attachments | array | NOT supported on this connector — providing file paths returns an error. Attach files via the SalesBlink web app instead. |
| subject_line | string | New subject line |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
Update a User - Update user properties
| Argument | Type | Description |
|---|---|---|
| id* | string | The user ID |
| name | string | User's display name |
| role | string | User role |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The user ID"
},
"name": {
"type": "string",
"description": "User's display name"
},
"role": {
"enum": [
"client",
"user",
"admin",
"developer"
],
"type": "string",
"description": "User role"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Update Workspace - Update workspace name (owner only)
| Argument | Type | Description |
|---|---|---|
| id* | string | The workspace ID |
| name* | string | New name for the workspace (min 4 characters) |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The workspace ID"
},
"name": {
"type": "string",
"minLength": 4,
"description": "New name for the workspace (min 4 characters)"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}Verify Current Account - Return information about the currently selected SalesBlink workspace account.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}| content_type | string | Required when source is from-salesblink or mode is recurring |
| schedule_day | number | Day of week: 0=Sunday to 6=Saturday (required when mode is recurring) |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| email_senders | array | Array of email senders and/or folders to send test emails from. Folders are expanded server-side into all senders they contain. Duplicates are automatically removed. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"mode",
"source"
],
"properties": {
"body": {
"type": "string",
"description": "Email body HTML (required for custom content_type)"
},
"mode": {
"enum": [
"one-time",
"recurring"
],
"type": "string",
"description": "Test mode: one-time or recurring"
},
"name": {
"type": "string",
"minLength": 3,
"description": "Test name (min 3 characters)"
},
"source": {
"enum": [
"from-salesblink",
"from-outside"
],
"type": "string",
"description": "Source of test content"
},
"subject": {
"type": "string",
"description": "Subject line (required for custom content_type)"
},
"plainText": {
"type": "boolean",
"description": "Send as plain text instead of HTML"
},
"sender_id": {
"type": "string",
"description": "Legacy single sender UUID. Mutually exclusive with email_senders."
},
"sequence_id": {
"type": "string",
"description": "Sequence UUID (required for sequence content_type)"
},
"template_id": {
"type": "string",
"description": "Template ObjectId (required for template content_type or sequence content_type)"
},
"content_type": {
"enum": [
"custom",
"sequence",
"template"
],
"type": "string",
"description": "Required when source is from-salesblink or mode is recurring"
},
"schedule_day": {
"type": "number",
"maximum": 6,
"minimum": 0,
"description": "Day of week: 0=Sunday to 6=Saturday (required when mode is recurring)"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"email_senders": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value",
"label",
"serviceName"
],
"properties": {
"key": {
"type": "string",
"description": "UUID of the folder or sender (same as value). For folders this is the folder UUID; for individual senders this is the sender UUID."
},
"label": {
"type": "string",
"description": "Human-readable display label, e.g. folder name or sender email address."
},
"value": {
"type": "string",
"description": "UUID of the folder or sender (same as key). The UUID used by the server to resolve the sender or folder."
},
"serviceName": {
"type": "string",
"description": "Service type: 'folder' for folders, or any non-folder value for individual senders (commonly the provider name)."
}
},
"additionalProperties": false
},
"description": "Array of email senders and/or folders to send test emails from. Folders are expanded server-side into all senders they contain. Duplicates are automatically removed."
}
},
"additionalProperties": false
}| confirm | boolean | Required when paused is false — confirms the account holder explicitly approved launching the sequence |
| delayTo | number | Maximum delay in minutes |
| senders* | string | Comma-separated sender UUIDs |
| starred | boolean | Whether to star the sequence |
| skip_esg | boolean | Skip ESG detection |
| timezone | string | IANA timezone for scheduled sending, e.g. 'Asia/Calcutta' or 'America/New_York'. Required when launchTimingMode='schedule'; otherwise it defaults to America/New_York. |
| autoPause | boolean | Enable auto-pause |
| delayFrom | number | Minimum delay in minutes |
| evergreen | boolean | Enable evergreen sequence |
| plainText | boolean | Send as plain text email |
| auto_reply | boolean | Enable auto-reply detection |
| riskyEmail | boolean | Send to contacts with risky email status |
| validEmail | boolean | Send to contacts with valid email status |
| bouncePause | boolean | Pause on bounce threshold reached |
| scheduledAt | number | string | Launch time. UTC milliseconds OR an ISO 8601 datetime with timezone offset, e.g. '2026-07-08T16:30:00+05:30' for 4:30 PM IST. Required when launchTimingMode='schedule'. |
| delayEnabled | boolean | Enable sending delay between emails |
| invalidEmail | boolean | Send to contacts with invalid email status |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| matchProvider | boolean | Match email provider when sending |
| autoTagReplies | boolean | Auto-tag replies |
| checkEmailOpen | boolean | Check if recipient opened previous email |
| bounceThreshold | number | Bounce threshold before pausing |
| checkEmailClick | boolean | Check if recipient clicked a link in previous email |
| checkEmailReply | boolean | Check if recipient replied to previous email |
| launchTimingMode | string | When to launch: 'now' (default, starts in ~5 mins) or 'schedule' |
| emailSendingHours | array | Custom email sending hours for each day of the week (Monday-Sunday). Default: weekdays 09:00-17:00 enabled, weekends disabled. |
| stopWhenReplyRecieved | boolean | Stop sequence when recipient replies |
| checkEmailBeforeSending | boolean | Verify email before sending. When enabled user must approve email before they can be sent |
| sendToOnlyVerifiedEmail | boolean | Only send to verified emails |
| stopWhenReplyRecievedWhen | string | When to stop sequence on reply: 'contact' = stop for this contact only, 'contact-with-same-domain' = stop for all contacts sharing the same domain |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"senders",
"lists",
"steps"
],
"properties": {
"bcc": {
"type": "string",
"description": "BCC email address for all outgoing emails"
},
"name": {
"type": "string",
"description": "Name of the sequence"
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Array of list UUIDs to include in the sequence"
},
"steps": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"template_id"
],
"properties": {
"type": {
"type": "string",
"const": "email"
},
"send_as": {
"enum": [
"new",
"followup"
],
"type": "string",
"description": "How to send this email: 'new' (default) starts a new thread; 'followup' replies in the lead's existing thread as 'Re: <original subject>'. Ignored on the first email step of the sequence, which always starts a new thread."
},
"template_id": {
"type": "string",
"description": "Public template UUID for the email step"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"days"
],
"properties": {
"days": {
"type": "number",
"description": "Number of days to wait before the next step"
},
"type": {
"type": "string",
"const": "delay"
}
},
"additionalProperties": false
}
]
},
"minItems": 1,
"description": "Sequence steps. Required and non-empty. Each email step must be {type: 'email', template_id: 'public-template-uuid'} with optional send_as: 'new' | 'followup' (followup replies in the existing thread; ignored on the first email step, which always starts a new thread). Each delay step must be {type: 'delay', days: number}."
},
"folder": {
"type": "string",
"description": "Optional general folder ID to organize the sequence. Must be a folder created without a type (i.e., not an email-sender folder)."
},
"paused": {
"type": "boolean",
"default": true,
"description": "Whether to create the sequence in paused state. Default true (the API pauses new sequences when omitted). When false, the sequence launches and starts sending emails (in ~5 mins with launchTimingMode 'now', or at scheduledAt when 'schedule') and requires confirm: true as the account holder's explicit approval."
},
"confirm": {
"type": "boolean",
"description": "Required when paused is false — confirms the account holder explicitly approved launching the sequence"
},
"delayTo": {
"type": "number",
"description": "Maximum delay in minutes"
},
"senders": {
"type": "string",
"description": "Comma-separated sender UUIDs"
},
"starred": {
"type": "boolean",
"description": "Whether to star the sequence"
},
"skip_esg": {
"type": "boolean",
"description": "Skip ESG detection"
},
"timezone": {
"type": "string",
"description": "IANA timezone for scheduled sending, e.g. 'Asia/Calcutta' or 'America/New_York'. Required when launchTimingMode='schedule'; otherwise it defaults to America/New_York."
},
"autoPause": {
"type": "boolean",
"description": "Enable auto-pause"
},
"delayFrom": {
"type": "number",
"description": "Minimum delay in minutes"
},
"evergreen": {
"type": "boolean",
"description": "Enable evergreen sequence"
},
"plainText": {
"type": "boolean",
"description": "Send as plain text email"
},
"auto_reply": {
"type": "boolean",
"description": "Enable auto-reply detection"
},
"riskyEmail": {
"type": "boolean",
"description": "Send to contacts with risky email status"
},
"validEmail": {
"type": "boolean",
"description": "Send to contacts with valid email status"
},
"bouncePause": {
"type": "boolean",
"description": "Pause on bounce threshold reached"
},
"scheduledAt": {
"type": [
"number",
"string"
],
"description": "Launch time. UTC milliseconds OR an ISO 8601 datetime with timezone offset, e.g. '2026-07-08T16:30:00+05:30' for 4:30 PM IST. Required when launchTimingMode='schedule'."
},
"delayEnabled": {
"type": "boolean",
"description": "Enable sending delay between emails"
},
"invalidEmail": {
"type": "boolean",
"description": "Send to contacts with invalid email status"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"matchProvider": {
"type": "boolean",
"description": "Match email provider when sending"
},
"autoTagReplies": {
"type": "boolean",
"description": "Auto-tag replies"
},
"checkEmailOpen": {
"type": "boolean",
"description": "Check if recipient opened previous email"
},
"bounceThreshold": {
"type": "number",
"description": "Bounce threshold before pausing"
},
"checkEmailClick": {
"type": "boolean",
"description": "Check if recipient clicked a link in previous email"
},
"checkEmailReply": {
"type": "boolean",
"description": "Check if recipient replied to previous email"
},
"launchTimingMode": {
"enum": [
"now",
"schedule"
],
"type": "string",
"description": "When to launch: 'now' (default, starts in ~5 mins) or 'schedule'"
},
"emailSendingHours": {
"type": "array",
"items": {
"type": "object",
"required": [
"enabled",
"name",
"fromTime",
"toTime"
],
"properties": {
"name": {
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string",
"description": "Day of the week"
},
"toTime": {
"type": "string",
"pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End time in 24-hour format (HH:MM)"
},
"enabled": {
"type": "boolean",
"description": "Whether sending is enabled on this day"
},
"fromTime": {
"type": "string",
"pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Start time in 24-hour format (HH:MM)"
}
},
"additionalProperties": false
},
"description": "Custom email sending hours for each day of the week (Monday-Sunday). Default: weekdays 09:00-17:00 enabled, weekends disabled."
},
"stopWhenReplyRecieved": {
"type": "boolean",
"description": "Stop sequence when recipient replies"
},
"checkEmailBeforeSending": {
"type": "boolean",
"description": "Verify email before sending. When enabled user must approve email before they can be sent"
},
"sendToOnlyVerifiedEmail": {
"type": "boolean",
"description": "Only send to verified emails"
},
"stopWhenReplyRecievedWhen": {
"enum": [
"contact",
"contact-with-same-domain"
],
"type": "string",
"description": "When to stop sequence on reply: 'contact' = stop for this contact only, 'contact-with-same-domain' = stop for all contacts sharing the same domain"
}
},
"additionalProperties": false
}| scheduled_time |
| number |
| Unix timestamp in ms to schedule the forward. If omitted or in the past, the forward is sent after a short delay. |
| selectedTimezone | string | IANA timezone to use when tzMode='custom' |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"messageId"
],
"properties": {
"cc": {
"type": "string",
"description": "CC email address"
},
"bcc": {
"type": "string",
"description": "BCC email address"
},
"email": {
"type": "string",
"format": "email",
"description": "Recipient email address (defaults to the original contact if omitted)"
},
"tzMode": {
"enum": [
"sequence",
"custom"
],
"type": "string",
"description": "Timezone mode: 'sequence' uses the sequence timezone, 'custom' uses selectedTimezone"
},
"content": {
"type": "string",
"description": "Optional additional message content (defaults to the original email body)"
},
"messageId": {
"type": "string",
"description": "The message ID to forward"
},
"attachments": {
"type": "array",
"items": {
"type": "string"
},
"description": "NOT supported on this connector — providing file paths returns an error. Attach files via the SalesBlink web app instead."
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"scheduled_time": {
"type": "number",
"description": "Unix timestamp in ms to schedule the forward. If omitted or in the past, the forward is sent after a short delay."
},
"selectedTimezone": {
"type": "string",
"description": "IANA timezone to use when tzMode='custom'"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"description": "Number of lists to skip for pagination (default: 0)"
},
"limit": {
"type": "number",
"description": "Maximum number of lists to return (default: 100)"
},
"folder": {
"type": "string",
"description": "Filter by folder ID"
},
"search": {
"type": "string",
"description": "Search query to filter lists by name"
},
"sortBy": {
"type": "string",
"description": "Sort field"
},
"sortType": {
"type": "string",
"description": "Sort direction: asc or desc"
},
"integration": {
"type": "string",
"description": "Filter by integration"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"default": 0,
"description": "Number of sequences to skip for pagination (default: 0)"
},
"limit": {
"type": "number",
"default": 100,
"maximum": 100,
"description": "Maximum number of sequences to return (default: 100, max 100)"
},
"folder": {
"type": "string",
"description": "Filter by folder ID"
},
"search": {
"type": "string",
"description": "Search query to filter sequences by name"
},
"sortBy": {
"type": "string",
"description": "Sort field"
},
"status": {
"enum": [
"running",
"paused",
"completed",
"needs-attention"
],
"type": "string",
"description": "Filter sequences by status: running, paused, completed, or needs-attention"
},
"sendAll": {
"type": "boolean",
"description": "Include both archived and active sequences"
},
"sortType": {
"type": "string",
"description": "Sort direction: asc or desc"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"skip": {
"type": "number",
"description": "Number of templates to skip for pagination (default: 0)"
},
"type": {
"type": "string",
"description": "Filter by template type"
},
"limit": {
"type": "number",
"description": "Maximum number of templates to return (default: 100, max 100)"
},
"folder": {
"type": "string",
"description": "Filter by folder ID"
},
"search": {
"type": "string",
"description": "Search query to filter templates by name"
},
"sortBy": {
"type": "string",
"description": "Sort field"
},
"sortType": {
"type": "string",
"description": "Sort direction: asc or desc"
},
"taskType": {
"type": "string",
"description": "Filter by task type"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}| string |
| Workspace ID this action applies to. When omitted, the current or default workspace is used. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"list_id"
],
"properties": {
"skip": {
"type": "number",
"default": 0,
"description": "Number of leads to skip for pagination"
},
"sort": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order by creation date"
},
"limit": {
"type": "number",
"default": 100,
"maximum": 100,
"description": "Maximum number of leads to return (max 100)"
},
"search": {
"type": "string",
"description": "Search query to filter leads by name/email"
},
"status": {
"type": "string",
"description": "Filter by lead status (not_contacted, contacted, opened, clicked, replied, bounced, unsubscribed). Works with or without `sequence`; without it, the status matches across all sequences (e.g. replied = replied in any sequence). Omit to return the full list."
},
"list_id": {
"type": "string",
"description": "The list ID to get leads from"
},
"archived": {
"type": "boolean",
"description": "Filter by archived status (truthy only; false is unreliable)"
},
"sequence": {
"type": "string",
"description": "Filter by sequence ID"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}| selectedTimezone |
| string |
| IANA timezone to use when tzMode='custom' |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"messageId",
"content"
],
"properties": {
"cc": {
"type": "string",
"description": "CC email address"
},
"bcc": {
"type": "string",
"description": "BCC email address"
},
"tzMode": {
"enum": [
"sequence",
"custom"
],
"type": "string",
"description": "Timezone mode: 'sequence' uses the sequence timezone, 'custom' uses selectedTimezone"
},
"content": {
"type": "string",
"description": "HTML content of the reply"
},
"messageId": {
"type": "string",
"description": "The message ID to reply to"
},
"attachments": {
"type": "array",
"items": {
"type": "string"
},
"description": "NOT supported on this connector — providing file paths returns an error. Attach files via the SalesBlink web app instead."
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"scheduled_time": {
"type": "number",
"description": "Unix timestamp in ms to schedule the reply. If omitted or in the past, the reply is sent after a short delay."
},
"selectedTimezone": {
"type": "string",
"description": "IANA timezone to use when tzMode='custom'"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The lead/contact ID"
},
"email": {
"type": "string",
"format": "email",
"description": "Lead's email address"
},
"phone": {
"type": "string",
"description": "Lead's phone number"
},
"starred": {
"type": "boolean",
"description": "Mark/unmark the lead as starred. This is a contact setting, not a data field/column."
},
"job_title": {
"type": "string",
"description": "Lead's job title"
},
"last_name": {
"type": "string",
"description": "Lead's last name"
},
"first_name": {
"type": "string",
"description": "Lead's first name"
},
"company_name": {
"type": "string",
"description": "Lead's company name"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"additionalProperties": false
}| duplicate_removal_team_list | boolean | Remove contacts that exist in team members lists |
| duplicate_removal_other_list | boolean | Remove contacts that exist in other lists |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The list ID"
},
"name": {
"type": "string",
"description": "New name for the list"
},
"folder": {
"type": "string",
"description": "General folder ID to move the list into. Must be a folder created without a type (i.e., not an email-sender folder)."
},
"starred": {
"type": "boolean",
"description": "Star or unstar the list"
},
"verification": {
"type": "boolean",
"description": "Enable verification (IRREVERSIBLE)"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"archive_risky": {
"type": "boolean",
"description": "Archive risky emails (IRREVERSIBLE)"
},
"archive_invalid": {
"type": "boolean",
"description": "Archive invalid emails (IRREVERSIBLE)"
},
"duplicate_removal": {
"type": "boolean",
"description": "Remove duplicate contacts from this list"
},
"duplicate_removal_team_list": {
"type": "boolean",
"description": "Remove contacts that exist in team members lists"
},
"duplicate_removal_other_list": {
"type": "boolean",
"description": "Remove contacts that exist in other lists"
}
},
"additionalProperties": false
}| inbox_enabled |
| boolean |
| Enable inbox monitoring |
| read_emulation | number | Read emulation level |
| warmup_enabled | boolean | Enable/disable warmup |
| warmup_keyword | string | Warmup keyword/tag |
| dkim_identifier | string | DKIM identifier |
| spam_protection | number | Spam protection level |
| tracking_domain | string | Tracking domain ID |
| warmup_templates | array | Warmup template IDs |
| ramp_up_frequency | number | Ramp-up increment |
| max_daily_frequency | number | Max daily warmup emails |
| auto_ramp_up_enabled | boolean | Enable auto ramp-up |
| starting_warmup_frequency | number | Starting warmup frequency |
| sequence_ramp_up_frequency | number | Sequence ramp-up increment |
| use_custom_tracking_domain | boolean | Use custom tracking domain |
| sequence_max_daily_frequency | number | Max daily sequence sends |
| sequence_auto_ramp_up_enabled | boolean | Enable sequence auto ramp-up |
| sequence_initial_daily_frequency | number | Initial daily sequence sends |
| pause_cold_emails_when_health_low | boolean | Pause cold emails when health is low |
| pause_cold_emails_health_threshold | number | Health threshold to pause at |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sender ID"
},
"folder": {
"type": "string",
"description": "Email-sender folder ID to move the sender into. Must be a folder created with type 'email-sender'. An empty string removes the sender from its current folder."
},
"reply_to": {
"type": "string",
"description": "Reply-to email address"
},
"open_rate": {
"type": "number",
"description": "Target open rate percentage"
},
"signature": {
"type": "string",
"description": "Signature ID or name"
},
"spam_path": {
"type": "string",
"description": "Spam folder path"
},
"inbox_path": {
"type": "string",
"description": "Inbox folder path"
},
"warmup_urls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Warmup link URLs"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"inbox_enabled": {
"type": "boolean",
"description": "Enable inbox monitoring"
},
"read_emulation": {
"type": "number",
"description": "Read emulation level"
},
"warmup_enabled": {
"type": "boolean",
"description": "Enable/disable warmup"
},
"warmup_keyword": {
"type": "string",
"description": "Warmup keyword/tag"
},
"dkim_identifier": {
"type": "string",
"description": "DKIM identifier"
},
"spam_protection": {
"type": "number",
"description": "Spam protection level"
},
"tracking_domain": {
"type": "string",
"description": "Tracking domain ID"
},
"warmup_templates": {
"type": "array",
"items": {
"type": "string"
},
"description": "Warmup template IDs"
},
"ramp_up_frequency": {
"type": "number",
"description": "Ramp-up increment"
},
"max_daily_frequency": {
"type": "number",
"description": "Max daily warmup emails"
},
"auto_ramp_up_enabled": {
"type": "boolean",
"description": "Enable auto ramp-up"
},
"starting_warmup_frequency": {
"type": "number",
"description": "Starting warmup frequency"
},
"sequence_ramp_up_frequency": {
"type": "number",
"description": "Sequence ramp-up increment"
},
"use_custom_tracking_domain": {
"type": "boolean",
"description": "Use custom tracking domain"
},
"sequence_max_daily_frequency": {
"type": "number",
"description": "Max daily sequence sends"
},
"sequence_auto_ramp_up_enabled": {
"type": "boolean",
"description": "Enable sequence auto ramp-up"
},
"sequence_initial_daily_frequency": {
"type": "number",
"description": "Initial daily sequence sends"
},
"pause_cold_emails_when_health_low": {
"type": "boolean",
"description": "Pause cold emails when health is low"
},
"pause_cold_emails_health_threshold": {
"type": "number",
"description": "Health threshold to pause at"
}
},
"additionalProperties": false
}| confirm | boolean | Required when paused is false — confirms the account holder explicitly approved resuming the sequence |
| delayTo | number | Maximum delay in minutes |
| senders | string | Comma-separated sender UUIDs |
| starred | boolean | Star the sequence |
| skip_esg | boolean | Skip ESG detection |
| timezone | string | IANA timezone for sending emails, e.g. 'Asia/Calcutta' or 'America/New_York' |
| delayFrom | number | Minimum delay in minutes |
| evergreen | boolean | Enable evergreen sequence |
| plainText | boolean | Send as plain text email |
| auto_reply | boolean | Enable auto-reply detection |
| riskyEmail | boolean | Send to contacts with risky email status |
| validEmail | boolean | Send to contacts with valid email status |
| scheduledAt | number | string | Launch time. UTC milliseconds OR an ISO 8601 datetime with timezone offset, e.g. '2026-07-08T16:30:00+05:30' for 4:30 PM IST. |
| delayEnabled | boolean | Enable sending delay |
| invalidEmail | boolean | Send to contacts with invalid email status |
| workspace_id | string | Workspace ID this action applies to. When omitted, the current or default workspace is used. |
| matchProvider | boolean | Match email provider when sending |
| checkEmailOpen | boolean | Check if recipient opened previous email |
| checkEmailClick | boolean | Check if recipient clicked a link in previous email |
| checkEmailReply | boolean | Check if recipient replied to previous email |
| launchTimingMode | string | Launch timing mode |
| emailSendingHours | array | Custom email sending hours for each day of the week (Monday-Sunday). Must include all 7 days if provided. |
| stopWhenReplyRecieved | boolean | Stop sequence when recipient replies |
| checkEmailBeforeSending | boolean | Verify email before sending. When enabled user must approve email before they can be sent |
| sendToOnlyVerifiedEmail | boolean | Only send to verified emails |
| stopWhenReplyRecievedWhen | string | When to stop sequence on reply: 'contact' = stop for this contact only, 'contact-with-same-domain' = stop for all contacts sharing the same domain |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The sequence ID"
},
"bcc": {
"type": "string",
"description": "BCC email address for all outgoing emails"
},
"name": {
"type": "string",
"description": "Sequence name"
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Array of list UUIDs to associate with sequence"
},
"steps": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"template_id"
],
"properties": {
"type": {
"type": "string",
"const": "email"
},
"send_as": {
"enum": [
"new",
"followup"
],
"type": "string",
"description": "How to send this email: 'new' (default) starts a new thread; 'followup' replies in the lead's existing thread as 'Re: <original subject>'. Ignored on the first email step of the sequence, which always starts a new thread."
},
"template_id": {
"type": "string",
"description": "Public template UUID for the email step"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"days"
],
"properties": {
"days": {
"type": "number",
"description": "Number of days to wait before the next step"
},
"type": {
"type": "string",
"const": "delay"
}
},
"additionalProperties": false
}
]
},
"minItems": 1,
"description": "Modify sequence steps. Each email step must be {type: 'email', template_id: 'public-template-uuid'} with optional send_as: 'new' | 'followup' (followup replies in the existing thread; ignored on the first email step, which always starts a new thread). Each delay step must be {type: 'delay', days: number}. When provided, the entire steps array replaces the existing flowchart."
},
"folder": {
"type": "string",
"description": "General folder ID to move the sequence into. Must be a folder created without a type (i.e., not an email-sender folder)."
},
"paused": {
"type": "boolean",
"description": "Pause or resume the sequence. Setting false resumes sending emails to recipients and requires confirm: true as the account holder's explicit approval."
},
"confirm": {
"type": "boolean",
"description": "Required when paused is false — confirms the account holder explicitly approved resuming the sequence"
},
"delayTo": {
"type": "number",
"description": "Maximum delay in minutes"
},
"senders": {
"type": "string",
"description": "Comma-separated sender UUIDs"
},
"starred": {
"type": "boolean",
"description": "Star the sequence"
},
"skip_esg": {
"type": "boolean",
"description": "Skip ESG detection"
},
"timezone": {
"type": "string",
"description": "IANA timezone for sending emails, e.g. 'Asia/Calcutta' or 'America/New_York'"
},
"delayFrom": {
"type": "number",
"description": "Minimum delay in minutes"
},
"evergreen": {
"type": "boolean",
"description": "Enable evergreen sequence"
},
"plainText": {
"type": "boolean",
"description": "Send as plain text email"
},
"auto_reply": {
"type": "boolean",
"description": "Enable auto-reply detection"
},
"riskyEmail": {
"type": "boolean",
"description": "Send to contacts with risky email status"
},
"validEmail": {
"type": "boolean",
"description": "Send to contacts with valid email status"
},
"scheduledAt": {
"type": [
"number",
"string"
],
"description": "Launch time. UTC milliseconds OR an ISO 8601 datetime with timezone offset, e.g. '2026-07-08T16:30:00+05:30' for 4:30 PM IST."
},
"delayEnabled": {
"type": "boolean",
"description": "Enable sending delay"
},
"invalidEmail": {
"type": "boolean",
"description": "Send to contacts with invalid email status"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"matchProvider": {
"type": "boolean",
"description": "Match email provider when sending"
},
"checkEmailOpen": {
"type": "boolean",
"description": "Check if recipient opened previous email"
},
"checkEmailClick": {
"type": "boolean",
"description": "Check if recipient clicked a link in previous email"
},
"checkEmailReply": {
"type": "boolean",
"description": "Check if recipient replied to previous email"
},
"launchTimingMode": {
"enum": [
"now",
"schedule"
],
"type": "string",
"description": "Launch timing mode"
},
"emailSendingHours": {
"type": "array",
"items": {
"type": "object",
"required": [
"enabled",
"name",
"fromTime",
"toTime"
],
"properties": {
"name": {
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string",
"description": "Day of the week"
},
"toTime": {
"type": "string",
"pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End time in 24-hour format (HH:MM)"
},
"enabled": {
"type": "boolean",
"description": "Whether sending is enabled on this day"
},
"fromTime": {
"type": "string",
"pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Start time in 24-hour format (HH:MM)"
}
},
"additionalProperties": false
},
"description": "Custom email sending hours for each day of the week (Monday-Sunday). Must include all 7 days if provided."
},
"stopWhenReplyRecieved": {
"type": "boolean",
"description": "Stop sequence when recipient replies"
},
"checkEmailBeforeSending": {
"type": "boolean",
"description": "Verify email before sending. When enabled user must approve email before they can be sent"
},
"sendToOnlyVerifiedEmail": {
"type": "boolean",
"description": "Only send to verified emails"
},
"stopWhenReplyRecievedWhen": {
"enum": [
"contact",
"contact-with-same-domain"
],
"type": "string",
"description": "When to stop sequence on reply: 'contact' = stop for this contact only, 'contact-with-same-domain' = stop for all contacts sharing the same domain"
}
},
"additionalProperties": false
}| remove_attachments |
| array |
| Array of existing attachment names to remove |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The template ID"
},
"name": {
"type": "string",
"description": "New name for the template"
},
"folder": {
"type": "string",
"description": "General folder ID to move the template into. Must be a folder created without a type (i.e., not an email-sender folder). An empty string removes the template from its folder."
},
"content": {
"type": "string",
"description": "New HTML content"
},
"starred": {
"type": "boolean",
"description": "Star or unstar the template"
},
"attachments": {
"type": "array",
"items": {
"type": "string"
},
"description": "NOT supported on this connector — providing file paths returns an error. Attach files via the SalesBlink web app instead."
},
"subject_line": {
"type": "string",
"description": "New subject line"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
},
"remove_attachments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of existing attachment names to remove"
}
},
"additionalProperties": false
}