Skip to main content
Smartlead logo
  • Category: ai sales tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 51
  • Triggers: 0
  • Slug: SMARTLEAD
  • Version: 20261103_00

Tools

Slug: SMARTLEAD_ADD_CAMPAIGN_LEADSImport 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

object
Optional duplicate, suppression-list, bounce-list, and ID-return controls.
array
required
Between 1 and 400 leads to import into the campaign.
integer
required
Campaign that should receive the leads.
string
Optional Smartlead import type for leads sourced from existing lists.
array
Existing positive lead-list IDs to include in this campaign import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_CONFIGURE_CAMPAIGN_SCHEDULEConfigure the timezone, sending days, daily time window, pacing, and optional new-lead limit for a Smartlead campaign.

Input Parameters

string
required
End of the daily sending window in 24-hour HH:MM format.
string
required
IANA timezone for the sending window.
string
required
Start of the daily sending window in 24-hour HH:MM format.
integer
required
Campaign ID whose sending schedule should be configured.
array
required
Days when emails may be sent, using 0 for Sunday through 6 for Saturday.
integer
Optional minimum number of minutes between consecutive campaign emails.
integer
Optional maximum number of new leads contacted per day.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_CREATE_CAMPAIGNCreate a new campaign in DRAFTED status. This creates persistent account data but does not send email or start the campaign.

Input Parameters

string
required
Distinct name for the draft campaign.
integer
Client sub-account ID that should own the campaign, if applicable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_CREATE_DELIVERY_FOLDERCreate an organizational folder for Smart Delivery tests. This creates persistent data but does not run or send a test.

Input Parameters

string
required
Distinct name for the new Smart Delivery test folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_DELETE_CAMPAIGNPermanently delete a campaign and all associated sequences, mappings, and statistics. This is irreversible and requires explicit confirmation.

Input Parameters

integer
required
Campaign ID to permanently delete.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_DELETE_CAMPAIGN_LEADRemove one lead from a selected campaign without deleting the campaign.

Input Parameters

integer
required
Lead to remove from the campaign.
integer
required
Campaign containing the lead to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_DELETE_DELIVERY_FOLDERDelete an empty Smart Delivery folder. The folder must contain no tests, and deletion requires explicit confirmation.

Input Parameters

string
required
ID of the empty Smart Delivery folder to 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_CAMPAIGNGet configuration and performance summary for one Smartlead campaign by ID.

Input Parameters

integer
required
Campaign ID returned by a list or create campaign operation.
boolean
Whether to include campaign tags in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_CAMPAIGN_ANALYTICSRetrieve lifetime campaign performance analytics, or date-bounded analytics when start and end dates are supplied together.

Input Parameters

string
Last analytics date in YYYY-MM-DD format; requires start_date and must be no more than 30 days after it.
string
IANA time zone used for date boundaries on date-bounded analytics.
string
First analytics date in YYYY-MM-DD format; requires end_date.
integer
required
Campaign whose performance analytics to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_CAMPAIGNSGet configuration and performance summaries for 1-20 Smartlead campaigns. Returns one success or failure result per campaign ID.

Input Parameters

array
required
Campaign IDs to retrieve in order (1-20 IDs).
boolean
Whether to include campaign tags in each campaign response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_CAMPAIGN_SEQUENCESGet a campaign’s ordered email sequence steps, including message content, delays, and A/B test variants.

Input Parameters

integer
required
Campaign whose ordered email sequence steps to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_CAMPAIGN_STATISTICSReturn one offset-paginated page of email-level campaign statistics, optionally filtered by sequence step, engagement status, or sent time.

Input Parameters

integer
Maximum statistics records to return (1-1000).
integer
Zero-based result offset.
integer
required
Campaign whose email-level statistics to retrieve.
string ("opened" | "clicked" | "replied" | "unsubscribed" | "bounced")
Return only emails that were opened, clicked, replied to, unsubscribed, or bounced.
string
Inclusive sent-time end in ISO 8601 format.
string
Inclusive sent-time start in ISO 8601 format.
integer
Return statistics only for this campaign sequence step (1-20).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_CAMPAIGN_WEBHOOK_SUMMARYGet a campaign’s webhook delivery activity for a required time range.

Input Parameters

string
required
Inclusive end of the webhook activity range as an ISO 8601 datetime.
string
required
Inclusive start of the webhook activity range as an ISO 8601 datetime.
integer
required
Campaign whose webhook delivery activity to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_DAY_WISE_OVERALL_STATSRetrieve account-wide daily Smartlead email engagement metrics for an inclusive date range and timezone.

Input Parameters

string
required
Last date in the inclusive analytics range, in YYYY-MM-DD format; must be on or after start_date.
string
Timezone Smartlead uses for the inclusive date boundaries.
array
Client IDs to include, sent to Smartlead as one comma-separated value.
string
required
First date in the inclusive analytics range, in YYYY-MM-DD format.
array
Campaign IDs to include, sent to Smartlead as one comma-separated value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_DELIVERY_TESTGet the documented configuration for one Smart Delivery spam test by ID.

Input Parameters

string
required
Spam test ID returned by List Smart Delivery Tests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_EMAIL_ACCOUNT_WARMUP_STATSRetrieve recent daily warmup performance statistics for one Smartlead sending account.

Input Parameters

integer
required
Sending account ID returned by LIST_EMAIL_ACCOUNTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_INBOX_CONVERSATIONRetrieve one Master Inbox conversation by campaign-lead-map ID, requesting its message history.

Input Parameters

integer
required
Campaign-lead-map ID from inbox or campaign lead results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_LEADRetrieve a global Smartlead lead by numeric ID.

Input Parameters

integer
required
Numeric ID of the global lead to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_LEAD_BY_EMAILFind an account-wide Smartlead lead by exact email address and return its contact details and campaign memberships.

Input Parameters

string
required
Exact lead email address to find across the Smartlead account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_LEAD_CAMPAIGN_OVERVIEWRetrieve a Smartlead lead by ID with every campaign membership, campaign status, and current sequence position.

Input Parameters

integer
required
Lead ID whose campaign memberships should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_LEAD_MESSAGE_HISTORYGet a campaign lead’s email conversation history, optionally filtering by time and including plain text bodies.

Input Parameters

integer
required
Lead whose conversation history to retrieve.
integer
required
Campaign containing the lead.
string
Return messages after this ISO 8601 timestamp.
boolean
Include plain text email content when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_MAILBOX_HEALTH_METRICSRetrieve date-bounded health and performance metrics for individual Smartlead sending mailboxes.

Input Parameters

integer
Maximum number of mailbox metrics for Smartlead to return.
integer
Pagination offset requested from Smartlead.
string
required
Last date in the inclusive analytics range, in YYYY-MM-DD format; must be on or after start_date.
string
IANA timezone Smartlead uses for the inclusive date boundaries.
boolean
Whether Smartlead should return detailed metrics for the full data set.
array
Client IDs to include, sent to Smartlead as one comma-separated value.
boolean
Filter mailboxes by whether they have bounced.
string
required
First date in the inclusive analytics range, in YYYY-MM-DD format.
array
Campaign IDs to include, sent to Smartlead as one comma-separated value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_OVERALL_ANALYTICSRetrieve account-wide Smartlead email performance counts and rates for an inclusive date range.

Input Parameters

string
required
Last date in the inclusive analytics range, in YYYY-MM-DD format; must be on or after start_date.
string
Timezone Smartlead uses for the inclusive date boundaries.
boolean
Whether Smartlead should return detailed metrics for the full data set.
boolean
Whether to filter analytics for agency accounts.
array
Client IDs to include, sent to Smartlead as one comma-separated value.
string
required
First date in the inclusive analytics range, in YYYY-MM-DD format.
array
Campaign IDs to include, sent to Smartlead as one comma-separated value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_GET_PROSPECT_USAGEGet Smart Prospect lead-search metrics, fetch counts, daily limits, and available credit balance. This read does not consume credits.

Input Parameters

string
Optional numeric Smart Prospect filter ID for filter-specific lead and email metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_ACCOUNT_LEADSReturn one filtered, offset- or cursor-paginated page of leads across the connected Smartlead account without requiring a campaign.

Input Parameters

string
Return leads matching this email address.
integer
Maximum leads to return in this page (1-100). Omit to use Smartlead’s documented default of 1.
integer
Number of matching leads to skip; do not combine with a cursor.
string
Opaque continuation cursor returned by a previous call.
string
Return leads created after this date, in YYYY-MM-DD format.
integer
Provider lead ID returned by a previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_CAMPAIGN_LEADSReturn one offset-paginated page of leads in a campaign with optional status, category, engagement, and date filters.

Input Parameters

integer
Maximum leads to return (1-100).
integer
Zero-based result offset.
string ("STARTED" | "INPROGRESS" | "COMPLETED" | "PAUSED" | "STOPPED")
Return leads with this sequence status.
integer
required
Campaign whose leads to list.
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.
string
Return leads created after this ISO 8601 date-time.
string
Return leads whose last event is after this ISO 8601 date-time.
integer
Return leads assigned to this category ID.
string
Return leads last emailed after this ISO 8601 date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_CAMPAIGNSList campaigns visible to the connected Smartlead account, optionally for one client.

Input Parameters

integer
Return only campaigns belonging to this client ID.
boolean
Include campaign tags in each result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_CAMPAIGN_WEBHOOKSReturn webhook registrations configured for a Smartlead campaign.

Input Parameters

integer
required
Campaign whose webhook registrations to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_CLIENTSList whitelabel client sub-accounts and the identifiers used by client-scoped Smartlead actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_DELIVERY_FOLDERSList folders used to organize Smart Delivery tests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_DELIVERY_TESTSList Smart Delivery spam and inbox-placement tests. This POST endpoint is read-only and does not create or send a test.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_DOMAIN_BLOCK_ENTRIESReturn one offset-paginated page of email addresses and domains excluded from Smartlead outreach, optionally filtered by client or search text.

Input Parameters

integer
Maximum entries to return (1-1000).
integer
Zero-based result offset.
integer
Return entries assigned to this client ID.
string
Search blocked email addresses and domains.
string
Search for an email address containing a domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_EMAIL_ACCOUNTSList 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

integer
Maximum accounts to return in this page (1-100).
boolean
Filter by whether the account is used in campaigns.
string ("GMAIL" | "OUTLOOK" | "SMTP")
Filter by email service provider.
string
Partially match the sending username.
integer
Filter accounts by client ID.
string
Opaque continuation cursor returned by a previous call.
string ("ACTIVE" | "INACTIVE")
Filter by ACTIVE or INACTIVE warmup status.
boolean
Filter by SMTP connection success.
boolean
Filter by whether warmup is blocked.
boolean
Include campaign IDs attached to each account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_INBOX_REPLIESList 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

integer
Maximum replies in this page (1-20).
Match lead email, name, or message text (maximum 30 characters).
string ("REPLY_TIME_DESC" | "SENT_TIME_DESC")
Sort by most recent reply time or most recent sent time.
string
Opaque continuation cursor returned by a previous call. Omit for the first page.
array
Campaign IDs to include (maximum five).
array
Lead category IDs to include (maximum 10).
array
Engagement statuses to include.
array
Sending-account IDs to include (maximum 20).
array
Exactly two ISO 8601 timestamps defining the reply-time range.
boolean
Include complete conversation threads. False returns only the latest message and is faster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_PROSPECT_INDUSTRIESList and search Smart Prospect industry filter values without searching contacts or consuming contact-fetch credits.

Input Parameters

integer
Maximum industries to return in this page (1-100).
string
Prefix to match against industry names.
string
Opaque continuation cursor returned by a previous call.
boolean
Include sub-industry values for each industry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_PURCHASED_DOMAINSList domains already purchased through Smart Senders. This is read-only and does not purchase domains or provision mailboxes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_SAVED_PROSPECT_SEARCHESList saved Smart Prospect search definitions without executing them or consuming contact-search credits.

Input Parameters

integer
Maximum saved searches to return in this page.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_LIST_SENDER_VENDORSList Smart Senders marketplace vendors and current domain/mailbox pricing without placing an order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_PAUSE_CAMPAIGN_LEADPause scheduled outreach for one lead in a campaign.

Input Parameters

integer
required
Lead whose scheduled outreach should be paused.
integer
required
Campaign containing the lead to pause.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_RESUME_CAMPAIGN_LEADResume a paused lead in a campaign, optionally after a delay.

Input Parameters

integer
required
Paused lead to resume.
integer
required
Campaign containing the paused lead.
integer
Days to wait before resuming; omit to use the sequence default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_SAVE_CAMPAIGN_WEBHOOKCreate a webhook for campaign events, or update an existing webhook when webhook_id is supplied.

Input Parameters

string
required
Name used to identify the webhook.
integer
Existing webhook ID to update. Omit for a new webhook.
integer
required
Campaign whose webhook should be created or updated.
array
required
Campaign events that trigger the webhook.
string
required
Absolute HTTP(S) URL that receives Smartlead webhook requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_SEARCH_AVAILABLE_DOMAINSCheck 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

integer
required
Vendor ID returned by List Smart Senders Vendors.
string
required
Domain name or candidate text to check for marketplace availability. This search does not purchase the domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_SEARCH_CAMPAIGN_LEADSSearch one cursor-paginated page of campaign leads by text, status, category, sequence, sender, source, and manual-completion filters.

Input Parameters

integer
Maximum leads to return (1-100).
string ("drafted_table" | "active_table")
Return the compact drafted-table or full active-table lead fields.
integer
required
Campaign whose leads to search.
string
Opaque continuation cursor returned by a previous search page.
string
Text to match across lead email, first name, and last name.
array
Campaign sequence IDs to include.
array
Lead sequence statuses to include.
array
Segment types to include (each 0-10).
string ("all" | "active" | "replied" | "failed" | "scheduled" | "manual_followups" | "completed" | "paused")
Campaign lead status tab to search.
array
Email engagement statuses to include.
array
ESP domain types to include (each 0-2).
array
Sequence step numbers to include (each 1-999).
array
Sending email account IDs to include.
integer
Lead map ID cursor from a previous page.
array
Lead category IDs to include; use -1 to also include uncategorized leads.
string
Latest reply time cursor used with last_seen_lead_id for replied active-table searches.
array
Sequence variant IDs to include.
boolean
Include leads whose sender account bounced.
boolean
Return only leads without a category.
string ("MANUAL" | "AUTO")
Filter by manual or automatic sequence scheduling.
array
Deleted lead email addresses to include (maximum 320 characters each).
array
Manual sequence IDs used with the manual-completion filter.
boolean
Filter leads eligible for manual completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_SEARCH_PROSPECT_CONTACTSSearch 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

integer
required
Contacts to return in this credit-consuming page (1-500). Choose the smallest useful value.
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”]}.
string
Opaque cursor returned by a previous page. Continuing performs another credit-consuming call.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_SEND_SINGLE_EMAILImmediately send one email outside a campaign from a connected Smartlead sender account. This externally visible action cannot be undone.

Input Parameters

string
required
Recipient email address.
string
required
HTML or plain-text email body.
string
required
Email subject.
string
Reply-to email address.
string
Sender display name.
string
Sender email address; provide exactly one of this or from_email_id.
array
Files to attach, each with a filename, base64-encoded content, and provider-required mimeType.
integer
Smartlead sender account ID; provide exactly one of this or from_email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_UNSUBSCRIBE_CAMPAIGN_LEADPermanently unsubscribe a lead from future email in a specific campaign. This cannot be undone through the Smartlead API.

Input Parameters

integer
required
Lead to unsubscribe permanently; this cannot be undone through the API.
integer
required
Campaign containing the lead to unsubscribe permanently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_UPDATE_CAMPAIGN_LEADUpdate one campaign lead’s contact information and merge custom fields using Smartlead’s current campaign-lead endpoint.

Input Parameters

string
required
Current or replacement email address required by Smartlead.
integer
required
Lead to update.
string
Updated website URL.
string
Updated location.
string
Updated last name.
string
Updated first name.
integer
required
Campaign containing the lead.
string
Updated company URL.
string
Updated company name.
string
Updated phone number.
object
Up to 200 custom fields to merge into the lead.
string
Updated LinkedIn profile URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_UPDATE_CAMPAIGN_SEQUENCESCreate or update a draft or paused campaign’s ordered email sequence steps, including delays and documented A/B test variants.

Input Parameters

array
required
One or more ordered email sequence steps.
integer
required
Draft or paused campaign whose sequence steps to create or update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_UPDATE_CAMPAIGN_SETTINGSChange settings for future campaign sends; in-progress leads keep their existing settings. Omitted settings remain unchanged.

Input Parameters

string
New campaign name.
integer
Client ID to associate with the campaign. Pass null explicitly to clear it; omit this field to leave it unchanged.
integer
required
Campaign whose settings to update.
array
Tracking features to disable. Pass an empty list to enable all tracking.
boolean
Whether to force plain-text delivery.
string
Unsubscribe text to include in campaign emails.
boolean
Whether to send campaign emails as plain text.
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.
boolean
Whether to add an unsubscribe tag to campaign emails.
integer
Percentage of campaign sends allocated to follow-ups.
boolean
Whether to enable AI-based email service provider matching.
boolean
Whether to apply domain-level sending rate limits.
array
Provider-defined AI reply categorization option objects.
string
Bounce threshold at which Smartlead automatically pauses the campaign.
boolean
Whether to ignore the SmartSend mailbox sending limit.
boolean
Whether a reply should pause other leads from the same domain.
object
Out-of-office reply handling and automatic reactivation settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_UPDATE_CAMPAIGN_STATUSStart, pause, stop, or archive a campaign. STOPPED is permanent and cannot be undone; START can begin sending emails.

Input Parameters

string ("START" | "PAUSED" | "STOPPED" | "ARCHIVED")
required
New campaign status. STOPPED permanently stops the campaign and cannot be undone; START can begin sending emails.
integer
required
Campaign to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTLEAD_UPDATE_LEAD_CATEGORYAssign, change, or remove a category for one campaign lead, optionally pausing campaign outreach for it.

Input Parameters

integer
required
Lead whose campaign category should be updated.
boolean
Whether to pause campaign outreach for the lead after the update.
integer
required
Campaign containing the lead.
string
required
Category ID to assign. Pass null explicitly to remove the category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not