Servers Playground How we check Add a server Log in

Emailchaser

Working · 1.4 s

com.emailchaser/emailchaserv1.0.1 Domain verified

Run cold email outbound from an AI agent: campaigns, leads, replies, sender accounts, autopilot.

Sales & CRM Marketing & SEO

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://app.emailchaser.com/api/mcp

Authorization (required)

Bearer token using an Emailchaser API key, created in the app under API & MCP.

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_blocklist_entries

Adds up to 1,000 suppression entries in one call so no campaign ever emails them. Each value is either a full email address (contains @) or a bare domain; the type is inferred per value. Existing entries and invalid values are skipped, so the call is safe to retry and suited to carrying over a suppression list from another sending platform. Scope defaults to "workspace"; "global" blocks across every workspace on the account and only works from the main workspace.

valuesarray, required

Email addresses and/or domains to block, e.g. ["competitor.com", "[email protected]"] (1 to 1,000 per request)

scopestring

"workspace" (default) blocks for this workspace only; "global" blocks for every workspace on the account

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Emailchaser MCP server | mcptry

Emailchaser

Working · 1.4 s

com.emailchaser/emailchaserv1.0.1 Domain verified

Run cold email outbound from an AI agent: campaigns, leads, replies, sender accounts, autopilot.

Sales & CRM Marketing & SEO

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://app.emailchaser.com/api/mcp

Authorization (required)

Bearer token using an Emailchaser API key, created in the app under API & MCP.

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_blocklist_entries

valuesarray, required

Email addresses and/or domains to block, e.g. ["competitor.com", "[email protected]"] (1 to 1,000 per request)

scopestring

"workspace" (default) blocks for this workspace only; "global" blocks for every workspace on the account

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Tools (102)

add_blocklist_entries

Argument	Type	Description
scope	string	"workspace" (default) blocks for this workspace only; "global" blocks for every workspace on the account
values*	array	Email addresses and/or domains to block, e.g. ["competitor.com", "[email protected]"] (1 to 1,000 per request)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "values"
  ],
  "properties": {
    "scope": {
      "enum": [
        "workspace",
        "global"
      ],
      "type": "string",
      "description": "\"workspace\" (default) blocks for this workspace only; \"global\" blocks for every workspace on the account"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "maxItems": 1000,
      "minItems": 1,
      "description": "Email addresses and/or domains to block, e.g. [\"competitor.com\", \"[email protected]\"] (1 to 1,000 per request)"
    }
  }
}

add_lead_finder_prospects

SPENDS CREDITS, AND BY DEFAULT METERED EMAIL VERIFICATION. Adds people from the Lead Finder contact database to a campaign as leads, revealing their contact details, in the background. Pass refs (from search_lead_finder results; up to 1,000 different people by default) to add exactly those people, or pass filters and count (1 to 5,000 by default) to add count people matching the filters who are not in the workspace yet. A filters add always walks the matches from the top and skips anyone already a lead, free and not counted, so repeating the same add adds the NEXT count people and charges again. Never repeat an add to retry: after an error or a timeout, call list_lead_finder_imports to see whether it started. A filters add stops early when the audience runs out or once it has looked at five people for every one requested (at least 1,000). People already added count toward that limit even though skipping them is free, so after an add of more than about 1,000 people a small follow-up can stop with nobody added. Every person a filters add looks at, added or skipped, also uses the account's daily allowance for filters adds (25,000 people by default). Each person added costs 1 credit ($0.033 at list), reported as creditsPerProspect; the response reports estimatedCredits, the most the add can cost in credits, and the wallet must hold that much for it to start. People already in the workspace, blocklisted, without a usable address, on a personal mailbox when the campaign only takes business addresses, or marked invalid by verification are skipped and cost no credits. verifyEmails (on by default) checks every screened address with the paid email verification waterfall, including the ones it marks invalid: one or two checks per address, billed as metered usage on the next invoice (price per check: GET /email-verification/rates in the REST API), within the account's monthly verification spend limit. Catch-all and unconfirmed addresses are added and charged, and so is every address once that limit is reached; verification.limitReached and verification.unknown on get_lead_finder_import count them. Leads added to a running or paused campaign get their emails at once (a paused campaign sends them when resumed); adding to a completed campaign resumes it, so it starts sending again; in a draft campaign the emails are created at launch. At most 3 adds run at once in a workspace. A refusal names its reason, and a 429 also says when to retry (reason running_imports, daily_import_limit, daily_budget, monthly_budget or fair_use_floor). Poll get_lead_finder_import with the importId until finishedAt is set. Check get_credit_balance first; buy credits with purchase_credits.

add_leads

Creates or updates up to 1,000 leads in one request, optionally adding them to a campaign via campaignId. Existing leads (matched by email) are updated instead of duplicated. Returns the id of every lead written, so they can be fetched or updated afterwards. Attributes outside the named fields can be passed in customVariables and become merge tags in email copy.

Argument	Type	Description
leads*	array	The leads to create or update (1 to 1,000 per request)
campaignId	integer	Campaign to add the leads to (from list_campaigns)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "leads"
  ],
  "properties": {
    "leads": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email"
        ],
        "properties": {
          "email": {
            "type": "string",
            "description": "Lead email address (required)"
          },
          "phone": {
            "type": "string",
            "description": "Phone number"
          },
          "title": {
            "type": "string",
            "description": "Job title"
          },
          "company": {
            "type": "string",
            "description": "Company name"
          },
          "website": {
            "type": "string",
            "description": "Company website URL"
          },
          "lastName": {
            "type": "string",
            "description": "Lead last name"
          },
          "linkedin": {
            "type": "string",
            "description": "LinkedIn profile URL"
          },
          "firstName": {
            "type": "string",
            "description": "Lead first name"
          },
          "middleName": {
            "type": "string",
            "description": "Lead middle name"
          },
          "customVariables": {
            "type": "object",
            "description": "Any attribute the named fields do not cover, e.g. { pageVisited: '/pricing' }. Each key becomes a merge tag usable in email copy as {key}. Keys match case-insensitively with spaces treated as underscores, so 'Page Visited' and 'page_visited' are the same tag.",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          }
        }
      },
      "maxItems": 1000,
      "minItems": 1,
      "description": "The leads to create or update (1 to 1,000 per request)"
    },
    "campaignId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Campaign to add the leads to (from list_campaigns)",
      "exclusiveMinimum": 0
    }
  }
}

approve_autopilot_run

Approves an autopilot run that is awaiting approval — the one human gate in the flow. CAN SPEND REAL MONEY: approval first reveals the run's prospects at 1 credit ($0.033 at list) each, then, if the workspace has no connected sending account, places one done-for-you order sized from the plan snapshotted at start, at most 10 .com domains and at most six mailboxes per domain, never more mailboxes than the plan, charged at the prices in effect when the order is placed. So the plan's mailbox and domain counts are a ceiling and its dollar figures an estimate, not an exact quote. No credits are bought, but the reveal and later top-ups spend the wallet's credits. If a sending account is already connected, no infrastructure is bought; a run started without budgetUsd and with no connected account fails. Show the user the plan from the start_autopilot_run response before calling this. Nothing is revealed, bought or sent before this call; after it, sending starts without further confirmation.

Argument	Type	Description
id*	integer	The numeric autopilot run ID (from list_autopilot_runs)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric autopilot run ID (from list_autopilot_runs)",
      "exclusiveMinimum": 0
    }
  }
}

attach_campaign_sender_emails

Attaches connected sender email accounts to a campaign. A campaign only sends through the senders attached to it, so this call decides which mailboxes it uses. Idempotent: already-attached senders are left untouched and only missing ones are added. The call is refused whole when any requested sender is not a connected sender email in the workspace. Attaching to a running campaign reschedules it so the new senders are picked up.

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)
senderEmailIds*	array	Sender email IDs to attach (from list_sender_emails). Every ID must be a connected sender email in the workspace

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "senderEmailIds"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    },
    "senderEmailIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "minItems": 1,
      "description": "Sender email IDs to attach (from list_sender_emails). Every ID must be a connected sender email in the workspace"
    }
  }
}

cancel_email_verification_job

Stops a running verification job. Addresses already verified stay in the results and stay billed; addresses that never ran are never charged, so cancelling costs nothing further.

Argument	Type	Description
jobId*	string	The job ID

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "jobId"
  ],
  "properties": {
    "jobId": {
      "type": "string",
      "minLength": 1,
      "description": "The job ID"
    }
  }
}

cancel_lead_finder_import

Stops a running Lead Finder add. It reads canceled at once. A batch the worker is already writing is still added and charged; a batch still being screened or verified is dropped, though verification checks already made are billed. Credits held for the rest are released. Until finishedAt is set, added, creditsSpent and even status can still change: if that batch was the add's last, it ends completed or failed instead. People already added stay in the campaign. A stopped add cannot be resumed: start a new add_lead_finder_prospects instead. Stopping one that already finished changes nothing.

destructive

Argument	Type	Description
id*	integer	The import ID (importId from add_lead_finder_prospects or list_lead_finder_imports)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The import ID (importId from add_lead_finder_prospects or list_lead_finder_imports)",
      "exclusiveMinimum": 0
    }
  }
}

confirm_connection

Confirms the API key works and tells Emailchaser which AI assistant connected. Call it as your first action after connecting, and whenever the user asks you to confirm or check the Emailchaser connection: it records the assistant and time on the key, which the app's API & MCP page watches to show the user you are in, and completes the 'Connect your AI' onboarding step. Idempotent: repeat calls simply refresh the record. Works with read-only keys as well as read & write keys.

Argument	Type	Description
agent	string	Your name in any form, e.g. claude, chatgpt, cursor, gemini. Normalized to a short lowercase identifier and echoed back

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "agent": {
      "type": "string",
      "maxLength": 60,
      "description": "Your name in any form, e.g. claude, chatgpt, cursor, gemini. Normalized to a short lowercase identifier and echoed back"
    }
  }
}

connect_sender_email

Connects an SMTP/IMAP mailbox to the workspace using an app password, with no browser step. Google and Microsoft mailboxes are NOT supported here because both require an interactive consent screen that cannot be automated; connect those in the app. The address must be on a business domain, so gmail.com and similar are rejected. The returned account's healthScore is null until warm-up has checked 20 of its emails (see get_sender_email).

Argument	Type	Description
email*	string	The mailbox address, on a business domain
lastName	string	Sender last name
password*	string	App password for the mailbox, not the account login password
firstName	string	Sender first name
loginString	string	Login username if it differs from the email address
imapServerUrl*	string	IMAP host, optionally with a port, e.g. imap.fastmail.com:993
smtpServerUrl*	string	SMTP host, optionally with a port, e.g. smtp.fastmail.com:587

Input schema (JSON)

copilot_launch

Creates a DRAFT campaign from a sequence. With a LinkedIn Sales Navigator search it also starts finding + verifying leads for it; without one the draft holds the emails and leads can be added from Lead Finder or a CSV upload. Nothing sends — the campaign stays a draft until you review and launch it. Returns the new campaign id, plus a lead-finding job id when lead finding started.

Argument	Type	Description
icp	object	Optional ICP object as returned by copilot_plan, stored with the campaign for reference only
name*	string	Campaign name
sequence*	array	The email sequence: the first step is the initial email, the rest are follow-ups
salesNavData	string	Optional base64 LinkedIn session payload from the browser extension; required for lead-finding to actually run
salesNavSearchUrl	string	Optional LinkedIn Sales Navigator people-search URL to source leads from. Leave it out to create the draft with its emails only. Required when salesNavData is given.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "sequence"
  ],
  "properties": {
    "icp": {
      "type": "object",
      "description": "Optional ICP object as returned by copilot_plan, stored with the campaign for reference only",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "Campaign name"
    },
    "sequence": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "subject",
          "body"
        ],
        "properties": {
          "body": {
            "type": "string",
            "description": "Email body"
          },
          "subject": {
            "type": "string",
            "description": "Email subject (supports {firstName}, {companyName}, etc.)"
          },
          "followUpAfter": {
            "type": "integer",
            "maximum": 9007199254740991,
            "minimum": 0,
            "description": "Days to wait after the previous step (0 for the first email)"
          }
        }
      },
      "minItems": 1,
      "description": "The email sequence: the first step is the initial email, the rest are follow-ups"
    },
    "salesNavData": {
      "type": "string",
      "description": "Optional base64 LinkedIn session payload from the browser extension; required for lead-finding to actually run"
    },
    "salesNavSearchUrl": {
      "type": "string",
      "description": "Optional LinkedIn Sales Navigator people-search URL to source leads from. Leave it out to create the draft with its emails only. Required when salesNavData is given."
    }
  }
}

copilot_plan

Given a company website, the honest AI SDR builds an ideal-customer-profile (ICP) and a suggested cold-email sequence. Read-only — creates nothing. Returns the ICP (personas, titles, industries, suggested Sales Navigator keywords) and a draft sequence you can review or pass to copilot_launch.

Argument	Type	Description
context	string	Optional extra context, e.g. 'we sell to dental clinics in the US'
website*	string	The company website to analyze, e.g. https://acme.com
description	string	Optional: what the company sells and to whom, in its own words. When given, the plan is built from it and the website is not read. Send it when copilot_plan answers that the website shows a placeholder page.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "website"
  ],
  "properties": {
    "context": {
      "type": "string",
      "description": "Optional extra context, e.g. 'we sell to dental clinics in the US'"
    },
    "website": {
      "type": "string",
      "minLength": 1,
      "description": "The company website to analyze, e.g. https://acme.com"
    },
    "description": {
      "type": "string",
      "description": "Optional: what the company sells and to whom, in its own words. When given, the plan is built from it and the website is not read. Send it when copilot_plan answers that the website shows a placeholder page."
    }
  }
}

create_campaign

Creates a campaign in the workspace. The campaign starts as a DRAFT and sends nothing. A new campaign has no emails in it, so it cannot be launched until a sequence is written with replace_campaign_sequence and a sender email is attached. Sending limits and deliverability settings can be set here or changed later with update_campaign.

Argument	Type	Description
flow	string	Campaign flow. Defaults to multiple_leads_scheduled, which behaves exactly like a campaign created in the app. Only pass api if you specifically want lead validation skipped at launch
name*	string	Campaign name
emoji	string	Campaign emoji shown in the app. Defaults to a generic one
timezone	string	IANA timezone, e.g. America/New_York
dailyLimit	integer	Cap on the total emails (initial + follow-ups) the campaign may schedule per calendar day in its timezone. Omit for no campaign-level cap; per-mailbox limits still apply
isEnabledLlm	boolean	Enable AI (LLM) features for this campaign
minimumHealthScore	integer	Minimum email account health score for this campaign, 1-100 (see healthScore in list_sender_emails). An account below it, or with no score yet, sends nothing in this campaign, first emails and follow-ups alike, until its score is back at or above it; its conversations wait for it and never move to another account. 0 means no minimum; omit it to leave the setting as it is

create_dfy_order

SPENDS REAL MONEY. Places a real order for sending domains and pre-warmed mailboxes: domains are registered at their listed price (about $13.99/year for a .com — search_dfy_domains shows the exact price per domain) and each mailbox costs about $3 setup plus $6/month. The order is accepted immediately and provisioned in the background; poll get_dfy_order for progress. Purchased domains redirect visitors to forwardingDomain. Use search_dfy_domains first to confirm availability and price. Every domain in domains needs at least one mailbox in mailboxes whose domainName is that domain, or the order is refused before anything is bought; mailboxes can also go on a domain from an earlier order.

Argument	Type	Description
domains	array	Domains to purchase. Each one needs at least one mailbox in mailboxes with the same domainName.
mailboxes	array	Mailboxes to provision: at least one on every domain in domains. A mailbox can also go on a domain from an earlier order.
forwardingDomain	string	Where the purchased domains redirect visitors, e.g. acme.com

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "domains": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "domainName"
        ],
        "properties": {
          "domainName": {
            "type": "string",
            "minLength": 1,
            "description": "Domain to register, e.g. acme-mail.com"
          }
        }
      },
      "description": "Domains to purchase. Each one needs at least one mailbox in mailboxes with the same domainName."
    },
    "mailboxes": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "username",
          "firstName",
          "lastName",
          "domainName"
        ],
        "properties": {
          "lastName": {
            "type": "string",
            "minLength": 1,
            "description": "Sender last name"
          },
          "username": {
            "type": "string",
            "minLength": 1,
            "description": "Mailbox local part, e.g. john"
          },
          "firstName": {
            "type": "string",
            "minLength": 1,
            "description": "Sender first name"
          },
          "domainName": {
            "type": "string",
            "minLength": 1,
            "description": "Domain the mailbox lives on (from this order or an earlier one)"
          },
          "profilePicture": {
            "type": "string",
            "description": "Optional profile picture URL"
          }
        }
      },
      "description": "Mailboxes to provision: at least one on every domain in domains. A mailbox can also go on a domain from an earlier order."
    },
    "forwardingDomain": {
      "type": "string",
      "description": "Where the purchased domains redirect visitors, e.g. acme.com"
    }
  }
}

create_email_verification_job

SPENDS MONEY: every address checked adds metered usage to the workspace's next invoice. This does NOT use prospect credits and it does NOT create or send a campaign — it verifies a list on its own and gives back a per-address verdict you can download as CSV. Call get_email_verification_rates first for the current price: an address costs one verification credit when the first provider rejects it outright and two when both providers answer, so multiply your list size by perAddressCeilingUsd to budget. An address that gets no verdict is NOT billed and comes back with result unknown. Duplicates are removed and unparseable entries are returned in invalid_emails before anything is charged, so the total in the response is what will be billed against, not what you submitted. Needs an active or trialing subscription: a past_due workspace is refused with subscription_not_active, and a trialing workspace may submit up to 100 addresses in total across all its jobs, after which it is refused with trial_allowance_exceeded (the message says how many are left). If the workspace's monthly verification allowance runs out mid-job the job does not fail — the remaining addresses come back unknown, marked, still in the download, and unbilled. Poll get_email_verification_job until state is done, then read the results with list_email_verification_results.

Argument	Type	Description
name*	string	What to call this job in the app, e.g. 'Q3 conference list'
emails*	array	The addresses to verify, up to 50,000. Duplicates and unparseable entries are dropped before billing.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "emails"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "What to call this job in the app, e.g. 'Q3 conference list'"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 50000,
      "minItems": 1,
      "description": "The addresses to verify, up to 50,000. Duplicates and unparseable entries are dropped before billing."
    }
  }
}

create_icp

Stores a manually-authored Ideal Customer Profile (ICP): who the workspace sells to, as targeting criteria (titles, seniorities, industries, company sizes, locations, keywords). Set makePrimary to promote it to the workspace's active profile. Use copilot_plan instead when you want the AI to build the ICP from a website.

Argument	Type	Description
name*	string	Profile name, e.g. "Mid-market SaaS RevOps leaders"
titles	array	Job titles to target, e.g. ["CEO", "Head of Sales"]
summary	string	One to three sentences describing who the workspace sells to
keywords	array	Free-text keywords, e.g. ["b2b saas"]
locations	array	Locations, e.g. ["United States"]
industries	array	Industries, e.g. ["Software"]
makePrimary	boolean	Promote this profile to the workspace's active one, demoting any existing primary
seniorities	array	Seniority levels, e.g. ["owner", "director"]
companySizes	array

create_webhook

Registers a webhook endpoint that receives a POST request whenever the selected event happens (email sent, reply received, bounce, lead created, lead category updated, or campaign status changed).

Argument	Type	Description
url*	string	HTTPS URL that will receive the events
name	string	Display name for the webhook, shown in the app
type*	string	The event type to subscribe to

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "url",
    "type"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "HTTPS URL that will receive the events"
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Display name for the webhook, shown in the app"
    },
    "type": {
      "enum": [
        "EmailSent",
        "EmailReply",
        "EmailBounce",
        "LeadCategoryUpdate",
        "LeadCreated",
        "CampaignStatusChanged"
      ],
      "type": "string",
      "description": "The event type to subscribe to"
    }
  }
}

create_workspace

Creates a sub-workspace under the account's main workspace (for example one per client, for an agency) and by default mints a read & write API key bound to it. The key's fullKey is returned exactly ONCE and cannot be retrieved again, so hand it to the user straight away; it never outlives the calling key. Must be called with the main workspace's key: sub-workspace keys are refused. Workspaces are a Professional-plan feature.

Argument	Type	Description
name*	string	Name of the new workspace (1 to 60 characters)
generateApiKey	boolean	Also mint a read & write API key for the new workspace. Defaults to true

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1,
      "description": "Name of the new workspace (1 to 60 characters)"
    },
    "generateApiKey": {
      "type": "boolean",
      "description": "Also mint a read & write API key for the new workspace. Defaults to true"
    }
  }
}

create_workspace_api_key

Mints a new API key bound to a workspace the calling key already owns: its own workspace, or one of its sub-workspaces when called with the main workspace's key. This is how a workspace whose key was lost gets a new one without a UI step. fullKey is returned exactly ONCE and cannot be retrieved again, so hand it to the user straight away. The new key authorizes the named workspace only and never outlives the calling key. Keys can be revoked in the app under API & MCP.

Argument	Type	Description
id*	integer	The numeric workspace ID (from list_workspaces)
name	string	Name shown in the app's API key list. Defaults to "<workspace name> key"
readOnly	boolean	Mint a read-only key. It can use the read (list and get) tools plus confirm_connection, get_audience_size and search_lead_finder, so it can read, size audiences and browse Lead Finder (which still uses the account's daily browsing allowance), but it cannot spend credits or change anything else. Defaults to false, a read & write key

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric workspace ID (from list_workspaces)",
      "exclusiveMinimum": 0
    },
    "name": {
      "type": "string",
      "maxLength": 60,
      "description": "Name shown in the app's API key list. Defaults to \"<workspace name> key\""
    },
    "readOnly": {
      "type": "boolean",
      "description": "Mint a read-only key. It can use the read (list and get) tools plus confirm_connection, get_audience_size and search_lead_finder, so it can read, size audiences and browse Lead Finder (which still uses the account's daily browsing allowance), but it cannot spend credits or change anything else. Defaults to false, a read & write key"
    }
  }
}

delete_campaign

Permanently deletes a campaign and all associated data, including its emails, sequences and scheduled tasks. This cannot be undone.

destructive

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    }
  }
}

delete_icp

Deletes an Ideal Customer Profile. Deleting the primary leaves the workspace without an active profile. This cannot be undone.

destructive

Argument	Type	Description
id*	integer	The numeric ICP ID (from list_icps)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric ICP ID (from list_icps)",
      "exclusiveMinimum": 0
    }
  }
}

delete_lead

Permanently deletes a lead by ID. This cannot be undone.

destructive

Argument	Type	Description
id*	integer	The numeric lead ID (returned when the lead was created)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric lead ID (returned when the lead was created)",
      "exclusiveMinimum": 0
    }
  }
}

delete_webhook

Deletes a registered webhook endpoint by ID so it stops receiving events.

destructive

Argument	Type	Description
id*	integer	The numeric webhook ID (from list_webhooks)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric webhook ID (from list_webhooks)",
      "exclusiveMinimum": 0
    }
  }
}

detach_campaign_sender_email

Detaches a sender email from a campaign so the campaign stops sending through that mailbox. Unsent follow-ups to emails this sender already sent are canceled and do not come back on re-attach; a running campaign is rescheduled onto its remaining senders; already-sent emails are untouched. Idempotent: detaching a sender that is not attached is a no-op.

destructive

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)
senderEmailId*	integer	The numeric sender email ID (from list_sender_emails)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "senderEmailId"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    },
    "senderEmailId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric sender email ID (from list_sender_emails)",
      "exclusiveMinimum": 0
    }
  }
}

get_audience_size

Counts how many prospects match ad-hoc targeting criteria (titles, seniorities, industries, company sizes, locations, keywords) without saving anything. Free — searching never spends credits; only revealing contact details is metered. Use it to validate targeting before creating an ICP or sourcing leads. A read-only key may call it: a read-only key can use the read (list and get) tools plus confirm_connection, get_audience_size and search_lead_finder.

read-only

Argument	Type	Description
titles	array	Job titles to target, e.g. ["CEO", "Head of Sales"]
keywords	array	Free-text keywords, e.g. ["b2b saas"]
locations	array	Locations, e.g. ["United States"]
industries	array	Industries, e.g. ["Software"]
seniorities	array	Seniority levels, e.g. ["owner", "director"]
companySizes	array	Company headcount ranges, e.g. ["11-50", "51-200"]

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "titles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Job titles to target, e.g. [\"CEO\", \"Head of Sales\"]"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Free-text keywords, e.g. [\"b2b saas\"]"
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Locations, e.g. [\"United States\"]"
    },
    "industries": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Industries, e.g. [\"Software\"]"
    },
    "seniorities": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Seniority levels, e.g. [\"owner\", \"director\"]"
    },
    "companySizes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Company headcount ranges, e.g. [\"11-50\", \"51-200\"]"
    }
  }
}

get_autopilot_run

Returns one autopilot run including its full audit trail. It does not return the budget plan: that comes back only from start_autopilot_run (when budgetUsd was given) and from plan_autopilot. Use it to check progress.

read-only

Argument	Type	Description
id*	integer	The numeric autopilot run ID (from list_autopilot_runs)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric autopilot run ID (from list_autopilot_runs)",
      "exclusiveMinimum": 0
    }
  }
}

get_billing_profile

Returns the registrant and postal contact details held for the workspace: what is filed with the registrar when a done-for-you order buys a domain, and the postal address a CAN-SPAM footer must carry. Errors with 404 until set_billing_profile has been called.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

get_blocklist_entry

Returns one suppression entry by ID: the blocked domain or email address, when it was added and which list it belongs to. Entries inherited from the account-wide list are visible from a sub-workspace too and report scope "global".

read-only

Argument	Type	Description
id*	integer	The numeric blocklist entry ID (from list_blocklist_entries)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric blocklist entry ID (from list_blocklist_entries)",
      "exclusiveMinimum": 0
    }
  }
}

get_campaign

Retrieves a campaign by ID, including settings, sending schedule, stats and per-status email counts. minimumHealth lists each connected email account on the campaign with its healthScore and whether the campaign's minimum health score (settings.minimumHealthScore) holds it back, with the reason; when every account is held back, allHeldBack is true and message says the campaign is sending nothing.

read-only

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    }
  }
}

get_campaign_sequence

Returns the ordered emails that make up a campaign's sequence, including any A/B variants. delayDays on each step is counted from the previous step, and the first step is always 0.

read-only

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    }
  }
}

get_campaign_stats

Returns a campaign's performance in one call: totals (sent, replied, positive, bounced, meetings), per-A/B-variant results, per-sequence-step results and a daily time series (UTC days). Use it to judge how a campaign is doing or to compare variants. There is no opens metric anywhere in the response: Emailchaser does not track opens, so its absence is deliberate, not an omission.

read-only

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    }
  }
}

get_credit_balance

Returns the workspace's credit wallet: available, reserved, lifetime granted and used, and the monthly grant. Credits pay for prospect reveals and AI work (list price $0.033 each). A new workspace sees zeros, not an error. unlimited is true when Emailchaser has made this workspace's credits free: every credit action then goes through without using available and is never refused for lack of credits, so there is no need to check the balance or buy credits.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

get_deliverability_insights

What is wrong with deliverability across the workspace right now, worst first, each with the action that fixes it. Combines the inbox placement measured over the window with the latest health check of every connected mailbox: authentication records, blacklist listings and measured placement per mailbox. The best first call when asked 'why are we landing in spam'.

read-only

Argument	Type	Description
days	integer	How many days of runs to summarise (default 30)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "days": {
      "type": "integer",
      "maximum": 365,
      "minimum": 1,
      "description": "How many days of runs to summarise (default 30)"
    }
  }
}

get_dfy_order

Returns one done-for-you order: status (created, pending_approval, processing, completed, failed, partially_completed, canceled), cost breakdown and any failure reason. Poll it to track provisioning after create_dfy_order.

read-only

Argument	Type	Description
id*	integer	The numeric order ID (from create_dfy_order or list_dfy_orders)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric order ID (from create_dfy_order or list_dfy_orders)",
      "exclusiveMinimum": 0
    }
  }
}

get_email_verification_job

Returns one verification job: its state, per-verdict counts and what it has billed. Poll until state is done. An errorCode of monthly_limit_reached means the allowance ran out and the remaining addresses came back unknown rather than missing — they are still in the results, marked, and were not billed.

read-only

Argument	Type	Description
jobId*	string	The job ID

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "jobId"
  ],
  "properties": {
    "jobId": {
      "type": "string",
      "minLength": 1,
      "description": "The job ID"
    }
  }
}

get_email_verification_rates

Returns what one email verification costs right now, read from the billing plan the meter actually charges against. Call this before create_email_verification_job rather than assuming a price. Every check runs a waterfall of up to two providers and each one that returns a verdict is one billable verification credit, so an address costs ONE credit when the first provider rejects it outright and TWO when both answer. Budget against perAddressCeilingUsd, which is the common case, not perAddressFloorUsd.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

get_icp

Retrieves one Ideal Customer Profile by ID, including its targeting criteria, whether it is AI-generated or human-edited, primary status and estimated audience size.

read-only

Argument	Type	Description
id*	integer	The numeric ICP ID (from list_icps)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric ICP ID (from list_icps)",
      "exclusiveMinimum": 0
    }
  }
}

get_inbox_placement_run

Returns one inbox placement run with its complete report: the headline inbox / spam / promotions / missing split, the breakdown per mailbox provider and per sending mailbox, and the content spam rules the copy triggered. 'Promotions' rolls up every Gmail category tab. 'Missing' means the probe was never found in any folder, which usually indicates a silent block: a worse problem than spam, with a different fix. spamScore is in tenths of a point (47 means 4.7) and -1 means not scored.

read-only

Argument	Type	Description
id*	integer	The numeric inbox placement run ID (from list_inbox_placement_runs)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric inbox placement run ID (from list_inbox_placement_runs)",
      "exclusiveMinimum": 0
    }
  }
}

get_inbox_placement_stats_by_date

Rolls completed inbox placement runs up by UTC calendar day over a window, for a trend. Defaults to the last 30 days. Days on which nothing ran are ABSENT from the series rather than zero: never report a missing day as 0% placement, it means nobody ran a test that day.

read-only

Argument	Type	Description
to	string	End of the window, RFC3339. Defaults to now
from	string	Start of the window, RFC3339, e.g. 2026-08-01T00:00:00Z. Defaults to 30 days ago

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "to": {
      "type": "string",
      "description": "End of the window, RFC3339. Defaults to now"
    },
    "from": {
      "type": "string",
      "description": "Start of the window, RFC3339, e.g. 2026-08-01T00:00:00Z. Defaults to 30 days ago"
    }
  }
}

get_lead

Retrieves a lead by ID, including contact details and company information.

read-only

Argument	Type	Description
id*	integer	The numeric lead ID (returned when the lead was created)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric lead ID (returned when the lead was created)",
      "exclusiveMinimum": 0
    }
  }
}

get_lead_conversation

Returns a lead's full email thread in chronological order: outbound emails (sent, scheduled and unsent drafts) plus inbound replies, each with direction and status. AI reply drafts awaiting review are marked isDraft; edit one with update_reply_draft and send it with send_reply_draft (or a human sends it from the app). To write your own answer to any inbound reply in the thread, use send_reply with that reply's id. Use it to read the back-and-forth with one lead before deciding what to do next.

read-only

Argument	Type	Description
id*	integer	The numeric lead ID (returned when the lead was created)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric lead ID (returned when the lead was created)",
      "exclusiveMinimum": 0
    }
  }
}

get_lead_finder_filters

Returns the values Lead Finder's list filters accept (seniorities, jobFunctions, companySizes, revenue, industries, countries, headquartersCountries, regions, continents), the limits that apply to this workspace (page sizes, deepest page, people per add, first-N count, imports running at once, and the daily browsing allowance with what is left today), and creditsPerProspect, what adding one person to a campaign costs. Free, and makes no call to the data provider. Call it before search_lead_finder so filter values match exactly.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

get_lead_finder_import

Returns one Lead Finder add's progress: status (running, completed, failed or canceled), how many people were added and skipped and why (skipReasons), what email verification said, and credits spent. added, creditsSpent and status can still change until finishedAt is set, so poll it after add_lead_finder_prospects until it is. A completed add's endReason is all_selected, requested_reached, audience_exhausted or fetch_limit, and a canceled one's is canceled. A failed add can still have added and charged people (see added and creditsSpent); lastError says why it stopped: insufficient_credits, contact_cap_reached, results_expired, budget_exhausted, provider_blocked, invalid_filters, campaign_not_found or internal. A new filters add to finish a partial one starts from the top again and counts the people already added toward its fetch limit (five people per one requested, at least 1,000), so after a large add, pick the missing people by ref from search_lead_finder results instead.

read-only

Argument	Type	Description
id*	integer	The import ID (importId from add_lead_finder_prospects or list_lead_finder_imports)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The import ID (importId from add_lead_finder_prospects or list_lead_finder_imports)",
      "exclusiveMinimum": 0
    }
  }
}

get_lead_finder_search

Reads a search started with search_lead_finder, by its searchId. While it is still running, or while its exact total is still being counted (totalStatus pending), the call waits up to about six seconds, so calling again straight away is fine. A finished page can be re-read for 10 minutes after it was fetched (less if it came from cache), and re-reading it in that window keeps its refs valid for another 60 minutes. After that the call answers status failed with error expired, though refs already shown stay usable until 60 minutes after they were last shown; running search_lead_finder again shows them afresh and uses browsing rows. After 15 minutes the search is not found.

read-only

Argument	Type	Description
searchId*	string	The searchId returned by search_lead_finder

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "searchId"
  ],
  "properties": {
    "searchId": {
      "type": "string",
      "minLength": 1,
      "description": "The searchId returned by search_lead_finder"
    }
  }
}

get_outcomes_report

Puts money against results for a time window: credit spend (grouped by reason, valued at the $0.033 list price) plus done-for-you order costs on one side, and sent emails, replies, positive replies and booked meetings on the other, with cost per reply, per positive reply and per meeting. Subscription fees are NOT included. campaignId narrows the outcome side only — spend stays workspace-level — so per-campaign cost figures are partial attribution, not a true campaign cost. Use it to answer 'what did we spend and what did we get'.

read-only

Argument	Type	Description
since	string	Window start, RFC3339 or YYYY-MM-DD (inclusive)
until	string	Window end, RFC3339 or YYYY-MM-DD (inclusive; a bare date means midnight UTC at the start of that day)
campaignId	integer	Narrow the outcome side to one campaign (spend stays workspace-level)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "since": {
      "type": "string",
      "description": "Window start, RFC3339 or YYYY-MM-DD (inclusive)"
    },
    "until": {
      "type": "string",
      "description": "Window end, RFC3339 or YYYY-MM-DD (inclusive; a bare date means midnight UTC at the start of that day)"
    },
    "campaignId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Narrow the outcome side to one campaign (spend stays workspace-level)",
      "exclusiveMinimum": 0
    }
  }
}

get_primary_icp

Returns the workspace's active (primary) Ideal Customer Profile — the profile the workspace currently targets; at most one is primary. Errors with 404 when none is set.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

get_sender_email

Retrieves a connected sending email account by ID, including its health score. healthScore is the account's health score: 0-100, higher is better, the share of its warm-up emails over the last 7 full days that landed in the inbox rather than spam. It moves daily as warm-up emails land in the inbox (up) or in spam (down), and is null while warm-up is off or before 20 warm-up emails were checked.

read-only

Argument	Type	Description
id*	integer	The numeric sender email ID (from list_sender_emails)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric sender email ID (from list_sender_emails)",
      "exclusiveMinimum": 0
    }
  }
}

get_sender_email_dns

Checks the sender domain's SPF, DKIM, DMARC and MX records and reports each as OK, WARNING, MISSING or ERROR with human-readable issues (the same checks behind the app's DNS vitals view), plus the mailbox's warm-up status: whether it is enrolled, today's ramp target, the daily cap and its healthScore (0-100, higher is better, the share of its warm-up emails over the last 7 full days that landed in the inbox rather than spam). Use it to diagnose deliverability. DNS lookups run live at request time, so the call can take a few seconds but never returns stale records.

read-only

Argument	Type	Description
id*	integer	The numeric sender email ID (from list_sender_emails)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric sender email ID (from list_sender_emails)",
      "exclusiveMinimum": 0
    }
  }
}

get_sender_email_warmup

Reads a mailbox's warm-up settings: whether warm-up is on, the ramp (startLimit warm-up emails on the first day, increaseBy more each sending day, up to capLimit a day), weekdays-only, timezone, today's ramp target (currentPerDay) and the account's healthScore (0-100, higher is better, the share of its warm-up emails over the last 7 full days that landed in the inbox rather than spam; null while warm-up is off or before 20 were checked). Warm-up volume is separate from the campaign sending limits changed with update_sender_email. When configured is false the mailbox has never warmed, and the values shown are the defaults that switching warm-up on would use.

read-only

Argument	Type	Description
id*	integer	The numeric sender email ID (from list_sender_emails)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric sender email ID (from list_sender_emails)",
      "exclusiveMinimum": 0
    }
  }
}

get_sender_reputation

Returns the latest health check for every connected mailbox: SPF, DKIM, DMARC and MX status (OK, WARNING, MISSING or ERROR), blacklist listings with their delisting links, measured inbox placement over recent runs and a combined 0-100 health score. blacklistsChecked is reported next to blacklistsListed so the count is never read as a total. A placementScore or healthScore of -1 means not measured, not zero.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

get_workspace_details

Returns the workspace behind the API key: campaign counts broken down by status and the list of members. Useful as a first call to confirm which workspace a key belongs to.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

import_instantly

Imports your Instantly.ai campaigns and leads into Emailchaser using your Instantly API key. Imported campaigns are created as DRAFTS — nothing sends until you review and launch them. Runs in the background and returns a job id.

Argument	Type	Description
instantlyApiKey*	string	Your Instantly.ai API key (Instantly → Settings → API keys)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "instantlyApiKey"
  ],
  "properties": {
    "instantlyApiKey": {
      "type": "string",
      "minLength": 1,
      "description": "Your Instantly.ai API key (Instantly → Settings → API keys)"
    }
  }
}

kill_autopilot_run

Engages the kill switch: the run halts wherever it is and can NEVER be resumed, and any campaign the run launched is paused so nothing more sends. Use pause_autopilot_run instead when you might want to continue later. The optional reason is recorded in the run's audit trail.

destructive

Argument	Type	Description
id*	integer	The numeric autopilot run ID (from list_autopilot_runs)
reason	string	Why the run is being killed, for the audit trail

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric autopilot run ID (from list_autopilot_runs)",
      "exclusiveMinimum": 0
    },
    "reason": {
      "type": "string",
      "maxLength": 200,
      "description": "Why the run is being killed, for the audit trail"
    }
  }
}

launch_campaign

Launches a new campaign or resumes a paused one. The campaign configuration is validated before launching; emails start sending per the campaign schedule.

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    }
  }
}

list_autopilot_runs

Lists the workspace's autopilot runs, newest first, with status (pending, building_icp, writing_sequence, sourcing_prospects, awaiting_approval, running, paused, completed, failed) and linked ICP/campaign IDs.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1
limit	integer	Page size (default 50, max 200)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 50, max 200)",
      "exclusiveMinimum": 0
    }
  }
}

list_blocklist_entries

Returns the suppression entries (blocked domains and email addresses) that apply to this workspace, newest first. Blocked entries are never emailed by any campaign. By default that spans both lists: this workspace's own entries and the account-wide ones inherited from the main workspace. Each entry reports which list it came from.

read-only

Argument	Type	Description
limit	integer	Page size (default 100, max 1,000)
scope	string	Which list to return: "workspace" for this workspace's own entries, "global" for the account-wide list, "all" for both (default)
offset	integer	Number of entries to skip (default 0)
search	string	Case-insensitive substring match on the domain or address

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "description": "Page size (default 100, max 1,000)",
      "exclusiveMinimum": 0
    },
    "scope": {
      "enum": [
        "workspace",
        "global",
        "all"
      ],
      "type": "string",
      "description": "Which list to return: \"workspace\" for this workspace's own entries, \"global\" for the account-wide list, \"all\" for both (default)"
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Number of entries to skip (default 0)"
    },
    "search": {
      "type": "string",
      "minLength": 1,
      "description": "Case-insensitive substring match on the domain or address"
    }
  }
}

list_campaigns

Lists cold email campaigns in the workspace with their status and stats (sent, replies, bounces). Supports pagination and filtering by status or folder.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1 (20 campaigns per page)
limit	integer	Page size (default 20, max 200)
status	string	Filter by campaign status
folderId	integer	Filter by folder ID

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1 (20 campaigns per page)",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 20, max 200)",
      "exclusiveMinimum": 0
    },
    "status": {
      "enum": [
        "not_started",
        "running",
        "completed",
        "paused",
        "draft"
      ],
      "type": "string",
      "description": "Filter by campaign status"
    },
    "folderId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Filter by folder ID",
      "exclusiveMinimum": 0
    }
  }
}

list_credit_transactions

Lists the workspace's credit ledger, newest first: every grant, spend, reservation and refund with the balance after each entry. Filter by movement kind, reason or a time window. Use it to see where credits went, or to check for a stripe_topup entry after an unconfirmed purchase_credits call. An entry with free set to true was written while the workspace's credits were free: its amount is what the action would have cost, and no credits moved.

read-only

Argument	Type	Description
kind	string	Filter by movement type
page	integer	Page number, starting at 1
limit	integer	Page size (default 50, max 200)
since	string	Only entries at or after this time (RFC3339 or YYYY-MM-DD)
until	string	Only entries at or before this time (RFC3339 or YYYY-MM-DD; a bare date means midnight UTC at the start of that day)
reason	string	Filter by what the credits were spent on or granted for

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "kind": {
      "enum": [
        "grant",
        "topup",
        "reserve",
        "commit",
        "refund",
        "expire",
        "adjustment"
      ],
      "type": "string",
      "description": "Filter by movement type"
    },
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 50, max 200)",
      "exclusiveMinimum": 0
    },
    "since": {
      "type": "string",
      "description": "Only entries at or after this time (RFC3339 or YYYY-MM-DD)"
    },
    "until": {
      "type": "string",
      "description": "Only entries at or before this time (RFC3339 or YYYY-MM-DD; a bare date means midnight UTC at the start of that day)"
    },
    "reason": {
      "enum": [
        "monthly_grant",
        "prospect_reveal",
        "ai_icp",
        "ai_sequence",
        "ai_reply",
        "stripe_topup",
        "manual_adjustment"
      ],
      "type": "string",
      "description": "Filter by what the credits were spent on or granted for"
    }
  }
}

list_dfy_orders

Lists the workspace's done-for-you orders, newest first, each with status, cost breakdown and the ordered domains and mailboxes. Internal billing and provider records are never exposed.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1
limit	integer	Page size (default 50, max 200)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 50, max 200)",
      "exclusiveMinimum": 0
    }
  }
}

list_email_verification_jobs

Lists the workspace's standalone email verification jobs, newest first, with live counts and what each has billed so far (meterEvents and spentUsd).

read-only

Argument	Type	Description
page	integer	Page number, starting at 1
size	integer	Page size (default 25, max 200)
search	string	Filter by job name

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "size": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 25, max 200)",
      "exclusiveMinimum": 0
    },
    "search": {
      "type": "string",
      "description": "Filter by job name"
    }
  }
}

list_email_verification_results

Returns one row per address with its verdict: valid, catchall_validated (the domain accepts everything, so delivery is likely but not proven), invalid, or unknown (no verdict, and not billed). Each row also carries what each provider said and how many verification credits it cost. Filter with result, where 'deliverable' means valid plus catch-all, which is what a campaign will actually send to.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1
size	integer	Page size (default 25, max 200)
jobId*	string	The job ID
result	string	Filter by verdict

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "jobId"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "size": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 25, max 200)",
      "exclusiveMinimum": 0
    },
    "jobId": {
      "type": "string",
      "minLength": 1,
      "description": "The job ID"
    },
    "result": {
      "enum": [
        "valid",
        "catchall_validated",
        "invalid",
        "unknown",
        "deliverable"
      ],
      "type": "string",
      "description": "Filter by verdict"
    }
  }
}

list_icps

Lists the workspace's stored Ideal Customer Profiles (ICPs), newest first, with their targeting criteria, whether each is AI-generated or human-edited, and the estimated audience size.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1
limit	integer	Page size (default 50, max 200)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 50, max 200)",
      "exclusiveMinimum": 0
    }
  }
}

list_inbox_placement_run_results

Returns one row per probe email of a run: which of your mailboxes sent it, which seed mailbox received it, where it landed and how many seconds it took to arrive. deliverySeconds is worth watching on its own: greylisting and throttling show up there before they show up in a placement number.

read-only

Argument	Type	Description
id*	integer	The numeric inbox placement run ID (from list_inbox_placement_runs)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric inbox placement run ID (from list_inbox_placement_runs)",
      "exclusiveMinimum": 0
    }
  }
}

list_inbox_placement_runs

Lists inbox placement runs, newest first, optionally only those of one test. Each run counts how many probe emails landed in the inbox, in spam, in a Gmail category tab (promotions) or nowhere (missing, which usually means a silent block). Counters are only final once status is completed. Any rate of -1 means NOT MEASURED yet and must never be reported as 0%.

read-only

Argument	Type	Description
limit	integer	How many runs to return (default 50, max 200)
testId	integer	Only runs of this test (from list_inbox_placement_tests)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "How many runs to return (default 50, max 200)",
      "exclusiveMinimum": 0
    },
    "testId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only runs of this test (from list_inbox_placement_tests)",
      "exclusiveMinimum": 0
    }
  }
}

list_inbox_placement_tests

Lists every inbox placement test defined in the workspace, newest first. A test is the definition: the email content, which mailboxes send it and, for a recurring test, how often it runs. Each execution of a test is a run (list_inbox_placement_runs). Inbox placement is a paid add-on: a workspace without it gets an error, not an empty list.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

list_instantly_accounts

Fetches the sending accounts of an Instantly.ai workspace using your Instantly API key, together with a pre-filled CSV for Emailchaser's bulk IMAP/SMTP connection flow. A read-only preview before an import: nothing is written to the workspace. Mailbox passwords cannot be exported from any provider, so each account is either reconnected via Google/Microsoft OAuth in the app or bulk-uploaded with app passwords using the CSV. The backend treats all non-GET calls as writes, so this needs a read & write API key.

read-only

Argument	Type	Description
instantlyApiKey*	string	Your Instantly.ai API key (Instantly → Settings → API keys)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "instantlyApiKey"
  ],
  "properties": {
    "instantlyApiKey": {
      "type": "string",
      "minLength": 1,
      "description": "Your Instantly.ai API key (Instantly → Settings → API keys)"
    }
  }
}

list_lead_finder_imports

Lists the workspace's Lead Finder adds (people added to campaigns from the contact database), newest first, each with its progress: requested, added, skipped and why, what email verification said, and credits spent.

read-only

Argument	Type	Description
limit	integer	How many to return (default 10, max 50)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 50,
      "minimum": 1,
      "description": "How many to return (default 10, max 50)"
    }
  }
}

list_leads

Lists the leads in the workspace, newest first, 20 per page. Filter by exact email to look up a single lead, or by campaign to list only that campaign's leads. This is how you find the ID of a lead you added earlier.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1
email	string	Filter by exact email address, which returns at most one lead
limit	integer	Page size (default 20, max 200)
campaignId	integer	Filter to the leads in one campaign

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "email": {
      "type": "string",
      "description": "Filter by exact email address, which returns at most one lead"
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 20, max 200)",
      "exclusiveMinimum": 0
    },
    "campaignId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Filter to the leads in one campaign",
      "exclusiveMinimum": 0
    }
  }
}

list_replies

Lists inbound emails (replies received from prospects) in the workspace, newest first, 20 per page. Filter by AI response category, campaign, lead or a time floor. responseCategory is null while AI categorization is still pending. This tool only lists. To answer a reply, write your own message with send_reply (it works for every reply, including ones with no AI draft, such as wrong_person or uncategorized), or review its AI draft (list_reply_drafts), edit it if needed (update_reply_draft) and send it with send_reply_draft.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1
limit	integer	Page size (default 20, max 200)
since	string	Only replies received at or after this time (RFC3339 or YYYY-MM-DD)
leadId	integer	Filter by lead ID
category	string	Filter by AI response category
campaignId	integer	Filter by campaign ID

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 20, max 200)",
      "exclusiveMinimum": 0
    },
    "since": {
      "type": "string",
      "description": "Only replies received at or after this time (RFC3339 or YYYY-MM-DD)"
    },
    "leadId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Filter by lead ID",
      "exclusiveMinimum": 0
    },
    "category": {
      "enum": [
        "interested",
        "not_interested",
        "wrong_person",
        "bounced",
        "out_of_office",
        "delivery_incomplete",
        "dmarc_report",
        "mixmax",
        "warmup_email",
        "unsubscribe",
        "newsletter"
      ],
      "type": "string",
      "description": "Filter by AI response category"
    },
    "campaignId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Filter by campaign ID",
      "exclusiveMinimum": 0
    }
  }
}

list_reply_drafts

Lists AI-suggested reply drafts awaiting review, newest first, 20 per page. Each draft answers the inbound reply referenced by inReplyToEmailId. Nothing here has been sent: a draft stays a draft until a human sends it from the app or send_reply_draft is called. Edit one first with update_reply_draft if the wording needs work.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1
limit	integer	Page size (default 20, max 200)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 20, max 200)",
      "exclusiveMinimum": 0
    }
  }
}

list_sender_emails

Lists the sending email accounts in the workspace, 20 per page, with their connection status, daily limits and health score. Filter to one campaign's senders, to connected or disconnected mailboxes only, or to one workspace on the account. healthScore is the account's health score: 0-100, higher is better, the share of its warm-up emails over the last 7 full days that landed in the inbox rather than spam. It moves daily as warm-up emails land in the inbox (up) or in spam (down), and is null while warm-up is off or before 20 warm-up emails were checked. Use it to pick the accounts to add to a campaign.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1
limit	integer	Page size (default 20, max 200)
spaceId	integer	Only the sender emails of this workspace (from list_workspaces)
campaignId	integer	Only the sender emails attached to this campaign
isConnected	boolean	true for mailboxes that are connected and able to send, false for disconnected ones

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number, starting at 1",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "Page size (default 20, max 200)",
      "exclusiveMinimum": 0
    },
    "spaceId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only the sender emails of this workspace (from list_workspaces)",
      "exclusiveMinimum": 0
    },
    "campaignId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only the sender emails attached to this campaign",
      "exclusiveMinimum": 0
    },
    "isConnected": {
      "type": "boolean",
      "description": "true for mailboxes that are connected and able to send, false for disconnected ones"
    }
  }
}

list_webhooks

Lists the webhook endpoints registered for the workspace, with their event type and status.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

list_workspaces

Lists the workspaces owned by the account behind the API key: the main workspace and its sub-workspaces, each with id, name, icon and creation date. isCurrent marks the workspace this key is bound to. Every other tool acts on the current workspace only; to work in another workspace, connect with that workspace's own key (create_workspace_api_key mints one).

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

mark_lead_meeting

Records that a meeting was actually booked with this lead: sets meetingBookedAt to now, sets the lead's category to meeting_booked and fires the LeadCategoryUpdate webhook. Emailchaser never infers meetings from reply text or calendars, so this explicit mark is the only way a meeting is counted (in get_campaign_stats totals.meetings and get_outcomes_report). Idempotent: repeating the call keeps the original timestamp and fires no second webhook.

Argument	Type	Description
id*	integer	The numeric lead ID (returned when the lead was created)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric lead ID (returned when the lead was created)",
      "exclusiveMinimum": 0
    }
  }
}

move_lead_to_campaign

Moves a lead from one campaign to another: the lead's unsent emails in the source campaign are deleted, and if the target campaign is running, emails for the lead are enqueued there. Use it to re-route a lead into a better-fitting campaign.

Argument	Type	Description
leadId*	integer	The numeric lead ID (returned when the lead was created)
sourceCampaignId*	integer	The campaign the lead is currently in
targetCampaignId*	integer	The campaign to move the lead into

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "sourceCampaignId",
    "leadId",
    "targetCampaignId"
  ],
  "properties": {
    "leadId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric lead ID (returned when the lead was created)",
      "exclusiveMinimum": 0
    },
    "sourceCampaignId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The campaign the lead is currently in",
      "exclusiveMinimum": 0
    },
    "targetCampaignId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The campaign to move the lead into",
      "exclusiveMinimum": 0
    }
  }
}

pause_autopilot_run

Suspends an autopilot run that is still in flight; resume later with resume_autopilot_run. Pausing never skips the approval gate. A completed or failed run cannot be paused.

Argument	Type	Description
id*	integer	The numeric autopilot run ID (from list_autopilot_runs)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric autopilot run ID (from list_autopilot_runs)",
      "exclusiveMinimum": 0
    }
  }
}

pause_campaign

Pauses a running campaign and cancels all currently scheduled emails.

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    }
  }
}

plan_autopilot

Turns a monthly budget in dollars into a concrete outbound setup: how many domains and mailboxes it buys, monthly sending volume, prospects per month, and costs (one-off setup, recurring, first month). creditsUsd, recurringUsd and firstMonthUsd value prospect credits at the list price, 1 credit ($0.033 at list) per revealed prospect, and a note says when that puts the monthly cost above the budget. Pure computation — nothing is created or charged. expectedMeetingsPerMonth is a planning estimate on pessimistic assumptions, not a promise. Use it to answer 'what does $X/month get me' before start_autopilot_run.

Argument	Type	Description
budgetUsd*	number	Total monthly budget in US dollars, inclusive of the platform subscription
platformUsd	number	Subscription cost to reserve before sizing infrastructure. Defaults to 0
maxMailboxes	integer	Cap on mailboxes regardless of budget. 0 means no cap

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "budgetUsd"
  ],
  "properties": {
    "budgetUsd": {
      "type": "number",
      "description": "Total monthly budget in US dollars, inclusive of the platform subscription",
      "exclusiveMinimum": 0
    },
    "platformUsd": {
      "type": "number",
      "minimum": 0,
      "description": "Subscription cost to reserve before sizing infrastructure. Defaults to 0"
    },
    "maxMailboxes": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cap on mailboxes regardless of budget. 0 means no cap"
    }
  }
}

purchase_credits

SPENDS REAL MONEY. Immediately charges the workspace's saved default card (the one behind the active subscription), off-session, with no confirmation step beyond this call — every successful call is a new charge. Buys 1,000 to 10,000 prospect credits at the tiered list price: $33/1k · $20/1k from 5k. The server prices the charge, so treat this as the list price and not a quote. Errors carry a machine-readable code: billing_required and payment_failed mean no money moved (fix billing or the card, then retry); credits_free means this workspace's credits are free, so nothing was charged and there is nothing to buy; temporarily_unavailable means the purchase stopped before any charge, so it is safe to retry shortly; purchase_incomplete means the card WAS charged but crediting failed — do NOT retry, support is already notified; purchase_unconfirmed means the outcome is unknown or the purchase completed without a balance to report — check list_credit_transactions for a stripe_topup entry before retrying. After a timeout or a dropped connection, check the same way before calling this again.

Argument	Type	Description
credits*	integer	How many prospect credits to buy (1,000 to 10,000)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "credits"
  ],
  "properties": {
    "credits": {
      "type": "integer",
      "maximum": 10000,
      "minimum": 1000,
      "description": "How many prospect credits to buy (1,000 to 10,000)"
    }
  }
}

refresh_icp_audience_size

Re-counts how many prospects match an ICP's targeting criteria against the live data provider and caches the result on the profile. Sizing is free — it never spends credits; only revealing contact details is metered.

Argument	Type	Description
id*	integer	The numeric ICP ID (from list_icps)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric ICP ID (from list_icps)",
      "exclusiveMinimum": 0
    }
  }
}

remove_blocklist_entries

Unblocks up to 1,000 domains or email addresses in one call, so campaigns can email them again. Pass values (domains or addresses, matched case-insensitively) and/or ids (entry IDs from list_blocklist_entries); a value that is not blocked is counted as skipped rather than failing the call. Scope defaults to "workspace" and never touches the account-wide list unless asked; removing an account-wide entry only works from the main workspace.

destructive

Argument	Type	Description
ids	array	Blocklist entry IDs to remove (from list_blocklist_entries). Provide values, ids or both
scope	string	Which list to remove from: "workspace" (default), "global", or "all"
values	array	Email addresses and/or domains to unblock, e.g. ["competitor.com", "[email protected]"] (1 to 1,000 per request)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 1000,
      "minItems": 1,
      "description": "Blocklist entry IDs to remove (from list_blocklist_entries). Provide values, ids or both"
    },
    "scope": {
      "enum": [
        "workspace",
        "global",
        "all"
      ],
      "type": "string",
      "description": "Which list to remove from: \"workspace\" (default), \"global\", or \"all\""
    },
    "values": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "maxItems": 1000,
      "minItems": 1,
      "description": "Email addresses and/or domains to unblock, e.g. [\"competitor.com\", \"[email protected]\"] (1 to 1,000 per request)"
    }
  }
}

remove_blocklist_entry

Removes one suppression entry by ID, so campaigns can email that domain or address again. This cannot be undone: the entry and the record of when it was added are gone. A sub-workspace key cannot remove an account-wide entry it merely inherits. To unblock many values at once use remove_blocklist_entries.

destructive

Argument	Type	Description
id*	integer	The numeric blocklist entry ID (from list_blocklist_entries)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric blocklist entry ID (from list_blocklist_entries)",
      "exclusiveMinimum": 0
    }
  }
}

replace_campaign_sequence

Replaces a campaign's WHOLE sequence with the steps provided. This is not a partial edit: steps you leave out are removed, so send the full sequence every time. Sending the same payload twice leaves the same result, so a retry cannot duplicate steps. Editing a running campaign is allowed and changes future sends only; already-sent emails are untouched.

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)
steps*	array	The full sequence, first email first. The first step must have delayDays 0
signature	string	Optional signature appended to every step

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "steps"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    },
    "steps": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "subject",
          "body"
        ],
        "properties": {
          "body": {
            "type": "string",
            "minLength": 1,
            "description": "Email body"
          },
          "subject": {
            "type": "string",
            "minLength": 1,
            "description": "Email subject. Supports merge tags such as {first_name} and {company_name}"
          },
          "variants": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "label",
                "subject"
              ],
              "properties": {
                "body": {
                  "type": "string",
                  "description": "Body for this variant. Omit to reuse the step's body, which is the common 'same email, different subject' test"
                },
                "label": {
                  "type": "string",
                  "maxLength": 2,
                  "minLength": 1,
                  "description": "Variant label, e.g. B. The step's own subject and body are variant A, so A must not be repeated here"
                },
                "subject": {
                  "type": "string",
                  "minLength": 1,
                  "description": "Subject line for this variant"
                }
              }
            },
            "maxItems": 25,
            "description": "Optional A/B variants for this step"
          },
          "delayDays": {
            "type": "integer",
            "maximum": 365,
            "minimum": 0,
            "description": "Days to wait after the PREVIOUS step, not after the first email. The first step must be 0 because it sends when the campaign launches. Steps at 0, 3 and 4 send on day 0, day 3 and day 7"
          },
          "contentType": {
            "enum": [
              "html",
              "text"
            ],
            "type": "string",
            "description": "Body content type. Defaults to html"
          },
          "useSameThread": {
            "type": "boolean",
            "description": "Send this follow-up in the same email thread as the first email. Defaults to true"
          }
        }
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "The full sequence, first email first. The first step must have delayDays 0"
    },
    "signature": {
      "type": "string",
      "description": "Optional signature appended to every step"
    }
  }
}

resume_autopilot_run

Resumes a paused autopilot run. A run paused before approval goes back to awaiting approval — resuming can never skip the gate. A failed run resumes from the stage it failed at once the cause (e.g. insufficient credits) is fixed.

Argument	Type	Description
id*	integer	The numeric autopilot run ID (from list_autopilot_runs)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric autopilot run ID (from list_autopilot_runs)",
      "exclusiveMinimum": 0
    }
  }
}

search_dfy_domains

Checks availability and pricing of sending domains derived from a brand name (e.g. 'acme' yields acme-mail.com and similar). Only .com and .org are supported. Free to call — use it to pick domains and see exact prices before create_dfy_order.

read-only

Argument	Type	Description
tlds	string	Comma-separated TLDs to check (default "com,org"; only com and org are supported)
limit	integer	Maximum suggestions to return
query*	string	Brand name to derive domain suggestions from

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "query"
  ],
  "properties": {
    "tlds": {
      "type": "string",
      "description": "Comma-separated TLDs to check (default \"com,org\"; only com and org are supported)"
    },
    "limit": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Maximum suggestions to return",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "description": "Brand name to derive domain suggestions from"
    }
  }
}

search_lead_finder

Searches Emailchaser's B2B contact database (Lead Finder) with explicit filters and returns one page of matching people, masked: first name, last initial, title, seniority, job function, company name, industry, size and revenue band, and location. Email addresses, domains, LinkedIn URLs and phone numbers are never shown; contact details are revealed only when people are added to a campaign with add_lead_finder_prospects. Spends no credits, but every result row uses the account's daily browsing allowance (rowsLeftToday; 2,000 rows a day by default, 250 on a trial). An account may start 20 searches a minute. Searches that find nobody also draw on a bucket of 120 that refills one every 30 seconds; while it is empty every new search is refused for a moment (rate_limited, reason empty_searches, with retryAfterSeconds). The same page asked for again within 10 minutes costs nothing. total is the exact audience size only when totalIsExact is true; otherwise it is a lower bound (often 50,000). If status is running or totalStatus is pending, call get_lead_finder_search with the searchId: total, hasMore and maxPage are recomputed then. status failed means the search did not run, and error says why (rate_limited, timeout, provider_blocked, budget_exhausted, invalid_filters, expired or internal): it is not an empty audience, so try again later. Each result's ref is what add_lead_finder_prospects takes, valid for 60 minutes after its page was last shown. inWorkspace means Lead Finder added that person to this workspace and their lead is still there, so adding them again is skipped for free; someone who is a lead from another source shows false, and adding them is skipped for free too. A read-only key may use this tool.

read-only

Argument	Type	Description
page	integer	Results page, starting at 1 (default 1). The deepest page is 100 by default, and a search's maxPage says how deep that audience goes
filters*	object

send_reply

Answers an inbound reply with your own message, in the same email thread and from the mailbox the conversation runs through (in a conversation the prospect started, your mailbox they wrote to). It works for every inbound reply, including the ones Emailchaser writes no AI draft for (wrong_person, uncategorized), and it is how you send a second message in a conversation that went quiet: answer the prospect's latest reply again. The message is scheduled at once, goes out within about a minute and cannot be recalled; get_lead_conversation then shows its status move from scheduled to sent. Only id and body are required. Leave to out to Reply All: the person who wrote goes in To and everyone else they addressed in Cc, never one of your own mailboxes. Set to to choose the recipients yourself: then to, cc and bcc are used exactly as given (cc is only read together with to; bcc works either way), at most 20 addresses in all. There is no subject: the answer keeps the thread's subject with "Re: " in front, so the thread never breaks. contentType is "text" by default; use "html" only when body is HTML (paragraphs, line breaks, bold, italics, links, lists and headings are kept; images, tables and inline styles are removed). Merge tags such as {first_name} and spintax such as {Hi|Hello} are filled in when it sends. No signature is added: put yours in body. attachments takes at most 5 files, 10 MB in total. Refused with 409 when the id is not an inbound reply or an identical body went to it less than 60 seconds ago (so a retry after a timeout never sends twice), 422 when there is no connected sender mailbox or recipient, the lead has unsubscribed or an earlier email to the recipient hard-bounced, and 429 after 20 answers to one reply in an hour. Needs a read & write key.

Argument	Type	Description
cc	array	Cc recipients; only read together with to
id*	integer	The numeric ID of the inbound reply to answer (from list_replies, or an inbound item of get_lead_conversation)

send_reply_draft

Sends an AI reply draft to the prospect through the conversation's sender mailbox; it is scheduled for delivery right away and cannot be recalled. The draft's CURRENT subject and body are what goes out, so read it first (list_reply_drafts or get_lead_conversation) and fix it with update_reply_draft if needed. Refused with 409 for anything that is not a sendable AI reply draft (already sent or scheduled emails, inbound replies, sequence templates) and with 422 when the conversation has no connected sender mailbox or no resolvable recipient.

Argument	Type	Description
id*	integer	The numeric reply draft ID (from list_reply_drafts)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric reply draft ID (from list_reply_drafts)",
      "exclusiveMinimum": 0
    }
  }
}

set_billing_profile

Creates or replaces the workspace's registrant and postal contact details. Do this before create_dfy_order: domain registration files these details with the registrar, so every field except addressLineTwo is required. Idempotent: sending the same body twice leaves the same state.

Argument	Type	Description
city*	string	City
phone*	string	Phone number without the country code
state*	string	State, province or region
company*	string	Company name
country*	string	ISO 3166-1 alpha-2 country code, e.g. US
phoneCc*	string	Telephone country calling code without the plus, e.g. 1
lastName*	string	Registrant last name
firstName*	string	Registrant first name
postalCode

set_primary_icp

Promotes an Ideal Customer Profile to the workspace's active one, demoting any existing primary. At most one profile is primary per workspace.

Argument	Type	Description
id*	integer	The numeric ICP ID (from list_icps)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric ICP ID (from list_icps)",
      "exclusiveMinimum": 0
    }
  }
}

source_prospects

SPENDS CREDITS. Queues a background job that searches Emailchaser's contact database with an Ideal Customer Profile's targeting criteria, reveals the matching people and adds them to the campaign as leads. Uses the workspace's primary ICP when icpId is omitted, and adds 50 prospects unless count says otherwise (max 500 per call). Every stored prospect costs the reveal price in credits (1 at the time of writing; the response reports creditsPerProspect and estimatedCredits, the most this batch can cost). Duplicates, blocklisted domains and contacts without an email address are filtered out before any credit is spent. Asynchronous: poll list_leads with campaignId to watch the prospects arrive. Calling again for the same campaign and profile pages deeper into the audience instead of re-revealing (and re-paying for) the same people. Check get_credit_balance and get_audience_size first.

Argument	Type	Description
count	integer	How many prospects to add in this call (default 50, max 500)
icpId	integer	The ICP whose targeting criteria drive the search (from list_icps). Defaults to the primary ICP
campaignId*	integer	The campaign the sourced prospects are added to (from list_campaigns)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "campaignId"
  ],
  "properties": {
    "count": {
      "type": "integer",
      "maximum": 500,
      "minimum": 1,
      "description": "How many prospects to add in this call (default 50, max 500)"
    },
    "icpId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The ICP whose targeting criteria drive the search (from list_icps). Defaults to the primary ICP",
      "exclusiveMinimum": 0
    },
    "campaignId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The campaign the sourced prospects are added to (from list_campaigns)",
      "exclusiveMinimum": 0
    }
  }
}

start_autopilot_run

Starts an autopilot run for a company website: the AI builds an ICP, writes a sequence and checks that prospects match, then STOPS at an approval gate. Nothing is revealed, charged or sent and no sending accounts are bought until approve_autopilot_run is called; approval then reveals the first batch at 1 credit ($0.033 at list) per prospect, up to targetProspects and at most 2,000. The call is refused when the wallet cannot cover that batch. When budgetUsd is given, the sized budget plan is snapshotted on the run and returned in this response, the only response that carries it, with credits valued at list, and targetProspects defaults to the plan's monthly prospects. Without budgetUsd the run can never buy sending accounts, so the workspace needs one connected before approval or the run fails. Requires an active subscription (any plan).

Argument	Type	Description
website*	string	The company website to seed the run from, e.g. https://acme.com
budgetUsd	number	Monthly budget in US dollars; sizes a plan that is snapshotted on the run
replyMode	string	How inbound replies are handled: off, draft (default: AI drafts a reply for a human to send), approve, or auto. auto SENDS AI replies to interested prospects without review, so only pass it when the user has asked for that explicitly
maxMailboxes	integer	Cap on the budget plan's mailboxes. 0 means no cap
targetProspects	integer	How many prospects approval reveals first, at 1 credit ($0.033 at list) each (at most 2,000 in one batch). Defaults to the budget plan's monthly prospects when budgetUsd is given, else 50

unmark_lead_meeting

Removes the booked-meeting mark from a lead, e.g. when it was recorded by mistake or the meeting was canceled: clears meetingBookedAt and, when the category is still meeting_booked, reverts it to interested. The original booked time is lost. Idempotent: unmarking a lead with no meeting is a no-op.

destructive

Argument	Type	Description
id*	integer	The numeric lead ID (returned when the lead was created)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric lead ID (returned when the lead was created)",
      "exclusiveMinimum": 0
    }
  }
}

update_blocklist_entry

Changes one suppression entry's blocked value, its scope, or both; provide at least one. A value containing @ is stored as an email address, otherwise as a domain, so an entry can be converted between the two. Moving an entry to or from the account-wide list ("global") requires the main workspace's key and moves the entry onto the main workspace.

Argument	Type	Description
id*	integer	The numeric blocklist entry ID (from list_blocklist_entries)
scope	string	"workspace" blocks for this workspace only; "global" blocks for every workspace on the account
value	string	The new domain or email address to block

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric blocklist entry ID (from list_blocklist_entries)",
      "exclusiveMinimum": 0
    },
    "scope": {
      "enum": [
        "workspace",
        "global"
      ],
      "type": "string",
      "description": "\"workspace\" blocks for this workspace only; \"global\" blocks for every workspace on the account"
    },
    "value": {
      "type": "string",
      "minLength": 1,
      "description": "The new domain or email address to block"
    }
  }
}

update_campaign

Updates campaign properties such as name, emoji, timezone, sending limits, the minimum email account health score and deliverability settings. Only the provided fields are changed. A new minimum health score re-plans a running campaign at once.

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)
name	string	New campaign name
emoji	string	Campaign emoji
timezone	string	IANA timezone, e.g. America/New_York
dailyLimit	integer	Cap on the total emails (initial + follow-ups) the campaign may schedule per calendar day in its timezone. Omit for no campaign-level cap; per-mailbox limits still apply
isEnabledLlm	boolean	Enable AI (LLM) features for this campaign
minimumHealthScore	integer	Minimum email account health score for this campaign, 1-100 (see healthScore in list_sender_emails). An account below it, or with no score yet, sends nothing in this campaign, first emails and follow-ups alike, until its score is back at or above it; its conversations wait for it and never move to another account. 0 means no minimum; omit it to leave the setting as it is
allowNonBusinessEmails

update_campaign_schedule

Updates a campaign's sending schedule: timezone, sending days, daily time window and frequency.

Argument	Type	Description
id*	integer	The numeric campaign ID (from list_campaigns)
sendAt	string	Exact send time for single-lead scheduled campaigns (ISO 8601)
timezone*	string	IANA timezone the schedule runs in, e.g. Europe/London
endSchedule	string	Daily sending window end time, e.g. 17:00
daysSchedule	array	Days of the week to send on, e.g. ["monday", "tuesday", "wednesday"]
everySchedule	integer	Sending frequency interval
startSchedule	string	Daily sending window start time, e.g. 09:00
maximumTimeBetweenEmails	integer	Maximum gap between two sends, in minutes
minimumTimeBetweenEmails	integer	Minimum gap between two sends, in minutes

update_icp

Applies a partial edit to an Ideal Customer Profile: omitted fields are left unchanged, and sending an empty list clears that list. Any edit marks the profile as human-authored.

Argument	Type	Description
id*	integer	The numeric ICP ID (from list_icps)
name	string	New profile name
titles	array	Job titles to target, e.g. ["CEO", "Head of Sales"]
summary	string	New one-to-three-sentence summary
keywords	array	Free-text keywords, e.g. ["b2b saas"]
locations	array	Locations, e.g. ["United States"]
industries	array	Industries, e.g. ["Software"]
seniorities	array	Seniority levels, e.g. ["owner", "director"]
companySizes	array	Company headcount ranges, e.g. ["11-50", "51-200"]

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric ICP ID (from list_icps)",
      "exclusiveMinimum": 0
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "New profile name"
    },
    "titles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Job titles to target, e.g. [\"CEO\", \"Head of Sales\"]"
    },
    "summary": {
      "type": "string",
      "description": "New one-to-three-sentence summary"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Free-text keywords, e.g. [\"b2b saas\"]"
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Locations, e.g. [\"United States\"]"
    },
    "industries": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Industries, e.g. [\"Software\"]"
    },
    "seniorities": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Seniority levels, e.g. [\"owner\", \"director\"]"
    },
    "companySizes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Company headcount ranges, e.g. [\"11-50\", \"51-200\"]"
    }
  }
}

update_lead

Updates a lead's contact details. Only the provided fields are changed.

Argument	Type	Description
id*	integer	The numeric lead ID (returned when the lead was created)
email	string	Lead email address
phone	string	Phone number
title	string	Job title
company	string	Company name
website	string	Company website URL
lastName	string	Lead last name
linkedin	string	LinkedIn profile URL
firstName	string	Lead first name
middleName	string	Lead middle name
customVariables	object	Any attribute the named fields do not cover, e.g. { pageVisited: '/pricing' }. Each key becomes a merge tag usable in email copy as {key}. Keys match case-insensitively with spaces treated as underscores, so 'Page Visited' and 'page_visited' are the same tag.

update_lead_category

Sets or corrects a lead's category (tag), typically to fix an AI misclassification of a reply. Setting meeting_booked behaves exactly like mark_lead_meeting. Changing the category away from meeting_booked does NOT clear the booked-meeting mark; use unmark_lead_meeting for that. A real change fires the LeadCategoryUpdate webhook; setting the value the lead already has is a no-op.

Argument	Type	Description
id*	integer	The numeric lead ID (returned when the lead was created)
category*	string	The category to set

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "category"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric lead ID (returned when the lead was created)",
      "exclusiveMinimum": 0
    },
    "category": {
      "enum": [
        "interested",
        "not_interested",
        "bounced",
        "out_of_office",
        "delivery_incomplete",
        "meeting_booked"
      ],
      "type": "string",
      "description": "The category to set"
    }
  }
}

update_reply_draft

Edits the subject and/or body of an AI reply draft before it goes out. Provide at least one field; provided fields must be non-empty. This never changes the draft's status or sends anything: the draft stays a draft until a human sends it from the app or send_reply_draft is called. Emails that are not AI reply drafts (sent or scheduled emails, inbound replies, sequence templates) are refused.

Argument	Type	Description
id*	integer	The numeric reply draft ID (from list_reply_drafts)
body	string	New body
subject	string	New subject line

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric reply draft ID (from list_reply_drafts)",
      "exclusiveMinimum": 0
    },
    "body": {
      "type": "string",
      "minLength": 1,
      "description": "New body"
    },
    "subject": {
      "type": "string",
      "minLength": 1,
      "description": "New subject line"
    }
  }
}

update_sender_email

Updates a connected sending email account's display name, signature or daily sending limits. Only the provided fields are changed. Warm-up settings are separate: use update_sender_email_warmup. The returned account includes its healthScore (see get_sender_email).

Argument	Type	Description
id*	integer	The numeric sender email ID (from list_sender_emails)
givenName	string	Sender first name
signature	string	Email signature appended to sends from this mailbox
familyName	string	Sender last name
currentDailyLimit	integer	Today's effective daily limit
toggleGradualBuildUp	boolean	Ramp the daily limit up gradually (recommended for new mailboxes)
maximumSendingsLimitPerDay	integer	Maximum emails this mailbox may send per day
minimumSendingsLimitPerDay	integer	Minimum emails per day during gradual build-up

Input schema (JSON)

update_sender_email_warmup

Switches warm-up on or off and changes the warm-up ramp for up to 100 mailboxes in one call, applying the same settings to each. Only the settings provided change. Warm-up sends startLimit emails on the first day and adds increaseBy each sending day until it reaches capLimit a day; this is separate from campaign sending limits. A mailbox that has never warmed needs enabled: true to take any other setting, and is then enrolled with the defaults (2 a day, 2 more each day, up to 10 a day, weekdays only, UTC) plus the settings given. Raising capLimit on a mailbox that is already warming lifts today's target without restarting its ramp. Each mailbox succeeds or fails on its own: the result lists the updated mailboxes' settings, each with its healthScore (see get_sender_email_warmup), under updated, and any failures with the reason under failed.

Argument	Type	Description
ids*	array	Sender email IDs to update (from list_sender_emails)
enabled	boolean	true switches warm-up on, false switches it off
capLimit	integer	Most warm-up emails per day; the ramp stops here
timezone	string	IANA timezone for the warm-up send window, e.g. America/New_York
increaseBy	integer	Warm-up emails added each sending day until the cap
startLimit	integer	Warm-up emails on the first day

update_webhook

Updates a registered webhook's name, URL, event type or enabled state. Only the provided fields are changed. Disabling a webhook stops deliveries without deleting it.

Argument	Type	Description
id*	integer	The numeric webhook ID (from list_webhooks)
url	string	New HTTPS URL to receive events
name	string	New display name
type	string	New event type
isEnabled	boolean	Enable or disable deliveries without deleting the webhook

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric webhook ID (from list_webhooks)",
      "exclusiveMinimum": 0
    },
    "url": {
      "type": "string",
      "description": "New HTTPS URL to receive events"
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "New display name"
    },
    "type": {
      "enum": [
        "EmailSent",
        "EmailReply",
        "EmailBounce",
        "LeadCategoryUpdate",
        "LeadCreated",
        "CampaignStatusChanged"
      ],
      "type": "string",
      "description": "New event type"
    },
    "isEnabled": {
      "type": "boolean",
      "description": "Enable or disable deliveries without deleting the webhook"
    }
  }
}

Argument	Type	Description
refs	array	Refs of the people to add, from search_lead_finder results. Duplicates and blanks are dropped before sending; up to 1,000 different people per add by default (get_lead_finder_filters has the limit that applies). Use either refs, or filters with count
count	integer	How many people not yet in the workspace to add with filters (1 to 5,000 by default; get_lead_finder_filters has the limit that applies)
filters	object	Add people matching these filters (same shape as search_lead_finder). Needs count. The matches are walked from the top every time and people already in the workspace are skipped, so a repeat adds the next count people
campaignId*	integer	The numeric campaign ID (from list_campaigns)
verifyEmails	boolean	Check each address with the paid email verification waterfall before adding it (default true): one or two checks per address, billed on the next invoice, including addresses that turn out invalid. Invalid addresses are skipped and cost no credits; catch-all and unconfirmed ones are still added and charged, and so is every address once the monthly verification spend limit is reached. false skips verification

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "campaignId"
  ],
  "properties": {
    "refs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 10000,
      "minItems": 1,
      "description": "Refs of the people to add, from search_lead_finder results. Duplicates and blanks are dropped before sending; up to 1,000 different people per add by default (get_lead_finder_filters has the limit that applies). Use either refs, or filters with count"
    },
    "count": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 1,
      "description": "How many people not yet in the workspace to add with filters (1 to 5,000 by default; get_lead_finder_filters has the limit that applies)"
    },
    "filters": {
      "type": "object",
      "properties": {
        "cities": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Cities, free text matched inside the person's location. Only on their own or with countries"
        },
        "states": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "States or provinces, free text matched inside the person's location. Only on their own or with countries"
        },
        "domains": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer domains to include, e.g. acme.com (up to 1,000 by default)"
        },
        "regions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Regions the person is in (e.g. EMEA), values from get_lead_finder_filters"
        },
        "revenue": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer revenue bands, values from get_lead_finder_filters"
        },
        "countries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Countries the person is in, values from get_lead_finder_filters. Use countries, regions or continents, never two of them"
        },
        "jobTitles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Job titles to include, free text, each an OR term (e.g. \"Head of Sales\")"
        },
        "continents": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Continents the person is in, values from get_lead_finder_filters"
        },
        "industries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer industries, values from get_lead_finder_filters"
        },
        "companyName": {
          "type": "string",
          "description": "One phrase matched against the employer's name (up to 100 characters)"
        },
        "seniorities": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Seniority levels, values from get_lead_finder_filters"
        },
        "companySizes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer headcount bands (e.g. \"51 to 200\"), values from get_lead_finder_filters"
        },
        "jobFunctions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Job functions, values from get_lead_finder_filters"
        },
        "technologies": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Tools the employer uses, free text (e.g. HubSpot)"
        },
        "excludeDomains": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer domains to leave out (up to 1,000 by default)"
        },
        "companyKeywords": {
          "type": "string",
          "description": "One phrase matched against what the employer does (up to 100 characters)"
        },
        "excludeCountries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Countries to leave out, values from get_lead_finder_filters"
        },
        "excludeJobTitles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Job titles to leave out, free text"
        },
        "excludeIndustries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Industries to leave out"
        },
        "headquartersCountries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Countries the employer is headquartered in, values from get_lead_finder_filters"
        },
        "excludeHeadquartersCountries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Headquarters countries to leave out"
        }
      },
      "description": "Add people matching these filters (same shape as search_lead_finder). Needs count. The matches are walked from the top every time and people already in the workspace are skipped, so a repeat adds the next count people",
      "additionalProperties": false
    },
    "campaignId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    },
    "verifyEmails": {
      "type": "boolean",
      "description": "Check each address with the paid email verification waterfall before adding it (default true): one or two checks per address, billed on the next invoice, including addresses that turn out invalid. Invalid addresses are skipped and cost no credits; catch-all and unconfirmed ones are still added and charged, and so is every address once the monthly verification spend limit is reached. false skips verification"
    }
  }
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "email",
    "password",
    "imapServerUrl",
    "smtpServerUrl"
  ],
  "properties": {
    "email": {
      "type": "string",
      "minLength": 1,
      "description": "The mailbox address, on a business domain"
    },
    "lastName": {
      "type": "string",
      "description": "Sender last name"
    },
    "password": {
      "type": "string",
      "minLength": 1,
      "description": "App password for the mailbox, not the account login password"
    },
    "firstName": {
      "type": "string",
      "description": "Sender first name"
    },
    "loginString": {
      "type": "string",
      "description": "Login username if it differs from the email address"
    },
    "imapServerUrl": {
      "type": "string",
      "minLength": 1,
      "description": "IMAP host, optionally with a port, e.g. imap.fastmail.com:993"
    },
    "smtpServerUrl": {
      "type": "string",
      "minLength": 1,
      "description": "SMTP host, optionally with a port, e.g. smtp.fastmail.com:587"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "flow": {
      "enum": [
        "multiple_leads_scheduled",
        "api"
      ],
      "type": "string",
      "description": "Campaign flow. Defaults to multiple_leads_scheduled, which behaves exactly like a campaign created in the app. Only pass api if you specifically want lead validation skipped at launch"
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Campaign name"
    },
    "emoji": {
      "type": "string",
      "maxLength": 10,
      "minLength": 1,
      "description": "Campaign emoji shown in the app. Defaults to a generic one"
    },
    "timezone": {
      "type": "string",
      "description": "IANA timezone, e.g. America/New_York"
    },
    "dailyLimit": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Cap on the total emails (initial + follow-ups) the campaign may schedule per calendar day in its timezone. Omit for no campaign-level cap; per-mailbox limits still apply",
      "exclusiveMinimum": 0
    },
    "isEnabledLlm": {
      "type": "boolean",
      "description": "Enable AI (LLM) features for this campaign"
    },
    "minimumHealthScore": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Minimum email account health score for this campaign, 1-100 (see healthScore in list_sender_emails). An account below it, or with no score yet, sends nothing in this campaign, first emails and follow-ups alike, until its score is back at or above it; its conversations wait for it and never move to another account. 0 means no minimum; omit it to leave the setting as it is"
    },
    "allowNonBusinessEmails": {
      "type": "boolean",
      "description": "Allow sending to free mailbox providers (gmail.com, etc.)"
    },
    "isEnabledEmailVerifier": {
      "type": "boolean",
      "description": "Verify lead emails before sending"
    },
    "ignoreOutOfOfficeReplies": {
      "type": "boolean",
      "description": "Do not stop follow-ups on out-of-office replies"
    },
    "maximumTimeBetweenEmails": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Maximum gap between two sends, in minutes"
    },
    "minimumTimeBetweenEmails": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Minimum gap between two sends, in minutes"
    },
    "isEnabledCatchallValidated": {
      "type": "boolean",
      "description": "Send to catch-all validated addresses"
    },
    "isEnabledStopFollowUpsOnReply": {
      "type": "boolean",
      "description": "Stop follow-ups to a lead once they reply"
    },
    "isEnabledIgnoreHardBouncedLeads": {
      "type": "boolean",
      "description": "Skip leads that previously hard-bounced"
    },
    "isEnabledSkipLeadIfAlreadyExists": {
      "type": "boolean",
      "description": "Skip leads that already exist in the workspace"
    },
    "maximumSendingLimitPerSenderEmail": {
      "type": "integer",
      "maximum": 10000,
      "minimum": 1,
      "description": "Daily sending limit per sender email account"
    },
    "isEnabledStopFollowUpsForSameCompany": {
      "type": "boolean",
      "description": "Company reply stop: once a lead replies (out-of-office and other automatic replies don't count), stop emailing the other leads at the same company in this campaign. Subdomains count as the same company; personal addresses like @gmail.com never do. On by default"
    },
    "isEnabledIgnoreLeadsWhoAlreadyResponded": {
      "type": "boolean",
      "description": "Skip leads who already responded in another campaign"
    },
    "maximumSendingLimitPerSenderEmailVariation": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Random daily variation applied to the sending limit"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "filters"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 1,
      "description": "Results page, starting at 1 (default 1). The deepest page is 100 by default, and a search's maxPage says how deep that audience goes"
    },
    "filters": {
      "type": "object",
      "properties": {
        "cities": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Cities, free text matched inside the person's location. Only on their own or with countries"
        },
        "states": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "States or provinces, free text matched inside the person's location. Only on their own or with countries"
        },
        "domains": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer domains to include, e.g. acme.com (up to 1,000 by default)"
        },
        "regions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Regions the person is in (e.g. EMEA), values from get_lead_finder_filters"
        },
        "revenue": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer revenue bands, values from get_lead_finder_filters"
        },
        "countries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Countries the person is in, values from get_lead_finder_filters. Use countries, regions or continents, never two of them"
        },
        "jobTitles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Job titles to include, free text, each an OR term (e.g. \"Head of Sales\")"
        },
        "continents": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Continents the person is in, values from get_lead_finder_filters"
        },
        "industries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer industries, values from get_lead_finder_filters"
        },
        "companyName": {
          "type": "string",
          "description": "One phrase matched against the employer's name (up to 100 characters)"
        },
        "seniorities": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Seniority levels, values from get_lead_finder_filters"
        },
        "companySizes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer headcount bands (e.g. \"51 to 200\"), values from get_lead_finder_filters"
        },
        "jobFunctions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Job functions, values from get_lead_finder_filters"
        },
        "technologies": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Tools the employer uses, free text (e.g. HubSpot)"
        },
        "excludeDomains": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Employer domains to leave out (up to 1,000 by default)"
        },
        "companyKeywords": {
          "type": "string",
          "description": "One phrase matched against what the employer does (up to 100 characters)"
        },
        "excludeCountries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Countries to leave out, values from get_lead_finder_filters"
        },
        "excludeJobTitles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Job titles to leave out, free text"
        },
        "excludeIndustries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Industries to leave out"
        },
        "headquartersCountries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Countries the employer is headquartered in, values from get_lead_finder_filters"
        },
        "excludeHeadquartersCountries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Headquarters countries to leave out"
        }
      },
      "description": "Who to look for. Every field is optional but at least one include filter is required. Free-text fields take up to 50 values of up to 100 characters each (get_lead_finder_filters has the limits that apply); a value with commas is split into one value per comma, and blank values are ignored. A filter the API cannot use is refused with the field, value and reason named.",
      "additionalProperties": false
    },
    "pageSize": {
      "anyOf": [
        {
          "type": "number",
          "const": 25
        },
        {
          "type": "number",
          "const": 50
        }
      ],
      "description": "People per page: 25 (default) or 50"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "body"
  ],
  "properties": {
    "cc": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email",
        "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
      },
      "description": "Cc recipients; only read together with to"
    },
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric ID of the inbound reply to answer (from list_replies, or an inbound item of get_lead_conversation)",
      "exclusiveMinimum": 0
    },
    "to": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email",
        "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
      },
      "minItems": 1,
      "description": "Recipients. Leave out to Reply All"
    },
    "bcc": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email",
        "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
      },
      "description": "Bcc recipients, with or without to"
    },
    "body": {
      "type": "string",
      "minLength": 1,
      "description": "Your message: plain text, or HTML when contentType is \"html\""
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "fileName",
          "contentBase64"
        ],
        "properties": {
          "fileName": {
            "type": "string",
            "minLength": 1,
            "description": "File name, e.g. proposal.pdf"
          },
          "contentBase64": {
            "type": "string",
            "minLength": 1,
            "description": "The file's bytes, base64-encoded"
          }
        }
      },
      "maxItems": 5,
      "description": "At most 5 files, 10 MB in total"
    },
    "contentType": {
      "enum": [
        "text",
        "html"
      ],
      "type": "string",
      "description": "\"text\" (default) or \"html\""
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric campaign ID (from list_campaigns)",
      "exclusiveMinimum": 0
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "New campaign name"
    },
    "emoji": {
      "type": "string",
      "maxLength": 10,
      "minLength": 1,
      "description": "Campaign emoji"
    },
    "timezone": {
      "type": "string",
      "description": "IANA timezone, e.g. America/New_York"
    },
    "dailyLimit": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Cap on the total emails (initial + follow-ups) the campaign may schedule per calendar day in its timezone. Omit for no campaign-level cap; per-mailbox limits still apply",
      "exclusiveMinimum": 0
    },
    "isEnabledLlm": {
      "type": "boolean",
      "description": "Enable AI (LLM) features for this campaign"
    },
    "minimumHealthScore": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Minimum email account health score for this campaign, 1-100 (see healthScore in list_sender_emails). An account below it, or with no score yet, sends nothing in this campaign, first emails and follow-ups alike, until its score is back at or above it; its conversations wait for it and never move to another account. 0 means no minimum; omit it to leave the setting as it is"
    },
    "allowNonBusinessEmails": {
      "type": "boolean",
      "description": "Allow sending to free mailbox providers (gmail.com, etc.)"
    },
    "isEnabledEmailVerifier": {
      "type": "boolean",
      "description": "Verify lead emails before sending"
    },
    "ignoreOutOfOfficeReplies": {
      "type": "boolean",
      "description": "Do not stop follow-ups on out-of-office replies"
    },
    "maximumTimeBetweenEmails": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Maximum gap between two sends, in minutes"
    },
    "minimumTimeBetweenEmails": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Minimum gap between two sends, in minutes"
    },
    "isEnabledCatchallValidated": {
      "type": "boolean",
      "description": "Send to catch-all validated addresses"
    },
    "isEnabledStopFollowUpsOnReply": {
      "type": "boolean",
      "description": "Stop follow-ups to a lead once they reply"
    },
    "isEnabledIgnoreHardBouncedLeads": {
      "type": "boolean",
      "description": "Skip leads that previously hard-bounced"
    },
    "isEnabledSkipLeadIfAlreadyExists": {
      "type": "boolean",
      "description": "Skip leads that already exist in the workspace"
    },
    "maximumSendingLimitPerSenderEmail": {
      "type": "integer",
      "maximum": 10000,
      "minimum": 1,
      "description": "Daily sending limit per sender email account"
    },
    "isEnabledStopFollowUpsForSameCompany": {
      "type": "boolean",
      "description": "Company reply stop: once a lead replies (out-of-office and other automatic replies don't count), stop emailing the other leads at the same company in this campaign. Subdomains count as the same company; personal addresses like @gmail.com never do. On by default"
    },
    "isEnabledStopFollowUpsAcrossCampaigns": {
      "type": "boolean",
      "description": "Stop follow-ups to a lead in this campaign once they reply in any campaign"
    },
    "isEnabledIgnoreLeadsWhoAlreadyResponded": {
      "type": "boolean",
      "description": "Skip leads who already responded in another campaign"
    },
    "maximumSendingLimitPerSenderEmailVariation": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Random daily variation applied to the sending limit"
    }
  }
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The numeric sender email ID (from list_sender_emails)",
      "exclusiveMinimum": 0
    },
    "givenName": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Sender first name"
    },
    "signature": {
      "type": "string",
      "description": "Email signature appended to sends from this mailbox"
    },
    "familyName": {
      "type": "string",
      "maxLength": 255,
      "description": "Sender last name"
    },
    "currentDailyLimit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 0,
      "description": "Today's effective daily limit"
    },
    "toggleGradualBuildUp": {
      "type": "boolean",
      "description": "Ramp the daily limit up gradually (recommended for new mailboxes)"
    },
    "maximumSendingsLimitPerDay": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum emails this mailbox may send per day"
    },
    "minimumSendingsLimitPerDay": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Minimum emails per day during gradual build-up"
    }
  }
}