> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Smartlead

> Smartlead is a sales engagement platform for managing cold email campaigns, leads, sending accounts, inbox activity, deliverability, prospecting, and sender provisioning.

![Smartlead logo](https://mintcdn.com/composio-preview/B09iGux45A5cYDuO/images/toolkits/smartlead.svg?fit=max\&auto=format\&n=B09iGux45A5cYDuO\&q=85\&s=3f80f159d9afc19ea46324eb50745dd2)

* **Category:** ai sales tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 51
* **Triggers:** 0
* **Slug:** `SMARTLEAD`
* **Version:** 20261103\_00

## Tools

> [accordion] Add Campaign Leads
>
> **Slug:** `SMARTLEAD_ADD_CAMPAIGN_LEADS`
>
> Import up to 400 leads into a Smartlead campaign with optional duplicate, block-list, unsubscribe-list, and bounce-list controls. Adding leads to an ACTIVE campaign starts outreach to them immediately.
>
> #### Input Parameters
>
> **settings** `object`
>
> Optional duplicate, suppression-list, bounce-list, and ID-return controls.
>
> **lead\_list** `array` *required*
>
> Between 1 and 400 leads to import into the campaign.
>
> **campaign\_id** `integer` *required*
>
> Campaign that should receive the leads.
>
> **import\_type** `string`
>
> Optional Smartlead import type for leads sourced from existing lists.
>
> **lead\_list\_ids** `array`
>
> Existing positive lead-list IDs to include in this campaign import.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Configure Campaign Schedule
>
> **Slug:** `SMARTLEAD_CONFIGURE_CAMPAIGN_SCHEDULE`
>
> Configure the timezone, sending days, daily time window, pacing, and optional new-lead limit for a Smartlead campaign.
>
> #### Input Parameters
>
> **end\_hour** `string` *required*
>
> End of the daily sending window in 24-hour HH:MM format.
>
> **timezone** `string` *required*
>
> IANA timezone for the sending window.
>
> **start\_hour** `string` *required*
>
> Start of the daily sending window in 24-hour HH:MM format.
>
> **campaign\_id** `integer` *required*
>
> Campaign ID whose sending schedule should be configured.
>
> **days\_of\_the\_week** `array` *required*
>
> Days when emails may be sent, using 0 for Sunday through 6 for Saturday.
>
> **min\_time\_btw\_emails** `integer`
>
> Optional minimum number of minutes between consecutive campaign emails.
>
> **max\_new\_leads\_per\_day** `integer`
>
> Optional maximum number of new leads contacted per day.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Draft Campaign
>
> **Slug:** `SMARTLEAD_CREATE_CAMPAIGN`
>
> Create a new campaign in DRAFTED status. This creates persistent account data but does not send email or start the campaign.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Distinct name for the draft campaign.
>
> **client\_id** `integer`
>
> Client sub-account ID that should own the campaign, if applicable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Smart Delivery Folder
>
> **Slug:** `SMARTLEAD_CREATE_DELIVERY_FOLDER`
>
> Create an organizational folder for Smart Delivery tests. This creates persistent data but does not run or send a test.
>
> #### Input Parameters
>
> **folder\_name** `string` *required*
>
> Distinct name for the new Smart Delivery test folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Campaign
>
> **Slug:** `SMARTLEAD_DELETE_CAMPAIGN`
>
> Permanently delete a campaign and all associated sequences, mappings, and statistics. This is irreversible and requires explicit confirmation.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> Campaign ID to permanently delete.
>
> **confirm\_irreversible** `boolean` *required*
>
> Must be true to acknowledge that deleting the campaign and its associated data is permanent. This confirmation is not sent to Smartlead.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Campaign Lead
>
> **Slug:** `SMARTLEAD_DELETE_CAMPAIGN_LEAD`
>
> Remove one lead from a selected campaign without deleting the campaign.
>
> #### Input Parameters
>
> **lead\_id** `integer` *required*
>
> Lead to remove from the campaign.
>
> **campaign\_id** `integer` *required*
>
> Campaign containing the lead to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Smart Delivery Folder
>
> **Slug:** `SMARTLEAD_DELETE_DELIVERY_FOLDER`
>
> Delete an empty Smart Delivery folder. The folder must contain no tests, and deletion requires explicit confirmation.
>
> #### Input Parameters
>
> **folder\_id** `string` *required*
>
> ID of the empty Smart Delivery folder to delete.
>
> **confirm\_delete** `boolean` *required*
>
> Must be true to acknowledge deletion of the empty folder. This confirmation is validated locally and is not sent to Smartlead.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaign
>
> **Slug:** `SMARTLEAD_GET_CAMPAIGN`
>
> Get configuration and performance summary for one Smartlead campaign by ID.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> Campaign ID returned by a list or create campaign operation.
>
> **include\_tags** `boolean`
>
> Whether to include campaign tags in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaign Analytics
>
> **Slug:** `SMARTLEAD_GET_CAMPAIGN_ANALYTICS`
>
> Retrieve lifetime campaign performance analytics, or date-bounded analytics when start and end dates are supplied together.
>
> #### Input Parameters
>
> **end\_date** `string`
>
> Last analytics date in YYYY-MM-DD format; requires start\_date and must be no more than 30 days after it.
>
> **time\_zone** `string`
>
> IANA time zone used for date boundaries on date-bounded analytics.
>
> **start\_date** `string`
>
> First analytics date in YYYY-MM-DD format; requires end\_date.
>
> **campaign\_id** `integer` *required*
>
> Campaign whose performance analytics to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaigns
>
> **Slug:** `SMARTLEAD_GET_CAMPAIGNS`
>
> Get configuration and performance summaries for 1-20 Smartlead campaigns. Returns one success or failure result per campaign ID.
>
> #### Input Parameters
>
> **campaign\_ids** `array` *required*
>
> Campaign IDs to retrieve in order (1-20 IDs).
>
> **include\_tags** `boolean`
>
> Whether to include campaign tags in each campaign response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaign Sequences
>
> **Slug:** `SMARTLEAD_GET_CAMPAIGN_SEQUENCES`
>
> Get a campaign's ordered email sequence steps, including message content, delays, and A/B test variants.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> Campaign whose ordered email sequence steps to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaign Statistics
>
> **Slug:** `SMARTLEAD_GET_CAMPAIGN_STATISTICS`
>
> Return one offset-paginated page of email-level campaign statistics, optionally filtered by sequence step, engagement status, or sent time.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum statistics records to return (1-1000).
>
> **offset** `integer`
>
> Zero-based result offset.
>
> **campaign\_id** `integer` *required*
>
> Campaign whose email-level statistics to retrieve.
>
> **email\_status** `string ("opened" | "clicked" | "replied" | "unsubscribed" | "bounced")`
>
> Return only emails that were opened, clicked, replied to, unsubscribed, or bounced.
>
> **sent\_time\_end\_date** `string`
>
> Inclusive sent-time end in ISO 8601 format.
>
> **sent\_time\_start\_date** `string`
>
> Inclusive sent-time start in ISO 8601 format.
>
> **email\_sequence\_number** `integer`
>
> Return statistics only for this campaign sequence step (1-20).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaign Webhook Summary
>
> **Slug:** `SMARTLEAD_GET_CAMPAIGN_WEBHOOK_SUMMARY`
>
> Get a campaign's webhook delivery activity for a required time range.
>
> #### Input Parameters
>
> **to\_time** `string` *required*
>
> Inclusive end of the webhook activity range as an ISO 8601 datetime.
>
> **from\_time** `string` *required*
>
> Inclusive start of the webhook activity range as an ISO 8601 datetime.
>
> **campaign\_id** `integer` *required*
>
> Campaign whose webhook delivery activity to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Day-Wise Overall Stats
>
> **Slug:** `SMARTLEAD_GET_DAY_WISE_OVERALL_STATS`
>
> Retrieve account-wide daily Smartlead email engagement metrics for an inclusive date range and timezone.
>
> #### Input Parameters
>
> **end\_date** `string` *required*
>
> Last date in the inclusive analytics range, in YYYY-MM-DD format; must be on or after start\_date.
>
> **timezone** `string`
>
> Timezone Smartlead uses for the inclusive date boundaries.
>
> **client\_ids** `array`
>
> Client IDs to include, sent to Smartlead as one comma-separated value.
>
> **start\_date** `string` *required*
>
> First date in the inclusive analytics range, in YYYY-MM-DD format.
>
> **campaign\_ids** `array`
>
> Campaign IDs to include, sent to Smartlead as one comma-separated value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Smart Delivery Test
>
> **Slug:** `SMARTLEAD_GET_DELIVERY_TEST`
>
> Get the documented configuration for one Smart Delivery spam test by ID.
>
> #### Input Parameters
>
> **spam\_test\_id** `string` *required*
>
> Spam test ID returned by List Smart Delivery Tests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Account Warmup Statistics
>
> **Slug:** `SMARTLEAD_GET_EMAIL_ACCOUNT_WARMUP_STATS`
>
> Retrieve recent daily warmup performance statistics for one Smartlead sending account.
>
> #### Input Parameters
>
> **email\_account\_id** `integer` *required*
>
> Sending account ID returned by LIST\_EMAIL\_ACCOUNTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inbox Conversation
>
> **Slug:** `SMARTLEAD_GET_INBOX_CONVERSATION`
>
> Retrieve one Master Inbox conversation by campaign-lead-map ID, requesting its message history.
>
> #### Input Parameters
>
> **inbox\_item\_id** `integer` *required*
>
> Campaign-lead-map ID from inbox or campaign lead results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lead
>
> **Slug:** `SMARTLEAD_GET_LEAD`
>
> Retrieve a global Smartlead lead by numeric ID.
>
> #### Input Parameters
>
> **lead\_id** `integer` *required*
>
> Numeric ID of the global lead to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lead by Email
>
> **Slug:** `SMARTLEAD_GET_LEAD_BY_EMAIL`
>
> Find an account-wide Smartlead lead by exact email address and return its contact details and campaign memberships.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Exact lead email address to find across the Smartlead account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lead Campaign Overview
>
> **Slug:** `SMARTLEAD_GET_LEAD_CAMPAIGN_OVERVIEW`
>
> Retrieve a Smartlead lead by ID with every campaign membership, campaign status, and current sequence position.
>
> #### Input Parameters
>
> **lead\_id** `integer` *required*
>
> Lead ID whose campaign memberships should be retrieved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lead Message History
>
> **Slug:** `SMARTLEAD_GET_LEAD_MESSAGE_HISTORY`
>
> Get a campaign lead's email conversation history, optionally filtering by time and including plain text bodies.
>
> #### Input Parameters
>
> **lead\_id** `integer` *required*
>
> Lead whose conversation history to retrieve.
>
> **campaign\_id** `integer` *required*
>
> Campaign containing the lead.
>
> **event\_time\_gt** `string`
>
> Return messages after this ISO 8601 timestamp.
>
> **show\_plain\_text\_response** `boolean`
>
> Include plain text email content when available.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Mailbox Health Metrics
>
> **Slug:** `SMARTLEAD_GET_MAILBOX_HEALTH_METRICS`
>
> Retrieve date-bounded health and performance metrics for individual Smartlead sending mailboxes.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of mailbox metrics for Smartlead to return.
>
> **offset** `integer`
>
> Pagination offset requested from Smartlead.
>
> **end\_date** `string` *required*
>
> Last date in the inclusive analytics range, in YYYY-MM-DD format; must be on or after start\_date.
>
> **timezone** `string`
>
> IANA timezone Smartlead uses for the inclusive date boundaries.
>
> **full\_data** `boolean`
>
> Whether Smartlead should return detailed metrics for the full data set.
>
> **client\_ids** `array`
>
> Client IDs to include, sent to Smartlead as one comma-separated value.
>
> **is\_bounced** `boolean`
>
> Filter mailboxes by whether they have bounced.
>
> **start\_date** `string` *required*
>
> First date in the inclusive analytics range, in YYYY-MM-DD format.
>
> **campaign\_ids** `array`
>
> Campaign IDs to include, sent to Smartlead as one comma-separated value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Overall Analytics
>
> **Slug:** `SMARTLEAD_GET_OVERALL_ANALYTICS`
>
> Retrieve account-wide Smartlead email performance counts and rates for an inclusive date range.
>
> #### Input Parameters
>
> **end\_date** `string` *required*
>
> Last date in the inclusive analytics range, in YYYY-MM-DD format; must be on or after start\_date.
>
> **timezone** `string`
>
> Timezone Smartlead uses for the inclusive date boundaries.
>
> **full\_data** `boolean`
>
> Whether Smartlead should return detailed metrics for the full data set.
>
> **is\_agency** `boolean`
>
> Whether to filter analytics for agency accounts.
>
> **client\_ids** `array`
>
> Client IDs to include, sent to Smartlead as one comma-separated value.
>
> **start\_date** `string` *required*
>
> First date in the inclusive analytics range, in YYYY-MM-DD format.
>
> **campaign\_ids** `array`
>
> Campaign IDs to include, sent to Smartlead as one comma-separated value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Smart Prospect Usage
>
> **Slug:** `SMARTLEAD_GET_PROSPECT_USAGE`
>
> Get Smart Prospect lead-search metrics, fetch counts, daily limits, and available credit balance. This read does not consume credits.
>
> #### Input Parameters
>
> **filter\_id** `string`
>
> Optional numeric Smart Prospect filter ID for filter-specific lead and email metrics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Account Leads
>
> **Slug:** `SMARTLEAD_LIST_ACCOUNT_LEADS`
>
> Return one filtered, offset- or cursor-paginated page of leads across the connected Smartlead account without requiring a campaign.
>
> #### Input Parameters
>
> **email** `string`
>
> Return leads matching this email address.
>
> **limit** `integer`
>
> Maximum leads to return in this page (1-100). Omit to use Smartlead's documented default of 1.
>
> **offset** `integer`
>
> Number of matching leads to skip; do not combine with a cursor.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call.
>
> **created\_at\_gt** `string`
>
> Return leads created after this date, in YYYY-MM-DD format.
>
> **last\_seen\_lead\_id** `integer`
>
> Provider lead ID returned by a previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaign Leads
>
> **Slug:** `SMARTLEAD_LIST_CAMPAIGN_LEADS`
>
> Return one offset-paginated page of leads in a campaign with optional status, category, engagement, and date filters.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum leads to return (1-100).
>
> **offset** `integer`
>
> Zero-based result offset.
>
> **status** `string ("STARTED" | "INPROGRESS" | "COMPLETED" | "PAUSED" | "STOPPED")`
>
> Return leads with this sequence status.
>
> **campaign\_id** `integer` *required*
>
> Campaign whose leads to list.
>
> **email\_status** `string ("is_opened" | "is_clicked" | "is_bounced" | "is_replied" | "is_unsubscribed" | "is_spam" | "is_accepted" | "not_replied" | "is_sender_bounced")`
>
> Return leads matching this email engagement status.
>
> **created\_at\_gt** `string`
>
> Return leads created after this ISO 8601 date-time.
>
> **event\_time\_gt** `string`
>
> Return leads whose last event is after this ISO 8601 date-time.
>
> **lead\_category\_id** `integer`
>
> Return leads assigned to this category ID.
>
> **last\_sent\_time\_gt** `string`
>
> Return leads last emailed after this ISO 8601 date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaigns
>
> **Slug:** `SMARTLEAD_LIST_CAMPAIGNS`
>
> List campaigns visible to the connected Smartlead account, optionally for one client.
>
> #### Input Parameters
>
> **client\_id** `integer`
>
> Return only campaigns belonging to this client ID.
>
> **include\_tags** `boolean`
>
> Include campaign tags in each result.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaign Webhooks
>
> **Slug:** `SMARTLEAD_LIST_CAMPAIGN_WEBHOOKS`
>
> Return webhook registrations configured for a Smartlead campaign.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> Campaign whose webhook registrations to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Clients
>
> **Slug:** `SMARTLEAD_LIST_CLIENTS`
>
> List whitelabel client sub-accounts and the identifiers used by client-scoped Smartlead actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Smart Delivery Folders
>
> **Slug:** `SMARTLEAD_LIST_DELIVERY_FOLDERS`
>
> List folders used to organize Smart Delivery tests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Smart Delivery Tests
>
> **Slug:** `SMARTLEAD_LIST_DELIVERY_TESTS`
>
> List Smart Delivery spam and inbox-placement tests. This POST endpoint is read-only and does not create or send a test.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Domain Block Entries
>
> **Slug:** `SMARTLEAD_LIST_DOMAIN_BLOCK_ENTRIES`
>
> Return one offset-paginated page of email addresses and domains excluded from Smartlead outreach, optionally filtered by client or search text.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum entries to return (1-1000).
>
> **offset** `integer`
>
> Zero-based result offset.
>
> **client\_id** `integer`
>
> Return entries assigned to this client ID.
>
> **email\_or\_domain** `string`
>
> Search blocked email addresses and domains.
>
> **email\_with\_domain** `string`
>
> Search for an email address containing a domain.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Email Accounts
>
> **Slug:** `SMARTLEAD_LIST_EMAIL_ACCOUNTS`
>
> List one page of connected sending accounts with health, warmup, usage, and provider filters, optionally including campaign IDs. Credential-like response fields are removed.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum accounts to return in this page (1-100).
>
> **in\_use** `boolean`
>
> Filter by whether the account is used in campaigns.
>
> **provider** `string ("GMAIL" | "OUTLOOK" | "SMTP")`
>
> Filter by email service provider.
>
> **username** `string`
>
> Partially match the sending username.
>
> **client\_id** `integer`
>
> Filter accounts by client ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call.
>
> **warmup\_status** `string ("ACTIVE" | "INACTIVE")`
>
> Filter by ACTIVE or INACTIVE warmup status.
>
> **smtp\_connected** `boolean`
>
> Filter by SMTP connection success.
>
> **warmup\_blocked** `boolean`
>
> Filter by whether warmup is blocked.
>
> **include\_campaign\_ids** `boolean`
>
> Include campaign IDs attached to each account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Inbox Replies
>
> **Slug:** `SMARTLEAD_LIST_INBOX_REPLIES`
>
> List lead replies across campaigns from Master Inbox using bounded filters and one page at a time. This reads email content but does not send or modify messages.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum replies in this page (1-20).
>
> **search** `string`
>
> Match lead email, name, or message text (maximum 30 characters).
>
> **sort\_by** `string ("REPLY_TIME_DESC" | "SENT_TIME_DESC")`
>
> Sort by most recent reply time or most recent sent time.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call. Omit for the first page.
>
> **campaign\_ids** `array`
>
> Campaign IDs to include (maximum five).
>
> **category\_ids** `array`
>
> Lead category IDs to include (maximum 10).
>
> **email\_statuses** `array`
>
> Engagement statuses to include.
>
> **email\_account\_ids** `array`
>
> Sending-account IDs to include (maximum 20).
>
> **reply\_time\_between** `array`
>
> Exactly two ISO 8601 timestamps defining the reply-time range.
>
> **include\_message\_history** `boolean`
>
> Include complete conversation threads. False returns only the latest message and is faster.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Smart Prospect Industries
>
> **Slug:** `SMARTLEAD_LIST_PROSPECT_INDUSTRIES`
>
> List and search Smart Prospect industry filter values without searching contacts or consuming contact-fetch credits.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum industries to return in this page (1-100).
>
> **search** `string`
>
> Prefix to match against industry names.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call.
>
> **include\_sub\_industries** `boolean`
>
> Include sub-industry values for each industry.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Purchased Smart Senders Domains
>
> **Slug:** `SMARTLEAD_LIST_PURCHASED_DOMAINS`
>
> List domains already purchased through Smart Senders. This is read-only and does not purchase domains or provision mailboxes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Saved Smart Prospect Searches
>
> **Slug:** `SMARTLEAD_LIST_SAVED_PROSPECT_SEARCHES`
>
> List saved Smart Prospect search definitions without executing them or consuming contact-search credits.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum saved searches to return in this page.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Smart Senders Vendors
>
> **Slug:** `SMARTLEAD_LIST_SENDER_VENDORS`
>
> List Smart Senders marketplace vendors and current domain/mailbox pricing without placing an order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause Campaign Lead
>
> **Slug:** `SMARTLEAD_PAUSE_CAMPAIGN_LEAD`
>
> Pause scheduled outreach for one lead in a campaign.
>
> #### Input Parameters
>
> **lead\_id** `integer` *required*
>
> Lead whose scheduled outreach should be paused.
>
> **campaign\_id** `integer` *required*
>
> Campaign containing the lead to pause.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume Campaign Lead
>
> **Slug:** `SMARTLEAD_RESUME_CAMPAIGN_LEAD`
>
> Resume a paused lead in a campaign, optionally after a delay.
>
> #### Input Parameters
>
> **lead\_id** `integer` *required*
>
> Paused lead to resume.
>
> **campaign\_id** `integer` *required*
>
> Campaign containing the paused lead.
>
> **resume\_lead\_with\_delay\_days** `integer`
>
> Days to wait before resuming; omit to use the sequence default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Save Campaign Webhook
>
> **Slug:** `SMARTLEAD_SAVE_CAMPAIGN_WEBHOOK`
>
> Create a webhook for campaign events, or update an existing webhook when webhook\_id is supplied.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name used to identify the webhook.
>
> **webhook\_id** `integer`
>
> Existing webhook ID to update. Omit for a new webhook.
>
> **campaign\_id** `integer` *required*
>
> Campaign whose webhook should be created or updated.
>
> **event\_types** `array` *required*
>
> Campaign events that trigger the webhook.
>
> **webhook\_url** `string` *required*
>
> Absolute HTTP(S) URL that receives Smartlead webhook requests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Available Smart Senders Domains
>
> **Slug:** `SMARTLEAD_SEARCH_AVAILABLE_DOMAINS`
>
> Check Smart Senders marketplace domain availability for a vendor. This read-only search does not purchase a domain, place an order, or provision mailboxes.
>
> #### Input Parameters
>
> **vendor\_id** `integer` *required*
>
> Vendor ID returned by List Smart Senders Vendors.
>
> **domain\_name** `string` *required*
>
> Domain name or candidate text to check for marketplace availability. This search does not purchase the domain.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Campaign Leads
>
> **Slug:** `SMARTLEAD_SEARCH_CAMPAIGN_LEADS`
>
> Search one cursor-paginated page of campaign leads by text, status, category, sequence, sender, source, and manual-completion filters.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum leads to return (1-100).
>
> **field\_set** `string ("drafted_table" | "active_table")`
>
> Return the compact drafted-table or full active-table lead fields.
>
> **campaign\_id** `integer` *required*
>
> Campaign whose leads to search.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous search page.
>
> **search\_text** `string`
>
> Text to match across lead email, first name, and last name.
>
> **sequence\_ids** `array`
>
> Campaign sequence IDs to include.
>
> **lead\_statuses** `array`
>
> Lead sequence statuses to include.
>
> **segment\_types** `array`
>
> Segment types to include (each 0-10).
>
> **status\_filter** `string ("all" | "active" | "replied" | "failed" | "scheduled" | "manual_followups" | "completed" | "paused")`
>
> Campaign lead status tab to search.
>
> **email\_statuses** `array`
>
> Email engagement statuses to include.
>
> **esp\_domain\_types** `array`
>
> ESP domain types to include (each 0-2).
>
> **sequence\_numbers** `array`
>
> Sequence step numbers to include (each 1-999).
>
> **email\_account\_ids** `array`
>
> Sending email account IDs to include.
>
> **last\_seen\_lead\_id** `integer`
>
> Lead map ID cursor from a previous page.
>
> **lead\_category\_ids** `array`
>
> Lead category IDs to include; use -1 to also include uncategorized leads.
>
> **last\_seen\_reply\_time** `string`
>
> Latest reply time cursor used with last\_seen\_lead\_id for replied active-table searches.
>
> **sequence\_variant\_ids** `array`
>
> Sequence variant IDs to include.
>
> **include\_sender\_bounce** `boolean`
>
> Include leads whose sender account bounced.
>
> **lead\_category\_is\_null** `boolean`
>
> Return only leads without a category.
>
> **sequence\_schedule\_type** `string ("MANUAL" | "AUTO")`
>
> Filter by manual or automatic sequence scheduling.
>
> **deleted\_email\_addresses** `array`
>
> Deleted lead email addresses to include (maximum 320 characters each).
>
> **filter\_manual\_sequence\_ids** `array`
>
> Manual sequence IDs used with the manual-completion filter.
>
> **filter\_for\_manual\_completion** `boolean`
>
> Filter leads eligible for manual completion.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Smart Prospect Contacts (Consumes Credits)
>
> **Slug:** `SMARTLEAD_SEARCH_PROSPECT_CONTACTS`
>
> Search one page of Smart Prospect contacts. The initial call and every explicit continuation may consume credits; inspect usage first, choose the smallest useful limit, and confirm each page.
>
> #### Input Parameters
>
> **limit** `integer` *required*
>
> Contacts to return in this credit-consuming page (1-500). Choose the smallest useful value.
>
> **filters** `object` *required*
>
> Person and company filters for the contact search. Provide at least one non-empty list filter, such as titles or countries, or set exclude\_owned\_contacts to true. Example: \{"titles":\["VP Sales"],"countries":\["United States"]}.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous page. Continuing performs another credit-consuming call.
>
> **confirm\_credit\_consumption** `boolean` *required*
>
> Must be true to acknowledge that this page may consume Smart Prospect credits. This confirmation is validated locally and is not sent upstream.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Single Email
>
> **Slug:** `SMARTLEAD_SEND_SINGLE_EMAIL`
>
> Immediately send one email outside a campaign from a connected Smartlead sender account. This externally visible action cannot be undone.
>
> #### Input Parameters
>
> **to** `string` *required*
>
> Recipient email address.
>
> **body** `string` *required*
>
> HTML or plain-text email body.
>
> **subject** `string` *required*
>
> Email subject.
>
> **reply\_to** `string`
>
> Reply-to email address.
>
> **from\_name** `string`
>
> Sender display name.
>
> **from\_email** `string`
>
> Sender email address; provide exactly one of this or from\_email\_id.
>
> **attachments** `array`
>
> Files to attach, each with a filename, base64-encoded content, and provider-required mimeType.
>
> **from\_email\_id** `integer`
>
> Smartlead sender account ID; provide exactly one of this or from\_email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unsubscribe Campaign Lead
>
> **Slug:** `SMARTLEAD_UNSUBSCRIBE_CAMPAIGN_LEAD`
>
> Permanently unsubscribe a lead from future email in a specific campaign. This cannot be undone through the Smartlead API.
>
> #### Input Parameters
>
> **lead\_id** `integer` *required*
>
> Lead to unsubscribe permanently; this cannot be undone through the API.
>
> **campaign\_id** `integer` *required*
>
> Campaign containing the lead to unsubscribe permanently.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Campaign Lead
>
> **Slug:** `SMARTLEAD_UPDATE_CAMPAIGN_LEAD`
>
> Update one campaign lead's contact information and merge custom fields using Smartlead's current campaign-lead endpoint.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Current or replacement email address required by Smartlead.
>
> **lead\_id** `integer` *required*
>
> Lead to update.
>
> **website** `string`
>
> Updated website URL.
>
> **location** `string`
>
> Updated location.
>
> **last\_name** `string`
>
> Updated last name.
>
> **first\_name** `string`
>
> Updated first name.
>
> **campaign\_id** `integer` *required*
>
> Campaign containing the lead.
>
> **company\_url** `string`
>
> Updated company URL.
>
> **company\_name** `string`
>
> Updated company name.
>
> **phone\_number** `string`
>
> Updated phone number.
>
> **custom\_fields** `object`
>
> Up to 200 custom fields to merge into the lead.
>
> **linkedin\_profile** `string`
>
> Updated LinkedIn profile URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Campaign Sequences
>
> **Slug:** `SMARTLEAD_UPDATE_CAMPAIGN_SEQUENCES`
>
> Create or update a draft or paused campaign's ordered email sequence steps, including delays and documented A/B test variants.
>
> #### Input Parameters
>
> **sequences** `array` *required*
>
> One or more ordered email sequence steps.
>
> **campaign\_id** `integer` *required*
>
> Draft or paused campaign whose sequence steps to create or update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Campaign Settings
>
> **Slug:** `SMARTLEAD_UPDATE_CAMPAIGN_SETTINGS`
>
> Change settings for future campaign sends; in-progress leads keep their existing settings. Omitted settings remain unchanged.
>
> #### Input Parameters
>
> **name** `string`
>
> New campaign name.
>
> **client\_id** `integer`
>
> Client ID to associate with the campaign. Pass null explicitly to clear it; omit this field to leave it unchanged.
>
> **campaign\_id** `integer` *required*
>
> Campaign whose settings to update.
>
> **track\_settings** `array`
>
> Tracking features to disable. Pass an empty list to enable all tracking.
>
> **force\_plain\_text** `boolean`
>
> Whether to force plain-text delivery.
>
> **unsubscribe\_text** `string`
>
> Unsubscribe text to include in campaign emails.
>
> **send\_as\_plain\_text** `boolean`
>
> Whether to send campaign emails as plain text.
>
> **stop\_lead\_settings** `string ("REPLY_TO_AN_EMAIL" | "CLICK_ON_A_LINK" | "OPEN_AN_EMAIL")`
>
> Event that stops outreach to a lead: REPLY\_TO\_AN\_EMAIL, CLICK\_ON\_A\_LINK, or OPEN\_AN\_EMAIL.
>
> **add\_unsubscribe\_tag** `boolean`
>
> Whether to add an unsubscribe tag to campaign emails.
>
> **follow\_up\_percentage** `integer`
>
> Percentage of campaign sends allocated to follow-ups.
>
> **enable\_ai\_esp\_matching** `boolean`
>
> Whether to enable AI-based email service provider matching.
>
> **domain\_level\_rate\_limit** `boolean`
>
> Whether to apply domain-level sending rate limits.
>
> **ai\_categorisation\_options** `array`
>
> Provider-defined AI reply categorization option objects.
>
> **bounce\_autopause\_threshold** `string`
>
> Bounce threshold at which Smartlead automatically pauses the campaign.
>
> **ignore\_ss\_mailbox\_sending\_limit** `boolean`
>
> Whether to ignore the SmartSend mailbox sending limit.
>
> **auto\_pause\_domain\_leads\_on\_reply** `boolean`
>
> Whether a reply should pause other leads from the same domain.
>
> **out\_of\_office\_detection\_settings** `object`
>
> Out-of-office reply handling and automatic reactivation settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Campaign Status
>
> **Slug:** `SMARTLEAD_UPDATE_CAMPAIGN_STATUS`
>
> Start, pause, stop, or archive a campaign. STOPPED is permanent and cannot be undone; START can begin sending emails.
>
> #### Input Parameters
>
> **status** `string ("START" | "PAUSED" | "STOPPED" | "ARCHIVED")` *required*
>
> New campaign status. STOPPED permanently stops the campaign and cannot be undone; START can begin sending emails.
>
> **campaign\_id** `integer` *required*
>
> Campaign to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Lead Category
>
> **Slug:** `SMARTLEAD_UPDATE_LEAD_CATEGORY`
>
> Assign, change, or remove a category for one campaign lead, optionally pausing campaign outreach for it.
>
> #### Input Parameters
>
> **lead\_id** `integer` *required*
>
> Lead whose campaign category should be updated.
>
> **pause\_lead** `boolean`
>
> Whether to pause campaign outreach for the lead after the update.
>
> **campaign\_id** `integer` *required*
>
> Campaign containing the lead.
>
> **category\_id** `string` *required*
>
> Category ID to assign. Pass null explicitly to remove the category.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
