Skip to main content

Smartlead

Smartlead is a cold email outreach platform for running multi-step email campaigns from many sender mailboxes, with mailbox warmup, a unified inbox for replies, deliverability testing, and agency client management. The Smartlead connector reads campaigns, leads, sequences, email accounts, campaign and account analytics, inbox conversations, webhooks, clients, Smart Delivery spam tests, Smart Prospect searches, and Smart Senders and SmartServers data, and can create and manage campaigns, leads, lead lists, email accounts, webhooks, and clients, start campaigns, and send replies and emails.

Smartlead icon

Power end-to-end data operations for your Smartlead API with Nexla. Our bi-directional Smartlead connector is purpose-built for Smartlead, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Smartlead or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Smartlead workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to the Smartlead API with an API key from your Smartlead account. To create a key:

  1. Sign in to Smartlead.

  2. Click your profile icon, and select Settings.

  3. In the API key section, generate a new API key, and copy it. Store the key securely; Smartlead may not show it again.

For details, see Smartlead's Authentication guide. The API key carries the same access as your Smartlead account, so treat it like a password. Every Smartlead request authenticates with the key in the api_key query parameter; Nexla adds this parameter to each request automatically, so do not add it to endpoint URLs yourself.

Smart Delivery, Smart Prospect, Smart Senders, and SmartServers are separate Smartlead products. The templates for them only work if the product (or add-on) is enabled on your Smartlead account, and they can fail with an authorization error otherwise.

Some destinations send real email

Several Smartlead destination templates cause Smartlead to send email to real recipients: starting or resuming a campaign, adding or pushing leads into an active campaign, resuming a lead, attaching mailboxes to an active campaign, saving sequences on an active campaign, replying to or forwarding an email, sending a single or test email, enabling warmup, and creating placement tests. These templates are marked Sends email below. Test them against a draft or paused campaign and your own addresses before using them with live data.

Some Smart Prospect templates spend credits

The Find Emails API and Fetch Contacts API destination templates reveal contact email addresses and spend Smart Prospect credits on your Smartlead account for every record they send. These templates are marked Spends credits below. Check your credit balance with the Search Analytics API source template before running them.

Smartlead API rate limits

Smartlead rate-limits each API key across all endpoints, by plan (for example, 60 requests per minute on the Standard tier), and returns HTTP 429 Too Many Requests when the limit is exceeded. Three endpoints have their own, stricter limit of 10 requests per minute per account: campaign lead statistics, all leads activities, and domain-wise health metrics. Templates that page through large result sets make one request per page. See Smartlead's Rate Limits guide for details.

Authenticate​

Credentials required​

Smartlead API key, sent as the api_key query parameter on every request (all Smartlead hosts).

FieldRequiredSecretDescription
API KeyYesYesYour Smartlead API key, from Settings > Your Profile > Smartlead API Key. Sent as the api_key query parameter on every request.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Smartlead API key in the API Key field. This is the key you created in Prerequisites. Nexla sends it as the api_key query parameter on every request to every Smartlead host.

    If your API key is compromised, generate a new key in Smartlead under Settings, and update the API Key on this credential.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests the credential by listing the campaigns in your Smartlead account.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Smartlead connector tile, then select the credential that will be used to connect to your Smartlead account, and click Next; or, create a new Smartlead credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Smartlead endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below, grouped by area.

Templates that say "Results are paged automatically" read every page, advancing the offset by the page size until a page comes back short; all other templates make a single request. Templates that need an ID, such as a campaign or email account ID, read data for that one object; use the matching list template to find the ID. Templates with a date range default to the last 30 days.

Campaigns​

Get All Campaigns

Lists every campaign in the account, newest first, with each campaign's ID, name, status, schedule, tracking settings, and sending limits. Use it to find the campaign IDs that most other templates need.

Get Campaign by ID

Retrieves one campaign with its settings, schedule, tracking preferences, and sending limits.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Get Campaign Sequences

Lists the email sequence steps configured for a campaign, in sequence order, including each step's subject, body, delay, and A/B variants.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Get Campaign Email Accounts

Lists the email accounts (sender mailboxes) attached to a campaign and used in its sender rotation.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Get Campaign AI Prompt Template

Retrieves the AI reply-categorization prompt and lead categories configured on a campaign.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Export Campaign Leads

Exports all of a campaign's leads as CSV. The whole CSV file is returned as a single text record rather than one record per lead.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Campaign statistics and analytics​

Get Campaign Statistics

Lists email-level statistics for every email sent in a campaign, including each email's lead, sequence number, and sent, open, click, reply, and bounce times.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Results are paged automatically, 1,000 records per page.
  • See the Smartlead API reference for the response fields.

Fetch Campaign Lead Statistics

Lists per-lead statistics for a campaign.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Results are paged automatically, 100 records per page.
  • Smartlead limits this endpoint to 10 requests per minute per account, separately from the plan-wide limit.
  • See the Smartlead API reference for the response fields.

Fetch Campaign Mailbox Statistics

Lists per-mailbox sending statistics for a campaign.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Results are paged automatically, 20 records per page.
  • See the Smartlead API reference for the response fields.

Fetch Campaign Sequence Analytics

Returns per-sequence and per-variant performance for a campaign over a date range, with open, click, and reply rates.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Get Campaign Analytics

Returns overall analytics for a campaign, such as sent, opened, clicked, replied, bounced, and unsubscribed counts.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Get Campaign Analytics by Date Range

Returns a campaign's analytics for a date range.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Get Top Level Analytics by Date

Returns a campaign's high-level metrics for a date range.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Get All Leads Activities

Lists lead activities across all campaigns in the account.

  • Results are paged automatically, 1,000 records per page.
  • Smartlead limits this endpoint to 10 requests per minute per account, separately from the plan-wide limit.
  • See the Smartlead API reference for the response fields.

Leads and lead lists​

Get Campaign Leads

Lists the leads in a campaign, including each lead's details, status, and campaign lead mapping ID.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Results are paged automatically, 100 records per page.
  • See the Smartlead API reference for the response fields.

Search Campaign Leads

Searches a campaign's leads. As configured, the template sends an empty filter and returns the first page of the campaign's leads; to filter by name or email text, status, category, or sequence, use manual configuration with the filters Smartlead documents.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Get Lead by ID

Retrieves one lead's details.

  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the response fields.

Get Lead by Email

Looks up a lead by email address and returns the lead with its campaign data.

Get Lead Campaign Overview

Retrieves a lead's details and every campaign it is in, with its status and current sequence step in each.

  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the response fields.

Get Lead Sequence Details

Lists the send status of every sequence step for a lead in a campaign.

  • Enter the Lead Map ID. This is the lead's campaign mapping ID (campaign_lead_map_id); use the Get Campaign Leads template to find it.
  • See the Smartlead API reference for the response fields.

Get Lead Message History

Retrieves the complete email conversation history between a campaign and one lead.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the response fields.

Get Bulk Lead Message History

Retrieves message history for many leads of a campaign at once. As configured, the template sends an empty request body, so it does not narrow the result to particular leads.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Get Lead Categories

Lists the lead categories available in the account, both Smartlead's global categories (such as Interested) and your custom ones.

Get Lead Notes

Lists the notes recorded on a lead.

  • Enter the Lead ID of the lead whose notes you want. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the response fields.

Get Lead Tasks

Lists the tasks created for a lead.

  • Enter the Lead ID of the lead whose tasks you want. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the response fields.

Get All Lead Lists

Lists all lead lists in the account.

Get Lead List by ID

Retrieves one lead list.

  • Enter the Lead List ID. Use the Get All Lead Lists template to find it.
  • See the Smartlead API reference for the response fields.

Email accounts​

Get All Email Accounts

Lists every email account (sender mailbox) connected to Smartlead, with its type, sending limits, connection status, and warmup details.

Get Email Account by ID

Retrieves one email account's configuration and warmup details.

  • Enter the Email Account ID. Use the Get All Email Accounts template to find it.
  • See the Smartlead API reference for the response fields.

Get Email Account by Email Address

Looks up a single email account by its email address.

  • Enter the Email. Enter the email address of the email account.
  • See the Smartlead API reference for the response fields.

Get Warmup Statistics

Returns daily warmup statistics for an email account over the past seven days.

  • Enter the Email Account ID. Use the Get All Email Accounts template to find it.
  • See the Smartlead API reference for the response fields.

Get All Tags

Lists all email account tags in the account.

Get Email Account Tags

Lists the tags on specific email accounts, by email address.

  • Enter the Email IDs. Enter a JSON array of email account addresses, for example ["sales@example.com", "team@example.com"].
  • See the Smartlead API reference for the response fields.

Account analytics​

Get Overall Analytics

Returns account-wide sent, opened, clicked, replied, and bounced totals for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Campaign Performance

Returns performance for each campaign over a date range, with engagement rates and lead counts.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • Timezone defaults to utc.
  • See the Smartlead API reference for the response fields.

Get Campaign List

Lists the campaigns available for analytics filtering.

Campaign Status Stats

Returns the number of campaigns in each status.

Campaign Response Stats

Returns a response analysis for each campaign over a date range, with a sentiment breakdown.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Follow-up Reply Rate

Returns reply rates for follow-up steps (second, third, and later emails) over a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Lead to Reply Time

Returns the average time from first email sent to first reply received, over a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Leads Take for First Reply

Returns the average number of leads contacted before the first reply, over a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Get Day-wise Overall Stats

Returns day-by-day email engagement metrics for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Day-wise Stats by Sent Time

Returns day-by-day engagement metrics grouped by the time emails were sent, for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • Timezone defaults to utc.
  • See the Smartlead API reference for the response fields.

Day-wise Positive Reply Stats

Returns day-by-day positive reply counts (interested and other positive categories) for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Positive Reply Stats by Sent Time

Returns day-by-day positive replies grouped by the time emails were sent, for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • Timezone defaults to utc.
  • See the Smartlead API reference for the response fields.

Lead Statistics

Returns lead engagement statistics by status and category for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Lead Category-wise Response

Returns lead responses broken down by category for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Mailbox Overall Stats

Returns overall health and performance statistics across all mailboxes.

Domain-wise Health Metrics

Returns mailbox performance aggregated by sending domain, for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • Smartlead limits this endpoint to 10 requests per minute per account, separately from the plan-wide limit.
  • See the Smartlead API reference for the response fields.

Email-ID-wise Health Metrics

Returns health metrics for each email account, for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Provider-wise Performance

Compares performance across email providers (such as Gmail, Outlook, and SMTP) for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Team Board Stats

Returns performance metrics by team member for a date range.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Get Client List

Lists the clients available for analytics filtering.

Client Overall Stats

Returns performance metrics for each client over a date range, for agency reporting.

  • Start Date and End Date default to {now-30} and {now}, the last 30 days, and are sent as yyyy-MM-dd. Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Get Month-wise Client Count

Returns the number of active clients per month.

Master inbox​

Get Inbox Replies

Lists lead replies across all campaigns in the unified inbox.

Get Unread Replies

Lists unread lead replies.

Get Sent Emails

Lists emails sent across campaigns.

Get Scheduled Emails

Lists emails queued for future sending.

Get Important Emails

Lists conversations marked as important.

Get Assigned to Me

Lists conversations assigned to the user that owns the API key.

Get Reminder Emails

Lists conversations with active reminders.

Get Snoozed Emails

Lists snoozed conversations.

Get Archived Emails

Lists archived conversations.

Get Custom View Emails

Lists conversations that match your saved custom inbox views.

Get Untracked Replies

Lists replies that Smartlead could not match to a campaign lead.

Get Inbox Item by ID

Retrieves one master inbox conversation.

  • Enter the Master Inbox ID. This is the lead's campaign_lead_map_id, as returned by the inbox and campaign lead templates (for example, Get Inbox Replies).
  • See the Smartlead API reference for the response fields.

Get Reply Status

Returns the delivery status of a reply sent from the unified inbox.

  • Enter the Message ID. This is the message ID of a reply sent from the unified inbox.
  • See the Smartlead API reference for the response fields.

Webhooks​

Get Campaign Webhooks

Lists the webhooks configured on a campaign.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Get Webhook

Retrieves the configuration of one webhook.

  • Enter the Webhook ID. Use the Get Campaign Webhooks template to find it.
  • See the Smartlead API reference for the response fields.

Get Webhook Summary

Returns a summary of a campaign's webhook deliveries, such as successful and failed events, for a time range.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • From Time and To Time default to {now-30} and {now}, the last 30 days, and are sent as UTC timestamps (for example, 2026-01-31T00:00:00.000Z). Replace them with other date macros or fixed dates to change the range.
  • See the Smartlead API reference for the response fields.

Clients and utilities​

Get All Clients

Lists the client sub-accounts under your Smartlead account.

Get Client by ID

Retrieves one client, with its permissions, credits, code integrations, and whitelabel details.

  • Enter the Client ID. Use the Get All Clients template to find it.
  • See the Smartlead API reference for the response fields.

Get Domain Block List

Lists the domains and email addresses on the account's block list, with the source and client of each entry.

Smart Delivery​

List All Tests

Lists the account's spam (inbox placement) tests.

Get Spam Test Details

Retrieves a spam test's complete results, including inbox placement and scores.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

Get All Folders

Lists the folders that organize spam tests.

Get Folder by ID

Retrieves one spam test folder.

  • Enter the Folder ID. Use the Get All Folders template to find it.
  • See the Smartlead API reference for the response fields.

Get Provider IDs

Lists the region-wise email provider IDs used to configure spam tests.

Mailbox Count

Returns the number of test mailboxes by provider.

Mailbox Summary

Returns a summary of the test mailboxes.

Provider-wise Report

Returns a spam test's deliverability by email provider (such as Gmail, Outlook, and Yahoo).

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

Geo-wise Report

Returns a spam test's deliverability by geographic region.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

Sender Account Report

Returns a spam test's results by sender email account.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

Sender Account List

Lists the sender accounts used in a spam test.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

Spam Filter Report

Lists the spam filters that a test's emails triggered, and why.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

DKIM Details

Returns the DKIM authentication results of a spam test.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

SPF Details

Returns the SPF authentication results of a spam test.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

rDNS Report

Returns the reverse DNS results for a spam test's sending IP addresses.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

IP Blacklist Check

Checks whether a spam test's sending IP addresses are listed on major blacklists.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

Domain Blacklist

Checks whether a spam test's sending domain is blacklisted.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

IP Details

Returns details about a spam test's sending IP addresses.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

Test Email Content

Retrieves the email content used in a spam test.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

Email Reply Headers

Retrieves the email headers of a test reply, for advanced diagnostics.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • Enter the Reply ID. This is the ID of a reply in the test; use the Sender Account Report template to find it.
  • See the Smartlead API reference for the response fields.

Schedule History

Lists the runs of an automated spam test.

  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the response fields.

Smart Prospect​

Search Contacts API

Searches Smartlead's prospect database for contacts that match your filters. Contacts are returned as found; revealing their email addresses is a separate, credit-consuming step (see Fetch Contacts API and Find Emails API under destinations).

  • Enter the complete JSON request body in Search Body, with any of the filters that Smartlead documents for this endpoint. The default, {"limit": 100}, returns the first 100 matching contacts.
  • See the Smartlead API reference for the response fields.

Get Contacts API

Lists the contacts already saved for a Smart Prospect search.

  • Enter the Filter ID. This is the ID of a saved or fetched Smart Prospect search; use the Saved Searches API or Fetched Searches API template to find it.
  • Results are paged automatically, 1,000 records per page.
  • See the Smartlead API reference for the response fields.

Saved Searches API

Lists your saved Smart Prospect searches.

Recent Searches API

Lists your recent Smart Prospect searches.

Fetched Searches API

Lists your Smart Prospect searches whose contacts have been fetched.

Search Analytics API

Returns Smart Prospect search analytics, such as leads found, emails fetched, and credits used.

Reply Analytics API

Returns reply analytics, such as the replied count and trend, for Smart Prospect contacts.

Cities API

Lists the city values available as Smart Prospect search filters.

States API

Lists the state values available as Smart Prospect search filters.

Countries API

Lists the country values available as Smart Prospect search filters.

Company API

Lists the company values available as Smart Prospect search filters.

Domain API

Lists the company domain values available as Smart Prospect search filters.

Departments API

Lists the department values available as Smart Prospect search filters.

Levels API

Lists the job and seniority level values available as Smart Prospect search filters.

Job Title API

Lists the job title values available as Smart Prospect search filters.

Head Counts API

Lists the company size (head count) ranges available as Smart Prospect search filters.

Industries API

Lists the industry values available as Smart Prospect search filters.

Sub-Industries API

Lists the sub-industry values available as Smart Prospect search filters.

Keywords API

Lists the keyword values available as Smart Prospect search filters.

Revenue API

Lists the company revenue ranges available as Smart Prospect search filters.

Smart Senders and SmartServers​

Get Vendors

Lists the active mailbox vendors in the Smart Senders marketplace, with pricing and service details.

Search Domain

Checks whether a domain is available in the Smart Senders marketplace. Returns one record with the domain, whether it is available, and up to 30 suggested domains. Read-only; it buys nothing.

  • Enter the Domain Name to check, without the TLD (for example, acmeoutreach). Values are placed in the URL as typed, so use letters, numbers and hyphens only.
  • Enter the Vendor ID of the Smart Senders vendor to search with. Use the Get Vendors template to find it; Smartlead requires it even though its docs mark it optional.
  • See the Smartlead API reference for the response fields.

Get Purchased Domain List

Lists the domains purchased through Smart Senders.

Get Order Details

Retrieves the status and details of a Smart Senders order.

  • Enter the Order ID. This is the ID of an order placed through Smart Senders.
  • See the Smartlead API reference for the response fields.

List SmartServers

Lists your SmartServers (dedicated sending IPs).

Get SmartServers for a Campaign

Lists the SmartServers attached to a campaign.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the response fields.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Smartlead data sources can also be manually configured to ingest data from any valid Smartlead API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or optional filters that the templates do not send, such as campaign, client, or status filters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers. Most Smartlead endpoint URLs take the form https://server.smartlead.ai/api/v1/...; Smart Delivery, Smart Prospect, Smart Senders, and SmartServers use the hosts smartdelivery.smartlead.ai, prospect-api.smartlead.ai, smart-senders.smartlead.ai, and smartservers.smartlead.ai. See the Smartlead API reference for the available endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Smartlead data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Smartlead destination, and select the Send to Destination option from the menu. Select the Smartlead connector from the list of available destination connectors, then select the credential that will be used to connect to your Smartlead account, and click Next; or, create a new Smartlead credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Smartlead endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Each record in the Nexset is sent as the JSON body of one request, one record at a time, so shape each record to match the request body that Smartlead documents for the endpoint. ID settings, such as a campaign or lead ID, are fixed on the destination and apply to every record it sends. Templates are marked Sends email when they cause Smartlead to send email, Spends credits when they consume Smart Prospect credits, and Side effect when they delete data or make other changes that cannot be undone from Nexla.

Campaigns​

Create Campaign

Creates a campaign from each record, in DRAFTED status with default settings. A record can carry name and client_id. Add sequences, a schedule, settings, and email accounts with the templates below before starting it.

Duplicate Campaign

Copies a campaign, including its sequences and settings. A record can set duplicate_sub_sequence and duplicate_client_label.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Create Subsequence Campaign

Creates a subsequence (a child campaign that leads enter when a condition is met). Each record must include parent_campaign_id, and can carry a name and conditionEvents.

Update Campaign Status

Changes a campaign's status. Each record must include status: START (start or resume sending), PAUSED, STOPPED, or ARCHIVED.

  • Sends email: a record with status set to START starts or resumes sending the campaign's emails to its leads.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Update Campaign Settings

Updates campaign settings such as the name, open and click tracking, stop-lead rule, unsubscribe text, and plain-text sending.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Update Campaign Schedule

Sets when a campaign sends. Each record carries the timezone, sending days, start_hour and end_hour, and optionally min_time_btw_emails.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Update Campaign Sequences

Creates or updates a campaign's email sequence steps. Each record carries a sequences array; steps with an id are updated, and steps without one are created.

  • Sends email: on an active campaign, the new or changed steps are what its leads receive next.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Send Test Email

Sends a test email of one sequence step. Each record must include leadId and sequenceNumber, and can set selectedEmailAccountId and customEmailAddress.

  • Sends email: sends a test email for each record.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Add Email Accounts to Campaign

Attaches email accounts to a campaign's sender rotation. Each record must include email_account_ids.

  • Sends email: an active campaign starts sending from the added mailboxes.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Add Email Accounts to Campaign by Tag

Attaches every email account that carries the given tags to a campaign. Each record must include tag_ids.

  • Sends email: an active campaign starts sending from the added mailboxes.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Remove Email Accounts from Campaign

Detaches email accounts from a campaign's sender rotation. Each record must include email_account_ids. Smartlead rejects removing the last email account from an active campaign.

  • Side effect: removes mailboxes from the campaign.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Reallocate Mailboxes

Moves a campaign's leads off mailboxes that are no longer attached to it, onto its attached mailboxes. Leads in STARTED status are not moved.

  • Sends email: the moved leads' pending emails are sent from the campaign's other mailboxes.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Add Tags to Campaigns

Adds tags to campaigns. Each record must include campaignIds and tagIds.

Remove Tags from Campaigns

Removes tags from campaigns. Each record must include campaignIds and tagIds.

Assign Client to Campaign

Assigns a campaign to a client, or removes its client. Each record must include campaignId, and can set clientId and applyClientDNC.

Move Campaigns to Folder

Moves campaigns into a folder, or out of their folder. Each record must include campaign_ids and folder_id.

Update Campaign Team Member

Assigns the team member responsible for a campaign. A record carries teamMemberId.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Update Spintax Distribution Mode

Sets how spintax variations are distributed across a campaign's leads. Each record must include campaignId and spintaxDistributionMode (1 for incremental, 2 for random).

Create Campaign AI Prompt Template

Adds an AI reply-categorization prompt and lead categories to a campaign. Each record must include prompt_content and categories.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Update Campaign AI Prompt Template

Updates a campaign's AI reply-categorization prompt, its lead categories, or whether it is active (prompt_content, categories, is_active).

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Template ID. Use the Get Campaign AI Prompt Template template to find it.
  • See the Smartlead API reference for the request body fields.

Delete Campaign

Deletes a campaign with all of its sequences, lead mappings, statistics, and settings. To keep the data, use Update Campaign Status to stop or archive the campaign instead.

  • Side effect: permanently deletes the campaign.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Campaign leads​

Add Leads to Campaign

Adds leads to a campaign. Each record carries a lead_list array of leads (each with an email and optional name, company, and custom_fields), up to 400 leads per request, and optional settings that control duplicate, block-list, and unsubscribe checks.

  • Sends email: leads added to an active campaign start receiving its emails.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Update Campaign Lead Details

Updates a lead's details and custom fields in a campaign. Each record must include the lead's email.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the request body fields.

Update Lead Category in Campaign

Sets a lead's category within a campaign. A record carries category_id and, optionally, pause_lead.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the request body fields.

Update Lead Email Account

Changes which email account sends to a lead. Each record must include email_account_id, email_campaign_id, and email_lead_id.

Pause Campaign Lead

Pauses a lead's sequence in a campaign.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the request body fields.

Resume Campaign Lead

Resumes a paused lead's sequence in a campaign. A record can set resume_lead_with_delay_days.

  • Sends email: resumes the lead's sequence; it starts receiving emails again.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the request body fields.

Mark Lead as Complete

Marks a lead's sequence in a campaign as completed.

  • Side effect: ends the lead's sequence.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Lead Map ID. This is the lead's campaign mapping ID (campaign_lead_map_id); use the Get Campaign Leads template to find it.
  • See the Smartlead API reference for the request body fields.

Unsubscribe Lead from Campaign

Unsubscribes a lead from one campaign, stopping all of that campaign's future emails to the lead.

  • Side effect: unsubscribes the lead from the campaign.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the request body fields.

Delete Lead from Campaign

Removes a lead from a campaign.

  • Side effect: permanently removes the lead from the campaign.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Reply to Campaign Lead

Sends a reply in a lead's email thread, from the campaign. Each record must include email_stats_id (the message being replied to) and email_body, and can set recipients, CC, BCC, a scheduled time, and attachments.

  • Sends email: sends the reply to the lead.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Forward Email

Forwards a campaign email to other recipients. Each record must include message_id, stats_id, and to_emails.

  • Sends email: sends the forwarded email to the given addresses.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Leads, categories, and tags​

Unsubscribe Lead Globally

Unsubscribes a lead from all current and future campaigns.

  • Side effect: unsubscribes the lead from all campaigns.
  • Enter the Lead ID. Use the Get Campaign Leads or Get Lead by Email template to find it.
  • See the Smartlead API reference for the request body fields.

Create Lead Category

Creates a custom lead category.

Update Lead Category

Updates the name, sentiment, or color of a custom lead category.

  • Enter the Category ID. Use the Get Lead Categories template to find it.
  • See the Smartlead API reference for the request body fields.

Delete Lead Category

Deletes a custom lead category. Smartlead only deletes categories that are not assigned to any lead.

  • Side effect: deletes the lead category.
  • Enter the Category ID. Use the Get Lead Categories template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Add Tags to Lead

Adds tags to a lead. Each record must include leadId and tagIds.

Remove Tag from Lead

Removes a tag from a lead. The tag itself is not deleted.

  • Side effect: removes the tag from the lead.
  • Enter the Tag Mapping ID. This is the tag_mapping_id of the tag on the lead; Smartlead returns it when the tag is added to the lead.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Lead lists​

Create Lead List

Creates a lead list. Each record must include listName.

Update Lead List

Renames a lead list. Each record must include listName.

  • Enter the Lead List ID. Use the Get All Lead Lists template to find it.
  • See the Smartlead API reference for the request body fields.

Delete Lead List

Deletes a lead list.

  • Side effect: deletes the lead list.
  • Enter the Lead List ID. Use the Get All Lead Lists template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Import Leads to List

Imports leads into a lead list. Each record must include leadList (the leads) and fileName.

  • Enter the Lead List ID. Use the Get All Lead Lists template to find it.
  • See the Smartlead API reference for the request body fields.

Assign Tags to Lead Lists

Adds tags to, or removes tags from, lead lists. Each record must include listIds and tagIds, and can set removeTagIds.

Move Leads Between Lists

Copies or moves leads from one lead list to another. Each record must include action and toListId.

Push Leads to Campaign

Pushes leads from a lead list, or by lead ID, into a campaign. Each record must include action, and identifies the campaign and the leads.

  • Sends email: leads pushed into an active campaign start receiving its emails.
  • See the Smartlead API reference for the request body fields.

Email accounts​

Add SMTP Email Account

Connects an SMTP/IMAP email account. Each record carries the sender name and address and the SMTP and IMAP host, port, user name, and password, and sets warmup_enabled. Smartlead validates the connection before saving.

Add OAuth Email Account

Connects a Gmail or Outlook email account with OAuth tokens that you already hold. Each record carries the sender name and address and the OAuth token details.

Update Email Account

Updates an email account's settings, such as its daily sending limit, sender name, tracking domain, signature, BCC, and client.

  • Enter the Email Account ID. Use the Get All Email Accounts template to find it.
  • See the Smartlead API reference for the request body fields.

Bulk Update Email Account Config

Updates sending, warmup, tag, and client settings of many email accounts at once. Each record must include emailAccountIds and updateData.

Update Warmup Settings

Configures an email account's warmup. Each record must include warmup_enabled, and can set daily volume, ramp-up, and reply rate.

  • Sends email: enabling warmup starts sending warmup emails from the mailbox.
  • Enter the Email Account ID. Use the Get All Email Accounts template to find it.
  • See the Smartlead API reference for the request body fields.

Suspend Email Account

Suspends an email account from all sending, including campaigns and warmup.

  • Enter the Email Account ID. Use the Get All Email Accounts template to find it.
  • See the Smartlead API reference for the request body fields.

Unsuspend Email Account

Reactivates a suspended email account.

  • Enter the Email Account ID. Use the Get All Email Accounts template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Reconnect Failed Email Accounts

Queues a reconnect of every email account whose SMTP or IMAP connection has failed.

Send Warmup Unblock OTP

Emails a one-time password (OTP) to a warmup-blocked email account, so that its warmup can be unblocked.

  • Sends email: sends an OTP email to the mailbox.
  • Enter the Account ID. This is the email account ID; use the Get All Email Accounts template to find it.
  • See the Smartlead API reference for the request body fields.

Verify Warmup Unblock OTP

Submits the warmup unblock OTP to re-activate an email account's warmup. Each record must include otp.

  • Enter the Account ID. This is the email account ID; use the Get All Email Accounts template to find it.
  • See the Smartlead API reference for the request body fields.

Delete Email Account

Deletes an email account and removes it from all campaigns.

  • Side effect: deletes the mailbox from Smartlead.
  • Enter the Email Account ID. Use the Get All Email Accounts template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Create Tag

Creates an email account tag. Each record must include name, and can set a color in #RRGGBB format.

Update Email Account Tag

Updates an existing email account tag. Each record must include the tag's id, name, and color.

Assign Tags to Email Accounts

Adds tags to email accounts. Each record must include email_account_ids and tag_ids.

Remove Tags from Email Accounts

Removes tags from email accounts. Each record must include email_account_ids and tag_ids.

Master inbox​

Update Lead Category

Sets a lead's category, such as Interested or Not Interested. Each record must include email_lead_map_id and category_id.

Change Read Status

Marks a conversation as read or unread. Each record must include email_lead_map_id and read_status.

Ignore Reply

Marks a reply as ignored, so it is not counted as a reply, or counts it again. Each record must include id and ignore_reply.

Assign Team Member

Assigns a lead to a team member. Each record must include email_lead_map_id and team_member_id.

Update Lead Revenue

Sets the revenue value of a lead, for ROI tracking. Each record must include email_lead_map_id and revenue.

Set Lead Reminder

Sets a reminder on a lead conversation. Each record must include email_lead_map_id, email_stats_id, message, and reminder_time.

Create Lead Note

Adds a note to a lead. Each record must include email_lead_map_id and note_message.

Create Lead Task

Creates a follow-up task for a lead. Each record must include email_lead_map_id and name, and can set a description, priority, and due date.

Block Email Domains

Adds email domains to the block list, so that no campaign emails them. Each record must include domains.

Create Saved View

Creates a saved master inbox view (a named set of filters). Each record must include name and filters.

Associate Untracked Reply to Lead

Links an untracked reply to a campaign lead, so it shows as that lead's reply. Each record must include emailCampaignId, leadMapId, and untrackedReplyId.

Push Lead to Subsequence

Moves a lead into a subsequence (child campaign). Each record must include email_lead_map_id and sub_sequence_id.

  • Sends email: starts sending the subsequence's emails to the lead.
  • See the Smartlead API reference for the request body fields.

Resume Paused Lead

Resumes a paused lead in a campaign. Each record must include campaign_id and email_lead_map_id, and can set resume_delay_days.

  • Sends email: resumes the lead's sequence; it starts receiving emails again.
  • See the Smartlead API reference for the request body fields.

Webhooks​

Create Webhook

Creates a webhook that notifies a URL of events such as emails sent, opened, clicked, and replied. Each record must include webhook_url and association_type (user, client, or campaign).

Update Webhook

Updates a webhook's name, URL, event types, or categories.

  • Enter the Webhook ID. Use the Get Campaign Webhooks template to find it.
  • See the Smartlead API reference for the request body fields.

Delete Webhook

Deletes a webhook by its ID, which each record carries in id. The Delete Campaign Webhook template below deletes a webhook by campaign and webhook ID instead.

Create/Update Campaign Webhook

Creates a webhook on a campaign, or updates one when the record includes the webhook's id. Each record must include name, webhook_url, and event_types.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Delete Campaign Webhook

Deletes a webhook from a campaign, by campaign and webhook ID.

  • Side effect: deletes the webhook.
  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • Enter the Webhook ID. Use the Get Campaign Webhooks template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Retrigger Campaign Webhooks

Retries a campaign's failed webhook deliveries in a time range. Each record must include fromTime and toTime.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • See the Smartlead API reference for the request body fields.

Clients​

Create Client

Creates a client (whitelabel sub-account). Each record must include the client's email and name, and can set permissions and credits.

Add Client Code Snippet

Adds a code snippet (whitelabel code integration) to a client. Each record must include snippet_name and snippet_code.

  • Enter the Client ID. Use the Get All Clients template to find it.
  • See the Smartlead API reference for the request body fields.

Create Client API Key

Creates an API key for a client. Each record must include clientId and keyName. Use Reset Client API Key and Delete Client API Key to manage existing keys.

  • The new API key grants access to the client's data in Smartlead; store it securely.
  • See the Smartlead API reference for the request body fields.

Reset Client API Key

Regenerates a client API key, keeping the same key record.

  • Side effect: invalidates the old client API key.
  • Enter the Reset ID. This is the ID of the client API key to reset, returned when the key is created.
  • See the Smartlead API reference for the request body fields.

Delete Client API Key

Deletes a client API key.

  • Side effect: deletes the client API key.
  • Enter the Api Key ID. This is the ID of the client API key, returned when the key is created.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Delete Client

Deletes a client from your account.

  • Side effect: deletes the client and revokes its API keys.
  • Enter the Client ID. Use the Get All Clients template to find it.
  • Enter the Confirm Email. Enter the client's email address. Smartlead requires it to confirm the deletion.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Utilities​

Send Single Email

Sends a one-off email outside of campaigns. Each record must include to, subject, and body, and can set the sender, reply-to address, and Base64-encoded attachments.

  • Sends email: sends an email immediately for each record.
  • See the Smartlead API reference for the request body fields.

Add to Block List

Adds domains or email addresses to the global block list. Each record carries a domain_block_list array and, optionally, a client_id.

Delete from Block List

Removes an entry from the block list.

  • Side effect: deletes the block-list entry.
  • Enter the ID. This is the ID of the block-list entry; use the Get Domain Block List template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Smart Delivery​

Create Manual Placement Test

Creates a manual spam (inbox placement) test that you complete by sending your email to Smartlead's seed inboxes.

  • Sends email: the test is completed by sending your email to Smartlead's seed inboxes.
  • See the Smartlead API reference for the request body fields.

Create Automated Placement Test

Creates an automated, recurring spam test that sends test emails from your mailboxes on a schedule.

  • Sends email: sends test emails from your mailboxes to Smartlead's seed inboxes on a schedule until the test is stopped.
  • See the Smartlead API reference for the request body fields.

Stop Automated Test

Stops an automated spam test. Its results are kept.

  • Side effect: stops the scheduled spam test.
  • Enter the Spam Test ID. Use the List All Tests template to find it.
  • See the Smartlead API reference for the request body fields.

Delete Tests in Bulk

Deletes spam tests, by test ID, with their reports.

Create Folder

Creates a folder for organizing spam tests.

Delete Folder

Deletes an empty spam test folder.

  • Side effect: deletes the spam-test folder.
  • Enter the Folder ID. Use the Get All Folders template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Smart Prospect​

Find Emails API

Finds email addresses for up to 10 contacts per record. Each record carries a contacts array, each contact with firstName, lastName, and companyDomain.

  • Spends credits: spends Smart Prospect credits to find emails.
  • See the Smartlead API reference for the request body fields.

Fetch Contacts API

Reveals the email addresses of the contacts in a Smart Prospect search. Each record must include filter_id, and can set limit or contact IDs.

  • Spends credits: spends Smart Prospect credits to reveal emails.
  • See the Smartlead API reference for the request body fields.

Save Search API

Saves a Smart Prospect search. Each record must include search_string, and can carry the search filters and a name.

Update Saved Search API

Updates a saved Smart Prospect search. Each record must include search_string.

  • Enter the Save Search ID. Use the Saved Searches API template to find it.
  • See the Smartlead API reference for the request body fields.

Update Fetched Lead API

Updates a fetched Smart Prospect search. Each record must include search_string.

  • Enter the Fetched Search ID. Use the Fetched Searches API template to find it.
  • See the Smartlead API reference for the request body fields.

Review Contacts API

Reviews the contacts of a Smart Prospect search, syncing their metrics and status.

  • Enter the Filter ID. This is the ID of a saved or fetched Smart Prospect search; use the Saved Searches API or Fetched Searches API template to find it.
  • See the Smartlead API reference for the request body fields.

Smart Senders and SmartServers​

Auto Generate Mailboxes

Generates mailbox email addresses for one or more domains in Smart Senders.

Assign SmartInfra to Campaigns

Attaches a SmartInfra (one or more dedicated sending IPs) to many campaigns at once. A record carries infra_id or server_id, and campaign_ids.

Unassign SmartServers from Campaign

Removes the SmartServer assignments from a campaign.

  • Enter the Campaign ID. Use the Get All Campaigns template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Smartlead API reference for the request body fields.

Manual configuration​

Smartlead destinations can also be manually configured to send data to any valid Smartlead API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The Smartlead API expects JSON request bodies. Nexla adds the api_key query parameter from the credential, so leave it out of the endpoint URL.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Smartlead endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Smartlead endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.