/smartlead | Type: Application | PCID required: Yes
Tools
smartlead_add_domain_block_list
Add domains to block list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domains | any[] | Yes | — | List of domains to block |
smartlead_add_email_account_to_campaign
Add email account to a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
email_account_id | integer | Yes | — | The email account ID to add |
smartlead_add_leads_to_campaign
Add leads to a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_list | any[] | Yes | — | Array of lead objects to add |
settings | object | No | — | Import settings |
smartlead_configure_email_warmup
Configure email warmup Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_account_id | integer | Yes | — | The email account ID |
daily_rampup | integer | Yes | — | Additional warmup emails added per day |
reply_rate_percentage | integer | Yes | — | Percentage of warmup emails to reply to |
total_warmup_per_day | integer | Yes | — | Total warmup emails per day |
warmup_enabled | boolean | Yes | — | Whether warmup is enabled |
smartlead_create_campaign
Create a new campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
client_id | integer | No | — | Client ID to associate the campaign with |
name | string | No | — | Campaign name. Defaults to “Untitled Campaign” if not provided. |
smartlead_create_email_account
Create a new email account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bcc | string | No | — | BCC email address |
custom_tracking_url | string | No | — | Custom tracking domain URL |
from_email | string | Yes | — | Email address to send from |
from_name | string | Yes | — | Display name for the sender |
imap_host | string | Yes | — | IMAP server hostname (e.g., imap.gmail.com) |
imap_port | integer | Yes | — | IMAP port (typically 993) |
max_email_per_day | integer | No | — | Maximum emails to send per day |
password | string | Yes | — | App password for SMTP/IMAP |
signature | string | No | — | HTML email signature |
smtp_host | string | Yes | — | SMTP server hostname (e.g., smtp.gmail.com) |
smtp_port | integer | Yes | — | SMTP port (587 for TLS, 465 for SSL) |
smtp_port_type | string | Yes | — | SMTP encryption type |
username | string | Yes | — | SMTP/IMAP login username |
smartlead_delete_campaign
Delete a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
smartlead_delete_lead_from_campaign
Delete a lead from a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
smartlead_export_campaign_leads
Export campaign leads to CSV Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
smartlead_get_analytics_overview
Get global analytics overviewsmartlead_get_campaign
Get a campaign by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
smartlead_get_campaign_analytics
Get top-level campaign analytics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
smartlead_get_campaign_analytics_by_date
Get campaign analytics by date range Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
start_date | string | No | — | Start date (YYYY-MM-DD format) |
end_date | string | No | — | End date (YYYY-MM-DD format) |
smartlead_get_campaign_sequences
Get campaign email sequences Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
smartlead_get_campaign_statistics
Get campaign statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
smartlead_get_email_account
Get an email account by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_account_id | integer | Yes | — | The email account ID |
smartlead_get_email_warmup_stats
Get email warmup statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_account_id | integer | Yes | — | The email account ID |
smartlead_get_lead_by_email
Get a lead by email address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | The lead’s email address |
smartlead_get_lead_campaigns
Get campaigns for a lead Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
lead_id | integer | Yes | — | The lead ID |
smartlead_get_lead_categories
Get lead categoriessmartlead_get_lead_message_history
Get message history for a lead Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
smartlead_list_campaign_email_accounts
List email accounts assigned to a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
smartlead_list_campaign_leads
List leads in a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
offset | integer | No | — | Pagination offset |
limit | integer | No | — | Number of results to return (max 100) |
smartlead_list_campaigns
List all campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
client_id | integer | No | — | Filter campaigns by client ID |
include_tags | boolean | No | — | Include campaign tags in the response |
smartlead_list_email_accounts
List all email accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | No | — | Pagination offset |
limit | integer | No | — | Number of results to return (max 100) |
smartlead_pause_lead
Pause a lead in a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
smartlead_remove_email_account_from_campaign
Remove email account from a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
email_account_id | integer | Yes | — | The email account ID to remove |
smartlead_reply_to_email_thread
Reply to a lead’s email thread Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
email_body | string | Yes | — | The reply email body in HTML |
lead_id | integer | Yes | — | The lead ID to reply to |
smartlead_resume_lead
Resume a lead in a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
smartlead_save_campaign_sequences
Save campaign email sequences Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
body | any[] | Yes | — | Request body |
smartlead_unsubscribe_lead_from_campaign
Unsubscribe a lead from a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
smartlead_unsubscribe_lead_globally
Unsubscribe a lead globally Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
lead_id | integer | Yes | — | The lead ID |
smartlead_update_campaign_schedule
Update campaign sending schedule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
days_of_the_week | any[] | Yes | — | Active days (0=Sunday through 6=Saturday) |
end_hour | string | Yes | — | End hour in 24-hour format (e.g., 19:00) |
max_leads_per_day | integer | Yes | — | Maximum number of leads to contact per day |
min_time_btw_emails | integer | Yes | — | Minimum minutes between emails |
start_hour | string | Yes | — | Start hour in 24-hour format (e.g., 09:00) |
timezone | string | Yes | — | IANA timezone format (e.g., America/New_York) |
smartlead_update_campaign_settings
Update campaign general settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
client_id | integer | No | — | Client ID to associate (null to remove) |
enable_ai_esp_matching | boolean | No | — | Enable AI ESP matching |
follow_up_percentage | number | No | — | Follow-up percentage (0-100) |
send_as_plain_text | boolean | No | — | Send emails as plain text instead of HTML |
stop_lead_settings | string | No | — | When to stop sending to a lead |
track_settings | any[] | No | — | Tracking flags to disable |
unsubscribe_text | string | No | — | Custom unsubscribe text |
smartlead_update_campaign_status
Update campaign status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
status | string | Yes | — | New campaign status: ACTIVE, PAUSED, or STOPPED |
smartlead_update_email_account
Update an email account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_account_id | integer | Yes | — | The email account ID |
bcc | string | No | — | BCC email address |
custom_tracking_url | string | No | — | Custom tracking domain URL |
from_email | string | No | — | Email address to send from |
from_name | string | No | — | Display name for the sender |
max_email_per_day | integer | No | — | Maximum emails to send per day |
signature | string | No | — | HTML email signature |
smartlead_update_lead
Update a lead in a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
company | string | No | — | company |
custom_fields | object | No | — | custom_fields |
first_name | string | No | — | first_name |
last_name | string | No | — | last_name |

