Skip to main content
Server path: /smartlead | Type: Application | PCID required: Yes

Tools

ToolDescription
smartlead_add_domain_block_listAdd domains to block list
smartlead_add_email_account_to_campaignAdd email account to a campaign
smartlead_add_leads_to_campaignAdd leads to a campaign
smartlead_configure_email_warmupConfigure email warmup
smartlead_create_campaignCreate a new campaign
smartlead_create_email_accountCreate a new email account
smartlead_delete_campaignDelete a campaign
smartlead_delete_lead_from_campaignDelete a lead from a campaign
smartlead_export_campaign_leadsExport campaign leads to CSV
smartlead_get_analytics_overviewGet global analytics overview
smartlead_get_campaignGet a campaign by ID
smartlead_get_campaign_analyticsGet top-level campaign analytics
smartlead_get_campaign_analytics_by_dateGet campaign analytics by date range
smartlead_get_campaign_sequencesGet campaign email sequences
smartlead_get_campaign_statisticsGet campaign statistics
smartlead_get_email_accountGet an email account by ID
smartlead_get_email_warmup_statsGet email warmup statistics
smartlead_get_lead_by_emailGet a lead by email address
smartlead_get_lead_campaignsGet campaigns for a lead
smartlead_get_lead_categoriesGet lead categories
smartlead_get_lead_message_historyGet message history for a lead
smartlead_list_campaign_email_accountsList email accounts assigned to a campaign
smartlead_list_campaign_leadsList leads in a campaign
smartlead_list_campaignsList all campaigns
smartlead_list_email_accountsList all email accounts
smartlead_pause_leadPause a lead in a campaign
smartlead_remove_email_account_from_campaignRemove email account from a campaign
smartlead_reply_to_email_threadReply to a lead’s email thread
smartlead_resume_leadResume a lead in a campaign
smartlead_save_campaign_sequencesSave campaign email sequences
smartlead_unsubscribe_lead_from_campaignUnsubscribe a lead from a campaign
smartlead_unsubscribe_lead_globallyUnsubscribe a lead globally
smartlead_update_campaign_scheduleUpdate campaign sending schedule
smartlead_update_campaign_settingsUpdate campaign general settings
smartlead_update_campaign_statusUpdate campaign status
smartlead_update_email_accountUpdate an email account
smartlead_update_leadUpdate a lead in a campaign

smartlead_add_domain_block_list

Add domains to block list Parameters:
ParameterTypeRequiredDefaultDescription
domainsany[]YesList of domains to block

smartlead_add_email_account_to_campaign

Add email account to a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
email_account_idintegerYesThe email account ID to add

smartlead_add_leads_to_campaign

Add leads to a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
lead_listany[]YesArray of lead objects to add
settingsobjectNoImport settings

smartlead_configure_email_warmup

Configure email warmup Parameters:
ParameterTypeRequiredDefaultDescription
email_account_idintegerYesThe email account ID
daily_rampupintegerYesAdditional warmup emails added per day
reply_rate_percentageintegerYesPercentage of warmup emails to reply to
total_warmup_per_dayintegerYesTotal warmup emails per day
warmup_enabledbooleanYesWhether warmup is enabled

smartlead_create_campaign

Create a new campaign Parameters:
ParameterTypeRequiredDefaultDescription
client_idintegerNoClient ID to associate the campaign with
namestringNoCampaign name. Defaults to “Untitled Campaign” if not provided.

smartlead_create_email_account

Create a new email account Parameters:
ParameterTypeRequiredDefaultDescription
bccstringNoBCC email address
custom_tracking_urlstringNoCustom tracking domain URL
from_emailstringYesEmail address to send from
from_namestringYesDisplay name for the sender
imap_hoststringYesIMAP server hostname (e.g., imap.gmail.com)
imap_portintegerYesIMAP port (typically 993)
max_email_per_dayintegerNoMaximum emails to send per day
passwordstringYesApp password for SMTP/IMAP
signaturestringNoHTML email signature
smtp_hoststringYesSMTP server hostname (e.g., smtp.gmail.com)
smtp_portintegerYesSMTP port (587 for TLS, 465 for SSL)
smtp_port_typestringYesSMTP encryption type
usernamestringYesSMTP/IMAP login username

smartlead_delete_campaign

Delete a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID

smartlead_delete_lead_from_campaign

Delete a lead from a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
lead_idintegerYesThe lead ID

smartlead_export_campaign_leads

Export campaign leads to CSV Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID

smartlead_get_analytics_overview

Get global analytics overview

smartlead_get_campaign

Get a campaign by ID Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID

smartlead_get_campaign_analytics

Get top-level campaign analytics Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID

smartlead_get_campaign_analytics_by_date

Get campaign analytics by date range Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
start_datestringNoStart date (YYYY-MM-DD format)
end_datestringNoEnd date (YYYY-MM-DD format)

smartlead_get_campaign_sequences

Get campaign email sequences Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID

smartlead_get_campaign_statistics

Get campaign statistics Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID

smartlead_get_email_account

Get an email account by ID Parameters:
ParameterTypeRequiredDefaultDescription
email_account_idintegerYesThe email account ID

smartlead_get_email_warmup_stats

Get email warmup statistics Parameters:
ParameterTypeRequiredDefaultDescription
email_account_idintegerYesThe email account ID

smartlead_get_lead_by_email

Get a lead by email address Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesThe lead’s email address

smartlead_get_lead_campaigns

Get campaigns for a lead Parameters:
ParameterTypeRequiredDefaultDescription
lead_idintegerYesThe lead ID

smartlead_get_lead_categories

Get lead categories

smartlead_get_lead_message_history

Get message history for a lead Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
lead_idintegerYesThe lead ID

smartlead_list_campaign_email_accounts

List email accounts assigned to a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID

smartlead_list_campaign_leads

List leads in a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
offsetintegerNoPagination offset
limitintegerNoNumber of results to return (max 100)

smartlead_list_campaigns

List all campaigns Parameters:
ParameterTypeRequiredDefaultDescription
client_idintegerNoFilter campaigns by client ID
include_tagsbooleanNoInclude campaign tags in the response

smartlead_list_email_accounts

List all email accounts Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoPagination offset
limitintegerNoNumber of results to return (max 100)

smartlead_pause_lead

Pause a lead in a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
lead_idintegerYesThe lead ID

smartlead_remove_email_account_from_campaign

Remove email account from a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
email_account_idintegerYesThe email account ID to remove

smartlead_reply_to_email_thread

Reply to a lead’s email thread Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
email_bodystringYesThe reply email body in HTML
lead_idintegerYesThe lead ID to reply to

smartlead_resume_lead

Resume a lead in a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
lead_idintegerYesThe lead ID

smartlead_save_campaign_sequences

Save campaign email sequences Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
bodyany[]YesRequest body

smartlead_unsubscribe_lead_from_campaign

Unsubscribe a lead from a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
lead_idintegerYesThe lead ID

smartlead_unsubscribe_lead_globally

Unsubscribe a lead globally Parameters:
ParameterTypeRequiredDefaultDescription
lead_idintegerYesThe lead ID

smartlead_update_campaign_schedule

Update campaign sending schedule Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
days_of_the_weekany[]YesActive days (0=Sunday through 6=Saturday)
end_hourstringYesEnd hour in 24-hour format (e.g., 19:00)
max_leads_per_dayintegerYesMaximum number of leads to contact per day
min_time_btw_emailsintegerYesMinimum minutes between emails
start_hourstringYesStart hour in 24-hour format (e.g., 09:00)
timezonestringYesIANA timezone format (e.g., America/New_York)

smartlead_update_campaign_settings

Update campaign general settings Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
client_idintegerNoClient ID to associate (null to remove)
enable_ai_esp_matchingbooleanNoEnable AI ESP matching
follow_up_percentagenumberNoFollow-up percentage (0-100)
send_as_plain_textbooleanNoSend emails as plain text instead of HTML
stop_lead_settingsstringNoWhen to stop sending to a lead
track_settingsany[]NoTracking flags to disable
unsubscribe_textstringNoCustom unsubscribe text

smartlead_update_campaign_status

Update campaign status Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
statusstringYesNew campaign status: ACTIVE, PAUSED, or STOPPED

smartlead_update_email_account

Update an email account Parameters:
ParameterTypeRequiredDefaultDescription
email_account_idintegerYesThe email account ID
bccstringNoBCC email address
custom_tracking_urlstringNoCustom tracking domain URL
from_emailstringNoEmail address to send from
from_namestringNoDisplay name for the sender
max_email_per_dayintegerNoMaximum emails to send per day
signaturestringNoHTML email signature

smartlead_update_lead

Update a lead in a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaign_idintegerYesThe campaign ID
lead_idintegerYesThe lead ID
companystringNocompany
custom_fieldsobjectNocustom_fields
first_namestringNofirst_name
last_namestringNolast_name